Mercurial > hg > btrack

comparison doc/html/class_onset_detection_function.html @ 23:92ee4ace9d46 develop

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Did more commenting. Added documentation.
author Adam <adamstark.uk@gmail.com>
date Sat, 25 Jan 2014 18:17:51 +0000
parents
children deb49a2590f3
comparison
equal deleted inserted replaced
22:a8e3e95d14e4 23:92ee4ace9d46
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></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 <table class="memberdecls">
90 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
91 Public Member Functions</h2></td></tr>
92 <tr class="memitem:a7b4e4ab1b0be5f57682c52141eb959d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a7b4e4ab1b0be5f57682c52141eb959d6">OnsetDetectionFunction</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType)</td></tr>
93 <tr class="separator:a7b4e4ab1b0be5f57682c52141eb959d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <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>
95 <tr class="separator:aa01f8125c950f3def45154878107e503"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:a654ed22782f6dc62e8347df44c90fbeb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a654ed22782f6dc62e8347df44c90fbeb">initialise</a> (int hopSize_, int frameSize_, int onsetDetectionFunctionType_, int windowType)</td></tr>
97 <tr class="separator:a654ed22782f6dc62e8347df44c90fbeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <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>
99 <tr class="separator:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <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>
101 <tr class="separator:a51fdab443155aaaa935956645e8f9131"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 </table>
103 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
104 <a class="anchor" id="a7b4e4ab1b0be5f57682c52141eb959d6"></a>
105 <div class="memitem">
106 <div class="memproto">
107 <table class="memname">
108 <tr>
109 <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td>
110 <td>(</td>
111 <td class="paramtype">int&#160;</td>
112 <td class="paramname"><em>hopSize_</em>, </td>
113 </tr>
114 <tr>
115 <td class="paramkey"></td>
116 <td></td>
117 <td class="paramtype">int&#160;</td>
118 <td class="paramname"><em>frameSize_</em>, </td>
119 </tr>
120 <tr>
121 <td class="paramkey"></td>
122 <td></td>
123 <td class="paramtype">int&#160;</td>
124 <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td>
125 </tr>
126 <tr>
127 <td class="paramkey"></td>
128 <td></td>
129 <td class="paramtype">int&#160;</td>
130 <td class="paramname"><em>windowType</em>&#160;</td>
131 </tr>
132 <tr>
133 <td></td>
134 <td>)</td>
135 <td></td><td></td>
136 </tr>
137 </table>
138 </div><div class="memdoc">
139 <p>Constructor </p>
140 <dl class="params"><dt>Parameters</dt><dd>
141 <table class="params">
142 <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr>
143 <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr>
144 <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
145 <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr>
146 </table>
147 </dd>
148 </dl>
149
150 </div>
151 </div>
152 <a class="anchor" id="aa01f8125c950f3def45154878107e503"></a>
153 <div class="memitem">
154 <div class="memproto">
155 <table class="memname">
156 <tr>
157 <td class="memname">OnsetDetectionFunction::~OnsetDetectionFunction </td>
158 <td>(</td>
159 <td class="paramname"></td><td>)</td>
160 <td></td>
161 </tr>
162 </table>
163 </div><div class="memdoc">
164 <p>Destructor </p>
165
166 </div>
167 </div>
168 <h2 class="groupheader">Member Function Documentation</h2>
169 <a class="anchor" id="a7b8fffe6221d3bd4f6cac82c17db0e92"></a>
170 <div class="memitem">
171 <div class="memproto">
172 <table class="memname">
173 <tr>
174 <td class="memname">double OnsetDetectionFunction::calculateOnsetDetectionFunctionSample </td>
175 <td>(</td>
176 <td class="paramtype">double *&#160;</td>
177 <td class="paramname"><em>buffer</em></td><td>)</td>
178 <td></td>
179 </tr>
180 </table>
181 </div><div class="memdoc">
182 <p>process input frame and calculate detection function sample </p>
183
184 </div>
185 </div>
186 <a class="anchor" id="a654ed22782f6dc62e8347df44c90fbeb"></a>
187 <div class="memitem">
188 <div class="memproto">
189 <table class="memname">
190 <tr>
191 <td class="memname">void OnsetDetectionFunction::initialise </td>
192 <td>(</td>
193 <td class="paramtype">int&#160;</td>
194 <td class="paramname"><em>hopSize_</em>, </td>
195 </tr>
196 <tr>
197 <td class="paramkey"></td>
198 <td></td>
199 <td class="paramtype">int&#160;</td>
200 <td class="paramname"><em>frameSize_</em>, </td>
201 </tr>
202 <tr>
203 <td class="paramkey"></td>
204 <td></td>
205 <td class="paramtype">int&#160;</td>
206 <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td>
207 </tr>
208 <tr>
209 <td class="paramkey"></td>
210 <td></td>
211 <td class="paramtype">int&#160;</td>
212 <td class="paramname"><em>windowType</em>&#160;</td>
213 </tr>
214 <tr>
215 <td></td>
216 <td>)</td>
217 <td></td><td></td>
218 </tr>
219 </table>
220 </div><div class="memdoc">
221 <p>Initialisation Function </p>
222
223 </div>
224 </div>
225 <a class="anchor" id="a51fdab443155aaaa935956645e8f9131"></a>
226 <div class="memitem">
227 <div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname">void OnsetDetectionFunction::setOnsetDetectionFunctionType </td>
231 <td>(</td>
232 <td class="paramtype">int&#160;</td>
233 <td class="paramname"><em>onsetDetectionFunctionType_</em></td><td>)</td>
234 <td></td>
235 </tr>
236 </table>
237 </div><div class="memdoc">
238 <p>set the detection function type </p>
239
240 </div>
241 </div>
242 <hr/>The documentation for this class was generated from the following files:<ul>
243 <li>src/<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a></li>
244 <li>src/<a class="el" href="_onset_detection_function_8cpp.html">OnsetDetectionFunction.cpp</a></li>
245 </ul>
246 </div><!-- contents -->
247 <!-- start footer part -->
248 <hr class="footer"/><address class="footer"><small>
249 Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by &#160;<a href="http://www.doxygen.org/index.html">
250 <img class="footer" src="doxygen.png" alt="doxygen"/>
251 </a> 1.8.2
252 </small></address>
253 </body>
254 </html>