Sophie

Sophie

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

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

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="gcp__fft__1d__r2_8h" kind="file">
    <compoundname>gcp_fft_1d_r2.h</compoundname>
    <includes local="no">gcell/gc_job_manager.h</includes>
    <includes local="no">complex</includes>
    <incdepgraph>
      <node id="3809">
        <label>gcell/gc_job_manager.h</label>
      </node>
      <node id="3808">
        <label>gcp_fft_1d_r2.h</label>
        <link refid="gcp_fft_1d_r2.h"/>
        <childnode refid="3809" relation="include">
        </childnode>
        <childnode refid="3810" relation="include">
        </childnode>
      </node>
      <node id="3810">
        <label>complex</label>
      </node>
    </incdepgraph>
      <sectiondef kind="func">
      <memberdef kind="function" id="gcp__fft__1d__r2_8h_1aa183dec93bff6e55d81ab68aad393864" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_desc_sptr</ref></type>
        <definition>gc_job_desc_sptr gcp_fft_1d_r2_submit</definition>
        <argsstring>(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)</argsstring>
        <name>gcp_fft_1d_r2_submit</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_manager_sptr</ref></type>
          <declname>mgr</declname>
        </param>
        <param>
          <type>unsigned int</type>
          <declname>log2_fft_length</declname>
        </param>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>forward</declname>
        </param>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>shift</declname>
        </param>
        <param>
          <type>std::complex&lt; float &gt; *</type>
          <declname>out</declname>
        </param>
        <param>
          <type>const std::complex&lt; float &gt; *</type>
          <declname>in</declname>
        </param>
        <param>
          <type>const std::complex&lt; float &gt; *</type>
          <declname>twiddle</declname>
        </param>
        <param>
          <type>const float *</type>
          <declname>window</declname>
        </param>
        <briefdescription>
<para>Submit a job that computes the forward or inverse FFT. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>mgr</parametername>
</parameternamelist>
<parameterdescription>
<para>is the job manager instance </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>log2_fft_length</parametername>
</parameternamelist>
<parameterdescription>
<para>is the log2 of the fft_length (4 &lt;= x &lt;= 12). </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>forward</parametername>
</parameternamelist>
<parameterdescription>
<para>is true to compute the forward transform, else the inverse. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>shift</parametername>
</parameternamelist>
<parameterdescription>
<para>indicates if an &quot;fftshift&quot; should be applied to the output data </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>out</parametername>
</parameternamelist>
<parameterdescription>
<para>is the fft_length output from FFT (must be 16-byte aligned). </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>in</parametername>
</parameternamelist>
<parameterdescription>
<para>is the fft_length input to FFT (must be 16-byte aligned). </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>twiddle</parametername>
</parameternamelist>
<parameterdescription>
<para>is fft_length/4 twiddle factor input to FFT (must be 16-byte aligned). </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>window</parametername>
</parameternamelist>
<parameterdescription>
<para>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).</para></parameterdescription>
</parameteritem>
</parameterlist>
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. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gcp_fft_1d_r2.h" line="53"/>
      </memberdef>
      <memberdef kind="function" id="gcp__fft__1d__r2_8h_1ad336f205db6bf15fdaa491bd57370299" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gcp_fft_1d_r2_twiddle</definition>
        <argsstring>(unsigned int log2_fft_length, std::complex&lt; float &gt; *W)</argsstring>
        <name>gcp_fft_1d_r2_twiddle</name>
        <param>
          <type>unsigned int</type>
          <declname>log2_fft_length</declname>
        </param>
        <param>
          <type>std::complex&lt; float &gt; *</type>
          <declname>W</declname>
        </param>
        <briefdescription>
<para>Compute twiddle factors. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>log2_fft_length</parametername>
</parameternamelist>
<parameterdescription>
<para>is the log2 of the fft_length. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>W</parametername>
</parameternamelist>
<parameterdescription>
<para>is fft_length/4 twiddle factor output (must be 16-byte aligned). </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gcp_fft_1d_r2.h" line="62"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gcp_fft_1d_r2.h"/>
  </compounddef>
</doxygen>