<!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: gri_agc_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.3 -->
<div class="contents">
<h1>gri_agc_cc Class Reference</h1><!-- doxytag: class="gri_agc_cc" -->
<p>high performance Automatic Gain Control class
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gri__agc__cc_8h_source.html">gri_agc_cc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gri_agc_cc:</div>
<div class="dynsection">
<div class="center"><img src="classgri__agc__cc__inherit__graph.png" border="0" usemap="#gri__agc__cc_inherit__map" alt="Inheritance graph"/></div>
<map name="gri__agc__cc_inherit__map" id="gri__agc__cc_inherit__map">
<area shape="rect" id="node3" href="classgr__agc__cc.html" title="high performance Automatic Gain Control classFor Power the absolute value of the..." alt="" coords="7,83,89,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgri__agc__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="classgri__agc__cc.html#a289fd86c352e4f7d29a262acd5d91c64">gri_agc_cc</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__cc.html#ac7bf50c46a7f4c9750594f53f20df731">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__cc.html#a000e10b591cf7e4a56043f2542608b45">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__cc.html#a23b4bef23e09133d352096c2ffb20814">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__cc.html#ad686fd713a7c58e93c8f8c2d11076960">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__cc.html#a0c29ac4bbd8e9fd38b014bd81ce0ba26">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__cc.html#aafe2ae875b8057005f7fa12919846c75">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__cc.html#a670964c35b7d565cc4f8548907dee847">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__cc.html#aab963acbfaa924a1227f745307e67905">set_max_gain</a> (float max_gain)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__cc.html#a3a6eb679f0dfa459e94dd5c99fc842f0">scale</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> input)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__agc__cc.html#af17c36b0d622b93d411c56fc186f44c6">scaleN</a> (<a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> output[], const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> 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__cc.html#a780e7cc06eb312f481595fd96a0ab4c8">_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__cc.html#a9393e1d3305e194683cc9bbeac5cd958">_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__cc.html#acdbbec6fd48d9a1718519e91c8e92eab">_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__cc.html#aa3138ae9a324a76f6631af0cdb564d4e">_max_gain</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>high performance Automatic Gain Control class </p>
<p>For Power the absolute value of the complex number is used. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a289fd86c352e4f7d29a262acd5d91c64"></a><!-- doxytag: member="gri_agc_cc::gri_agc_cc" ref="a289fd86c352e4f7d29a262acd5d91c64" 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_cc::gri_agc_cc </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="a23b4bef23e09133d352096c2ffb20814"></a><!-- doxytag: member="gri_agc_cc::gain" ref="a23b4bef23e09133d352096c2ffb20814" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gri_agc_cc::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__cc_8h_source.html#l00070">_gain</a>.</p>
</div>
</div>
<a class="anchor" id="ad686fd713a7c58e93c8f8c2d11076960"></a><!-- doxytag: member="gri_agc_cc::max_gain" ref="ad686fd713a7c58e93c8f8c2d11076960" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gri_agc_cc::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__cc_8h_source.html#l00071">_max_gain</a>.</p>
</div>
</div>
<a class="anchor" id="ac7bf50c46a7f4c9750594f53f20df731"></a><!-- doxytag: member="gri_agc_cc::rate" ref="ac7bf50c46a7f4c9750594f53f20df731" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gri_agc_cc::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__cc_8h_source.html#l00068">_rate</a>.</p>
</div>
</div>
<a class="anchor" id="a000e10b591cf7e4a56043f2542608b45"></a><!-- doxytag: member="gri_agc_cc::reference" ref="a000e10b591cf7e4a56043f2542608b45" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float gri_agc_cc::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__cc_8h_source.html#l00069">_reference</a>.</p>
</div>
</div>
<a class="anchor" id="a3a6eb679f0dfa459e94dd5c99fc842f0"></a><!-- doxytag: member="gri_agc_cc::scale" ref="a3a6eb679f0dfa459e94dd5c99fc842f0" args="(gr_complex input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> gri_agc_cc::scale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </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__cc_8h_source.html#l00070">_gain</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00071">_max_gain</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00068">_rate</a>, and <a class="el" href="gri__agc__cc_8h_source.html#l00069">_reference</a>.</p>
<p>Referenced by <a class="el" href="gri__agc__cc_8h_source.html#l00062">scaleN()</a>.</p>
</div>
</div>
<a class="anchor" id="af17c36b0d622b93d411c56fc186f44c6"></a><!-- doxytag: member="gri_agc_cc::scaleN" ref="af17c36b0d622b93d411c56fc186f44c6" args="(gr_complex output[], const gr_complex input[], unsigned n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gri_agc_cc::scaleN </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </td>
<td class="paramname"> <em>output</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> </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__cc_8h_source.html#l00052">scale()</a>.</p>
</div>
</div>
<a class="anchor" id="a670964c35b7d565cc4f8548907dee847"></a><!-- doxytag: member="gri_agc_cc::set_gain" ref="a670964c35b7d565cc4f8548907dee847" args="(float gain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gri_agc_cc::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__cc_8h_source.html#l00070">_gain</a>.</p>
</div>
</div>
<a class="anchor" id="aab963acbfaa924a1227f745307e67905"></a><!-- doxytag: member="gri_agc_cc::set_max_gain" ref="aab963acbfaa924a1227f745307e67905" args="(float max_gain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gri_agc_cc::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__cc_8h_source.html#l00071">_max_gain</a>.</p>
</div>
</div>
<a class="anchor" id="a0c29ac4bbd8e9fd38b014bd81ce0ba26"></a><!-- doxytag: member="gri_agc_cc::set_rate" ref="a0c29ac4bbd8e9fd38b014bd81ce0ba26" args="(float rate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gri_agc_cc::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__cc_8h_source.html#l00068">_rate</a>.</p>
</div>
</div>
<a class="anchor" id="aafe2ae875b8057005f7fa12919846c75"></a><!-- doxytag: member="gri_agc_cc::set_reference" ref="aafe2ae875b8057005f7fa12919846c75" args="(float reference)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gri_agc_cc::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__cc_8h_source.html#l00069">_reference</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acdbbec6fd48d9a1718519e91c8e92eab"></a><!-- doxytag: member="gri_agc_cc::_gain" ref="acdbbec6fd48d9a1718519e91c8e92eab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classgri__agc__cc.html#acdbbec6fd48d9a1718519e91c8e92eab">gri_agc_cc::_gain</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gri__agc__cc_8h_source.html#l00044">gain()</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00052">scale()</a>, and <a class="el" href="gri__agc__cc_8h_source.html#l00049">set_gain()</a>.</p>
</div>
</div>
<a class="anchor" id="aa3138ae9a324a76f6631af0cdb564d4e"></a><!-- doxytag: member="gri_agc_cc::_max_gain" ref="aa3138ae9a324a76f6631af0cdb564d4e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classgri__agc__cc.html#aa3138ae9a324a76f6631af0cdb564d4e">gri_agc_cc::_max_gain</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gri__agc__cc_8h_source.html#l00045">max_gain()</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00052">scale()</a>, and <a class="el" href="gri__agc__cc_8h_source.html#l00050">set_max_gain()</a>.</p>
</div>
</div>
<a class="anchor" id="a780e7cc06eb312f481595fd96a0ab4c8"></a><!-- doxytag: member="gri_agc_cc::_rate" ref="a780e7cc06eb312f481595fd96a0ab4c8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classgri__agc__cc.html#a780e7cc06eb312f481595fd96a0ab4c8">gri_agc_cc::_rate</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gri__agc__cc_8h_source.html#l00042">rate()</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00052">scale()</a>, and <a class="el" href="gri__agc__cc_8h_source.html#l00047">set_rate()</a>.</p>
</div>
</div>
<a class="anchor" id="a9393e1d3305e194683cc9bbeac5cd958"></a><!-- doxytag: member="gri_agc_cc::_reference" ref="a9393e1d3305e194683cc9bbeac5cd958" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classgri__agc__cc.html#a9393e1d3305e194683cc9bbeac5cd958">gri_agc_cc::_reference</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="gri__agc__cc_8h_source.html#l00043">reference()</a>, <a class="el" href="gri__agc__cc_8h_source.html#l00052">scale()</a>, and <a class="el" href="gri__agc__cc_8h_source.html#l00048">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__cc_8h_source.html">gri_agc_cc.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:00 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>
