Sophie

Sophie

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

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="classgr__single__pole__iir" kind="class" prot="public">
    <compoundname>gr_single_pole_iir</compoundname>
    <includes refid="gr__single__pole__iir_8h" local="no">gr_single_pole_iir.h</includes>
    <templateparamlist>
      <param>
        <type>class</type>
        <declname>o_type</declname>
        <defname>o_type</defname>
      </param>
      <param>
        <type>class</type>
        <declname>i_type</declname>
        <defname>i_type</defname>
      </param>
      <param>
        <type>class</type>
        <declname>tap_type</declname>
        <defname>tap_type</defname>
      </param>
    </templateparamlist>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgr__single__pole__iir_1a3cecd484003a907e60ff8d0eff8fa887" prot="protected" static="no" mutable="no">
        <type>tap_type</type>
        <definition>tap_type gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_alpha</definition>
        <argsstring></argsstring>
        <name>d_alpha</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="77" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="77" bodyend="-1"/>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa833356db2d31691b39b166efd615880" compoundref="gr__single__pole__iir_8h" startline="168" endline="176">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filter</referencedby>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa97e7a76ddbefd08b3a32d674891ce8a" compoundref="gr__single__pole__iir_8h" startline="143" endline="150">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::set_taps</referencedby>
        <referencedby refid="classgr__single__pole__iir_1af8f1dfca2e1492caf5ef10a6d01f7851" compoundref="gr__single__pole__iir_8h" startline="59" endline="66">gr_single_pole_iir&lt; double, double, double &gt;::set_taps</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classgr__single__pole__iir_1a5e0f640e76cd29ba756d962097ede891" prot="protected" static="no" mutable="no">
        <type>tap_type</type>
        <definition>tap_type gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_one_minus_alpha</definition>
        <argsstring></argsstring>
        <name>d_one_minus_alpha</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="78" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="78" bodyend="-1"/>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa833356db2d31691b39b166efd615880" compoundref="gr__single__pole__iir_8h" startline="168" endline="176">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filter</referencedby>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa97e7a76ddbefd08b3a32d674891ce8a" compoundref="gr__single__pole__iir_8h" startline="143" endline="150">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::set_taps</referencedby>
        <referencedby refid="classgr__single__pole__iir_1af8f1dfca2e1492caf5ef10a6d01f7851" compoundref="gr__single__pole__iir_8h" startline="59" endline="66">gr_single_pole_iir&lt; double, double, double &gt;::set_taps</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" prot="protected" static="no" mutable="no">
        <type>tap_type</type>
        <definition>tap_type gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::d_prev_output</definition>
        <argsstring></argsstring>
        <name>d_prev_output</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="79" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="79" bodyend="-1"/>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1aa833356db2d31691b39b166efd615880" compoundref="gr__single__pole__iir_8h" startline="168" endline="176">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filter</referencedby>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a60f697c8924bd2d2ca6a370d606d2483" compoundref="gr__single__pole__iir_8h" startline="122" endline="126">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::gr_single_pole_iir</referencedby>
        <referencedby refid="classgr__single__pole__iir_1a0bd31e559ccc5cce039f198ec9b88e93" compoundref="gr__single__pole__iir_8h" startline="38" endline="42">gr_single_pole_iir&lt; double, double, double &gt;::gr_single_pole_iir</referencedby>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a443a747cd842732ea49484d871212ed0" compoundref="gr__single__pole__iir_8h" startline="158" endline="158">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::prev_output</referencedby>
        <referencedby refid="classgr__single__pole__iir_1a3cb0c20fea52b8168e5c0a57476dfb87" compoundref="gr__single__pole__iir_8h" startline="74" endline="74">gr_single_pole_iir&lt; double, double, double &gt;::prev_output</referencedby>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a93048bf18a6017347b42c6395564981b" compoundref="gr__single__pole__iir_8h" startline="153" endline="156">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::reset</referencedby>
        <referencedby refid="classgr__single__pole__iir_1aec64a97520727ae05377c782b44b6062" compoundref="gr__single__pole__iir_8h" startline="69" endline="72">gr_single_pole_iir&lt; double, double, double &gt;::reset</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__single__pole__iir_1a0bd31e559ccc5cce039f198ec9b88e93" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::gr_single_pole_iir</definition>
        <argsstring>(tap_type alpha=1.0)</argsstring>
        <name>gr_single_pole_iir</name>
        <param>
          <type>tap_type</type>
          <declname>alpha</declname>
          <defval>1.0</defval>
        </param>
        <briefdescription>
<para>construct new single pole IIR with given alpha </para>        </briefdescription>
        <detaileddescription>
<para>computes y(i) = (1-alpha) * y(i-1) + alpha * x(i) </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="38" bodyend="42"/>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_1ad8cecedbfed0bc1f24524d08914288c7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>o_type</type>
        <definition>o_type gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::filter</definition>
        <argsstring>(const i_type input)</argsstring>
        <name>filter</name>
        <param>
          <type>const i_type</type>
          <declname>input</declname>
        </param>
        <briefdescription>
<para>compute a single output value. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>the filtered input value. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="88" bodyend="96"/>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a8e96513599ab00798aac14f76b451ca2" compoundref="gr__single__pole__iir_8h" startline="182" endline="188">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::filterN</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_1aabd52c15f1973d6e75d8aad3a2c6381c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::filterN</definition>
        <argsstring>(o_type output[], const i_type input[], unsigned long n)</argsstring>
        <name>filterN</name>
        <param>
          <type>o_type</type>
          <declname>output</declname>
          <array>[]</array>
        </param>
        <param>
          <type>const i_type</type>
          <declname>input</declname>
          <array>[]</array>
        </param>
        <param>
          <type>unsigned long</type>
          <declname>n</declname>
        </param>
        <briefdescription>
<para>compute an array of N output values. <computeroutput>input</computeroutput> must have n valid entries. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="54" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="101" bodyend="107"/>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_1af8f1dfca2e1492caf5ef10a6d01f7851" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::set_taps</definition>
        <argsstring>(tap_type alpha)</argsstring>
        <name>set_taps</name>
        <param>
          <type>tap_type</type>
          <declname>alpha</declname>
        </param>
        <briefdescription>
<para>install <computeroutput>alpha</computeroutput> as the current taps. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="60" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="59" bodyend="66"/>
        <referencedby refid="classgr__single__pole__iir_3_01gr__complex_00_01i__type_00_01double_01_4_1a60f697c8924bd2d2ca6a370d606d2483" compoundref="gr__single__pole__iir_8h" startline="122" endline="126">gr_single_pole_iir&lt; gr_complex, i_type, double &gt;::gr_single_pole_iir</referencedby>
        <referencedby refid="classgr__single__pole__iir_1a0bd31e559ccc5cce039f198ec9b88e93" compoundref="gr__single__pole__iir_8h" startline="38" endline="42">gr_single_pole_iir&lt; double, double, double &gt;::gr_single_pole_iir</referencedby>
        <referencedby refid="classgr__pwr__squelch__ff_1a16af7fef6ad197132e4fe5c52e153ab2" compoundref="gr__pwr__squelch__ff_8h" startline="59" endline="59">gr_pwr_squelch_ff::set_alpha</referencedby>
        <referencedby refid="classgr__pwr__squelch__cc_1ab71484602f26be8baeba220aaff1c5cc" compoundref="gr__pwr__squelch__cc_8h" startline="59" endline="59">gr_pwr_squelch_cc::set_alpha</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_1aec64a97520727ae05377c782b44b6062" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::reset</definition>
        <argsstring>()</argsstring>
        <name>reset</name>
        <briefdescription>
<para>reset state to zero </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="70" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="69" bodyend="72"/>
      </memberdef>
      <memberdef kind="function" id="classgr__single__pole__iir_1a3cb0c20fea52b8168e5c0a57476dfb87" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>tap_type</type>
        <definition>tap_type gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;::prev_output</definition>
        <argsstring>()</argsstring>
        <name>prev_output</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="74" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="74" bodyend="74"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>class template for single pole IIR filter </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="12835">
        <label>tap_type</label>
      </node>
      <node id="12834">
        <label>gr_single_pole_iir&lt; o_type, i_type, tap_type &gt;</label>
        <link refid="classgr__single__pole__iir"/>
        <childnode refid="12835" relation="usage">
          <edgelabel>d_prev_output</edgelabel>
          <edgelabel>d_one_minus_alpha</edgelabel>
          <edgelabel>d_alpha</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" line="31" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/filter/gr_single_pole_iir.h" bodystart="31" bodyend="80"/>
    <listofallmembers>
      <member refid="classgr__single__pole__iir_1a3cecd484003a907e60ff8d0eff8fa887" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>d_alpha</name></member>
      <member refid="classgr__single__pole__iir_1a5e0f640e76cd29ba756d962097ede891" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>d_one_minus_alpha</name></member>
      <member refid="classgr__single__pole__iir_1a896007d3ed8be78894c19a6f58fd870f" prot="protected" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>d_prev_output</name></member>
      <member refid="classgr__single__pole__iir_1ad8cecedbfed0bc1f24524d08914288c7" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>filter</name></member>
      <member refid="classgr__single__pole__iir_1aabd52c15f1973d6e75d8aad3a2c6381c" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>filterN</name></member>
      <member refid="classgr__single__pole__iir_1a0bd31e559ccc5cce039f198ec9b88e93" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>gr_single_pole_iir</name></member>
      <member refid="classgr__single__pole__iir_1a3cb0c20fea52b8168e5c0a57476dfb87" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>prev_output</name></member>
      <member refid="classgr__single__pole__iir_1aec64a97520727ae05377c782b44b6062" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>reset</name></member>
      <member refid="classgr__single__pole__iir_1af8f1dfca2e1492caf5ef10a6d01f7851" prot="public" virt="non-virtual"><scope>gr_single_pole_iir</scope><name>set_taps</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>