<!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_adaptive_fir_ccf 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_adaptive_fir_ccf Class Reference<br/>
<small>
[<a class="el" href="group__filter__blk.html">Filters</a>]</small>
</h1><!-- doxytag: class="gr_adaptive_fir_ccf" --><!-- doxytag: inherits="gr_sync_decimator" -->
<p>Adaptive FIR filter with gr_complex input, gr_complex output and float taps.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__adaptive__fir__ccf_8h_source.html">gr_adaptive_fir_ccf.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_adaptive_fir_ccf:</div>
<div class="dynsection">
<div class="center"><img src="classgr__adaptive__fir__ccf__inherit__graph.png" border="0" usemap="#gr__adaptive__fir__ccf_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__adaptive__fir__ccf_inherit__map" id="gr__adaptive__fir__ccf_inherit__map">
<area shape="rect" id="node11" href="classgr__cma__equalizer__cc.html" title="Implements constant modulus adaptive filter on complex stream." alt="" coords="5,392,149,421"/><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="12,237,143,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="24,160,131,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="43,83,112,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="23,5,132,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__adaptive__fir__ccf-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#a36bb83ca52246f09bfd32b8ed6415308">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__adaptive__fir__ccf.html#a3e0c0093311ba2d108be83ad690e671e">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="#a3e0c0093311ba2d108be83ad690e671e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#a0abeacf7ed7b8bbe507f64b60d63624b">error</a> (const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &out)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#a787d83857ba5b55c77cf0e27ec5a1818">update_tap</a> (float &tap, const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &in)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#ae74a6e975910c4f83c720c691cf59d1c">gr_adaptive_fir_ccf</a> (const char *name, 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>)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#acb8212e9fd8cf32c7a48c96cf0600da2">d_error</a></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__adaptive__fir__ccf.html#a344bc7e44aa8595fbe42d4a3d4704652">d_taps</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Adaptive FIR filter with gr_complex input, gr_complex output and float taps. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae74a6e975910c4f83c720c691cf59d1c"></a><!-- doxytag: member="gr_adaptive_fir_ccf::gr_adaptive_fir_ccf" ref="ae74a6e975910c4f83c720c691cf59d1c" args="(const char *name, int decimation, const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_adaptive_fir_ccf::gr_adaptive_fir_ccf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0abeacf7ed7b8bbe507f64b60d63624b"></a><!-- doxytag: member="gr_adaptive_fir_ccf::error" ref="a0abeacf7ed7b8bbe507f64b60d63624b" args="(const gr_complex &out)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float gr_adaptive_fir_ccf::error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> & </td>
<td class="paramname"> <em>out</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classgr__cma__equalizer__cc.html#a18b38db1177078439dc121ccef960b4f">gr_cma_equalizer_cc</a>.</p>
</div>
</div>
<a class="anchor" id="a36bb83ca52246f09bfd32b8ed6415308"></a><!-- doxytag: member="gr_adaptive_fir_ccf::set_taps" ref="a36bb83ca52246f09bfd32b8ed6415308" args="(const std::vector< float > &taps)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_adaptive_fir_ccf::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="a787d83857ba5b55c77cf0e27ec5a1818"></a><!-- doxytag: member="gr_adaptive_fir_ccf::update_tap" ref="a787d83857ba5b55c77cf0e27ec5a1818" args="(float &tap, const gr_complex &in)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_adaptive_fir_ccf::update_tap </td>
<td>(</td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>tap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> & </td>
<td class="paramname"> <em>in</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classgr__cma__equalizer__cc.html#ab6e09ce0a3d190d05da1e5d736ff7113">gr_cma_equalizer_cc</a>.</p>
</div>
</div>
<a class="anchor" id="a3e0c0093311ba2d108be83ad690e671e"></a><!-- doxytag: member="gr_adaptive_fir_ccf::work" ref="a3e0c0093311ba2d108be83ad690e671e" 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_adaptive_fir_ccf::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>Member Data Documentation</h2>
<a class="anchor" id="acb8212e9fd8cf32c7a48c96cf0600da2"></a><!-- doxytag: member="gr_adaptive_fir_ccf::d_error" ref="acb8212e9fd8cf32c7a48c96cf0600da2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classgr__adaptive__fir__ccf.html#acb8212e9fd8cf32c7a48c96cf0600da2">gr_adaptive_fir_ccf::d_error</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gr__cma__equalizer__cc_8h_source.html#l00054">gr_cma_equalizer_cc::update_tap()</a>.</p>
</div>
</div>
<a class="anchor" id="a344bc7e44aa8595fbe42d4a3d4704652"></a><!-- doxytag: member="gr_adaptive_fir_ccf::d_taps" ref="a344bc7e44aa8595fbe42d4a3d4704652" 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__adaptive__fir__ccf.html#a344bc7e44aa8595fbe42d4a3d4704652">gr_adaptive_fir_ccf::d_taps</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__adaptive__fir__ccf_8h_source.html">gr_adaptive_fir_ccf.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>
