Sophie

Sophie

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

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="classgri__mmse__fir__interpolator__cc" kind="class" prot="public">
    <compoundname>gri_mmse_fir_interpolator_cc</compoundname>
    <includes refid="gri__mmse__fir__interpolator__cc_8h" local="no">gri_mmse_fir_interpolator_cc.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgri__mmse__fir__interpolator__cc_1a339ff39a576abda306191912ebe7a249" prot="protected" static="no" mutable="no">
        <type><ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>&lt; <ref refid="classgr__fir__ccf" kindref="compound">gr_fir_ccf</ref> * &gt;</type>
        <definition>std::vector&lt;gr_fir_ccf *&gt; gri_mmse_fir_interpolator_cc::filters</definition>
        <argsstring></argsstring>
        <name>filters</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" bodystart="65" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgri__mmse__fir__interpolator__cc_1ab40613fad362ff3891d8be5ed344a978" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gri_mmse_fir_interpolator_cc::gri_mmse_fir_interpolator_cc</definition>
        <argsstring>()</argsstring>
        <name>gri_mmse_fir_interpolator_cc</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="45"/>
      </memberdef>
      <memberdef kind="function" id="classgri__mmse__fir__interpolator__cc_1a3ec67acb5153b1ab71306855bcb0ab55" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gri_mmse_fir_interpolator_cc::~gri_mmse_fir_interpolator_cc</definition>
        <argsstring>()</argsstring>
        <name>~gri_mmse_fir_interpolator_cc</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="46"/>
      </memberdef>
      <memberdef kind="function" id="classgri__mmse__fir__interpolator__cc_1aa297b945c52bc8176c731e58f7ee9aa6" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>unsigned</type>
        <definition>unsigned gri_mmse_fir_interpolator_cc::ntaps</definition>
        <argsstring>() const </argsstring>
        <name>ntaps</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="48"/>
      </memberdef>
      <memberdef kind="function" id="classgri__mmse__fir__interpolator__cc_1a2d7ae1765a3919468ee4445328d33844" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>unsigned</type>
        <definition>unsigned gri_mmse_fir_interpolator_cc::nsteps</definition>
        <argsstring>() const </argsstring>
        <name>nsteps</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="49"/>
      </memberdef>
      <memberdef kind="function" id="classgri__mmse__fir__interpolator__cc_1a1da35404c1cd133a4bbd7347c1e49441" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
        <definition>gr_complex gri_mmse_fir_interpolator_cc::interpolate</definition>
        <argsstring>(const gr_complex input[], float mu)</argsstring>
        <name>interpolate</name>
        <param>
          <type>const <ref refid="gr__complex_8h_1aec4bfe41433369afae9327f1b0bc9109" kindref="member">gr_complex</ref></type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <param>
          <type>float</type>
          <declname>mu</declname>
        </param>
        <briefdescription>
<para>compute a single interpolated output value. </para>        </briefdescription>
        <detaileddescription>
<para><computeroutput>input</computeroutput> must have <ref refid="classgri__mmse__fir__interpolator__cc_1aa297b945c52bc8176c731e58f7ee9aa6" kindref="member">ntaps()</ref> valid entries and be 8-byte aligned. input[0] .. input[<ref refid="classgri__mmse__fir__interpolator__cc_1aa297b945c52bc8176c731e58f7ee9aa6" kindref="member">ntaps()</ref> - 1] are referenced to compute the output value. <parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>std::invalid_argument</parametername>
</parameternamelist>
<parameterdescription>
<para>if input is not 8-byte aligned.</para></parameterdescription>
</parameteritem>
</parameterlist>
<computeroutput>mu</computeroutput> must be in the range [0, 1] and specifies the fractional delay.</para><para><simplesect kind="return"><para>the interpolated input value. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="62"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Compute intermediate samples between signal samples x(k*Ts)</para><para>This implements a Mininum Mean Squared Error interpolator with 8 taps. It is suitable for signals where the bandwidth of interest B = 1/(4*Ts) Where Ts is the time between samples. </para>    </briefdescription>
    <detaileddescription>
<para>Although mu, the fractional delay, is specified as a float, it is actually quantized. 0.0 &lt;= mu &lt;= 1.0. That is, mu is quantized in the interpolate method to 32nd&apos;s of a sample. </para>    </detaileddescription>
    <collaborationgraph>
      <node id="14667">
        <label>std::vector&lt; float &gt;</label>
        <link refid="classstd_1_1vector"/>
      </node>
      <node id="14666">
        <label>gr_fir_ccf</label>
        <link refid="classgr__fir__ccf"/>
        <childnode refid="14667" relation="usage">
          <edgelabel>d_taps</edgelabel>
        </childnode>
      </node>
      <node id="14665">
        <label>std::vector&lt; gr_fir_ccf * &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="14666" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="14664">
        <label>gri_mmse_fir_interpolator_cc</label>
        <link refid="classgri__mmse__fir__interpolator__cc"/>
        <childnode refid="14665" relation="usage">
          <edgelabel>filters</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" line="43" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h" bodystart="43" bodyend="66"/>
    <listofallmembers>
      <member refid="classgri__mmse__fir__interpolator__cc_1a339ff39a576abda306191912ebe7a249" prot="protected" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>filters</name></member>
      <member refid="classgri__mmse__fir__interpolator__cc_1ab40613fad362ff3891d8be5ed344a978" prot="public" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>gri_mmse_fir_interpolator_cc</name></member>
      <member refid="classgri__mmse__fir__interpolator__cc_1a1da35404c1cd133a4bbd7347c1e49441" prot="public" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>interpolate</name></member>
      <member refid="classgri__mmse__fir__interpolator__cc_1a2d7ae1765a3919468ee4445328d33844" prot="public" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>nsteps</name></member>
      <member refid="classgri__mmse__fir__interpolator__cc_1aa297b945c52bc8176c731e58f7ee9aa6" prot="public" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>ntaps</name></member>
      <member refid="classgri__mmse__fir__interpolator__cc_1a3ec67acb5153b1ab71306855bcb0ab55" prot="public" virt="non-virtual"><scope>gri_mmse_fir_interpolator_cc</scope><name>~gri_mmse_fir_interpolator_cc</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>