<!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_scc 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_scc Class Reference<br/>
<small>
[<a class="el" href="group__filter__blk.html">Filters</a>]</small>
</h1><!-- doxytag: class="gr_freq_xlating_fir_filter_scc" --><!-- doxytag: inherits="gr_sync_decimator" -->
<p>FIR filter combined with frequency translation with short 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__scc_8h_source.html">gr_freq_xlating_fir_filter_scc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_freq_xlating_fir_filter_scc:</div>
<div class="dynsection">
<div class="center"><img src="classgr__freq__xlating__fir__filter__scc__inherit__graph.png" border="0" usemap="#gr__freq__xlating__fir__filter__scc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__freq__xlating__fir__filter__scc_inherit__map" id="gr__freq__xlating__fir__filter__scc_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="32,237,163,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="44,160,151,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="63,83,132,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="43,5,152,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__scc-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__scc.html#ab4baa1e5c87671bb3a95e552f237ac51">~gr_freq_xlating_fir_filter_scc</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__scc.html#aaee3a62cd0f31ef2d2d47663da55c33c">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__scc.html#a665a41137dc82721f5fbfdd6dc1c16ab">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__scc.html#a8647aece86d84760300a7ab4fa3eb1a4">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="#a8647aece86d84760300a7ab4fa3eb1a4"></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__scc.html#a9a2d6a2ec018abaf6d5f377506a0e084">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__scc.html#a2e3ec08f7502116080a1b5986bb84b19">gr_freq_xlating_fir_filter_scc</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__scc.html#a385c7a881424fb177b18f6db6f8ae15e">d_proto_taps</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgr__fir__scc.html">gr_fir_scc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__scc.html#aa4651c18c3d9e65abe54c4ad0cc979c2">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__scc.html#ab6e87e725f6a8bff8fbf2f9c1f68bb77">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__scc.html#a18a7b08a87b7a64d7a0ecb000f04f85e">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__scc.html#ac71f610c36a4be839495e73d37c22c53">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__scc.html#a93f10d04e08e1a4519569f5058bf7c67">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_scc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__scc.html#a17cc0c835842086f7a0cfb86e08f5ebf">gr_make_freq_xlating_fir_filter_scc</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 short 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="ab4baa1e5c87671bb3a95e552f237ac51"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::~gr_freq_xlating_fir_filter_scc" ref="ab4baa1e5c87671bb3a95e552f237ac51" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_freq_xlating_fir_filter_scc::~gr_freq_xlating_fir_filter_scc </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="a2e3ec08f7502116080a1b5986bb84b19"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::gr_freq_xlating_fir_filter_scc" ref="a2e3ec08f7502116080a1b5986bb84b19" 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_scc::gr_freq_xlating_fir_filter_scc </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="a9a2d6a2ec018abaf6d5f377506a0e084"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::build_composite_fir" ref="a9a2d6a2ec018abaf6d5f377506a0e084" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_freq_xlating_fir_filter_scc::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="aaee3a62cd0f31ef2d2d47663da55c33c"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::set_center_freq" ref="aaee3a62cd0f31ef2d2d47663da55c33c" args="(double center_freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_freq_xlating_fir_filter_scc::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="a665a41137dc82721f5fbfdd6dc1c16ab"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::set_taps" ref="a665a41137dc82721f5fbfdd6dc1c16ab" 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_scc::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="a8647aece86d84760300a7ab4fa3eb1a4"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::work" ref="a8647aece86d84760300a7ab4fa3eb1a4" 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_scc::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="a17cc0c835842086f7a0cfb86e08f5ebf"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::gr_make_freq_xlating_fir_filter_scc" ref="a17cc0c835842086f7a0cfb86e08f5ebf" 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_scc_sptr</a> gr_make_freq_xlating_fir_filter_scc </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="a18a7b08a87b7a64d7a0ecb000f04f85e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_center_freq" ref="a18a7b08a87b7a64d7a0ecb000f04f85e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__scc.html#a18a7b08a87b7a64d7a0ecb000f04f85e">gr_freq_xlating_fir_filter_scc::d_center_freq</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa4651c18c3d9e65abe54c4ad0cc979c2"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_composite_fir" ref="aa4651c18c3d9e65abe54c4ad0cc979c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgr__fir__scc.html">gr_fir_scc</a>* <a class="el" href="classgr__freq__xlating__fir__filter__scc.html#aa4651c18c3d9e65abe54c4ad0cc979c2">gr_freq_xlating_fir_filter_scc::d_composite_fir</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a385c7a881424fb177b18f6db6f8ae15e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_proto_taps" ref="a385c7a881424fb177b18f6db6f8ae15e" 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__scc.html#a385c7a881424fb177b18f6db6f8ae15e">gr_freq_xlating_fir_filter_scc::d_proto_taps</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab6e87e725f6a8bff8fbf2f9c1f68bb77"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_r" ref="ab6e87e725f6a8bff8fbf2f9c1f68bb77" 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__scc.html#ab6e87e725f6a8bff8fbf2f9c1f68bb77">gr_freq_xlating_fir_filter_scc::d_r</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac71f610c36a4be839495e73d37c22c53"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_sampling_freq" ref="ac71f610c36a4be839495e73d37c22c53" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__scc.html#ac71f610c36a4be839495e73d37c22c53">gr_freq_xlating_fir_filter_scc::d_sampling_freq</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a93f10d04e08e1a4519569f5058bf7c67"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scc::d_updated" ref="a93f10d04e08e1a4519569f5058bf7c67" 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__scc.html#a93f10d04e08e1a4519569f5058bf7c67">gr_freq_xlating_fir_filter_scc::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__scc_8h_source.html">gr_freq_xlating_fir_filter_scc.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>
