<!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_peak_detector2_fb 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__peak__detector2__fb.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_peak_detector2_fb Class Reference<div class="ingroups"><a class="el" href="group__level__blk.html">Signal Level Control (AGC)</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_peak_detector2_fb" --><!-- 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 separate debug output may be connected, to view the internal EWMA described below.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__peak__detector2__fb_8h_source.html">gr_peak_detector2_fb.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_peak_detector2_fb:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__peak__detector2__fb__inherit__graph.png" border="0" usemap="#gr__peak__detector2__fb_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__peak__detector2__fb_inherit__map" id="gr__peak__detector2__fb_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 implementa..." alt="" coords="25,160,132,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="44,83,113,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 abstraction of an ..." alt="" coords="24,5,133,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__peak__detector2__fb-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector2__fb.html#ae0ef9660f6a6ca4a689298df284e9d2c">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="#ae0ef9660f6a6ca4a689298df284e9d2c"></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__detector2__fb.html#a5d5c149b7d93137e3e1b981e82f9291b">set_look_ahead</a> (int look)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the look-ahead factor. <a href="#a5d5c149b7d93137e3e1b981e82f9291b"></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__detector2__fb.html#ac19060f3c2eb37be0e10b1376d41ccfe">set_alpha</a> (int alpha)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the running average alpha. <a href="#ac19060f3c2eb37be0e10b1376d41ccfe"></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__detector2__fb.html#a940f84e654a357264fe994244e458a7f">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="#a940f84e654a357264fe994244e458a7f"></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__detector2__fb.html#ab53ab96a2a75922a2f156d48da260ff7">look_ahead</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the look-ahead factor value. <a href="#ab53ab96a2a75922a2f156d48da260ff7"></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__detector2__fb.html#a3a7e28f5cc25d8a5977b37f83e00129e">alpha</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the alpha value of the running average. <a href="#a3a7e28f5cc25d8a5977b37f83e00129e"></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__detector2__fb.html#aa6958e3f5fa05b60b899d79ff6e9d21f">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="#aa6958e3f5fa05b60b899d79ff6e9d21f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_peak_detector2_fb_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__peak__detector2__fb.html#a453f723c64859d51442a3c9d4fd3520b">gr_make_peak_detector2_fb</a> (float threshold_factor_rise, int look_ahead, float alpha)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Detect the peak of a signal</p>
<p>If a peak is detected, this block outputs a 1, or it outputs 0's. A separate debug output may be connected, to view the internal EWMA described below. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">threshold_factor_rise</td><td>The threshold factor determins when a peak is present. An EWMA average of the signal is calculated and when the value of the signal goes over threshold_factor_rise*average, we call the peak. </td></tr>
<tr><td class="paramname">look_ahead</td><td>The look-ahead value is used when the threshold is found to locate the peak within this range. </td></tr>
<tr><td class="paramname">alpha</td><td>The gain value of a single-pole moving average filter </td></tr>
</table>
</dd>
</dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a7e28f5cc25d8a5977b37f83e00129e"></a><!-- doxytag: member="gr_peak_detector2_fb::alpha" ref="a3a7e28f5cc25d8a5977b37f83e00129e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_peak_detector2_fb::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>
<p>Referenced by <a class="el" href="classgr__peak__detector2__fb.html#ac19060f3c2eb37be0e10b1376d41ccfe">set_alpha()</a>.</p>
</div>
</div>
<a class="anchor" id="ab53ab96a2a75922a2f156d48da260ff7"></a><!-- doxytag: member="gr_peak_detector2_fb::look_ahead" ref="ab53ab96a2a75922a2f156d48da260ff7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_peak_detector2_fb::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="ac19060f3c2eb37be0e10b1376d41ccfe"></a><!-- doxytag: member="gr_peak_detector2_fb::set_alpha" ref="ac19060f3c2eb37be0e10b1376d41ccfe" args="(int alpha)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_peak_detector2_fb::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 class="params">
<tr><td class="paramname">alpha</td><td>new alpha for running average </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classgr__peak__detector2__fb.html#a3a7e28f5cc25d8a5977b37f83e00129e">alpha()</a>.</p>
</div>
</div>
<a class="anchor" id="a5d5c149b7d93137e3e1b981e82f9291b"></a><!-- doxytag: member="gr_peak_detector2_fb::set_look_ahead" ref="a5d5c149b7d93137e3e1b981e82f9291b" args="(int look)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_peak_detector2_fb::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 class="params">
<tr><td class="paramname">look</td><td>new look-ahead factor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae0ef9660f6a6ca4a689298df284e9d2c"></a><!-- doxytag: member="gr_peak_detector2_fb::set_threshold_factor_rise" ref="ae0ef9660f6a6ca4a689298df284e9d2c" args="(float thr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_peak_detector2_fb::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 class="params">
<tr><td class="paramname">thr</td><td>new threshold factor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a940f84e654a357264fe994244e458a7f"></a><!-- doxytag: member="gr_peak_detector2_fb::threshold_factor_rise" ref="a940f84e654a357264fe994244e458a7f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gr_peak_detector2_fb::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="aa6958e3f5fa05b60b899d79ff6e9d21f"></a><!-- doxytag: member="gr_peak_detector2_fb::work" ref="aa6958e3f5fa05b60b899d79ff6e9d21f" 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_detector2_fb::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>
</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>Friends And Related Function Documentation</h2>
<a class="anchor" id="a453f723c64859d51442a3c9d4fd3520b"></a><!-- doxytag: member="gr_peak_detector2_fb::gr_make_peak_detector2_fb" ref="a453f723c64859d51442a3c9d4fd3520b" args="(float threshold_factor_rise, 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_detector2_fb_sptr</a> gr_make_peak_detector2_fb </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">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>
</tr>
<tr>
<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__detector2__fb_8h_source.html">gr_peak_detector2_fb.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__peak__detector2__fb.html">gr_peak_detector2_fb</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
1749
