Mercurial > hg > aimc

annotate trunk/C++/api/html/classCAR.html @ 599:b4323584c9fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated the documentation
author flatmax
date Wed, 20 Feb 2013 22:34:13 +0000
parents 359bcd461dd1
children
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++: CAR 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('classCAR.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@599 101 <a href="#pub-methods">Public Member Functions</a> &#124;
flatmax@599 102 <a href="#pro-methods">Protected Member Functions</a> &#124;
flatmax@599 103 <a href="#pri-attribs">Private Attributes</a> &#124;
flatmax@599 104 <a href="#friends">Friends</a> </div>
flatmax@597 105 <div class="headertitle">
flatmax@597 106 <div class="title">CAR Class Reference</div> </div>
flatmax@597 107 </div><!--header-->
flatmax@597 108 <div class="contents">
flatmax@597 109 <!-- doxytag: class="CAR" --><!-- doxytag: inherits="EarComponent&lt; CARCoeff, CARParam, CARState &gt;" -->
flatmax@597 110 <p><code>#include &lt;<a class="el" href="CAR_8H_source.html">CAR.H</a>&gt;</code></p>
flatmax@597 111 <div class="dynheader">
flatmax@597 112 Inheritance diagram for CAR:</div>
flatmax@597 113 <div class="dyncontent">
flatmax@597 114 <div class="center"><img src="classCAR__inherit__graph.png" border="0" usemap="#CAR_inherit__map" alt="Inheritance graph"/></div>
flatmax@597 115 <map name="CAR_inherit__map" id="CAR_inherit__map">
flatmax@597 116 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; CARCoeff, CARParam, CARState \&gt;" alt="" coords="5,5,341,35"/></map>
flatmax@597 117 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@597 118 <div class="dynheader">
flatmax@597 119 Collaboration diagram for CAR:</div>
flatmax@597 120 <div class="dyncontent">
flatmax@597 121 <div class="center"><img src="classCAR__coll__graph.png" border="0" usemap="#CAR_coll__map" alt="Collaboration graph"/></div>
flatmax@597 122 <map name="CAR_coll__map" id="CAR_coll__map">
flatmax@597 123 <area shape="rect" id="node2" href="classEarComponent.html" title="EarComponent\&lt; CARCoeff, CARParam, CARState \&gt;" alt="" coords="5,181,341,211"/><area shape="rect" id="node4" href="classCARState.html" title="CARState" alt="" coords="23,85,105,115"/><area shape="rect" id="node6" href="classState.html" title="State" alt="" coords="37,5,91,35"/><area shape="rect" id="node8" href="classCARParam.html" title="CARParam" alt="" coords="129,85,217,115"/><area shape="rect" id="node10" href="classParameters.html" title="Parameters" alt="" coords="128,5,216,35"/><area shape="rect" id="node12" href="classCARCoeff.html" title="CARCoeff" alt="" coords="243,85,325,115"/><area shape="rect" id="node14" href="classCoefficients.html" title="Coefficients" alt="" coords="240,5,331,35"/></map>
flatmax@597 124 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@597 125
flatmax@597 126 <p><a href="classCAR-members.html">List of all members.</a></p>
flatmax@597 127 <table class="memberdecls">
flatmax@597 128 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@597 129 Public Member Functions</h2></td></tr>
flatmax@597 130 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR</a> ()</td></tr>
flatmax@597 131 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">~CAR</a> ()</td></tr>
flatmax@599 132 <tr><td colspan="2"><h2><a name="pro-methods"></a>
flatmax@599 133 Protected Member Functions</h2></td></tr>
flatmax@599 134 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a28852384d3c3fca2cd27fae743053eca">designFilters</a> (<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a> fs, int n_ch)</td></tr>
flatmax@599 135 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a00bed086fc910b91fa8ed1c97af6eca8">stageG</a> (Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic, 1 &gt; &amp;relative_undamping)</td></tr>
flatmax@599 136 <tr><td colspan="2"><h2><a name="pri-attribs"></a>
flatmax@599 137 Private Attributes</h2></td></tr>
flatmax@599 138 <tr><td class="memItemLeft" align="right" valign="top">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic, 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a27d57f14a604e7a444d12a5818f48994">pole_freqs</a></td></tr>
flatmax@599 139 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The vector of pole frequencies used in filter design and variable estimation. <a href="#a27d57f14a604e7a444d12a5818f48994"></a><br/></td></tr>
flatmax@599 140 <tr><td colspan="2"><h2><a name="friends"></a>
flatmax@599 141 Friends</h2></td></tr>
flatmax@599 142 <tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCAR.html#a38fd42a55b0aa61f4176bba8ace93988">Ear</a></td></tr>
flatmax@597 143 </table>
flatmax@597 144 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@597 145 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 146 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@597 147 <p>Cascade of asymmetric resonators (<a class="el" href="classCAR.html">CAR</a>). </p>
flatmax@597 148 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@597 149 <a class="anchor" id="a7c80d0ba9d83caf4cf129b251e41e65c"></a><!-- doxytag: member="CAR::CAR" ref="a7c80d0ba9d83caf4cf129b251e41e65c" args="()" -->
flatmax@597 150 <div class="memitem">
flatmax@597 151 <div class="memproto">
flatmax@597 152 <table class="memname">
flatmax@597 153 <tr>
flatmax@597 154 <td class="memname"><a class="el" href="classCAR.html#a7c80d0ba9d83caf4cf129b251e41e65c">CAR::CAR</a> </td>
flatmax@597 155 <td>(</td>
flatmax@597 156 <td class="paramname"></td><td>)</td>
flatmax@597 157 <td></td>
flatmax@597 158 </tr>
flatmax@597 159 </table>
flatmax@597 160 </div>
flatmax@597 161 <div class="memdoc">
flatmax@597 162 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@597 163 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
flatmax@597 164
flatmax@597 165 </div>
flatmax@597 166 </div>
flatmax@597 167 <a class="anchor" id="ac3174919d88d3be0118fcb0fdab84b56"></a><!-- doxytag: member="CAR::~CAR" ref="ac3174919d88d3be0118fcb0fdab84b56" args="()" -->
flatmax@597 168 <div class="memitem">
flatmax@597 169 <div class="memproto">
flatmax@597 170 <table class="memname">
flatmax@597 171 <tr>
flatmax@597 172 <td class="memname"><a class="el" href="classCAR.html#ac3174919d88d3be0118fcb0fdab84b56">CAR::~CAR</a> </td>
flatmax@597 173 <td>(</td>
flatmax@597 174 <td class="paramname"></td><td>)</td>
flatmax@597 175 <td><code> [virtual]</code></td>
flatmax@597 176 </tr>
flatmax@597 177 </table>
flatmax@597 178 </div>
flatmax@597 179 <div class="memdoc">
flatmax@597 180
flatmax@597 181 </div>
flatmax@597 182 </div>
flatmax@599 183 <hr/><h2>Member Function Documentation</h2>
flatmax@599 184 <a class="anchor" id="a28852384d3c3fca2cd27fae743053eca"></a><!-- doxytag: member="CAR::designFilters" ref="a28852384d3c3fca2cd27fae743053eca" args="(FP_TYPE fs, int n_ch)" -->
flatmax@599 185 <div class="memitem">
flatmax@599 186 <div class="memproto">
flatmax@599 187 <table class="memname">
flatmax@599 188 <tr>
flatmax@599 189 <td class="memname">void <a class="el" href="classCAR.html#a28852384d3c3fca2cd27fae743053eca">CAR::designFilters</a> </td>
flatmax@599 190 <td>(</td>
flatmax@599 191 <td class="paramtype"><a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>&#160;</td>
flatmax@599 192 <td class="paramname"><em>fs</em>, </td>
flatmax@599 193 </tr>
flatmax@599 194 <tr>
flatmax@599 195 <td class="paramkey"></td>
flatmax@599 196 <td></td>
flatmax@599 197 <td class="paramtype">int&#160;</td>
flatmax@599 198 <td class="paramname"><em>n_ch</em>&#160;</td>
flatmax@599 199 </tr>
flatmax@599 200 <tr>
flatmax@599 201 <td></td>
flatmax@599 202 <td>)</td>
flatmax@599 203 <td></td><td><code> [protected]</code></td>
flatmax@599 204 </tr>
flatmax@599 205 </table>
flatmax@599 206 </div>
flatmax@599 207 <div class="memdoc">
flatmax@599 208 <p>Method to design the auditory filter coefficients </p>
flatmax@599 209 <dl class="params"><dt><b>Parameters:</b></dt><dd>
flatmax@599 210 <table class="params">
flatmax@599 211 <tr><td class="paramname">fs</td><td>The sample rate in Hz </td></tr>
flatmax@599 212 </table>
flatmax@599 213 </dd>
flatmax@599 214 </dl>
flatmax@599 215
flatmax@599 216 </div>
flatmax@599 217 </div>
flatmax@599 218 <a class="anchor" id="a00bed086fc910b91fa8ed1c97af6eca8"></a><!-- doxytag: member="CAR::stageG" ref="a00bed086fc910b91fa8ed1c97af6eca8" args="(Array&lt; FP_TYPE, Dynamic, 1 &gt; &amp;relative_undamping)" -->
flatmax@599 219 <div class="memitem">
flatmax@599 220 <div class="memproto">
flatmax@599 221 <table class="memname">
flatmax@599 222 <tr>
flatmax@599 223 <td class="memname">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic, 1 &gt; <a class="el" href="classCAR.html#a00bed086fc910b91fa8ed1c97af6eca8">CAR::stageG</a> </td>
flatmax@599 224 <td>(</td>
flatmax@599 225 <td class="paramtype">Array&lt; <a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic, 1 &gt; &amp;&#160;</td>
flatmax@599 226 <td class="paramname"><em>relative_undamping</em></td><td>)</td>
flatmax@599 227 <td><code> [protected]</code></td>
flatmax@599 228 </tr>
flatmax@599 229 </table>
flatmax@599 230 </div>
flatmax@599 231 <div class="memdoc">
flatmax@599 232 <p>Return the stage gain g needed to get unity gain at DC </p>
flatmax@599 233 <dl class="params"><dt><b>Parameters:</b></dt><dd>
flatmax@599 234 <table class="params">
flatmax@599 235 <tr><td class="paramname">relative_undamping</td><td>Dick whats this ? </td></tr>
flatmax@599 236 </table>
flatmax@599 237 </dd>
flatmax@599 238 </dl>
flatmax@599 239 <dl class="return"><dt><b>Returns:</b></dt><dd>The stage gain required to obtain 0 dB at DC. </dd></dl>
flatmax@599 240
flatmax@599 241 </div>
flatmax@599 242 </div>
flatmax@599 243 <hr/><h2>Friends And Related Function Documentation</h2>
flatmax@599 244 <a class="anchor" id="a38fd42a55b0aa61f4176bba8ace93988"></a><!-- doxytag: member="CAR::Ear" ref="a38fd42a55b0aa61f4176bba8ace93988" args="" -->
flatmax@599 245 <div class="memitem">
flatmax@599 246 <div class="memproto">
flatmax@599 247 <table class="memname">
flatmax@599 248 <tr>
flatmax@599 249 <td class="memname">friend class <a class="el" href="classEar.html">Ear</a><code> [friend]</code></td>
flatmax@599 250 </tr>
flatmax@599 251 </table>
flatmax@599 252 </div>
flatmax@599 253 <div class="memdoc">
flatmax@599 254
flatmax@599 255 </div>
flatmax@599 256 </div>
flatmax@599 257 <hr/><h2>Member Data Documentation</h2>
flatmax@599 258 <a class="anchor" id="a27d57f14a604e7a444d12a5818f48994"></a><!-- doxytag: member="CAR::pole_freqs" ref="a27d57f14a604e7a444d12a5818f48994" args="" -->
flatmax@599 259 <div class="memitem">
flatmax@599 260 <div class="memproto">
flatmax@599 261 <table class="memname">
flatmax@599 262 <tr>
flatmax@599 263 <td class="memname">Array&lt;<a class="el" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0">FP_TYPE</a>, Dynamic,1&gt; <a class="el" href="classCAR.html#a27d57f14a604e7a444d12a5818f48994">CAR::pole_freqs</a><code> [private]</code></td>
flatmax@599 264 </tr>
flatmax@599 265 </table>
flatmax@599 266 </div>
flatmax@599 267 <div class="memdoc">
flatmax@599 268
flatmax@599 269 <p>The vector of pole frequencies used in filter design and variable estimation. </p>
flatmax@599 270
flatmax@599 271 </div>
flatmax@599 272 </div>
flatmax@597 273 <hr/>The documentation for this class was generated from the following files:<ul>
flatmax@597 274 <li><a class="el" href="CAR_8H_source.html">CAR.H</a></li>
flatmax@597 275 <li><a class="el" href="CAR_8C.html">CAR.C</a></li>
flatmax@597 276 </ul>
flatmax@597 277 </div><!-- contents -->
flatmax@597 278 </div>
flatmax@597 279 <!-- window showing the filter options -->
flatmax@597 280 <div id="MSearchSelectWindow"
flatmax@597 281 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@597 282 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@597 283 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@599 284 <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@597 285
flatmax@597 286 <!-- iframe showing the search results (closed by default) -->
flatmax@597 287 <div id="MSearchResultsWindow">
flatmax@597 288 <iframe src="javascript:void(0)" frameborder="0"
flatmax@597 289 name="MSearchResults" id="MSearchResults">
flatmax@597 290 </iframe>
flatmax@597 291 </div>
flatmax@597 292
flatmax@597 293 <div id="nav-path" class="navpath">
flatmax@597 294 <ul>
flatmax@597 295 <li class="navelem"><a class="el" href="classCAR.html">CAR</a> </li>
flatmax@597 296
flatmax@599 297 <li class="footer">Generated on Thu Feb 21 2013 09:31:11 for CARFAC C++ by
flatmax@597 298 <a href="http://www.doxygen.org/index.html">
flatmax@597 299 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@597 300 </ul>
flatmax@597 301 </div>
flatmax@597 302
flatmax@597 303
flatmax@597 304 </body>
flatmax@597 305 </html>