Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 543

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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="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__adaptive__fir__ccf.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<h1>gr_adaptive_fir_ccf 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_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 &lt;<a class="el" href="gr__adaptive__fir__ccf_8h_source.html">gr_adaptive_fir_ccf.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gr_adaptive_fir_ccf:</div>
<div class="dyncontent">
<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 implementa..." 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 implementa..." alt="" coords="24,160,131,189"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing flow is cons..." 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 abstraction of an ..." 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 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">void&#160;</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>&lt; float &gt; &amp;<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</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> &amp;input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items)</td></tr>
<tr><td class="mdescLeft">&#160;</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><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float&#160;</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> &amp;out)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__adaptive__fir__ccf.html#a787d83857ba5b55c77cf0e27ec5a1818">update_tap</a> (float &amp;tap, const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &amp;in)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</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>&lt; float &gt; &amp;<a class="el" href="interpolator__taps_8h.html#a30bf032e13c2a9fc4a98e14e390cd65a">taps</a>)</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">float&#160;</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>&lt; float &gt;&#160;</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>
<div class="textblock"><p>Adaptive FIR filter with gr_complex input, gr_complex output and float taps. </p>
</div><hr/><h2>Constructor &amp; 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&lt; float &gt; &amp;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 *&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</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>&lt; float &gt; &amp;&#160;</td>
          <td class="paramname"><em>taps</em>&#160;</td>
        </tr>
        <tr>
          <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 &amp;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> &amp;&#160;</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&lt; float &gt; &amp;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>&lt; float &gt; &amp;&#160;</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 &amp;tap, const gr_complex &amp;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 &amp;&#160;</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> &amp;&#160;</td>
          <td class="paramname"><em>in</em>&#160;</td>
        </tr>
        <tr>
          <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 &amp;input_items, gr_vector_void_star &amp;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&#160;</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> &amp;&#160;</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> &amp;&#160;</td>
          <td class="paramname"><em>output_items</em>&#160;</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>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="classgr__cma__equalizer__cc.html#ab6e09ce0a3d190d05da1e5d736ff7113">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>&lt;float&gt; <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>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classgr__adaptive__fir__ccf.html">gr_adaptive_fir_ccf</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>