comparison trunk/C++/api/html/CAR_8H_source.html @ 599:b4323584c9fa

updated the documentation
author flatmax
date Wed, 20 Feb 2013 22:34:13 +0000
parents 359bcd461dd1
children
comparison
equal deleted inserted replaced
598:34dccba19c54 599:b4323584c9fa
98 <div class="headertitle"> 98 <div class="headertitle">
99 <div class="title">CAR.H</div> </div> 99 <div class="title">CAR.H</div> </div>
100 </div><!--header--> 100 </div><!--header-->
101 <div class="contents"> 101 <div class="contents">
102 <a href="CAR_8H.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright 2013 Matt R. Flax &lt;flatmax\@&gt; All Rights Reserved.</span> 102 <a href="CAR_8H.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright 2013 Matt R. Flax &lt;flatmax\@&gt; All Rights Reserved.</span>
103 <a name="l00002"></a>00002 <span class="comment">// Author Matt Flax &lt;flatmax\@&gt;</span> 103 <a name="l00002"></a>00002 <span class="comment">// Author Matt Flax &lt;flatmax@&gt;</span>
104 <a name="l00003"></a>00003 <span class="comment">//</span> 104 <a name="l00003"></a>00003 <span class="comment">//</span>
105 <a name="l00004"></a>00004 <span class="comment">// This C++ file is part of an implementation of Lyon&#39;s cochlear model:</span> 105 <a name="l00004"></a>00004 <span class="comment">// This C++ file is part of an implementation of Lyon&#39;s cochlear model:</span>
106 <a name="l00005"></a>00005 <span class="comment">// &quot;Cascade of Asymmetric Resonators with Fast-Acting Compression&quot;</span> 106 <a name="l00005"></a>00005 <span class="comment">// &quot;Cascade of Asymmetric Resonators with Fast-Acting Compression&quot;</span>
107 <a name="l00006"></a>00006 <span class="comment">// to supplement Lyon&#39;s upcoming book &quot;Human and Machine Hearing&quot;</span> 107 <a name="l00006"></a>00006 <span class="comment">// to supplement Lyon&#39;s upcoming book &quot;Human and Machine Hearing&quot;</span>
108 <a name="l00007"></a>00007 <span class="comment">//</span> 108 <a name="l00007"></a>00007 <span class="comment">//</span>
120 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef CAR_H_</span> 120 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef CAR_H_</span>
121 <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define CAR_H_</span> 121 <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define CAR_H_</span>
122 <a name="l00021"></a>00021 <span class="preprocessor"></span> 122 <a name="l00021"></a>00021 <span class="preprocessor"></span>
123 <a name="l00022"></a>00022 <span class="preprocessor">#include &quot;<a class="code" href="EarComponent_8H.html">EarComponent.H</a>&quot;</span> <span class="comment">// includes the various {CAR, IHC, AGC} {Coeff, Param, State} .H files</span> 123 <a name="l00022"></a>00022 <span class="preprocessor">#include &quot;<a class="code" href="EarComponent_8H.html">EarComponent.H</a>&quot;</span> <span class="comment">// includes the various {CAR, IHC, AGC} {Coeff, Param, State} .H files</span>
124 <a name="l00023"></a>00023 124 <a name="l00023"></a>00023
125 <a name="l00030"></a><a class="code" href="classCAR.html">00030</a> <span class="keyword">class </span><a class="code" href="classCAR.html">CAR</a> : <span class="keyword">public</span> <a class="code" href="classEarComponent.html">EarComponent</a>&lt;CARCoeff, CARParam, CARState&gt; { 125 <a name="l00024"></a>00024 <span class="keyword">class </span><a class="code" href="classEar.html">Ear</a>;
126 <a name="l00031"></a>00031 <span class="keyword">public</span>: 126 <a name="l00025"></a>00025
127 <a name="l00032"></a>00032 <a class="code" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR</a>(); 127 <a name="l00032"></a><a class="code" href="classCAR.html">00032</a> <span class="keyword">class </span><a class="code" href="classCAR.html">CAR</a> : <span class="keyword">public</span> <a class="code" href="classEarComponent.html">EarComponent</a>&lt;CARCoeff, CARParam, CARState&gt; {
128 <a name="l00033"></a>00033 <span class="keyword">virtual</span> <a class="code" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">~CAR</a>(); 128 <a name="l00033"></a><a class="code" href="classCAR.html#a27d57f14a604e7a444d12a5818f48994">00033</a> Array&lt;FP_TYPE, Dynamic,1&gt; <a class="code" href="classCAR.html#a27d57f14a604e7a444d12a5818f48994" title="The vector of pole frequencies used in filter design and variable estimation.">pole_freqs</a>;
129 <a name="l00034"></a>00034 }; 129 <a name="l00034"></a>00034
130 <a name="l00035"></a>00035 130 <a name="l00035"></a>00035 <span class="keyword">protected</span>:
131 <a name="l00036"></a>00036 <span class="preprocessor">#endif // CAR_H_</span> 131 <a name="l00036"></a>00036
132 <a name="l00040"></a>00040 <span class="keywordtype">void</span> <a class="code" href="classCAR.html#a28852384d3c3fca2cd27fae743053eca">designFilters</a>(<a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> fs, <span class="keywordtype">int</span> n_ch);
133 <a name="l00041"></a>00041
134 <a name="l00046"></a>00046 Array&lt;FP_TYPE, Dynamic, 1&gt; <a class="code" href="classCAR.html#a00bed086fc910b91fa8ed1c97af6eca8">stageG</a>(Array&lt;FP_TYPE, Dynamic, 1&gt; &amp;relative_undamping);
135 <a name="l00047"></a>00047
136 <a name="l00048"></a>00048 <span class="keyword">public</span>:
137 <a name="l00049"></a>00049 <a class="code" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR</a>();
138 <a name="l00050"></a>00050 <span class="keyword">virtual</span> <a class="code" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">~CAR</a>();
139 <a name="l00051"></a>00051
140 <a name="l00052"></a><a class="code" href="classCAR.html#a38fd42a55b0aa61f4176bba8ace93988">00052</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classEar.html">Ear</a>;
141 <a name="l00053"></a>00053 };
142 <a name="l00054"></a>00054
143 <a name="l00055"></a>00055 <span class="preprocessor">#endif // CAR_H_</span>
132 </pre></div></div><!-- contents --> 144 </pre></div></div><!-- contents -->
133 </div> 145 </div>
134 <!-- window showing the filter options --> 146 <!-- window showing the filter options -->
135 <div id="MSearchSelectWindow" 147 <div id="MSearchSelectWindow"
136 onmouseover="return searchBox.OnSearchSelectShow()" 148 onmouseover="return searchBox.OnSearchSelectShow()"
137 onmouseout="return searchBox.OnSearchSelectHide()" 149 onmouseout="return searchBox.OnSearchSelectHide()"
138 onkeydown="return searchBox.OnSearchSelectKey(event)"> 150 onkeydown="return searchBox.OnSearchSelectKey(event)">
139 <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> 151 <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>
140 152
141 <!-- iframe showing the search results (closed by default) --> 153 <!-- iframe showing the search results (closed by default) -->
142 <div id="MSearchResultsWindow"> 154 <div id="MSearchResultsWindow">
143 <iframe src="javascript:void(0)" frameborder="0" 155 <iframe src="javascript:void(0)" frameborder="0"
144 name="MSearchResults" id="MSearchResults"> 156 name="MSearchResults" id="MSearchResults">
147 159
148 <div id="nav-path" class="navpath"> 160 <div id="nav-path" class="navpath">
149 <ul> 161 <ul>
150 <li class="navelem"><a class="el" href="CAR_8H.html">CAR.H</a> </li> 162 <li class="navelem"><a class="el" href="CAR_8H.html">CAR.H</a> </li>
151 163
152 <li class="footer">Generated on Sun Feb 10 2013 10:47:45 for CARFAC C++ by 164 <li class="footer">Generated on Thu Feb 21 2013 09:31:11 for CARFAC C++ by
153 <a href="http://www.doxygen.org/index.html"> 165 <a href="http://www.doxygen.org/index.html">
154 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li> 166 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
155 </ul> 167 </ul>
156 </div> 168 </div>
157 169