<!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: gr_freq_xlating_fir_filter_fcf Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <div class="contents"> <h1>gr_freq_xlating_fir_filter_fcf Class Reference<br/> <small> [<a class="el" href="group__filter__blk.html">Filters</a>]</small> </h1><!-- doxytag: class="gr_freq_xlating_fir_filter_fcf" --><!-- doxytag: inherits="gr_sync_decimator" --> <p>FIR filter combined with frequency translation with float input, gr_complex output and float tapsThis class efficiently combines a frequency translation (typically "down conversion") with a FIR filter (typically low-pass) and decimation. It is ideally suited for a "channel selection filter" and can be efficiently used to select and decimate a narrow band signal out of wide bandwidth input. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__freq__xlating__fir__filter__fcf_8h_source.html">gr_freq_xlating_fir_filter_fcf.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_freq_xlating_fir_filter_fcf:</div> <div class="dynsection"> <div class="center"><img src="classgr__freq__xlating__fir__filter__fcf__inherit__graph.png" border="0" usemap="#gr__freq__xlating__fir__filter__fcf_inherit__map" alt="Inheritance graph"/></div> <map name="gr__freq__xlating__fir__filter__fcf_inherit__map" id="gr__freq__xlating__fir__filter__fcf_inherit__map"> <area shape="rect" id="node2" href="classgr__sync__decimator.html" title="synchronous N:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="29,237,160,267"/><area shape="rect" id="node4" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="41,160,148,189"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="60,83,129,112"/><area shape="rect" id="node8" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="40,5,149,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__freq__xlating__fir__filter__fcf-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a28fec940e8084e7bec5f93f909869df7">~gr_freq_xlating_fir_filter_fcf</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a9785d6ac25c1bae2a10e9f49e8c6cf44">set_center_freq</a> (double center_freq)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#aebf0ddfcee181c009b19782b0a56f10e">set_taps</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a8e3688fefc86e24fa7d407338a0bc4ef">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a8e3688fefc86e24fa7d407338a0bc4ef"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#afe6ae5820be75c991e847edd0b7af322">build_composite_fir</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#af911d2f6079ddb943bf7f2310e5829b0">gr_freq_xlating_fir_filter_fcf</a> (int decimation, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>, double center_freq, double sampling_freq)</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#ab48333e62d0308f738ac0b4ea183ed36">d_proto_taps</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgr__fir__fcc.html">gr_fir_fcc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a4d0b2713cc8550d1c6eae53eb2522222">d_composite_fir</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgr__rotator.html">gr_rotator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#af70fc660ea9f7eb7eb2be8aa067ddf23">d_r</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#aa056dfea8ba09e55b4ee29ced432832d">d_center_freq</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a8402dc20c63249ee515a2fee0a7d4571">d_sampling_freq</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a7791d5ef716c6b932af5760bcec2be70">d_updated</a></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_freq_xlating_fir_filter_fcf_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#ae98eec795f0b87a474e7a256c54864f6">gr_make_freq_xlating_fir_filter_fcf</a> (int decimation, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > &<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>, double center_freq, double sampling_freq)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>FIR filter combined with frequency translation with float input, gr_complex output and float taps</p> <p>This class efficiently combines a frequency translation (typically "down conversion") with a FIR filter (typically low-pass) and decimation. It is ideally suited for a "channel selection filter" and can be efficiently used to select and decimate a narrow band signal out of wide bandwidth input. </p> <p>Uses a single input array to produce a single output array. Additional inputs and/or outputs are ignored. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a28fec940e8084e7bec5f93f909869df7"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::~gr_freq_xlating_fir_filter_fcf" ref="a28fec940e8084e7bec5f93f909869df7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gr_freq_xlating_fir_filter_fcf::~gr_freq_xlating_fir_filter_fcf </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af911d2f6079ddb943bf7f2310e5829b0"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::gr_freq_xlating_fir_filter_fcf" ref="af911d2f6079ddb943bf7f2310e5829b0" args="(int decimation, const std::vector< float > &taps, double center_freq, double sampling_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_freq_xlating_fir_filter_fcf::gr_freq_xlating_fir_filter_fcf </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>decimation</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"> <em>taps</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"> <em>center_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"> <em>sampling_freq</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a FIR filter with the given taps and a composite frequency translation that shifts center_freq down to zero Hz. The frequency translation logically comes before the filtering operation. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="afe6ae5820be75c991e847edd0b7af322"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::build_composite_fir" ref="afe6ae5820be75c991e847edd0b7af322" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_freq_xlating_fir_filter_fcf::build_composite_fir </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a9785d6ac25c1bae2a10e9f49e8c6cf44"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::set_center_freq" ref="a9785d6ac25c1bae2a10e9f49e8c6cf44" args="(double center_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_freq_xlating_fir_filter_fcf::set_center_freq </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>center_freq</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aebf0ddfcee181c009b19782b0a56f10e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::set_taps" ref="aebf0ddfcee181c009b19782b0a56f10e" args="(const std::vector< float > &taps)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_freq_xlating_fir_filter_fcf::set_taps </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"> <em>taps</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8e3688fefc86e24fa7d407338a0bc4ef"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::work" ref="a8e3688fefc86e24fa7d407338a0bc4ef" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_freq_xlating_fir_filter_fcf::work </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>noutput_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td> <td class="paramname"> <em>input_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td> <td class="paramname"> <em>output_items</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p> <p>The user must override work to define the signal processing code </p> <p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ae98eec795f0b87a474e7a256c54864f6"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::gr_make_freq_xlating_fir_filter_fcf" ref="ae98eec795f0b87a474e7a256c54864f6" args="(int decimation, const std::vector< float > &taps, double center_freq, double sampling_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_freq_xlating_fir_filter_fcf_sptr</a> gr_make_freq_xlating_fir_filter_fcf </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>decimation</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > & </td> <td class="paramname"> <em>taps</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"> <em>center_freq</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"> <em>sampling_freq</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a FIR filter with the given taps and a composite frequency translation that shifts center_freq down to zero Hz. The frequency translation logically comes before the filtering operation. </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="aa056dfea8ba09e55b4ee29ced432832d"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_center_freq" ref="aa056dfea8ba09e55b4ee29ced432832d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#aa056dfea8ba09e55b4ee29ced432832d">gr_freq_xlating_fir_filter_fcf::d_center_freq</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4d0b2713cc8550d1c6eae53eb2522222"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_composite_fir" ref="a4d0b2713cc8550d1c6eae53eb2522222" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgr__fir__fcc.html">gr_fir_fcc</a>* <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a4d0b2713cc8550d1c6eae53eb2522222">gr_freq_xlating_fir_filter_fcf::d_composite_fir</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab48333e62d0308f738ac0b4ea183ed36"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_proto_taps" ref="ab48333e62d0308f738ac0b4ea183ed36" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a><float> <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#ab48333e62d0308f738ac0b4ea183ed36">gr_freq_xlating_fir_filter_fcf::d_proto_taps</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af70fc660ea9f7eb7eb2be8aa067ddf23"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_r" ref="af70fc660ea9f7eb7eb2be8aa067ddf23" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgr__rotator.html">gr_rotator</a> <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#af70fc660ea9f7eb7eb2be8aa067ddf23">gr_freq_xlating_fir_filter_fcf::d_r</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8402dc20c63249ee515a2fee0a7d4571"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_sampling_freq" ref="a8402dc20c63249ee515a2fee0a7d4571" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a8402dc20c63249ee515a2fee0a7d4571">gr_freq_xlating_fir_filter_fcf::d_sampling_freq</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a7791d5ef716c6b932af5760bcec2be70"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcf::d_updated" ref="a7791d5ef716c6b932af5760bcec2be70" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classgr__freq__xlating__fir__filter__fcf.html#a7791d5ef716c6b932af5760bcec2be70">gr_freq_xlating_fir_filter_fcf::d_updated</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__freq__xlating__fir__filter__fcf_8h_source.html">gr_freq_xlating_fir_filter_fcf.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>