Mercurial > hg > aimc
view trunk/C++/api/html/IHCParam_8H_source.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 source
<!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++: IHCParam.H Source File</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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File 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('IHCParam_8H.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">IHCParam.H</div> </div> </div><!--header--> <div class="contents"> <a href="IHCParam_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 <flatmax\@> All Rights Reserved.</span> <a name="l00002"></a>00002 <span class="comment">// Author Matt Flax <flatmax\@></span> <a name="l00003"></a>00003 <span class="comment">//</span> <a name="l00004"></a>00004 <span class="comment">// This C++ file is part of an implementation of Lyon's cochlear model:</span> <a name="l00005"></a>00005 <span class="comment">// "Cascade of Asymmetric Resonators with Fast-Acting Compression"</span> <a name="l00006"></a>00006 <span class="comment">// to supplement Lyon's upcoming book "Human and Machine Hearing"</span> <a name="l00007"></a>00007 <span class="comment">//</span> <a name="l00008"></a>00008 <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span> <a name="l00009"></a>00009 <span class="comment">// you may not use this file except in compliance with the License.</span> <a name="l00010"></a>00010 <span class="comment">// You may obtain a copy of the License at</span> <a name="l00011"></a>00011 <span class="comment">//</span> <a name="l00012"></a>00012 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00013"></a>00013 <span class="comment">//</span> <a name="l00014"></a>00014 <span class="comment">// Unless required by applicable law or agreed to in writing, software</span> <a name="l00015"></a>00015 <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00016"></a>00016 <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00017"></a>00017 <span class="comment">// See the License for the specific language governing permissions and</span> <a name="l00018"></a>00018 <span class="comment">// limitations under the License.</span> <a name="l00019"></a>00019 <span class="preprocessor">#ifndef IHCPARAMS_H_</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define IHCPARAMS_H_</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="Parameters_8H.html">Parameters.H</a>"</span> <a name="l00023"></a>00023 <a name="l00030"></a><a class="code" href="classIHCParam.html">00030</a> <span class="keyword">class </span><a class="code" href="classIHCParam.html">IHCParam</a> : <span class="keyword">public</span> <a class="code" href="classParameters.html">Parameters</a> { <a name="l00031"></a><a class="code" href="classIHCParam.html#a91ccfc182580c7af8035eee45e8f2639">00031</a> <span class="keywordtype">bool</span> <a class="code" href="classIHCParam.html#a91ccfc182580c7af8035eee45e8f2639" title="not just a simple HWR">just_hwr</a>; <a name="l00032"></a><a class="code" href="classIHCParam.html#af2edbea861df9e71c3ab097a1ea20be7">00032</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#af2edbea861df9e71c3ab097a1ea20be7" title="Hz (the only param. used if just_hwr=true)">ac_corner_Hz</a>; <a name="l00033"></a><a class="code" href="classIHCParam.html#ac174f6cffad7fc45502c12a931f09cb6">00033</a> <span class="keywordtype">bool</span> <a class="code" href="classIHCParam.html#ac174f6cffad7fc45502c12a931f09cb6" title="0 for new two-cap hack">one_cap</a>; <a name="l00034"></a><a class="code" href="classIHCParam.html#a078a427d06ecaa2b16113b6150780408">00034</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#a078a427d06ecaa2b16113b6150780408" title="80 microseconds smoothing twice">tau_lpf</a>; <a name="l00035"></a><a class="code" href="classIHCParam.html#ab7e995ed4516c93d5a763b051d92ceec">00035</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#ab7e995ed4516c93d5a763b051d92ceec" title="depletion tau is pretty fast (used when one_cap=1)">tau_out</a>; <a name="l00036"></a><a class="code" href="classIHCParam.html#a45bfc257c1d54e481c9e9da5f7d6cb5c">00036</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#a45bfc257c1d54e481c9e9da5f7d6cb5c" title="recovery tau is slower (used when one_cap=1)">tau_in</a>; <a name="l00037"></a><a class="code" href="classIHCParam.html#a375cbe06ed95b05b423aaa85fab0137d">00037</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#a375cbe06ed95b05b423aaa85fab0137d" title="depletion tau is pretty fast (used when one_cap=0)">tau1_out</a>; <a name="l00038"></a><a class="code" href="classIHCParam.html#a694a674b8b53bd18a8c626b4f0882a57">00038</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#a694a674b8b53bd18a8c626b4f0882a57" title="recovery tau is slower (used when one_cap=0)">tau1_in</a>; <a name="l00039"></a><a class="code" href="classIHCParam.html#af0b0d82a843dd34eb8599da44e2457d8">00039</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#af0b0d82a843dd34eb8599da44e2457d8" title="depletion tau is pretty fast (used when one_cap=0)">tau2_out</a>; <a name="l00040"></a><a class="code" href="classIHCParam.html#ac03d3313623218fe2e996277e1813f00">00040</a> <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> <a class="code" href="classIHCParam.html#ac03d3313623218fe2e996277e1813f00" title="recovery tau is slower (used when one_cap=0)">tau2_in</a>; <a name="l00041"></a>00041 <span class="keyword">public</span>: <a name="l00042"></a>00042 <a class="code" href="classIHCParam.html#aaa6f7e7799eccad40739b963a114ef02">IHCParam</a>(<span class="keywordtype">bool</span> just_hwr_=0, <span class="keywordtype">bool</span> one_cap_=0, <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau_lpf_=0.000080, <a name="l00043"></a>00043 <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau_out_=0.0005, <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau_in_=0.010, <a name="l00044"></a>00044 <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau1_out_=0.010, <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau1_in_=0.020, <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau2_out_=0.0025, <a name="l00045"></a>00045 <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> tau2_in_=0.005, <a class="code" href="CARFACCommon_8H.html#af081989b61cc5b60e85ad3d01e4af4f0" title="The floating point type.">FP_TYPE</a> ac_corner_Hz_=20.); <a name="l00046"></a>00046 <a name="l00047"></a>00047 <span class="keyword">virtual</span> <a class="code" href="classIHCParam.html#a9b7674dd50b124f4e0af34c86413c1d0">~IHCParam</a>(); <a name="l00048"></a>00048 }; <a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="preprocessor">#endif // IHCPARAMS_H_</span> </pre></div></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="IHCParam_8H.html">IHCParam.H</a> </li> <li class="footer">Generated on Sun Feb 10 2013 10:47:45 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>