Mercurial > hg > aimc
diff trunk/C++/api/html/classEar.html @ 597:359bcd461dd1
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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/trunk/C++/api/html/classEar.html Sat Feb 09 23:53:48 2013 +0000 @@ -0,0 +1,249 @@ +<!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"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>CARFAC C++: Ear Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.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="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="icon.png"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">CARFAC C++ + + </div> + <div id="projectbrief">C++ implementation of CARFAC</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.6.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </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('classEar.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">Ear Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<!-- doxytag: class="Ear" --> +<p><code>#include <<a class="el" href="Ear_8H_source.html">Ear.H</a>></code></p> +<div class="dynheader"> +Collaboration diagram for Ear:</div> +<div class="dyncontent"> +<div class="center"><img src="classEar__coll__graph.png" border="0" usemap="#Ear_coll__map" alt="Collaboration graph"/></div> +<map name="Ear_coll__map" id="Ear_coll__map"> +<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\< IHCCoeff, IHCParam, IHCState \>" 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\< AGCCoeff, AGCParam, AGCState \>" 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\< CARCoeff, CARParam, CARState \>" alt="" coords="332,139,668,168"/></map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> + +<p><a href="classEar-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a58d5147ee3eb694d0b2e94897dd7bf57">Ear</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#aadc3da8092733631bcdde1bfa3f3734a">~Ear</a> ()</td></tr> +<tr><td colspan="2"><h2><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCAR.html">CAR</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a59243a8664d2c7d8bd3e5153e7f55e78">car</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The cascade of asymmetric resontaors for this ear. <a href="#a59243a8664d2c7d8bd3e5153e7f55e78"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIHC.html">IHC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#ac11c4afecd6ca8353fa7d2ed4689bbf6">ihc</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The inner hair cell for this ear. <a href="#ac11c4afecd6ca8353fa7d2ed4689bbf6"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAGC.html">AGC</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEar.html#a464fb557a2852865fc29242900ee1306">agc</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The automatic gain control for this ear. <a href="#a464fb557a2852865fc29242900ee1306"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax <flatmax@>} </dd></dl> +<dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl> +<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> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a58d5147ee3eb694d0b2e94897dd7bf57"></a><!-- doxytag: member="Ear::Ear" ref="a58d5147ee3eb694d0b2e94897dd7bf57" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classEar.html#a58d5147ee3eb694d0b2e94897dd7bf57">Ear::Ear</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax <flatmax@>} </dd></dl> +<dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl> + +</div> +</div> +<a class="anchor" id="aadc3da8092733631bcdde1bfa3f3734a"></a><!-- doxytag: member="Ear::~Ear" ref="aadc3da8092733631bcdde1bfa3f3734a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classEar.html#aadc3da8092733631bcdde1bfa3f3734a">Ear::~Ear</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a464fb557a2852865fc29242900ee1306"></a><!-- doxytag: member="Ear::agc" ref="a464fb557a2852865fc29242900ee1306" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The automatic gain control for this ear. </p> + +</div> +</div> +<a class="anchor" id="a59243a8664d2c7d8bd3e5153e7f55e78"></a><!-- doxytag: member="Ear::car" ref="a59243a8664d2c7d8bd3e5153e7f55e78" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The cascade of asymmetric resontaors for this ear. </p> + +</div> +</div> +<a class="anchor" id="ac11c4afecd6ca8353fa7d2ed4689bbf6"></a><!-- doxytag: member="Ear::ihc" ref="ac11c4afecd6ca8353fa7d2ed4689bbf6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <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> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The inner hair cell for this ear. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="Ear_8H_source.html">Ear.H</a></li> +<li><a class="el" href="Ear_8C.html">Ear.C</a></li> +</ul> +</div><!-- contents --> +</div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Defines</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="classEar.html">Ear</a> </li> + + <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li> + </ul> + </div> + + +</body> +</html>