Mercurial > hg > btrack
comparison doc/html/_onset_detection_function_8h.html @ 117:ca2d83d29814 tip master
Merge branch 'release/1.0.5'
author | Adam Stark <adamstark.uk@gmail.com> |
---|---|
date | Fri, 18 Aug 2023 20:07:33 +0200 |
parents | d6d9df2db3e1 |
children |
comparison
equal
deleted
inserted
replaced
96:c58f01834337 | 117:ca2d83d29814 |
---|---|
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: src/OnsetDetectionFunction.h File Reference</title> | 8 <title>BTrack - A Real-Time Beat Tracker: src/OnsetDetectionFunction.h File 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&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 Page</span></a></li> | 40 <script type="text/javascript"> |
39 <li><a href="annotated.html"><span>Classes</span></a></li> | 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
40 <li class="current"><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="files.html"><span>File List</span></a></li> | |
62 <li><a href="globals.html"><span>File Members</span></a></li> | |
63 </ul> | |
64 </div> | |
65 <!-- window showing the filter options --> | 49 <!-- window showing the filter options --> |
66 <div id="MSearchSelectWindow" | 50 <div id="MSearchSelectWindow" |
67 onmouseover="return searchBox.OnSearchSelectShow()" | 51 onmouseover="return searchBox.OnSearchSelectShow()" |
68 onmouseout="return searchBox.OnSearchSelectHide()" | 52 onmouseout="return searchBox.OnSearchSelectHide()" |
69 onkeydown="return searchBox.OnSearchSelectKey(event)"> | 53 onkeydown="return searchBox.OnSearchSelectKey(event)"> |
70 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div> | 54 </div> |
71 | 55 |
72 <!-- iframe showing the search results (closed by default) --> | 56 <!-- iframe showing the search results (closed by default) --> |
73 <div id="MSearchResultsWindow"> | 57 <div id="MSearchResultsWindow"> |
74 <iframe src="javascript:void(0)" frameborder="0" | 58 <div id="MSearchResults"> |
75 name="MSearchResults" id="MSearchResults"> | 59 <div class="SRPage"> |
76 </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> | |
77 </div> | 68 </div> |
78 | 69 |
79 <div id="nav-path" class="navpath"> | 70 <div id="nav-path" class="navpath"> |
80 <ul> | 71 <ul> |
81 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> | 72 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> |
83 </div><!-- top --> | 74 </div><!-- top --> |
84 <div class="header"> | 75 <div class="header"> |
85 <div class="summary"> | 76 <div class="summary"> |
86 <a href="#nested-classes">Classes</a> | | 77 <a href="#nested-classes">Classes</a> | |
87 <a href="#enum-members">Enumerations</a> </div> | 78 <a href="#enum-members">Enumerations</a> </div> |
88 <div class="headertitle"> | 79 <div class="headertitle"><div class="title">OnsetDetectionFunction.h File Reference</div></div> |
89 <div class="title">OnsetDetectionFunction.h File Reference</div> </div> | |
90 </div><!--header--> | 80 </div><!--header--> |
91 <div class="contents"> | 81 <div class="contents"> |
92 | 82 |
93 <p>A class for calculating onset detection functions. | 83 <p>A class for calculating onset detection functions. |
94 <a href="#details">More...</a></p> | 84 <a href="#details">More...</a></p> |
95 <div class="textblock"><code>#include "fftw3.h"</code><br/> | 85 <div class="textblock"><code>#include <vector></code><br /> |
96 <code>#include <vector></code><br/> | |
97 </div> | 86 </div> |
98 <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p> | 87 <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p> |
99 <table class="memberdecls"> | 88 <table class="memberdecls"> |
100 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> | 89 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
101 Classes</h2></td></tr> | 90 Classes</h2></td></tr> |
102 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html">OnsetDetectionFunction</a></td></tr> | 91 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html">OnsetDetectionFunction</a></td></tr> |
103 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | 92 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
104 </table><table class="memberdecls"> | 93 </table><table class="memberdecls"> |
105 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> | 94 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> |
106 Enumerations</h2></td></tr> | 95 Enumerations</h2></td></tr> |
107 <tr class="memitem:a36dbf81d14d771e0712d0316ec06612b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a> { <br/> | 96 <tr class="memitem:a36dbf81d14d771e0712d0316ec06612b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a> { <br /> |
108   <b>EnergyEnvelope</b>, | 97   <b>EnergyEnvelope</b> |
109 <b>EnergyDifference</b>, | 98 , <b>EnergyDifference</b> |
110 <b>SpectralDifference</b>, | 99 , <b>SpectralDifference</b> |
111 <b>SpectralDifferenceHWR</b>, | 100 , <b>SpectralDifferenceHWR</b> |
112 <br/> | 101 , <br /> |
113   <b>PhaseDeviation</b>, | 102   <b>PhaseDeviation</b> |
114 <b>ComplexSpectralDifference</b>, | 103 , <b>ComplexSpectralDifference</b> |
115 <b>ComplexSpectralDifferenceHWR</b>, | 104 , <b>ComplexSpectralDifferenceHWR</b> |
116 <b>HighFrequencyContent</b>, | 105 , <b>HighFrequencyContent</b> |
117 <br/> | 106 , <br /> |
118   <b>HighFrequencySpectralDifference</b>, | 107   <b>HighFrequencySpectralDifference</b> |
119 <b>HighFrequencySpectralDifferenceHWR</b> | 108 , <b>HighFrequencySpectralDifferenceHWR</b> |
120 <br/> | 109 <br /> |
121 }</td></tr> | 110 }</td></tr> |
122 <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2"> </td></tr> | 111 <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2"> </td></tr> |
123 <tr class="memitem:a476342970f954b62d70552bcbb5ee509"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a> { <br/> | 112 <tr class="memitem:a476342970f954b62d70552bcbb5ee509"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a> { <br /> |
124   <b>RectangularWindow</b>, | 113   <b>RectangularWindow</b> |
125 <b>HanningWindow</b>, | 114 , <b>HanningWindow</b> |
126 <b>HammingWindow</b>, | 115 , <b>HammingWindow</b> |
127 <b>BlackmanWindow</b>, | 116 , <b>BlackmanWindow</b> |
128 <br/> | 117 , <br /> |
129   <b>TukeyWindow</b> | 118   <b>TukeyWindow</b> |
130 <br/> | 119 <br /> |
131 }</td></tr> | 120 }</td></tr> |
132 <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2"> </td></tr> | 121 <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2"> </td></tr> |
133 </table> | 122 </table> |
134 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | 123 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
135 <div class="textblock"><p>A class for calculating onset detection functions. </p> | 124 <div class="textblock"><p>A class for calculating onset detection functions. </p> |
137 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl> | 126 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl> |
138 <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p> | 127 <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p> |
139 <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p> | 128 <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p> |
140 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p> | 129 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p> |
141 </div><h2 class="groupheader">Enumeration Type Documentation</h2> | 130 </div><h2 class="groupheader">Enumeration Type Documentation</h2> |
142 <a class="anchor" id="a36dbf81d14d771e0712d0316ec06612b"></a> | 131 <a id="a36dbf81d14d771e0712d0316ec06612b" name="a36dbf81d14d771e0712d0316ec06612b"></a> |
132 <h2 class="memtitle"><span class="permalink"><a href="#a36dbf81d14d771e0712d0316ec06612b">◆ </a></span>OnsetDetectionFunctionType</h2> | |
133 | |
143 <div class="memitem"> | 134 <div class="memitem"> |
144 <div class="memproto"> | 135 <div class="memproto"> |
145 <table class="memname"> | 136 <table class="memname"> |
146 <tr> | 137 <tr> |
147 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td> | 138 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td> |
150 </div><div class="memdoc"> | 141 </div><div class="memdoc"> |
151 <p>The type of onset detection function to calculate </p> | 142 <p>The type of onset detection function to calculate </p> |
152 | 143 |
153 </div> | 144 </div> |
154 </div> | 145 </div> |
155 <a class="anchor" id="a476342970f954b62d70552bcbb5ee509"></a> | 146 <a id="a476342970f954b62d70552bcbb5ee509" name="a476342970f954b62d70552bcbb5ee509"></a> |
147 <h2 class="memtitle"><span class="permalink"><a href="#a476342970f954b62d70552bcbb5ee509">◆ </a></span>WindowType</h2> | |
148 | |
156 <div class="memitem"> | 149 <div class="memitem"> |
157 <div class="memproto"> | 150 <div class="memproto"> |
158 <table class="memname"> | 151 <table class="memname"> |
159 <tr> | 152 <tr> |
160 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td> | 153 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td> |
166 </div> | 159 </div> |
167 </div> | 160 </div> |
168 </div><!-- contents --> | 161 </div><!-- contents --> |
169 <!-- start footer part --> | 162 <!-- start footer part --> |
170 <hr class="footer"/><address class="footer"><small> | 163 <hr class="footer"/><address class="footer"><small> |
171 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"> | 164 Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7 |
172 <img class="footer" src="doxygen.png" alt="doxygen"/> | |
173 </a> 1.8.2 | |
174 </small></address> | 165 </small></address> |
175 </body> | 166 </body> |
176 </html> | 167 </html> |