comparison doc/html/_onset_detection_function_8h_source.html @ 67:ae3ec9b14092

Updated README, installation instructions for Python module and added an example.py file to explain how to use the Python module. Also regenerated documentation.
author Adam Stark <adamstark@users.noreply.github.com>
date Tue, 28 Jan 2014 01:07:44 +0000
parents 105999275c2e
children d6d9df2db3e1
comparison
equal deleted inserted replaced
66:b387d8327729 67:ae3ec9b14092
123 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">//=======================================================================</span></div> 123 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">//=======================================================================</span></div>
124 <div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="class_onset_detection_function.html"> 57</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a></div> 124 <div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="class_onset_detection_function.html"> 57</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="class_onset_detection_function.html">OnsetDetectionFunction</a></div>
125 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div> 125 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div>
126 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">public</span>:</div> 126 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">public</span>:</div>
127 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div> 127 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
128 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="class_onset_detection_function.html#a7b4e4ab1b0be5f57682c52141eb959d6">OnsetDetectionFunction</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType);</div> 128 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div>
129 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
129 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div> 130 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
130 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div> 131 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType_);</div>
131 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div> 132 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
132 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a654ed22782f6dc62e8347df44c90fbeb">initialise</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType);</div> 133 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div>
133 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div> 134 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
134 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div> 135 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">initialise</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_);</div>
135 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div> 136 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
136 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div> 137 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">initialise</a>(<span class="keywordtype">int</span> hopSize_,<span class="keywordtype">int</span> frameSize_,<span class="keywordtype">int</span> onsetDetectionFunctionType_,<span class="keywordtype">int</span> windowType_);</div>
137 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div> 138 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
138 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="keyword">private</span>:</div> 139 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div>
139 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div> 140 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
140 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span> performFFT();</div> 141 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div>
141 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
142 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="comment">//=======================================================================</span></div>
143 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div>
144 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
145 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">double</span> energyDifference();</div>
146 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
147 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">double</span> spectralDifference();</div>
148 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div> 142 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
149 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">double</span> spectralDifferenceHWR();</div> 143 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="keyword">private</span>:</div>
150 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div> 144 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
151 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">double</span> phaseDeviation();</div> 145 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">void</span> performFFT();</div>
152 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div> 146 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
153 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">double</span> complexSpectralDifference();</div> 147 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">//=======================================================================</span></div>
148 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div>
154 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div> 149 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
155 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div> 150 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">double</span> energyDifference();</div>
156 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div> 151 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
157 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">double</span> highFrequencyContent();</div> 152 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">double</span> spectralDifference();</div>
158 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div> 153 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
159 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifference();</div> 154 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">double</span> spectralDifferenceHWR();</div>
160 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div> 155 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
161 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div> 156 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">double</span> phaseDeviation();</div>
162 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div> 157 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; </div>
163 <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="comment">//=======================================================================</span></div> 158 <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">double</span> complexSpectralDifference();</div>
164 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div> 159 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
165 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div> 160 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div>
166 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">void</span> calculateHanningWindow();</div> 161 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
167 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div> 162 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">double</span> highFrequencyContent();</div>
168 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordtype">void</span> calclulateHammingWindow();</div> 163 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; </div>
169 <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div> 164 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifference();</div>
170 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">void</span> calculateBlackmanWindow();</div> 165 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
171 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div> 166 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div>
172 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordtype">void</span> calculateTukeyWindow();</div> 167 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;</div>
173 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div> 168 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="comment">//=======================================================================</span></div>
174 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="comment">//=======================================================================</span></div> 169 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div>
175 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div> 170 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
176 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; </div> 171 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">void</span> calculateHanningWindow();</div>
177 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; </div> 172 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
178 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">double</span> pi; </div> 173 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordtype">void</span> calclulateHammingWindow();</div>
179 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">int</span> frameSize; </div> 174 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; </div>
180 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordtype">int</span> hopSize; </div> 175 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">void</span> calculateBlackmanWindow();</div>
181 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keywordtype">int</span> onsetDetectionFunctionType; </div> 176 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; </div>
182 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; fftw_plan p; </div> 177 <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keywordtype">void</span> calculateTukeyWindow();</div>
183 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; fftw_complex *complexIn; </div> 178 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div>
184 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; fftw_complex *complexOut; </div> 179 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="comment">//=======================================================================</span></div>
185 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keywordtype">bool</span> initialised; </div> 180 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div>
186 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; std::vector&lt;double&gt; frame; </div> 181 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; </div>
187 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; std::vector&lt;double&gt; window; </div> 182 <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; </div>
188 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordtype">double</span> prevEnergySum; </div> 183 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordtype">double</span> pi; </div>
189 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; std::vector&lt;double&gt; magSpec; </div> 184 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keywordtype">int</span> frameSize; </div>
190 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; std::vector&lt;double&gt; prevMagSpec; </div> 185 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">int</span> hopSize; </div>
191 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; std::vector&lt;double&gt; phase; </div> 186 <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordtype">int</span> onsetDetectionFunctionType; </div>
192 <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; std::vector&lt;double&gt; prevPhase; </div> 187 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordtype">int</span> windowType; </div>
193 <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; std::vector&lt;double&gt; prevPhase2; </div> 188 <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; fftw_plan p; </div>
194 <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;};</div> 189 <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; fftw_complex *complexIn; </div>
195 <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div> 190 <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; fftw_complex *complexOut; </div>
196 <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</div> 191 <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <span class="keywordtype">bool</span> initialised; </div>
197 <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="preprocessor">#endif</span></div> 192 <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; std::vector&lt;double&gt; frame; </div>
193 <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; std::vector&lt;double&gt; window; </div>
194 <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordtype">double</span> prevEnergySum; </div>
195 <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; std::vector&lt;double&gt; magSpec; </div>
196 <div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; std::vector&lt;double&gt; prevMagSpec; </div>
197 <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; std::vector&lt;double&gt; phase; </div>
198 <div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; std::vector&lt;double&gt; prevPhase; </div>
199 <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; std::vector&lt;double&gt; prevPhase2; </div>
200 <div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;};</div>
201 <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;</div>
202 <div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div>
203 <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;<span class="preprocessor">#endif</span></div>
198 </div><!-- fragment --></div><!-- contents --> 204 </div><!-- fragment --></div><!-- contents -->
199 <!-- start footer part --> 205 <!-- start footer part -->
200 <hr class="footer"/><address class="footer"><small> 206 <hr class="footer"/><address class="footer"><small>
201 Generated on Tue Jan 28 2014 00:29:23 for BTrack - A Real-Time Beat Tracker by &#160;<a href="http://www.doxygen.org/index.html"> 207 Generated on Tue Jan 28 2014 01:06:53 for BTrack - A Real-Time Beat Tracker by &#160;<a href="http://www.doxygen.org/index.html">
202 <img class="footer" src="doxygen.png" alt="doxygen"/> 208 <img class="footer" src="doxygen.png" alt="doxygen"/>
203 </a> 1.8.2 209 </a> 1.8.2
204 </small></address> 210 </small></address>
205 </body> 211 </body>
206 </html> 212 </html>