annotate C++/api/html/classAGCParam.html @ 594:97976133eb4d

updated the documentation
author flatmax
date Wed, 20 Feb 2013 22:34:13 +0000
parents 76c6b3fd0a05
children
rev   line source
flatmax@592 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@592 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@592 3 <head>
flatmax@592 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@592 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@592 6 <title>CARFAC C++: AGCParam Class Reference</title>
flatmax@592 7
flatmax@592 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@592 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@592 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@592 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@592 12 <script type="text/javascript" src="resize.js"></script>
flatmax@592 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@592 14 <script type="text/javascript">
flatmax@592 15 $(document).ready(initResizable);
flatmax@592 16 </script>
flatmax@592 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@592 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@592 19 <script type="text/javascript">
flatmax@592 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@592 21 </script>
flatmax@592 22
flatmax@592 23 </head>
flatmax@592 24 <body>
flatmax@592 25 <div id="top"><!-- do not remove this div! -->
flatmax@592 26
flatmax@592 27
flatmax@592 28 <div id="titlearea">
flatmax@592 29 <table cellspacing="0" cellpadding="0">
flatmax@592 30 <tbody>
flatmax@592 31 <tr style="height: 56px;">
flatmax@592 32
flatmax@592 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@592 34
flatmax@592 35
flatmax@592 36 <td style="padding-left: 0.5em;">
flatmax@592 37 <div id="projectname">CARFAC C++
flatmax@592 38
flatmax@592 39 </div>
flatmax@592 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@592 41 </td>
flatmax@592 42
flatmax@592 43
flatmax@592 44
flatmax@592 45 </tr>
flatmax@592 46 </tbody>
flatmax@592 47 </table>
flatmax@592 48 </div>
flatmax@592 49
flatmax@592 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@592 51 <script type="text/javascript">
flatmax@592 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@592 53 </script>
flatmax@592 54 <div id="navrow1" class="tabs">
flatmax@592 55 <ul class="tablist">
flatmax@592 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@592 57 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
flatmax@592 58 <li><a href="files.html"><span>Files</span></a></li>
flatmax@592 59 <li>
flatmax@592 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@592 61 <span class="left">
flatmax@592 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@592 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 65 alt=""/>
flatmax@592 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@592 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@592 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@592 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@592 70 </span><span class="right">
flatmax@592 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@592 72 </span>
flatmax@592 73 </div>
flatmax@592 74 </li>
flatmax@592 75 </ul>
flatmax@592 76 </div>
flatmax@592 77 <div id="navrow2" class="tabs2">
flatmax@592 78 <ul class="tablist">
flatmax@592 79 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
flatmax@592 80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
flatmax@592 81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
flatmax@592 82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
flatmax@592 83 </ul>
flatmax@592 84 </div>
flatmax@592 85 </div>
flatmax@592 86 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@592 87 <div id="nav-tree">
flatmax@592 88 <div id="nav-tree-contents">
flatmax@592 89 </div>
flatmax@592 90 </div>
flatmax@592 91 <div id="splitbar" style="-moz-user-select:none;"
flatmax@592 92 class="ui-resizable-handle">
flatmax@592 93 </div>
flatmax@592 94 </div>
flatmax@592 95 <script type="text/javascript">
flatmax@592 96 initNavTree('classAGCParam.html','');
flatmax@592 97 </script>
flatmax@592 98 <div id="doc-content">
flatmax@592 99 <div class="header">
flatmax@592 100 <div class="summary">
flatmax@592 101 <a href="#pub-methods">Public Member Functions</a> &#124;
flatmax@592 102 <a href="#pri-attribs">Private Attributes</a> </div>
flatmax@592 103 <div class="headertitle">
flatmax@592 104 <div class="title">AGCParam Class Reference</div> </div>
flatmax@592 105 </div><!--header-->
flatmax@592 106 <div class="contents">
flatmax@592 107 <!-- doxytag: class="AGCParam" --><!-- doxytag: inherits="Parameters" -->
flatmax@592 108 <p><code>#include &lt;<a class="el" href="AGCParam_8H_source.html">AGCParam.H</a>&gt;</code></p>
flatmax@592 109 <div class="dynheader">
flatmax@592 110 Inheritance diagram for AGCParam:</div>
flatmax@592 111 <div class="dyncontent">
flatmax@592 112 <div class="center"><img src="classAGCParam__inherit__graph.png" border="0" usemap="#AGCParam_inherit__map" alt="Inheritance graph"/></div>
flatmax@592 113 <map name="AGCParam_inherit__map" id="AGCParam_inherit__map">
flatmax@592 114 <area shape="rect" id="node2" href="classParameters.html" title="Parameters" alt="" coords="5,5,93,35"/></map>
flatmax@592 115 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@592 116 <div class="dynheader">
flatmax@592 117 Collaboration diagram for AGCParam:</div>
flatmax@592 118 <div class="dyncontent">
flatmax@592 119 <div class="center"><img src="classAGCParam__coll__graph.png" border="0" usemap="#AGCParam_coll__map" alt="Collaboration graph"/></div>
flatmax@592 120 <map name="AGCParam_coll__map" id="AGCParam_coll__map">
flatmax@592 121 <area shape="rect" id="node2" href="classParameters.html" title="Parameters" alt="" coords="5,5,93,35"/></map>
flatmax@592 122 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@592 123
flatmax@592 124 <p><a href="classAGCParam-members.html">List of all members.</a></p>
flatmax@592 125 <table class="memberdecls">
flatmax@592 126 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@592 127 Public Member Functions</h2></td></tr>
flatmax@592 128 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#aa822c90ba8da467c7bf31d85bf9b6f97">AGCParam</a> (int n_stages_=<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt; time_constants_=Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;(1., 4., 16., 64.)*0.002, <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a> AGC_stage_gain_=2., Array&lt; int, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt; decimation_=Array&lt; int, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;(8, 2, 2, 2), Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt; AGC1_scales_=Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;(1.0, 1.4, 2.0, 2.8), Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt; AGC2_scales_=Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;(1.6, 2.25, 3.2, 4.5), <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a> AGC_mix_coeff_=0.5)</td></tr>
flatmax@592 129 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with default parameter values. <a href="#aa822c90ba8da467c7bf31d85bf9b6f97"></a><br/></td></tr>
flatmax@592 130 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#a40249c83afc2cffec3c0fe8bb9cb9997">~AGCParam</a> ()</td></tr>
flatmax@592 131 <tr><td colspan="2"><h2><a name="pri-attribs"></a>
flatmax@592 132 Private Attributes</h2></td></tr>
flatmax@592 133 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#a6cb476c916e99e227ddcfec68be66b3a">n_stages</a></td></tr>
flatmax@592 134 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stage count. <a href="#a6cb476c916e99e227ddcfec68be66b3a"></a><br/></td></tr>
flatmax@592 135 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <br class="typebreak"/>
flatmax@592 136 <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#ae8073d3c194a9134cf736a564d4774fa">time_constants</a></td></tr>
flatmax@592 137 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">seconds <a href="#ae8073d3c194a9134cf736a564d4774fa"></a><br/></td></tr>
flatmax@592 138 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#a6a436005102557783fe4a0d30d3dcc51">AGC_stage_gain</a></td></tr>
flatmax@592 139 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">gain from each stage to next slower stage <a href="#a6a436005102557783fe4a0d30d3dcc51"></a><br/></td></tr>
flatmax@592 140 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; int, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#ac7fc293748c6e7d59b91998253a68657">decimation</a></td></tr>
flatmax@592 141 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">how often to update the <a class="el" href="classAGC.html">AGC</a> states <a href="#ac7fc293748c6e7d59b91998253a68657"></a><br/></td></tr>
flatmax@592 142 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <br class="typebreak"/>
flatmax@592 143 <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#adf027a80d6669e72d735fff7d41801d7">AGC1_scales</a></td></tr>
flatmax@592 144 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">in units of channels <a href="#adf027a80d6669e72d735fff7d41801d7"></a><br/></td></tr>
flatmax@592 145 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <br class="typebreak"/>
flatmax@592 146 <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#aca67e2871ee79cc96807d347acd55fe4">AGC2_scales</a></td></tr>
flatmax@592 147 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">spread more toward base <a href="#aca67e2871ee79cc96807d347acd55fe4"></a><br/></td></tr>
flatmax@592 148 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAGCParam.html#a968c25ad0327d2db3ebd287d661001b4">AGC_mix_coeff</a></td></tr>
flatmax@592 149 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Dick, whats this ? <a href="#a968c25ad0327d2db3ebd287d661001b4"></a><br/></td></tr>
flatmax@592 150 </table>
flatmax@592 151 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@592 152 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@592 153 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@592 154 <p><a class="el" href="classParameters.html">Parameters</a> for the automatic gain control </p>
flatmax@592 155 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@592 156 <a class="anchor" id="aa822c90ba8da467c7bf31d85bf9b6f97"></a><!-- doxytag: member="AGCParam::AGCParam" ref="aa822c90ba8da467c7bf31d85bf9b6f97" args="(int n_stages_=AGC_STAGE_COUNT, Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt; time_constants_=Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt;(1., 4., 16., 64.)*0.002, FP_TYPE AGC_stage_gain_=2., Array&lt; int, AGC_STAGE_COUNT, 1 &gt; decimation_=Array&lt; int, AGC_STAGE_COUNT, 1 &gt;(8, 2, 2, 2), Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt; AGC1_scales_=Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt;(1.0, 1.4, 2.0, 2.8), Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt; AGC2_scales_=Array&lt; FP_TYPE, AGC_STAGE_COUNT, 1 &gt;(1.6, 2.25, 3.2, 4.5), FP_TYPE AGC_mix_coeff_=0.5)" -->
flatmax@592 157 <div class="memitem">
flatmax@592 158 <div class="memproto">
flatmax@592 159 <table class="memname">
flatmax@592 160 <tr>
flatmax@592 161 <td class="memname"><a class="el" href="classAGCParam.html#aa822c90ba8da467c7bf31d85bf9b6f97">AGCParam::AGCParam</a> </td>
flatmax@592 162 <td>(</td>
flatmax@592 163 <td class="paramtype">int&#160;</td>
flatmax@592 164 <td class="paramname"><em>n_stages_</em> = <code><a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a></code>, </td>
flatmax@592 165 </tr>
flatmax@592 166 <tr>
flatmax@592 167 <td class="paramkey"></td>
flatmax@592 168 <td></td>
flatmax@592 169 <td class="paramtype">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td>
flatmax@592 170 <td class="paramname"><em>time_constants_</em> = <code>Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>,&#160;<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt;(1.,&#160;4.,&#160;16.,&#160;64.)*0.002</code>, </td>
flatmax@592 171 </tr>
flatmax@592 172 <tr>
flatmax@592 173 <td class="paramkey"></td>
flatmax@592 174 <td></td>
flatmax@592 175 <td class="paramtype"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>&#160;</td>
flatmax@592 176 <td class="paramname"><em>AGC_stage_gain_</em> = <code>2.</code>, </td>
flatmax@592 177 </tr>
flatmax@592 178 <tr>
flatmax@592 179 <td class="paramkey"></td>
flatmax@592 180 <td></td>
flatmax@592 181 <td class="paramtype">Array&lt; int, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td>
flatmax@592 182 <td class="paramname"><em>decimation_</em> = <code>Array&lt;int,<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,&#160;1&gt;(8,&#160;2,&#160;2,&#160;2)</code>, </td>
flatmax@592 183 </tr>
flatmax@592 184 <tr>
flatmax@592 185 <td class="paramkey"></td>
flatmax@592 186 <td></td>
flatmax@592 187 <td class="paramtype">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td>
flatmax@592 188 <td class="paramname"><em>AGC1_scales_</em> = <code>Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>,&#160;<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt;(1.0,&#160;1.4,&#160;&#160;2.0,&#160;2.8)</code>, </td>
flatmax@592 189 </tr>
flatmax@592 190 <tr>
flatmax@592 191 <td class="paramkey"></td>
flatmax@592 192 <td></td>
flatmax@592 193 <td class="paramtype">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1 &gt;&#160;</td>
flatmax@592 194 <td class="paramname"><em>AGC2_scales_</em> = <code>Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>,&#160;<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt;(1.6,&#160;2.25,&#160;3.2,&#160;4.5)</code>, </td>
flatmax@592 195 </tr>
flatmax@592 196 <tr>
flatmax@592 197 <td class="paramkey"></td>
flatmax@592 198 <td></td>
flatmax@592 199 <td class="paramtype"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>&#160;</td>
flatmax@592 200 <td class="paramname"><em>AGC_mix_coeff_</em> = <code>0.5</code>&#160;</td>
flatmax@592 201 </tr>
flatmax@592 202 <tr>
flatmax@592 203 <td></td>
flatmax@592 204 <td>)</td>
flatmax@592 205 <td></td><td></td>
flatmax@592 206 </tr>
flatmax@592 207 </table>
flatmax@592 208 </div>
flatmax@592 209 <div class="memdoc">
flatmax@592 210
flatmax@592 211 <p>Constructor with default parameter values. </p>
flatmax@592 212 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@592 213 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
flatmax@592 214
flatmax@592 215 </div>
flatmax@592 216 </div>
flatmax@592 217 <a class="anchor" id="a40249c83afc2cffec3c0fe8bb9cb9997"></a><!-- doxytag: member="AGCParam::~AGCParam" ref="a40249c83afc2cffec3c0fe8bb9cb9997" args="()" -->
flatmax@592 218 <div class="memitem">
flatmax@592 219 <div class="memproto">
flatmax@592 220 <table class="memname">
flatmax@592 221 <tr>
flatmax@592 222 <td class="memname"><a class="el" href="classAGCParam.html#a40249c83afc2cffec3c0fe8bb9cb9997">AGCParam::~AGCParam</a> </td>
flatmax@592 223 <td>(</td>
flatmax@592 224 <td class="paramname"></td><td>)</td>
flatmax@592 225 <td><code> [virtual]</code></td>
flatmax@592 226 </tr>
flatmax@592 227 </table>
flatmax@592 228 </div>
flatmax@592 229 <div class="memdoc">
flatmax@592 230
flatmax@592 231 </div>
flatmax@592 232 </div>
flatmax@592 233 <hr/><h2>Member Data Documentation</h2>
flatmax@592 234 <a class="anchor" id="adf027a80d6669e72d735fff7d41801d7"></a><!-- doxytag: member="AGCParam::AGC1_scales" ref="adf027a80d6669e72d735fff7d41801d7" args="" -->
flatmax@592 235 <div class="memitem">
flatmax@592 236 <div class="memproto">
flatmax@592 237 <table class="memname">
flatmax@592 238 <tr>
flatmax@592 239 <td class="memname">Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt; <a class="el" href="classAGCParam.html#adf027a80d6669e72d735fff7d41801d7">AGCParam::AGC1_scales</a><code> [private]</code></td>
flatmax@592 240 </tr>
flatmax@592 241 </table>
flatmax@592 242 </div>
flatmax@592 243 <div class="memdoc">
flatmax@592 244
flatmax@592 245 <p>in units of channels </p>
flatmax@592 246
flatmax@592 247 </div>
flatmax@592 248 </div>
flatmax@592 249 <a class="anchor" id="aca67e2871ee79cc96807d347acd55fe4"></a><!-- doxytag: member="AGCParam::AGC2_scales" ref="aca67e2871ee79cc96807d347acd55fe4" args="" -->
flatmax@592 250 <div class="memitem">
flatmax@592 251 <div class="memproto">
flatmax@592 252 <table class="memname">
flatmax@592 253 <tr>
flatmax@592 254 <td class="memname">Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt; <a class="el" href="classAGCParam.html#aca67e2871ee79cc96807d347acd55fe4">AGCParam::AGC2_scales</a><code> [private]</code></td>
flatmax@592 255 </tr>
flatmax@592 256 </table>
flatmax@592 257 </div>
flatmax@592 258 <div class="memdoc">
flatmax@592 259
flatmax@592 260 <p>spread more toward base </p>
flatmax@592 261
flatmax@592 262 </div>
flatmax@592 263 </div>
flatmax@592 264 <a class="anchor" id="a968c25ad0327d2db3ebd287d661001b4"></a><!-- doxytag: member="AGCParam::AGC_mix_coeff" ref="a968c25ad0327d2db3ebd287d661001b4" args="" -->
flatmax@592 265 <div class="memitem">
flatmax@592 266 <div class="memproto">
flatmax@592 267 <table class="memname">
flatmax@592 268 <tr>
flatmax@592 269 <td class="memname"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a> <a class="el" href="classAGCParam.html#a968c25ad0327d2db3ebd287d661001b4">AGCParam::AGC_mix_coeff</a><code> [private]</code></td>
flatmax@592 270 </tr>
flatmax@592 271 </table>
flatmax@592 272 </div>
flatmax@592 273 <div class="memdoc">
flatmax@592 274
flatmax@592 275 <p>Dick, whats this ? </p>
flatmax@592 276
flatmax@592 277 </div>
flatmax@592 278 </div>
flatmax@592 279 <a class="anchor" id="a6a436005102557783fe4a0d30d3dcc51"></a><!-- doxytag: member="AGCParam::AGC_stage_gain" ref="a6a436005102557783fe4a0d30d3dcc51" args="" -->
flatmax@592 280 <div class="memitem">
flatmax@592 281 <div class="memproto">
flatmax@592 282 <table class="memname">
flatmax@592 283 <tr>
flatmax@592 284 <td class="memname"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a> <a class="el" href="classAGCParam.html#a6a436005102557783fe4a0d30d3dcc51">AGCParam::AGC_stage_gain</a><code> [private]</code></td>
flatmax@592 285 </tr>
flatmax@592 286 </table>
flatmax@592 287 </div>
flatmax@592 288 <div class="memdoc">
flatmax@592 289
flatmax@592 290 <p>gain from each stage to next slower stage </p>
flatmax@592 291
flatmax@592 292 </div>
flatmax@592 293 </div>
flatmax@592 294 <a class="anchor" id="ac7fc293748c6e7d59b91998253a68657"></a><!-- doxytag: member="AGCParam::decimation" ref="ac7fc293748c6e7d59b91998253a68657" args="" -->
flatmax@592 295 <div class="memitem">
flatmax@592 296 <div class="memproto">
flatmax@592 297 <table class="memname">
flatmax@592 298 <tr>
flatmax@592 299 <td class="memname">Array&lt;int,<a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>, 1&gt; <a class="el" href="classAGCParam.html#ac7fc293748c6e7d59b91998253a68657">AGCParam::decimation</a><code> [private]</code></td>
flatmax@592 300 </tr>
flatmax@592 301 </table>
flatmax@592 302 </div>
flatmax@592 303 <div class="memdoc">
flatmax@592 304
flatmax@592 305 <p>how often to update the <a class="el" href="classAGC.html">AGC</a> states </p>
flatmax@592 306
flatmax@592 307 </div>
flatmax@592 308 </div>
flatmax@592 309 <a class="anchor" id="a6cb476c916e99e227ddcfec68be66b3a"></a><!-- doxytag: member="AGCParam::n_stages" ref="a6cb476c916e99e227ddcfec68be66b3a" args="" -->
flatmax@592 310 <div class="memitem">
flatmax@592 311 <div class="memproto">
flatmax@592 312 <table class="memname">
flatmax@592 313 <tr>
flatmax@592 314 <td class="memname">int <a class="el" href="classAGCParam.html#a6cb476c916e99e227ddcfec68be66b3a">AGCParam::n_stages</a><code> [private]</code></td>
flatmax@592 315 </tr>
flatmax@592 316 </table>
flatmax@592 317 </div>
flatmax@592 318 <div class="memdoc">
flatmax@592 319
flatmax@592 320 <p>Stage count. </p>
flatmax@592 321
flatmax@592 322 </div>
flatmax@592 323 </div>
flatmax@592 324 <a class="anchor" id="ae8073d3c194a9134cf736a564d4774fa"></a><!-- doxytag: member="AGCParam::time_constants" ref="ae8073d3c194a9134cf736a564d4774fa" args="" -->
flatmax@592 325 <div class="memitem">
flatmax@592 326 <div class="memproto">
flatmax@592 327 <table class="memname">
flatmax@592 328 <tr>
flatmax@592 329 <td class="memname">Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, <a class="el" href="CARFACCommon_8H.html#a62f6419e5a391863eb7d30a90462c239">AGC_STAGE_COUNT</a>,1&gt; <a class="el" href="classAGCParam.html#ae8073d3c194a9134cf736a564d4774fa">AGCParam::time_constants</a><code> [private]</code></td>
flatmax@592 330 </tr>
flatmax@592 331 </table>
flatmax@592 332 </div>
flatmax@592 333 <div class="memdoc">
flatmax@592 334
flatmax@592 335 <p>seconds </p>
flatmax@592 336
flatmax@592 337 </div>
flatmax@592 338 </div>
flatmax@592 339 <hr/>The documentation for this class was generated from the following files:<ul>
flatmax@592 340 <li><a class="el" href="AGCParam_8H_source.html">AGCParam.H</a></li>
flatmax@592 341 <li><a class="el" href="AGCParam_8C.html">AGCParam.C</a></li>
flatmax@592 342 </ul>
flatmax@592 343 </div><!-- contents -->
flatmax@592 344 </div>
flatmax@592 345 <!-- window showing the filter options -->
flatmax@592 346 <div id="MSearchSelectWindow"
flatmax@592 347 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 348 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 349 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@594 350 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>
flatmax@592 351
flatmax@592 352 <!-- iframe showing the search results (closed by default) -->
flatmax@592 353 <div id="MSearchResultsWindow">
flatmax@592 354 <iframe src="javascript:void(0)" frameborder="0"
flatmax@592 355 name="MSearchResults" id="MSearchResults">
flatmax@592 356 </iframe>
flatmax@592 357 </div>
flatmax@592 358
flatmax@592 359 <div id="nav-path" class="navpath">
flatmax@592 360 <ul>
flatmax@592 361 <li class="navelem"><a class="el" href="classAGCParam.html">AGCParam</a> </li>
flatmax@592 362
flatmax@594 363 <li class="footer">Generated on Thu Feb 21 2013 09:31:11 for CARFAC C++ by
flatmax@592 364 <a href="http://www.doxygen.org/index.html">
flatmax@592 365 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@592 366 </ul>
flatmax@592 367 </div>
flatmax@592 368
flatmax@592 369
flatmax@592 370 </body>
flatmax@592 371 </html>