Mercurial > hg > aimc

annotate trunk/C++/api/html/classEar.html @ 597:359bcd461dd1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
First commit. Refer to the api [1] 'Philosophy of the implementation' for information on the approach used to implement CARFAC in C++. [1] aimc/C++/api/html/index.html
author flatmax
date Sat, 09 Feb 2013 23:53:48 +0000
parents
children b4323584c9fa
rev   line source
flatmax@597 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@597 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@597 3 <head>
flatmax@597 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@597 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@597 6 <title>CARFAC C++: Ear Class Reference</title>
flatmax@597 7
flatmax@597 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@597 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@597 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@597 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@597 12 <script type="text/javascript" src="resize.js"></script>
flatmax@597 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@597 14 <script type="text/javascript">
flatmax@597 15 $(document).ready(initResizable);
flatmax@597 16 </script>
flatmax@597 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@597 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@597 19 <script type="text/javascript">
flatmax@597 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@597 21 </script>
flatmax@597 22
flatmax@597 23 </head>
flatmax@597 24 <body>
flatmax@597 25 <div id="top"><!-- do not remove this div! -->
flatmax@597 26
flatmax@597 27
flatmax@597 28 <div id="titlearea">
flatmax@597 29 <table cellspacing="0" cellpadding="0">
flatmax@597 30 <tbody>
flatmax@597 31 <tr style="height: 56px;">
flatmax@597 32
flatmax@597 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@597 34
flatmax@597 35
flatmax@597 36 <td style="padding-left: 0.5em;">
flatmax@597 37 <div id="projectname">CARFAC C++
flatmax@597 38
flatmax@597 39 </div>
flatmax@597 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@597 41 </td>
flatmax@597 42
flatmax@597 43
flatmax@597 44
flatmax@597 45 </tr>
flatmax@597 46 </tbody>
flatmax@597 47 </table>
flatmax@597 48 </div>
flatmax@597 49
flatmax@597 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@597 51 <script type="text/javascript">
flatmax@597 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@597 53 </script>
flatmax@597 54 <div id="navrow1" class="tabs">
flatmax@597 55 <ul class="tablist">
flatmax@597 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@597 57 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
flatmax@597 58 <li><a href="files.html"><span>Files</span></a></li>
flatmax@597 59 <li>
flatmax@597 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@597 61 <span class="left">
flatmax@597 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@597 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 65 alt=""/>
flatmax@597 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@597 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@597 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@597 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@597 70 </span><span class="right">
flatmax@597 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@597 72 </span>
flatmax@597 73 </div>
flatmax@597 74 </li>
flatmax@597 75 </ul>
flatmax@597 76 </div>
flatmax@597 77 <div id="navrow2" class="tabs2">
flatmax@597 78 <ul class="tablist">
flatmax@597 79 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
flatmax@597 80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
flatmax@597 81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
flatmax@597 82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
flatmax@597 83 </ul>
flatmax@597 84 </div>
flatmax@597 85 </div>
flatmax@597 86 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@597 87 <div id="nav-tree">
flatmax@597 88 <div id="nav-tree-contents">
flatmax@597 89 </div>
flatmax@597 90 </div>
flatmax@597 91 <div id="splitbar" style="-moz-user-select:none;"
flatmax@597 92 class="ui-resizable-handle">
flatmax@597 93 </div>
flatmax@597 94 </div>
flatmax@597 95 <script type="text/javascript">
flatmax@597 96 initNavTree('classEar.html','');
flatmax@597 97 </script>
flatmax@597 98 <div id="doc-content">
flatmax@597 99 <div class="header">
flatmax@597 100 <div class="summary">
flatmax@597 101 <a href="#pub-methods">Public Member Functions</a> &#124;
flatmax@597 102 <a href="#pri-attribs">Private Attributes</a> </div>
flatmax@597 103 <div class="headertitle">
flatmax@597 104 <div class="title">Ear Class Reference</div> </div>
flatmax@597 105 </div><!--header-->
flatmax@597 106 <div class="contents">
flatmax@597 107 <!-- doxytag: class="Ear" -->
flatmax@597 108 <p><code>#include &lt;<a class="el" href="Ear_8H_source.html">Ear.H</a>&gt;</code></p>
flatmax@597 109 <div class="dynheader">
flatmax@597 110 Collaboration diagram for Ear:</div>
flatmax@597 111 <div class="dyncontent">
flatmax@597 112 <div class="center"><img src="classEar__coll__graph.png" border="0" usemap="#Ear_coll__map" alt="Collaboration graph"/></div>
flatmax@597 113 <map name="Ear_coll__map" id="Ear_coll__map">
flatmax@597 114 <area shape="rect" id="node2" href="classIHC.html" title="IHC" alt="" coords="723,272,768,301"/><area shape="rect" id="node4" href="classEarComponent.html" title="EarComponent\&lt; IHCCoeff, IHCParam, IHCState \&gt;" alt="" coords="339,272,661,301"/><area shape="rect" id="node6" href="classIHCParam.html" title="IHCParam" alt="" coords="153,59,236,88"/><area shape="rect" id="node8" href="classParameters.html" title="Parameters" alt="" coords="8,59,96,88"/><area shape="rect" id="node28" href="classAGCParam.html" title="AGCParam" alt="" coords="151,219,239,248"/><area shape="rect" id="node38" href="classCARParam.html" title="CARParam" alt="" coords="151,5,239,35"/><area shape="rect" id="node10" href="classIHCCoeff.html" title="IHCCoeff" alt="" coords="156,272,233,301"/><area shape="rect" id="node12" href="classCoefficients.html" title="Coefficients" alt="" coords="7,272,97,301"/><area shape="rect" id="node22" href="classAGCCoeff.html" title="AGCCoeff" alt="" coords="153,379,236,408"/><area shape="rect" id="node41" href="classCARCoeff.html" title="CARCoeff" alt="" coords="153,112,236,141"/><area shape="rect" id="node14" href="classIHCState.html" title="IHCState" alt="" coords="156,325,233,355"/><area shape="rect" id="node16" href="classState.html" title="State" alt="" coords="25,325,79,355"/><area shape="rect" id="node25" href="classAGCState.html" title="AGCState" alt="" coords="153,432,236,461"/><area shape="rect" id="node35" href="classCARState.html" title="CARState" alt="" coords="153,165,236,195"/><area shape="rect" id="node18" href="classAGC.html" title="AGC" alt="" coords="720,331,771,360"/><area shape="rect" id="node20" href="classEarComponent.html" title="EarComponent\&lt; AGCCoeff, AGCParam, AGCState \&gt;" alt="" coords="332,348,668,377"/><area shape="rect" id="node31" href="classCAR.html" title="CAR" alt="" coords="720,199,771,228"/><area shape="rect" id="node33" href="classEarComponent.html" title="EarComponent\&lt; CARCoeff, CARParam, CARState \&gt;" alt="" coords="332,139,668,168"/></map>
flatmax@597 115 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@597 116
flatmax@597 117 <p><a href="classEar-members.html">List of all members.</a></p>
flatmax@597 118 <table class="memberdecls">
flatmax@597 119 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@597 120 Public Member Functions</h2></td></tr>
flatmax@597 121 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a58d5147ee3eb694d0b2e94897dd7bf57">Ear</a> ()</td></tr>
flatmax@597 122 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#aadc3da8092733631bcdde1bfa3f3734a">~Ear</a> ()</td></tr>
flatmax@597 123 <tr><td colspan="2"><h2><a name="pri-attribs"></a>
flatmax@597 124 Private Attributes</h2></td></tr>
flatmax@597 125 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAR.html">CAR</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a59243a8664d2c7d8bd3e5153e7f55e78">car</a></td></tr>
flatmax@597 126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The cascade of asymmetric resontaors for this ear. <a href="#a59243a8664d2c7d8bd3e5153e7f55e78"></a><br/></td></tr>
flatmax@597 127 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIHC.html">IHC</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#ac11c4afecd6ca8353fa7d2ed4689bbf6">ihc</a></td></tr>
flatmax@597 128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The inner hair cell for this ear. <a href="#ac11c4afecd6ca8353fa7d2ed4689bbf6"></a><br/></td></tr>
flatmax@597 129 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAGC.html">AGC</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a464fb557a2852865fc29242900ee1306">agc</a></td></tr>
flatmax@597 130 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The automatic gain control for this ear. <a href="#a464fb557a2852865fc29242900ee1306"></a><br/></td></tr>
flatmax@597 131 </table>
flatmax@597 132 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@597 133 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 134 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@597 135 <p>Class which encapsulates an ear, using the <a class="el" href="classCAR.html">CAR</a>, <a class="el" href="classIHC.html">IHC</a> and <a class="el" href="classAGC.html">AGC</a> classes </p>
flatmax@597 136 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@597 137 <a class="anchor" id="a58d5147ee3eb694d0b2e94897dd7bf57"></a><!-- doxytag: member="Ear::Ear" ref="a58d5147ee3eb694d0b2e94897dd7bf57" args="()" -->
flatmax@597 138 <div class="memitem">
flatmax@597 139 <div class="memproto">
flatmax@597 140 <table class="memname">
flatmax@597 141 <tr>
flatmax@597 142 <td class="memname"><a class="el" href="classEar.html#a58d5147ee3eb694d0b2e94897dd7bf57">Ear::Ear</a> </td>
flatmax@597 143 <td>(</td>
flatmax@597 144 <td class="paramname"></td><td>)</td>
flatmax@597 145 <td></td>
flatmax@597 146 </tr>
flatmax@597 147 </table>
flatmax@597 148 </div>
flatmax@597 149 <div class="memdoc">
flatmax@597 150 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 151 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
flatmax@597 152
flatmax@597 153 </div>
flatmax@597 154 </div>
flatmax@597 155 <a class="anchor" id="aadc3da8092733631bcdde1bfa3f3734a"></a><!-- doxytag: member="Ear::~Ear" ref="aadc3da8092733631bcdde1bfa3f3734a" args="()" -->
flatmax@597 156 <div class="memitem">
flatmax@597 157 <div class="memproto">
flatmax@597 158 <table class="memname">
flatmax@597 159 <tr>
flatmax@597 160 <td class="memname"><a class="el" href="classEar.html#aadc3da8092733631bcdde1bfa3f3734a">Ear::~Ear</a> </td>
flatmax@597 161 <td>(</td>
flatmax@597 162 <td class="paramname"></td><td>)</td>
flatmax@597 163 <td><code> [virtual]</code></td>
flatmax@597 164 </tr>
flatmax@597 165 </table>
flatmax@597 166 </div>
flatmax@597 167 <div class="memdoc">
flatmax@597 168
flatmax@597 169 </div>
flatmax@597 170 </div>
flatmax@597 171 <hr/><h2>Member Data Documentation</h2>
flatmax@597 172 <a class="anchor" id="a464fb557a2852865fc29242900ee1306"></a><!-- doxytag: member="Ear::agc" ref="a464fb557a2852865fc29242900ee1306" args="" -->
flatmax@597 173 <div class="memitem">
flatmax@597 174 <div class="memproto">
flatmax@597 175 <table class="memname">
flatmax@597 176 <tr>
flatmax@597 177 <td class="memname"><a class="el" href="classAGC.html">AGC</a> <a class="el" href="classEar.html#a464fb557a2852865fc29242900ee1306">Ear::agc</a><code> [private]</code></td>
flatmax@597 178 </tr>
flatmax@597 179 </table>
flatmax@597 180 </div>
flatmax@597 181 <div class="memdoc">
flatmax@597 182
flatmax@597 183 <p>The automatic gain control for this ear. </p>
flatmax@597 184
flatmax@597 185 </div>
flatmax@597 186 </div>
flatmax@597 187 <a class="anchor" id="a59243a8664d2c7d8bd3e5153e7f55e78"></a><!-- doxytag: member="Ear::car" ref="a59243a8664d2c7d8bd3e5153e7f55e78" args="" -->
flatmax@597 188 <div class="memitem">
flatmax@597 189 <div class="memproto">
flatmax@597 190 <table class="memname">
flatmax@597 191 <tr>
flatmax@597 192 <td class="memname"><a class="el" href="classCAR.html">CAR</a> <a class="el" href="classEar.html#a59243a8664d2c7d8bd3e5153e7f55e78">Ear::car</a><code> [private]</code></td>
flatmax@597 193 </tr>
flatmax@597 194 </table>
flatmax@597 195 </div>
flatmax@597 196 <div class="memdoc">
flatmax@597 197
flatmax@597 198 <p>The cascade of asymmetric resontaors for this ear. </p>
flatmax@597 199
flatmax@597 200 </div>
flatmax@597 201 </div>
flatmax@597 202 <a class="anchor" id="ac11c4afecd6ca8353fa7d2ed4689bbf6"></a><!-- doxytag: member="Ear::ihc" ref="ac11c4afecd6ca8353fa7d2ed4689bbf6" args="" -->
flatmax@597 203 <div class="memitem">
flatmax@597 204 <div class="memproto">
flatmax@597 205 <table class="memname">
flatmax@597 206 <tr>
flatmax@597 207 <td class="memname"><a class="el" href="classIHC.html">IHC</a> <a class="el" href="classEar.html#ac11c4afecd6ca8353fa7d2ed4689bbf6">Ear::ihc</a><code> [private]</code></td>
flatmax@597 208 </tr>
flatmax@597 209 </table>
flatmax@597 210 </div>
flatmax@597 211 <div class="memdoc">
flatmax@597 212
flatmax@597 213 <p>The inner hair cell for this ear. </p>
flatmax@597 214
flatmax@597 215 </div>
flatmax@597 216 </div>
flatmax@597 217 <hr/>The documentation for this class was generated from the following files:<ul>
flatmax@597 218 <li><a class="el" href="Ear_8H_source.html">Ear.H</a></li>
flatmax@597 219 <li><a class="el" href="Ear_8C.html">Ear.C</a></li>
flatmax@597 220 </ul>
flatmax@597 221 </div><!-- contents -->
flatmax@597 222 </div>
flatmax@597 223 <!-- window showing the filter options -->
flatmax@597 224 <div id="MSearchSelectWindow"
flatmax@597 225 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 226 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 227 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@597 228 <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>Defines</a></div>
flatmax@597 229
flatmax@597 230 <!-- iframe showing the search results (closed by default) -->
flatmax@597 231 <div id="MSearchResultsWindow">
flatmax@597 232 <iframe src="javascript:void(0)" frameborder="0"
flatmax@597 233 name="MSearchResults" id="MSearchResults">
flatmax@597 234 </iframe>
flatmax@597 235 </div>
flatmax@597 236
flatmax@597 237 <div id="nav-path" class="navpath">
flatmax@597 238 <ul>
flatmax@597 239 <li class="navelem"><a class="el" href="classEar.html">Ear</a> </li>
flatmax@597 240
flatmax@597 241 <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by
flatmax@597 242 <a href="http://www.doxygen.org/index.html">
flatmax@597 243 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@597 244 </ul>
flatmax@597 245 </div>
flatmax@597 246
flatmax@597 247
flatmax@597 248 </body>
flatmax@597 249 </html>