<!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_single_pole_iir_filter_cc 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_single_pole_iir_filter_cc Class Reference<br/> <small> [<a class="el" href="group__filter__blk.html">Filters</a>]</small> </h1><!-- doxytag: class="gr_single_pole_iir_filter_cc" --><!-- doxytag: inherits="gr_sync_block" --> <p>single pole IIR filter with complex input, complex outputThe input and output satisfy a difference equation of the form <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__single__pole__iir__filter__cc_8h_source.html">gr_single_pole_iir_filter_cc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_single_pole_iir_filter_cc:</div> <div class="dynsection"> <div class="center"><img src="classgr__single__pole__iir__filter__cc__inherit__graph.png" border="0" usemap="#gr__single__pole__iir__filter__cc_inherit__map" alt="Inheritance graph"/></div> <map name="gr__single__pole__iir__filter__cc_inherit__map" id="gr__single__pole__iir__filter__cc_inherit__map"> <area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="39,160,145,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="57,83,127,112"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="37,5,147,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__single__pole__iir__filter__cc-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir__filter__cc.html#af6fa1aa403d2e88b3c972fc154f5c9f9">~gr_single_pole_iir_filter_cc</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir__filter__cc.html#ad4d722586f2e3feeaef9bac41fa7b255">set_taps</a> (double alpha)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir__filter__cc.html#a260246be376f893de8819cc3f21c2f54">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="#a260246be376f893de8819cc3f21c2f54"></a><br/></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_single_pole_iir_filter_cc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__single__pole__iir__filter__cc.html#a8adbc32f4b716aa61c32305c50c29ab6">gr_make_single_pole_iir_filter_cc</a> (double alpha, unsigned int vlen)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>single pole IIR filter with complex input, complex output</p> <p>The input and output satisfy a difference equation of the form </p> <p class="formulaDsp"> <img class="formulaDsp" alt="\[ y[n] - (1-alpha) y[n-1] = alpha x[n] \]" src="form_2.png"/> </p> <p>with the corresponding rational system function</p> <p class="formulaDsp"> <img class="formulaDsp" alt="\[ H(z) = \frac{alpha}{1 - (1-alpha) z^{-1}} \]" src="form_3.png"/> </p> <p>Note that some texts define the system function with a + in the denominator. If you're using that convention, you'll need to negate the feedback tap. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="af6fa1aa403d2e88b3c972fc154f5c9f9"></a><!-- doxytag: member="gr_single_pole_iir_filter_cc::~gr_single_pole_iir_filter_cc" ref="af6fa1aa403d2e88b3c972fc154f5c9f9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_single_pole_iir_filter_cc::~gr_single_pole_iir_filter_cc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ad4d722586f2e3feeaef9bac41fa7b255"></a><!-- doxytag: member="gr_single_pole_iir_filter_cc::set_taps" ref="ad4d722586f2e3feeaef9bac41fa7b255" args="(double alpha)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_single_pole_iir_filter_cc::set_taps </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>alpha</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a260246be376f893de8819cc3f21c2f54"></a><!-- doxytag: member="gr_single_pole_iir_filter_cc::work" ref="a260246be376f893de8819cc3f21c2f54" 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_single_pole_iir_filter_cc::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="a8adbc32f4b716aa61c32305c50c29ab6"></a><!-- doxytag: member="gr_single_pole_iir_filter_cc::gr_make_single_pole_iir_filter_cc" ref="a8adbc32f4b716aa61c32305c50c29ab6" args="(double alpha, unsigned int vlen)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_single_pole_iir_filter_cc_sptr</a> gr_make_single_pole_iir_filter_cc </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>alpha</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>vlen</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"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__single__pole__iir__filter__cc_8h_source.html">gr_single_pole_iir_filter_cc.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>