You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libsdr/fftplan_8hh_source.html

152 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>libsdr: /Users/hannes/Uni/Elektronik/sdr/libsdr/src/fftplan.hh Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libsdr
&#160;<span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">A simple SDR library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">fftplan.hh</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __SDR_FFTPLAN_HH__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __SDR_FFTPLAN_HH__</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;buffer.hh&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;node.hh&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;config.hh&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesdr.html">sdr</a> {</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// Forward declaration of FFTPlan</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classsdr_1_1_f_f_t_plan.html"> 11</a></span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> Scalar&gt; <span class="keyword">class </span><a class="code" href="classsdr_1_1_f_f_t_plan.html">FFTPlan</a> { };</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classsdr_1_1_f_f_t.html"> 14</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsdr_1_1_f_f_t.html">FFT</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classsdr_1_1_f_f_t.html#a02a2b7ef1f2494d542b133a4995e5344"> 17</a></span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; FORWARD, BACKWARD</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; } <a class="code" href="classsdr_1_1_f_f_t.html#a02a2b7ef1f2494d542b133a4995e5344">Direction</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span> Scalar&gt;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classsdr_1_1_f_f_t.html#a8aaadbbb8ce1c61fd90c5b9842753d1c"> 23</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classsdr_1_1_f_f_t.html#a8aaadbbb8ce1c61fd90c5b9842753d1c">exec</a>(<span class="keyword">const</span> <a class="code" href="classsdr_1_1_buffer.html">Buffer</a>&lt; std::complex&lt;Scalar&gt; &gt; &amp;in,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">const</span> <a class="code" href="classsdr_1_1_buffer.html">Buffer</a>&lt; std::complex&lt;Scalar&gt; &gt; &amp;out, <a class="code" href="classsdr_1_1_f_f_t.html#a02a2b7ef1f2494d542b133a4995e5344">FFT::Direction</a> dir)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classsdr_1_1_f_f_t_plan.html">FFTPlan&lt;Scalar&gt;</a> plan(in, out, dir); plan();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span> Scalar&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classsdr_1_1_f_f_t.html#a9eede624e80fd59823522653156c0dc4"> 31</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classsdr_1_1_f_f_t.html#a9eede624e80fd59823522653156c0dc4">exec</a>(<span class="keyword">const</span> <a class="code" href="classsdr_1_1_buffer.html">Buffer</a>&lt; std::complex&lt;Scalar&gt; &gt; &amp;inplace, <a class="code" href="classsdr_1_1_f_f_t.html#a02a2b7ef1f2494d542b133a4995e5344">FFT::Direction</a> dir)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classsdr_1_1_f_f_t_plan.html">FFTPlan&lt;Scalar&gt;</a> plan(inplace, dir); plan();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#ifdef SDR_WITH_FFTW</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;fftplan_fftw3.hh&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#endif // __SDR_FFTPLAN_HH__</span></div>
<div class="ttc" id="classsdr_1_1_f_f_t_html_a02a2b7ef1f2494d542b133a4995e5344"><div class="ttname"><a href="classsdr_1_1_f_f_t.html#a02a2b7ef1f2494d542b133a4995e5344">sdr::FFT::Direction</a></div><div class="ttdeci">Direction</div><div class="ttdoc">Direction type. </div><div class="ttdef"><b>Definition:</b> fftplan.hh:17</div></div>
<div class="ttc" id="namespacesdr_html"><div class="ttname"><a href="namespacesdr.html">sdr</a></div><div class="ttdef"><b>Definition:</b> autocast.hh:8</div></div>
<div class="ttc" id="classsdr_1_1_f_f_t_plan_html"><div class="ttname"><a href="classsdr_1_1_f_f_t_plan.html">sdr::FFTPlan</a></div><div class="ttdoc">Trivial FFT implementation for buffer sizes of N=2**K. </div><div class="ttdef"><b>Definition:</b> fftplan.hh:11</div></div>
<div class="ttc" id="classsdr_1_1_f_f_t_html_a8aaadbbb8ce1c61fd90c5b9842753d1c"><div class="ttname"><a href="classsdr_1_1_f_f_t.html#a8aaadbbb8ce1c61fd90c5b9842753d1c">sdr::FFT::exec</a></div><div class="ttdeci">static void exec(const Buffer&lt; std::complex&lt; Scalar &gt; &gt; &amp;in, const Buffer&lt; std::complex&lt; Scalar &gt; &gt; &amp;out, FFT::Direction dir)</div><div class="ttdoc">Performs a FFT transform. </div><div class="ttdef"><b>Definition:</b> fftplan.hh:23</div></div>
<div class="ttc" id="classsdr_1_1_f_f_t_html_a9eede624e80fd59823522653156c0dc4"><div class="ttname"><a href="classsdr_1_1_f_f_t.html#a9eede624e80fd59823522653156c0dc4">sdr::FFT::exec</a></div><div class="ttdeci">static void exec(const Buffer&lt; std::complex&lt; Scalar &gt; &gt; &amp;inplace, FFT::Direction dir)</div><div class="ttdoc">Performs an in-place FFT transform. </div><div class="ttdef"><b>Definition:</b> fftplan.hh:31</div></div>
<div class="ttc" id="classsdr_1_1_f_f_t_html"><div class="ttname"><a href="classsdr_1_1_f_f_t.html">sdr::FFT</a></div><div class="ttdoc">FFT module class, provides static methods to perfrom a FFT directly. </div><div class="ttdef"><b>Definition:</b> fftplan.hh:14</div></div>
<div class="ttc" id="classsdr_1_1_buffer_html"><div class="ttname"><a href="classsdr_1_1_buffer.html">sdr::Buffer</a></div><div class="ttdoc">A typed buffer. </div><div class="ttdef"><b>Definition:</b> buffer.hh:111</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:36 for libsdr by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>