<!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_scf Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classgr__freq__xlating__fir__filter__scf.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_freq_xlating_fir_filter_scf Class Reference<div class="ingroups"><a class="el" href="group__filter__blk.html">Filters</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_freq_xlating_fir_filter_scf" --><!-- doxytag: inherits="gr_sync_decimator" -->
<p>FIR filter combined with frequency translation with short 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__scf_8h_source.html">gr_freq_xlating_fir_filter_scf.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_freq_xlating_fir_filter_scf:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__freq__xlating__fir__filter__scf__inherit__graph.png" border="0" usemap="#gr__freq__xlating__fir__filter__scf_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__freq__xlating__fir__filter__scf_inherit__map" id="gr__freq__xlating__fir__filter__scf_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 implementa..." 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 implementa..." 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 flow is cons..." 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 abstraction of an ..." 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__scf-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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__scf.html#a69b1a7b49b2e738efcf5b231c986af07">~gr_freq_xlating_fir_filter_scf</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__scf.html#ab01b03d9373f39609382afee3ec37e75">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__scf.html#a5eb895276824ad19521f381732f5f7a4">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__scf.html#a4c1621cf9e8cd06c27261040ab50ddec">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="#a4c1621cf9e8cd06c27261040ab50ddec"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
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__scf.html#a442a9e318f23483d904babaeabe3237a">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__scf.html#aa0a08601166b994c625d8a6edf57d000">gr_freq_xlating_fir_filter_scf</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><a name="pro-attribs"></a>
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__scf.html#a77361c1cafd317c97448c82d9e4afdd1">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__scf.html#a7490402a2e31a5fdaa426b92205d3986">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__scf.html#a8961434b4dd424f9b930339fb7048a5e">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__scf.html#a483ed0e013ce93112c52381ed49570c3">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__scf.html#aed4909d6fe6cc07eeeae6df1e2118dcc">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__scf.html#ae99d0da5bc2c44009ae1a82d32166651">d_updated</a></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
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_scf_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__freq__xlating__fir__filter__scf.html#a49ed46f749ff1a7267acd0fdcf0e2b3e">gr_make_freq_xlating_fir_filter_scf</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>
<div class="textblock"><p>FIR filter combined with frequency translation with short 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>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a69b1a7b49b2e738efcf5b231c986af07"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::~gr_freq_xlating_fir_filter_scf" ref="a69b1a7b49b2e738efcf5b231c986af07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_freq_xlating_fir_filter_scf::~gr_freq_xlating_fir_filter_scf </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="aa0a08601166b994c625d8a6edf57d000"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::gr_freq_xlating_fir_filter_scf" ref="aa0a08601166b994c625d8a6edf57d000" 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_scf::gr_freq_xlating_fir_filter_scf </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>
</tr>
<tr>
<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="a442a9e318f23483d904babaeabe3237a"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::build_composite_fir" ref="a442a9e318f23483d904babaeabe3237a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_freq_xlating_fir_filter_scf::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="ab01b03d9373f39609382afee3ec37e75"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::set_center_freq" ref="ab01b03d9373f39609382afee3ec37e75" args="(double center_freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_freq_xlating_fir_filter_scf::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="a5eb895276824ad19521f381732f5f7a4"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::set_taps" ref="a5eb895276824ad19521f381732f5f7a4" 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_scf::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="a4c1621cf9e8cd06c27261040ab50ddec"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::work" ref="a4c1621cf9e8cd06c27261040ab50ddec" 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_scf::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>
</tr>
<tr>
<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="a49ed46f749ff1a7267acd0fdcf0e2b3e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::gr_make_freq_xlating_fir_filter_scf" ref="a49ed46f749ff1a7267acd0fdcf0e2b3e" 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_scf_sptr</a> gr_make_freq_xlating_fir_filter_scf </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>
</tr>
<tr>
<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="a483ed0e013ce93112c52381ed49570c3"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_center_freq" ref="a483ed0e013ce93112c52381ed49570c3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__scf.html#a483ed0e013ce93112c52381ed49570c3">gr_freq_xlating_fir_filter_scf::d_center_freq</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7490402a2e31a5fdaa426b92205d3986"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_composite_fir" ref="a7490402a2e31a5fdaa426b92205d3986" 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__scf.html#a7490402a2e31a5fdaa426b92205d3986">gr_freq_xlating_fir_filter_scf::d_composite_fir</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a77361c1cafd317c97448c82d9e4afdd1"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_proto_taps" ref="a77361c1cafd317c97448c82d9e4afdd1" 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__scf.html#a77361c1cafd317c97448c82d9e4afdd1">gr_freq_xlating_fir_filter_scf::d_proto_taps</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8961434b4dd424f9b930339fb7048a5e"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_r" ref="a8961434b4dd424f9b930339fb7048a5e" 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__scf.html#a8961434b4dd424f9b930339fb7048a5e">gr_freq_xlating_fir_filter_scf::d_r</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aed4909d6fe6cc07eeeae6df1e2118dcc"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_sampling_freq" ref="aed4909d6fe6cc07eeeae6df1e2118dcc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classgr__freq__xlating__fir__filter__scf.html#aed4909d6fe6cc07eeeae6df1e2118dcc">gr_freq_xlating_fir_filter_scf::d_sampling_freq</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae99d0da5bc2c44009ae1a82d32166651"></a><!-- doxytag: member="gr_freq_xlating_fir_filter_scf::d_updated" ref="ae99d0da5bc2c44009ae1a82d32166651" 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__scf.html#ae99d0da5bc2c44009ae1a82d32166651">gr_freq_xlating_fir_filter_scf::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__scf_8h_source.html">gr_freq_xlating_fir_filter_scf.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__freq__xlating__fir__filter__scf.html">gr_freq_xlating_fir_filter_scf</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
1306
