Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 3497

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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"/>
<title>GNU Radio 3.2.2 C++ API: gcp_fft_1d_r2.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">GNU Radio 3.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('gcp__fft__1d__r2_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>gcp_fft_1d_r2.h File Reference</h1>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;gcell/gc_job_manager.h&gt;</code><br/>
<code>#include &lt;complex&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for gcp_fft_1d_r2.h:</div>
<div class="dyncontent">
<div class="center"><img src="gcp__fft__1d__r2_8h__incl.png" border="0" usemap="#gcp__fft__1d__r2_8h" alt=""/></div>
<map name="gcp__fft__1d__r2_8h" id="gcp__fft__1d__r2_8h">
</map>
</div>
</div>
<p><a href="gcp__fft__1d__r2_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_desc_sptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcp__fft__1d__r2_8h.html#aa183dec93bff6e55d81ab68aad393864">gcp_fft_1d_r2_submit</a> (<a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> mgr, unsigned int log2_fft_length, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> forward, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> shift, std::complex&lt; float &gt; *out, const std::complex&lt; float &gt; *in, const std::complex&lt; float &gt; *twiddle, const float *window)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit a job that computes the forward or inverse FFT.  <a href="#aa183dec93bff6e55d81ab68aad393864"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gcp__fft__1d__r2_8h.html#ad336f205db6bf15fdaa491bd57370299">gcp_fft_1d_r2_twiddle</a> (unsigned int log2_fft_length, std::complex&lt; float &gt; *W)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute twiddle factors.  <a href="#ad336f205db6bf15fdaa491bd57370299"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="aa183dec93bff6e55d81ab68aad393864"></a><!-- doxytag: member="gcp_fft_1d_r2.h::gcp_fft_1d_r2_submit" ref="aa183dec93bff6e55d81ab68aad393864" args="(gc_job_manager_sptr mgr, unsigned int log2_fft_length, bool forward, bool shift, std::complex&lt; float &gt; *out, const std::complex&lt; float &gt; *in, const std::complex&lt; float &gt; *twiddle, const float *window)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_desc_sptr</a> gcp_fft_1d_r2_submit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a>&#160;</td>
          <td class="paramname"><em>mgr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>log2_fft_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td>
          <td class="paramname"><em>forward</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&#160;</td>
          <td class="paramname"><em>shift</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::complex&lt; float &gt; *&#160;</td>
          <td class="paramname"><em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::complex&lt; float &gt; *&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::complex&lt; float &gt; *&#160;</td>
          <td class="paramname"><em>twiddle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const float *&#160;</td>
          <td class="paramname"><em>window</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Submit a job that computes the forward or inverse FFT. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">mgr</td><td>is the job manager instance </td></tr>
    <tr><td class="paramname">log2_fft_length</td><td>is the log2 of the fft_length (4 &lt;= x &lt;= 12). </td></tr>
    <tr><td class="paramname">forward</td><td>is true to compute the forward transform, else the inverse. </td></tr>
    <tr><td class="paramname">shift</td><td>indicates if an "fftshift" should be applied to the output data </td></tr>
    <tr><td class="paramname">out</td><td>is the fft_length output from FFT (must be 16-byte aligned). </td></tr>
    <tr><td class="paramname">in</td><td>is the fft_length input to FFT (must be 16-byte aligned). </td></tr>
    <tr><td class="paramname">twiddle</td><td>is fft_length/4 twiddle factor input to FFT (must be 16-byte aligned). </td></tr>
    <tr><td class="paramname">window</td><td>is the window to be applied to the input data. The window length must be either 0 or fft_length (must be 16-byte aligned).</td></tr>
  </table>
  </dd>
</dl>
<p>Returns a shared_ptr to a job descriptor which should be passed to wait_job*. Throws an exception in the event of a problem. This uses the FFTW conventions for scaling. That is, neither the forward nor inverse are scaled by 1/fft_length. </p>

</div>
</div>
<a class="anchor" id="ad336f205db6bf15fdaa491bd57370299"></a><!-- doxytag: member="gcp_fft_1d_r2.h::gcp_fft_1d_r2_twiddle" ref="ad336f205db6bf15fdaa491bd57370299" args="(unsigned int log2_fft_length, std::complex&lt; float &gt; *W)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp_fft_1d_r2_twiddle </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>log2_fft_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::complex&lt; float &gt; *&#160;</td>
          <td class="paramname"><em>W</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Compute twiddle factors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">log2_fft_length</td><td>is the log2 of the fft_length. </td></tr>
    <tr><td class="paramname">W</td><td>is fft_length/4 twiddle factor output (must be 16-byte aligned). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gcp__fft__1d__r2_8h.html">gcp_fft_1d_r2.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>