Mercurial > hg > btrack

comparison doc/html/class_onset_detection_function.html @ 114:d6d9df2db3e1

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