<!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_fcc 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_fcc Class Reference<br/> <small> [<a class="el" href="group__filter__blk.html">Filters</a>]</small> </h1><!-- doxytag: class="gr_freq_xlating_fir_filter_fcc" --><!-- doxytag: inherits="gr_sync_decimator" --> <p>FIR filter combined with frequency translation with float input, gr_complex output and gr_complex 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__fcc_8h_source.html">gr_freq_xlating_fir_filter_fcc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_freq_xlating_fir_filter_fcc:</div> <div class="dynsection"> <div class="center"><img src="classgr__freq__xlating__fir__filter__fcc__inherit__graph.png" border="0" usemap="#gr__freq__xlating__fir__filter__fcc_inherit__map" alt="Inheritance graph"/></div> <map name="gr__freq__xlating__fir__filter__fcc_inherit__map" id="gr__freq__xlating__fir__filter__fcc_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="31,237,161,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="43,160,149,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="61,83,131,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="41,5,151,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__fcc-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__fcc.html#aba5795d148448679f4370598dff209cc">~gr_freq_xlating_fir_filter_fcc</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__fcc.html#a6cd1e0f6cb3ac7c0baa69b2cd3e5a2f9">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__fcc.html#acbb1eeda7792c54b69cea0ede8a757b4">set_taps</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &<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__fcc.html#a8ed9d891d477018f3f17d62ecb474458">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="#a8ed9d891d477018f3f17d62ecb474458"></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__fcc.html#ad39ccabb8e55954b63f53e96f22b5acd">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__fcc.html#ab061342a8986dfd59fbaa60e532d5f56">gr_freq_xlating_fir_filter_fcc</a> (int decimation, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &<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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcc.html#a2a47f9ee899e52e4f573f97975431968">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__fcc.html#abaa144ae29be106eaebbc3e506fb1b45">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__fcc.html#a851168931b9439e2364a2e871ae1b3be">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__fcc.html#a8508ce9e1b693fb39e511c4c9dd63eaf">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__fcc.html#a5a19c9e1c3d479896a9ce499c5b429c5">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__fcc.html#ab4b6cef1933198fd8ed00f0ba1e93196">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_fcc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__fcc.html#a271deda75bd2650f1452adf581abfb5e">gr_make_freq_xlating_fir_filter_fcc</a> (int decimation, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > &<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 gr_complex 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="aba5795d148448679f4370598dff209cc"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::~gr_freq_xlating_fir_filter_fcc" ref="aba5795d148448679f4370598dff209cc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gr_freq_xlating_fir_filter_fcc::~gr_freq_xlating_fir_filter_fcc </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="ab061342a8986dfd59fbaa60e532d5f56"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::gr_freq_xlating_fir_filter_fcc" ref="ab061342a8986dfd59fbaa60e532d5f56" args="(int decimation, const std::vector< gr_complex > &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_fcc::gr_freq_xlating_fir_filter_fcc </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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </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="ad39ccabb8e55954b63f53e96f22b5acd"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::build_composite_fir" ref="ad39ccabb8e55954b63f53e96f22b5acd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_freq_xlating_fir_filter_fcc::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="a6cd1e0f6cb3ac7c0baa69b2cd3e5a2f9"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::set_center_freq" ref="a6cd1e0f6cb3ac7c0baa69b2cd3e5a2f9" args="(double center_freq)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_freq_xlating_fir_filter_fcc::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="acbb1eeda7792c54b69cea0ede8a757b4"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::set_taps" ref="acbb1eeda7792c54b69cea0ede8a757b4" args="(const std::vector< gr_complex > &taps)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_freq_xlating_fir_filter_fcc::set_taps </td> <td>(</td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </td> <td class="paramname"> <em>taps</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8ed9d891d477018f3f17d62ecb474458"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::work" ref="a8ed9d891d477018f3f17d62ecb474458" 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_fcc::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="a271deda75bd2650f1452adf581abfb5e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::gr_make_freq_xlating_fir_filter_fcc" ref="a271deda75bd2650f1452adf581abfb5e" args="(int decimation, const std::vector< gr_complex > &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_fcc_sptr</a> gr_make_freq_xlating_fir_filter_fcc </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>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > & </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="a8508ce9e1b693fb39e511c4c9dd63eaf"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_center_freq" ref="a8508ce9e1b693fb39e511c4c9dd63eaf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__fcc.html#a8508ce9e1b693fb39e511c4c9dd63eaf">gr_freq_xlating_fir_filter_fcc::d_center_freq</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="abaa144ae29be106eaebbc3e506fb1b45"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_composite_fir" ref="abaa144ae29be106eaebbc3e506fb1b45" 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__fcc.html#abaa144ae29be106eaebbc3e506fb1b45">gr_freq_xlating_fir_filter_fcc::d_composite_fir</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a2a47f9ee899e52e4f573f97975431968"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_proto_taps" ref="a2a47f9ee899e52e4f573f97975431968" 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><<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a>> <a class="el" href="classgr__freq__xlating__fir__filter__fcc.html#a2a47f9ee899e52e4f573f97975431968">gr_freq_xlating_fir_filter_fcc::d_proto_taps</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a851168931b9439e2364a2e871ae1b3be"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_r" ref="a851168931b9439e2364a2e871ae1b3be" 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__fcc.html#a851168931b9439e2364a2e871ae1b3be">gr_freq_xlating_fir_filter_fcc::d_r</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a5a19c9e1c3d479896a9ce499c5b429c5"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_sampling_freq" ref="a5a19c9e1c3d479896a9ce499c5b429c5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__fcc.html#a5a19c9e1c3d479896a9ce499c5b429c5">gr_freq_xlating_fir_filter_fcc::d_sampling_freq</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab4b6cef1933198fd8ed00f0ba1e93196"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_fcc::d_updated" ref="ab4b6cef1933198fd8ed00f0ba1e93196" 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__fcc.html#ab4b6cef1933198fd8ed00f0ba1e93196">gr_freq_xlating_fir_filter_fcc::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__fcc_8h_source.html">gr_freq_xlating_fir_filter_fcc.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>