<!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: gri_agc_ff 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>gri_agc_ff Class Reference</h1><!-- doxytag: class="gri_agc_ff" --> <p>high performance Automatic Gain Control class <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gri__agc__ff_8h_source.html">gri_agc_ff.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gri_agc_ff:</div> <div class="dynsection"> <div class="center"><img src="classgri__agc__ff__inherit__graph.png" border="0" usemap="#gri__agc__ff_inherit__map" alt="Inheritance graph"/></div> <map name="gri__agc__ff_inherit__map" id="gri__agc__ff_inherit__map"> <area shape="rect" id="node3" href="classgr__agc__ff.html" title="high performance Automatic Gain Control classPower is approximated by absolute value..." alt="" coords="7,83,81,112"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgri__agc__ff-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="classgri__agc__ff.html#a6a37d93547bce6f637fe741e5a68a55b">gri_agc_ff</a> (float rate=1e-4, float reference=1.0, float gain=1.0, float max_gain=0.0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#acec6a2a2778e4fd8746d521d88c16df9">rate</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a3c86925a6be8e686ab22fc3fc5433f73">reference</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a8823aade27e387b5b44b45d13faefcb4">gain</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#af718da2149e650d8c47ba88bac6965c8">max_gain</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a0faa33eebad5116c8bb55770afe24425">set_rate</a> (float rate)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a486601c1d862e7dd2d5f646dad7aa026">set_reference</a> (float reference)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a7f8d27e626282427bf163728c805ef40">set_gain</a> (float gain)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#ae38654d026cf2e4634febc8acaa84c03">set_max_gain</a> (float max_gain)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a6f5ef887c62144816b05327614c3b74a">scale</a> (float input)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a516257ff14a1d70b230773c0fdb7d77b">scaleN</a> (float output[], const float input[], unsigned n)</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#ab66e127802a267002c1fa2bbe52e2b29">_rate</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a6f644c07e2eb5da83ef7463b7254a84c">_reference</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a6c4339e60e22eabeed2f2bc8fb049502">_gain</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__ff.html#a727b4f656c8a37f92a94269b20103658">_max_gain</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>high performance Automatic Gain Control class </p> <p>Power is approximated by absolute value </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a6a37d93547bce6f637fe741e5a68a55b"></a><!-- doxytag: member="gri_agc_ff::gri_agc_ff" ref="a6a37d93547bce6f637fe741e5a68a55b" args="(float rate=1e-4, float reference=1.0, float gain=1.0, float max_gain=0.0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gri_agc_ff::gri_agc_ff </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>rate</em> = <code>1e-4</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>reference</em> = <code>1.0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>gain</em> = <code>1.0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>max_gain</em> = <code>0.0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a8823aade27e387b5b44b45d13faefcb4"></a><!-- doxytag: member="gri_agc_ff::gain" ref="a8823aade27e387b5b44b45d13faefcb4" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gri_agc_ff::gain </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00066">_gain</a>.</p> </div> </div> <a class="anchor" id="af718da2149e650d8c47ba88bac6965c8"></a><!-- doxytag: member="gri_agc_ff::max_gain" ref="af718da2149e650d8c47ba88bac6965c8" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gri_agc_ff::max_gain </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00067">_max_gain</a>.</p> </div> </div> <a class="anchor" id="acec6a2a2778e4fd8746d521d88c16df9"></a><!-- doxytag: member="gri_agc_ff::rate" ref="acec6a2a2778e4fd8746d521d88c16df9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gri_agc_ff::rate </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00064">_rate</a>.</p> </div> </div> <a class="anchor" id="a3c86925a6be8e686ab22fc3fc5433f73"></a><!-- doxytag: member="gri_agc_ff::reference" ref="a3c86925a6be8e686ab22fc3fc5433f73" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gri_agc_ff::reference </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00065">_reference</a>.</p> </div> </div> <a class="anchor" id="a6f5ef887c62144816b05327614c3b74a"></a><!-- doxytag: member="gri_agc_ff::scale" ref="a6f5ef887c62144816b05327614c3b74a" args="(float input)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float gri_agc_ff::scale </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>input</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00066">_gain</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00067">_max_gain</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00064">_rate</a>, and <a class="el" href="gri__agc__ff_8h_source.html#l00065">_reference</a>.</p> <p>Referenced by <a class="el" href="gri__agc__ff_8h_source.html#l00058">scaleN()</a>.</p> </div> </div> <a class="anchor" id="a516257ff14a1d70b230773c0fdb7d77b"></a><!-- doxytag: member="gri_agc_ff::scaleN" ref="a516257ff14a1d70b230773c0fdb7d77b" args="(float output[], const float input[], unsigned n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gri_agc_ff::scaleN </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>output</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const float </td> <td class="paramname"> <em>input</em>[], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned </td> <td class="paramname"> <em>n</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00050">scale()</a>.</p> </div> </div> <a class="anchor" id="a7f8d27e626282427bf163728c805ef40"></a><!-- doxytag: member="gri_agc_ff::set_gain" ref="a7f8d27e626282427bf163728c805ef40" args="(float gain)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gri_agc_ff::set_gain </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>gain</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00066">_gain</a>.</p> </div> </div> <a class="anchor" id="ae38654d026cf2e4634febc8acaa84c03"></a><!-- doxytag: member="gri_agc_ff::set_max_gain" ref="ae38654d026cf2e4634febc8acaa84c03" args="(float max_gain)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gri_agc_ff::set_max_gain </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>max_gain</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00067">_max_gain</a>.</p> </div> </div> <a class="anchor" id="a0faa33eebad5116c8bb55770afe24425"></a><!-- doxytag: member="gri_agc_ff::set_rate" ref="a0faa33eebad5116c8bb55770afe24425" args="(float rate)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gri_agc_ff::set_rate </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>rate</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00064">_rate</a>.</p> </div> </div> <a class="anchor" id="a486601c1d862e7dd2d5f646dad7aa026"></a><!-- doxytag: member="gri_agc_ff::set_reference" ref="a486601c1d862e7dd2d5f646dad7aa026" args="(float reference)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gri_agc_ff::set_reference </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>reference</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="gri__agc__ff_8h_source.html#l00065">_reference</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a6c4339e60e22eabeed2f2bc8fb049502"></a><!-- doxytag: member="gri_agc_ff::_gain" ref="a6c4339e60e22eabeed2f2bc8fb049502" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="classgri__agc__ff.html#a6c4339e60e22eabeed2f2bc8fb049502">gri_agc_ff::_gain</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="gri__agc__ff_8h_source.html#l00042">gain()</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00050">scale()</a>, and <a class="el" href="gri__agc__ff_8h_source.html#l00047">set_gain()</a>.</p> </div> </div> <a class="anchor" id="a727b4f656c8a37f92a94269b20103658"></a><!-- doxytag: member="gri_agc_ff::_max_gain" ref="a727b4f656c8a37f92a94269b20103658" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="classgri__agc__ff.html#a727b4f656c8a37f92a94269b20103658">gri_agc_ff::_max_gain</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="gri__agc__ff_8h_source.html#l00043">max_gain()</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00050">scale()</a>, and <a class="el" href="gri__agc__ff_8h_source.html#l00048">set_max_gain()</a>.</p> </div> </div> <a class="anchor" id="ab66e127802a267002c1fa2bbe52e2b29"></a><!-- doxytag: member="gri_agc_ff::_rate" ref="ab66e127802a267002c1fa2bbe52e2b29" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="classgri__agc__ff.html#ab66e127802a267002c1fa2bbe52e2b29">gri_agc_ff::_rate</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="gri__agc__ff_8h_source.html#l00040">rate()</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00050">scale()</a>, and <a class="el" href="gri__agc__ff_8h_source.html#l00045">set_rate()</a>.</p> </div> </div> <a class="anchor" id="a6f644c07e2eb5da83ef7463b7254a84c"></a><!-- doxytag: member="gri_agc_ff::_reference" ref="a6f644c07e2eb5da83ef7463b7254a84c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="classgri__agc__ff.html#a6f644c07e2eb5da83ef7463b7254a84c">gri_agc_ff::_reference</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="gri__agc__ff_8h_source.html#l00041">reference()</a>, <a class="el" href="gri__agc__ff_8h_source.html#l00050">scale()</a>, and <a class="el" href="gri__agc__ff_8h_source.html#l00046">set_reference()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gri__agc__ff_8h_source.html">gri_agc_ff.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>