File: classMooreSpread.html

package info (click to toggle)
libaudiomask 1.0-3
  • links: PTS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 17,668 kB
  • ctags: 636
  • sloc: cpp: 787; perl: 108; makefile: 67
file content (158 lines) | stat: -rw-r--r-- 10,569 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>libaudiomask: MooreSpread Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;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><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.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)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>MooreSpread Class Reference</h1><!-- doxytag: class="MooreSpread" -->
<p><code>#include &lt;<a class="el" href="MooreSpread_8H_source.html">MooreSpread.H</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for MooreSpread:</div>
<div class="dynsection">
 <div class="center">
  <img src="classMooreSpread.png" usemap="#MooreSpread_map" alt=""/>
  <map id="MooreSpread_map" name="MooreSpread_map">
<area href="classAudioMask.html" alt="AudioMask" shape="rect" coords="0,56,90,80"/>
<area href="classAudioMasker.html" alt="AudioMasker" shape="rect" coords="0,112,90,136"/>
</map>
 </div>
</div>

<p><a href="classMooreSpread-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee80952d98157b7f5459182c7e0eadb6"></a><!-- doxytag: member="MooreSpread::MooreSpread" ref="aee80952d98157b7f5459182c7e0eadb6" args="(int fBankCount)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#aee80952d98157b7f5459182c7e0eadb6">MooreSpread</a> (int fBankCount)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instantiation requiring the number of filter banks. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf8904d9cb996927b0b7b0cd3508a98f"></a><!-- doxytag: member="MooreSpread::~MooreSpread" ref="adf8904d9cb996927b0b7b0cd3508a98f" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#adf8904d9cb996927b0b7b0cd3508a98f">~MooreSpread</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ef2cfe6a5fa5a85fb33ed0bd425d510"></a><!-- doxytag: member="MooreSpread::setCFreq" ref="a4ef2cfe6a5fa5a85fb33ed0bd425d510" args="(int which, double value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#a4ef2cfe6a5fa5a85fb33ed0bd425d510">setCFreq</a> (int which, double value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for setting the centre freqs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#af7afee40cca47459499927e40f505129">excite</a> (double **filterBankOutput, int sampleCount, int sampleFreq)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea7e6dd1e8a6e4b82fa03b864b9aae09"></a><!-- doxytag: member="MooreSpread::centreFreqs" ref="aea7e6dd1e8a6e4b82fa03b864b9aae09" args="" -->
double *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#aea7e6dd1e8a6e4b82fa03b864b9aae09">centreFreqs</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The centreFrequencies of each filter bank. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a379167689352795fd121aa2799ac214f"></a><!-- doxytag: member="MooreSpread::bankCount" ref="a379167689352795fd121aa2799ac214f" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#a379167689352795fd121aa2799ac214f">bankCount</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of sub-bankds in the filter bank. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a8028884ae63c64d298f1fff45dc617"></a><!-- doxytag: member="MooreSpread::memory" ref="a0a8028884ae63c64d298f1fff45dc617" args="" -->
double *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#a0a8028884ae63c64d298f1fff45dc617">memory</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Memory used in the operation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6ad1e88f9c8b89a84b0b9066c74a957"></a><!-- doxytag: member="MooreSpread::spread" ref="ad6ad1e88f9c8b89a84b0b9066c74a957" args="" -->
double **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMooreSpread.html#ad6ad1e88f9c8b89a84b0b9066c74a957">spread</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Moore/Glasberg spreading due to the filters. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Finds the Moore spreading function. First implementation for the Gamma Chirp filter bank, but possible for any perceptual filter bank. References : [1] Moore B.C.J., Glasberg B.R. (1983) ``Suggested formulae for calculating auditory-filter bandwidths and excitation patterns'', J. Acous. Soc. Am., 74, 750-753 </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af7afee40cca47459499927e40f505129"></a><!-- doxytag: member="MooreSpread::excite" ref="af7afee40cca47459499927e40f505129" args="(double **filterBankOutput, int sampleCount, int sampleFreq)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void MooreSpread::excite </td>
          <td>(</td>
          <td class="paramtype">double **&nbsp;</td>
          <td class="paramname"> <em>filterBankOutput</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sampleCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sampleFreq</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Method for finding the Moore Spread </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>filterBankOutput</em>&nbsp;</td><td>The output of the filter bank, an array of magnitudes for each filter </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sampleCount</em>&nbsp;</td><td>The number of samples in each sub-band or filter </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>sampleFreq</em>&nbsp;</td><td>The sample frequency of the time domain signal </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="MooreSpread_8H_source.html">MooreSpread.H</a></li>
<li>MooreSpread.cc</li>
</ul>
</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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Jun 19 15:23:31 2010 for libaudiomask by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>