Mercurial > hg > btrack
diff doc/html/_onset_detection_function_8h_source.html @ 30:687b8dd41934 develop
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 <adamstark.uk@gmail.com> |
---|---|
date | Tue, 28 Jan 2014 01:07:44 +0000 |
parents | 7af87d3f2ce2 |
children | d6d9df2db3e1 |
line wrap: on
line diff
--- a/doc/html/_onset_detection_function_8h_source.html Tue Jan 28 00:49:53 2014 +0000 +++ b/doc/html/_onset_detection_function_8h_source.html Tue Jan 28 01:07:44 2014 +0000 @@ -125,80 +125,86 @@ <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> {</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> -<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <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> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <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> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> -<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div> -<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div> -<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <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> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <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> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a>();</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> -<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div> -<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> -<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div> -<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div> -<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">private</span>:</div> -<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> -<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> performFFT();</div> -<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> -<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">//=======================================================================</span></div> -<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div> -<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> -<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">double</span> energyDifference();</div> -<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> -<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">double</span> spectralDifference();</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <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> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <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> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">double</span> <a class="code" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a>(<span class="keywordtype">double</span> *buffer);</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> <a class="code" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a>(<span class="keywordtype">int</span> onsetDetectionFunctionType_);</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div> -<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">double</span> spectralDifferenceHWR();</div> -<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> -<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">double</span> phaseDeviation();</div> -<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div> -<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">double</span> complexSpectralDifference();</div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> performFFT();</div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span> <span class="keywordtype">double</span> energyEnvelope();</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div> -<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">double</span> energyDifference();</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div> -<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">double</span> highFrequencyContent();</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">double</span> spectralDifference();</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div> -<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">double</span> highFrequencySpectralDifference();</div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">double</span> spectralDifferenceHWR();</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> -<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div> -<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> -<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">//=======================================================================</span></div> -<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div> -<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div> -<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">void</span> calculateHanningWindow();</div> -<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div> -<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">void</span> calclulateHammingWindow();</div> -<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div> -<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">void</span> calculateBlackmanWindow();</div> -<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div> -<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> calculateTukeyWindow();</div> -<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> -<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">//=======================================================================</span></div> -<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div> -<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div> -<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div> -<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">double</span> pi; </div> -<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">int</span> frameSize; </div> -<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> hopSize; </div> -<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">int</span> onsetDetectionFunctionType; </div> -<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  fftw_plan p; </div> -<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  fftw_complex *complexIn; </div> -<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  fftw_complex *complexOut; </div> -<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">bool</span> initialised; </div> -<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  std::vector<double> frame; </div> -<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  std::vector<double> window; </div> -<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">double</span> prevEnergySum; </div> -<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  std::vector<double> magSpec; </div> -<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  std::vector<double> prevMagSpec; </div> -<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  std::vector<double> phase; </div> -<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  std::vector<double> prevPhase; </div> -<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  std::vector<double> prevPhase2; </div> -<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> };</div> -<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div> -<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div> -<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">double</span> phaseDeviation();</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">double</span> complexSpectralDifference();</div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div> +<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">double</span> complexSpectralDifferenceHWR();</div> +<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> +<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">double</span> highFrequencyContent();</div> +<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">double</span> highFrequencySpectralDifference();</div> +<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div> +<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">double</span> highFrequencySpectralDifferenceHWR();</div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"></span> <span class="keywordtype">void</span> calculateRectangularWindow();</div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">void</span> calculateHanningWindow();</div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div> +<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">void</span> calclulateHammingWindow();</div> +<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div> +<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">void</span> calculateBlackmanWindow();</div> +<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div> +<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> calculateTukeyWindow();</div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">//=======================================================================</span></div> +<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span> <span class="keywordtype">double</span> princarg(<span class="keywordtype">double</span> phaseVal);</div> +<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  </div> +<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div> +<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">double</span> pi; </div> +<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">int</span> frameSize; </div> +<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">int</span> hopSize; </div> +<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">int</span> onsetDetectionFunctionType; </div> +<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">int</span> windowType; </div> +<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  fftw_plan p; </div> +<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  fftw_complex *complexIn; </div> +<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  fftw_complex *complexOut; </div> +<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">bool</span> initialised; </div> +<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  std::vector<double> frame; </div> +<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  std::vector<double> window; </div> +<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">double</span> prevEnergySum; </div> +<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  std::vector<double> magSpec; </div> +<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  std::vector<double> prevMagSpec; </div> +<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  std::vector<double> phase; </div> +<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  std::vector<double> prevPhase; </div> +<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  std::vector<double> prevPhase2; </div> +<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> };</div> +<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div> +<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div> +<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Tue Jan 28 2014 00:29:23 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> +Generated on Tue Jan 28 2014 01:06:53 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.2 </small></address>