<!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_peak_detector_sb 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_peak_detector_sb Class Reference<br/> <small> [<a class="el" href="group__level__blk.html">Signal Level Control (AGC)</a>]</small> </h1><!-- doxytag: class="gr_peak_detector_sb" --><!-- doxytag: inherits="gr_sync_block" --> <p>Detect the peak of a signalIf a peak is detected, this block outputs a 1, or it outputs 0's. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__peak__detector__sb_8h_source.html">gr_peak_detector_sb.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_peak_detector_sb:</div> <div class="dynsection"> <div class="center"><img src="classgr__peak__detector__sb__inherit__graph.png" border="0" usemap="#gr__peak__detector__sb_inherit__map" alt="Inheritance graph"/></div> <map name="gr__peak__detector__sb_inherit__map" id="gr__peak__detector__sb_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="23,315,129,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="41,237,111,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="21,160,131,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="15,83,137,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="7,5,145,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__peak__detector__sb-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__peak__detector__sb.html#af87da42301b3a32ad23d924c0953a3e9">set_threshold_factor_rise</a> (float thr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the threshold factor value for the rise time. <a href="#af87da42301b3a32ad23d924c0953a3e9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#abc65412a7a48fb8aeba4e0965cb36d1a">set_threshold_factor_fall</a> (float thr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the threshold factor value for the fall time. <a href="#abc65412a7a48fb8aeba4e0965cb36d1a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#ae0b4ede9e51baa48c44d634abda2c490">set_look_ahead</a> (int look)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the look-ahead factor. <a href="#ae0b4ede9e51baa48c44d634abda2c490"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#a4a53ed060f60639079af13a2756db1a2">set_alpha</a> (int alpha)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the running average alpha. <a href="#a4a53ed060f60639079af13a2756db1a2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#a26b0eb094a52ea634645ba5289a9540a">threshold_factor_rise</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the threshold factor value for the rise time. <a href="#a26b0eb094a52ea634645ba5289a9540a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#a913a9d80832eb0a7b0aa12abb82fad13">threshold_factor_fall</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the threshold factor value for the fall time. <a href="#a913a9d80832eb0a7b0aa12abb82fad13"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#accd7ca68b60aad589da16a41aa42a4a4">look_ahead</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the look-ahead factor value. <a href="#accd7ca68b60aad589da16a41aa42a4a4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#a294c75f4c9b97da544cd33c18c8176e3">alpha</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the alpha value of the running average. <a href="#a294c75f4c9b97da544cd33c18c8176e3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#af2a6140a699f936576fe2c80ccf60e57">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="#af2a6140a699f936576fe2c80ccf60e57"></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_peak_detector_sb_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector__sb.html#ad88b0368ac6782b75ea86ac0240cbb5e">gr_make_peak_detector_sb</a> (float threshold_factor_rise, float threshold_factor_fall, int look_ahead, float alpha)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Detect the peak of a signal</p> <p>If a peak is detected, this block outputs a 1, or it outputs 0's. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>threshold_factor_rise</em> </td><td>The threshold factor determins when a peak has started. An average of the signal is calculated and when the value of the signal goes over threshold_factor_rise*average, we start looking for a peak. </td></tr> <tr><td valign="top"></td><td valign="top"><em>threshold_factor_fall</em> </td><td>The threshold factor determins when a peak has ended. An average of the signal is calculated and when the value of the signal goes bellow threshold_factor_fall*average, we stop looking for a peak. </td></tr> <tr><td valign="top"></td><td valign="top"><em>look_ahead</em> </td><td>The look-ahead value is used when the threshold is found to look if there another peak within this step range. If there is a larger value, we set that as the peak and look ahead again. This is continued until the highest point is found with This look-ahead range. </td></tr> <tr><td valign="top"></td><td valign="top"><em>alpha</em> </td><td>The gain value of a moving average filter </td></tr> </table> </dd> </dl> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a294c75f4c9b97da544cd33c18c8176e3"></a><!-- doxytag: member="gr_peak_detector_sb::alpha" ref="a294c75f4c9b97da544cd33c18c8176e3" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_peak_detector_sb::alpha </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the alpha value of the running average. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>alpha </dd></dl> </div> </div> <a class="anchor" id="accd7ca68b60aad589da16a41aa42a4a4"></a><!-- doxytag: member="gr_peak_detector_sb::look_ahead" ref="accd7ca68b60aad589da16a41aa42a4a4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_peak_detector_sb::look_ahead </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the look-ahead factor value. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>look-ahead factor </dd></dl> </div> </div> <a class="anchor" id="a4a53ed060f60639079af13a2756db1a2"></a><!-- doxytag: member="gr_peak_detector_sb::set_alpha" ref="a4a53ed060f60639079af13a2756db1a2" args="(int alpha)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_peak_detector_sb::set_alpha </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>alpha</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the running average alpha. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>alpha</em> </td><td>new alpha for running average </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae0b4ede9e51baa48c44d634abda2c490"></a><!-- doxytag: member="gr_peak_detector_sb::set_look_ahead" ref="ae0b4ede9e51baa48c44d634abda2c490" args="(int look)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_peak_detector_sb::set_look_ahead </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>look</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the look-ahead factor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>look</em> </td><td>new look-ahead factor </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="abc65412a7a48fb8aeba4e0965cb36d1a"></a><!-- doxytag: member="gr_peak_detector_sb::set_threshold_factor_fall" ref="abc65412a7a48fb8aeba4e0965cb36d1a" args="(float thr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_peak_detector_sb::set_threshold_factor_fall </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>thr</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the threshold factor value for the fall time. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>thr</em> </td><td>new threshold factor </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af87da42301b3a32ad23d924c0953a3e9"></a><!-- doxytag: member="gr_peak_detector_sb::set_threshold_factor_rise" ref="af87da42301b3a32ad23d924c0953a3e9" args="(float thr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gr_peak_detector_sb::set_threshold_factor_rise </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>thr</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the threshold factor value for the rise time. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>thr</em> </td><td>new threshold factor </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a913a9d80832eb0a7b0aa12abb82fad13"></a><!-- doxytag: member="gr_peak_detector_sb::threshold_factor_fall" ref="a913a9d80832eb0a7b0aa12abb82fad13" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_peak_detector_sb::threshold_factor_fall </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the threshold factor value for the fall time. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>threshold factor </dd></dl> </div> </div> <a class="anchor" id="a26b0eb094a52ea634645ba5289a9540a"></a><!-- doxytag: member="gr_peak_detector_sb::threshold_factor_rise" ref="a26b0eb094a52ea634645ba5289a9540a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gr_peak_detector_sb::threshold_factor_rise </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the threshold factor value for the rise time. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>threshold factor </dd></dl> </div> </div> <a class="anchor" id="af2a6140a699f936576fe2c80ccf60e57"></a><!-- doxytag: member="gr_peak_detector_sb::work" ref="af2a6140a699f936576fe2c80ccf60e57" 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_peak_detector_sb::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="ad88b0368ac6782b75ea86ac0240cbb5e"></a><!-- doxytag: member="gr_peak_detector_sb::gr_make_peak_detector_sb" ref="ad88b0368ac6782b75ea86ac0240cbb5e" args="(float threshold_factor_rise, float threshold_factor_fall, int look_ahead, float alpha)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_peak_detector_sb_sptr</a> gr_make_peak_detector_sb </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>threshold_factor_rise</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>threshold_factor_fall</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>look_ahead</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>alpha</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__peak__detector__sb_8h_source.html">gr_peak_detector_sb.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:52 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>