Mercurial > hg > btrack

comparison doc/html/class_onset_detection_function.html @ 36:5bd9ae503dcf master 1.0.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
flow: Merged <release> '1.0.0' to <master> ('master').
author Adam Stark <adamstark.uk@gmail.com>
date Tue, 08 Jul 2014 12:32:27 +0100
parents 687b8dd41934
children d6d9df2db3e1
comparison
equal deleted inserted replaced
13:0d29e68fa2ee 36:5bd9ae503dcf
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <title>BTrack - A Real-Time Beat Tracker: OnsetDetectionFunction Class Reference</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="jquery.js"></script>
9 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="search/search.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="search/search.js"></script>
12 <script type="text/javascript">
13 $(document).ready(function() { searchBox.OnSelectItem(0); });
14 </script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr style="height: 56px;">
23 <td style="padding-left: 0.5em;">
24 <div id="projectname">BTrack - A Real-Time Beat Tracker
25 </div>
26 </td>
27 </tr>
28 </tbody>
29 </table>
30 </div>
31 <!-- end header part -->
32 <!-- Generated by Doxygen 1.8.2 -->
33 <script type="text/javascript">
34 var searchBox = new SearchBox("searchBox", "search",false,'Search');
35 </script>
36 <div id="navrow1" class="tabs">
37 <ul class="tablist">
38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
40 <li><a href="files.html"><span>Files</span></a></li>
41 <li>
42 <div id="MSearchBox" class="MSearchBoxInactive">
43 <span class="left">
44 <img id="MSearchSelect" src="search/mag_sel.png"
45 onmouseover="return searchBox.OnSearchSelectShow()"
46 onmouseout="return searchBox.OnSearchSelectHide()"
47 alt=""/>
48 <input type="text" id="MSearchField" value="Search" accesskey="S"
49 onfocus="searchBox.OnSearchFieldFocus(true)"
50 onblur="searchBox.OnSearchFieldFocus(false)"
51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
52 </span><span class="right">
53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
54 </span>
55 </div>
56 </li>
57 </ul>
58 </div>
59 <div id="navrow2" class="tabs2">
60 <ul class="tablist">
61 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
62 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
63 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
64 </ul>
65 </div>
66 <!-- window showing the filter options -->
67 <div id="MSearchSelectWindow"
68 onmouseover="return searchBox.OnSearchSelectShow()"
69 onmouseout="return searchBox.OnSearchSelectHide()"
70 onkeydown="return searchBox.OnSearchSelectKey(event)">
71 <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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>
72
73 <!-- iframe showing the search results (closed by default) -->
74 <div id="MSearchResultsWindow">
75 <iframe src="javascript:void(0)" frameborder="0"
76 name="MSearchResults" id="MSearchResults">
77 </iframe>
78 </div>
79
80 </div><!-- top -->
81 <div class="header">
82 <div class="summary">
83 <a href="#pub-methods">Public Member Functions</a> &#124;
84 <a href="class_onset_detection_function-members.html">List of all members</a> </div>
85 <div class="headertitle">
86 <div class="title">OnsetDetectionFunction Class Reference</div> </div>
87 </div><!--header-->
88 <div class="contents">
89
90 <p><code>#include &lt;<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a>&gt;</code></p>
91 <table class="memberdecls">
92 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
93 Public Member Functions</h2></td></tr>
94 <tr class="memitem:a1af5db39698d413cbb892b3a6de7aee5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a> (int hopSize_, int frameSize_)</td></tr>
95 <tr class="separator:a1af5db39698d413cbb892b3a6de7aee5"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:ad2c23f2d1ac346da8289712df173b190"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#ad2c23f2d1ac346da8289712df173b190">OnsetDetectionFunction</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType_)</td></tr>
97 <tr class="separator:ad2c23f2d1ac346da8289712df173b190"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:aa01f8125c950f3def45154878107e503"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a> ()</td></tr>
99 <tr class="separator:aa01f8125c950f3def45154878107e503"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <tr class="memitem:ab3379d150c375e4a7e525f326ce5a2e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">initialise</a> (int hopSize_, int frameSize_)</td></tr>
101 <tr class="separator:ab3379d150c375e4a7e525f326ce5a2e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <tr class="memitem:a4f9e1352bfdcd032bdd8193cc72489ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a4f9e1352bfdcd032bdd8193cc72489ba">initialise</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType_)</td></tr>
103 <tr class="separator:a4f9e1352bfdcd032bdd8193cc72489ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
104 <tr class="memitem:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a> (double *buffer)</td></tr>
105 <tr class="separator:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:a51fdab443155aaaa935956645e8f9131"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a> (int onsetDetectionFunctionType_)</td></tr>
107 <tr class="separator:a51fdab443155aaaa935956645e8f9131"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 </table>
109 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
110 <div class="textblock"><p>A class for calculating onset detection functions. </p>
111 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
112 <a class="anchor" id="a1af5db39698d413cbb892b3a6de7aee5"></a>
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
116 <tr>
117 <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td>
118 <td>(</td>
119 <td class="paramtype">int&#160;</td>
120 <td class="paramname"><em>hopSize_</em>, </td>
121 </tr>
122 <tr>
123 <td class="paramkey"></td>
124 <td></td>
125 <td class="paramtype">int&#160;</td>
126 <td class="paramname"><em>frameSize_</em>&#160;</td>
127 </tr>
128 <tr>
129 <td></td>
130 <td>)</td>
131 <td></td><td></td>
132 </tr>
133 </table>
134 </div><div class="memdoc">
135 <p>Constructor that defaults the onset detection function type to ComplexSpectralDifferenceHWR and the window type to HanningWindow </p>
136 <dl class="params"><dt>Parameters</dt><dd>
137 <table class="params">
138 <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr>
139 <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr>
140 </table>
141 </dd>
142 </dl>
143
144 </div>
145 </div>
146 <a class="anchor" id="ad2c23f2d1ac346da8289712df173b190"></a>
147 <div class="memitem">
148 <div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td>
152 <td>(</td>
153 <td class="paramtype">int&#160;</td>
154 <td class="paramname"><em>hopSize_</em>, </td>
155 </tr>
156 <tr>
157 <td class="paramkey"></td>
158 <td></td>
159 <td class="paramtype">int&#160;</td>
160 <td class="paramname"><em>frameSize_</em>, </td>
161 </tr>
162 <tr>
163 <td class="paramkey"></td>
164 <td></td>
165 <td class="paramtype">int&#160;</td>
166 <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td>
167 </tr>
168 <tr>
169 <td class="paramkey"></td>
170 <td></td>
171 <td class="paramtype">int&#160;</td>
172 <td class="paramname"><em>windowType_</em>&#160;</td>
173 </tr>
174 <tr>
175 <td></td>
176 <td>)</td>
177 <td></td><td></td>
178 </tr>
179 </table>
180 </div><div class="memdoc">
181 <p>Constructor </p>
182 <dl class="params"><dt>Parameters</dt><dd>
183 <table class="params">
184 <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr>
185 <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr>
186 <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
187 <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr>
188 </table>
189 </dd>
190 </dl>
191
192 </div>
193 </div>
194 <a class="anchor" id="aa01f8125c950f3def45154878107e503"></a>
195 <div class="memitem">
196 <div class="memproto">
197 <table class="memname">
198 <tr>
199 <td class="memname">OnsetDetectionFunction::~OnsetDetectionFunction </td>
200 <td>(</td>
201 <td class="paramname"></td><td>)</td>
202 <td></td>
203 </tr>
204 </table>
205 </div><div class="memdoc">
206 <p>Destructor </p>
207
208 </div>
209 </div>
210 <h2 class="groupheader">Member Function Documentation</h2>
211 <a class="anchor" id="a7b8fffe6221d3bd4f6cac82c17db0e92"></a>
212 <div class="memitem">
213 <div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">double OnsetDetectionFunction::calculateOnsetDetectionFunctionSample </td>
217 <td>(</td>
218 <td class="paramtype">double *&#160;</td>
219 <td class="paramname"><em>buffer</em></td><td>)</td>
220 <td></td>
221 </tr>
222 </table>
223 </div><div class="memdoc">
224 <p>Process input frame and calculate detection function sample </p>
225 <dl class="params"><dt>Parameters</dt><dd>
226 <table class="params">
227 <tr><td class="paramname">buffer</td><td>a pointer to an array containing the audio samples to be processed </td></tr>
228 </table>
229 </dd>
230 </dl>
231 <dl class="section return"><dt>Returns</dt><dd>the onset detection function sample </dd></dl>
232
233 </div>
234 </div>
235 <a class="anchor" id="ab3379d150c375e4a7e525f326ce5a2e6"></a>
236 <div class="memitem">
237 <div class="memproto">
238 <table class="memname">
239 <tr>
240 <td class="memname">void OnsetDetectionFunction::initialise </td>
241 <td>(</td>
242 <td class="paramtype">int&#160;</td>
243 <td class="paramname"><em>hopSize_</em>, </td>
244 </tr>
245 <tr>
246 <td class="paramkey"></td>
247 <td></td>
248 <td class="paramtype">int&#160;</td>
249 <td class="paramname"><em>frameSize_</em>&#160;</td>
250 </tr>
251 <tr>
252 <td></td>
253 <td>)</td>
254 <td></td><td></td>
255 </tr>
256 </table>
257 </div><div class="memdoc">
258 <p>Initialisation function for only updating hop size and frame size (and not window type or onset detection function type </p>
259 <dl class="params"><dt>Parameters</dt><dd>
260 <table class="params">
261 <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr>
262 <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr>
263 </table>
264 </dd>
265 </dl>
266
267 </div>
268 </div>
269 <a class="anchor" id="a4f9e1352bfdcd032bdd8193cc72489ba"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">void OnsetDetectionFunction::initialise </td>
275 <td>(</td>
276 <td class="paramtype">int&#160;</td>
277 <td class="paramname"><em>hopSize_</em>, </td>
278 </tr>
279 <tr>
280 <td class="paramkey"></td>
281 <td></td>
282 <td class="paramtype">int&#160;</td>
283 <td class="paramname"><em>frameSize_</em>, </td>
284 </tr>
285 <tr>
286 <td class="paramkey"></td>
287 <td></td>
288 <td class="paramtype">int&#160;</td>
289 <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td>
290 </tr>
291 <tr>
292 <td class="paramkey"></td>
293 <td></td>
294 <td class="paramtype">int&#160;</td>
295 <td class="paramname"><em>windowType_</em>&#160;</td>
296 </tr>
297 <tr>
298 <td></td>
299 <td>)</td>
300 <td></td><td></td>
301 </tr>
302 </table>
303 </div><div class="memdoc">
304 <p>Initialisation Function </p>
305 <dl class="params"><dt>Parameters</dt><dd>
306 <table class="params">
307 <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr>
308 <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr>
309 <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
310 <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr>
311 </table>
312 </dd>
313 </dl>
314
315 </div>
316 </div>
317 <a class="anchor" id="a51fdab443155aaaa935956645e8f9131"></a>
318 <div class="memitem">
319 <div class="memproto">
320 <table class="memname">
321 <tr>
322 <td class="memname">void OnsetDetectionFunction::setOnsetDetectionFunctionType </td>
323 <td>(</td>
324 <td class="paramtype">int&#160;</td>
325 <td class="paramname"><em>onsetDetectionFunctionType_</em></td><td>)</td>
326 <td></td>
327 </tr>
328 </table>
329 </div><div class="memdoc">
330 <p>Set the detection function type </p>
331 <dl class="params"><dt>Parameters</dt><dd>
332 <table class="params">
333 <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
334 </table>
335 </dd>
336 </dl>
337
338 </div>
339 </div>
340 <hr/>The documentation for this class was generated from the following files:<ul>
341 <li>src/<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a></li>
342 <li>src/<a class="el" href="_onset_detection_function_8cpp.html">OnsetDetectionFunction.cpp</a></li>
343 </ul>
344 </div><!-- contents -->
345 <!-- start footer part -->
346 <hr class="footer"/><address class="footer"><small>
347 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">
348 <img class="footer" src="doxygen.png" alt="doxygen"/>
349 </a> 1.8.2
350 </small></address>
351 </body>
352 </html>