<!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.3.0 C++ API: gr_moving_average_ss 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.3 --> <div class="contents"> <h1>gr_moving_average_ss Class Reference<br/> <small> [<a class="el" href="group__filter__blk.html">Filters</a>]</small> </h1><!-- doxytag: class="gr_moving_average_ss" --><!-- doxytag: inherits="gr_sync_block" --> <p>output is the moving sum of the last N samples, scaled by the scale factormax_iter limits how long we go without flushing the accumulator This is necessary to avoid numerical instability for float and complex. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__moving__average__ss_8h_source.html">gr_moving_average_ss.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_moving_average_ss:</div> <div class="dynsection"> <div class="center"><img src="classgr__moving__average__ss__inherit__graph.png" border="0" usemap="#gr__moving__average__ss_inherit__map" alt="Inheritance graph"/></div> <map name="gr__moving__average__ss_inherit__map" id="gr__moving__average__ss_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="29,315,136,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="48,237,117,267"/><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="28,160,137,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="21,83,144,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="13,5,152,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__moving__average__ss-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__moving__average__ss.html#a4a7b4e09b87f7d7e8c217ae516fb880d">~gr_moving_average_ss</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__moving__average__ss.html#a5c40010acc612478071ff5d2ab865eb7">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="#a5c40010acc612478071ff5d2ab865eb7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__moving__average__ss.html#a3037d5332746782270197297a293346d">length</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__moving__average__ss.html#a1f3a3f4dab5343cb0b42126fd16be68e">scale</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__moving__average__ss.html#a519bef59e95c813670a968a6e9ec773b">set_length_and_scale</a> (int length, short scale)</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_moving_average_ss_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__moving__average__ss.html#a062117a2153caebffb59f603a508784d">gr_make_moving_average_ss</a> (int length, short scale, int max_iter)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>output is the moving sum of the last N samples, scaled by the scale factor</p> <p>max_iter limits how long we go without flushing the accumulator This is necessary to avoid numerical instability for float and complex. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4a7b4e09b87f7d7e8c217ae516fb880d"></a><!-- doxytag: member="gr_moving_average_ss::~gr_moving_average_ss" ref="a4a7b4e09b87f7d7e8c217ae516fb880d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_moving_average_ss::~gr_moving_average_ss </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="a3037d5332746782270197297a293346d"></a><!-- doxytag: member="gr_moving_average_ss::length" ref="a3037d5332746782270197297a293346d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_moving_average_ss::length </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a1f3a3f4dab5343cb0b42126fd16be68e"></a><!-- doxytag: member="gr_moving_average_ss::scale" ref="a1f3a3f4dab5343cb0b42126fd16be68e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">short gr_moving_average_ss::scale </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a519bef59e95c813670a968a6e9ec773b"></a><!-- doxytag: member="gr_moving_average_ss::set_length_and_scale" ref="a519bef59e95c813670a968a6e9ec773b" args="(int length, short scale)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_moving_average_ss::set_length_and_scale </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">short </td> <td class="paramname"> <em>scale</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a5c40010acc612478071ff5d2ab865eb7"></a><!-- doxytag: member="gr_moving_average_ss::work" ref="a5c40010acc612478071ff5d2ab865eb7" 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_moving_average_ss::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="a062117a2153caebffb59f603a508784d"></a><!-- doxytag: member="gr_moving_average_ss::gr_make_moving_average_ss" ref="a062117a2153caebffb59f603a508784d" args="(int length, short scale, int max_iter)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_moving_average_ss_sptr</a> gr_make_moving_average_ss </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">short </td> <td class="paramname"> <em>scale</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>max_iter</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__moving__average__ss_8h_source.html">gr_moving_average_ss.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:49 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>