Mercurial > hg > btrack

comparison doc/html/_onset_detection_function_8h.html @ 60:bf256abf1dd4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Did more commenting. Added documentation.
author Adam Stark <adamstark@users.noreply.github.com>
date Sat, 25 Jan 2014 18:17:51 +0000
parents
children deb49a2590f3
comparison
equal deleted inserted replaced
59:ba3fc238ccad 60:bf256abf1dd4
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: src/OnsetDetectionFunction.h File 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><a href="annotated.html"><span>Classes</span></a></li>
40 <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
62 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
63 </ul>
64 </div>
65 <!-- window showing the filter options -->
66 <div id="MSearchSelectWindow"
67 onmouseover="return searchBox.OnSearchSelectShow()"
68 onmouseout="return searchBox.OnSearchSelectHide()"
69 onkeydown="return searchBox.OnSearchSelectKey(event)">
70 <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>
71
72 <!-- iframe showing the search results (closed by default) -->
73 <div id="MSearchResultsWindow">
74 <iframe src="javascript:void(0)" frameborder="0"
75 name="MSearchResults" id="MSearchResults">
76 </iframe>
77 </div>
78
79 <div id="nav-path" class="navpath">
80 <ul>
81 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
82 </div>
83 </div><!-- top -->
84 <div class="header">
85 <div class="summary">
86 <a href="#nested-classes">Classes</a> &#124;
87 <a href="#enum-members">Enumerations</a> </div>
88 <div class="headertitle">
89 <div class="title">OnsetDetectionFunction.h File Reference</div> </div>
90 </div><!--header-->
91 <div class="contents">
92
93 <p>A class for calculating onset detection functions.
94 <a href="#details">More...</a></p>
95 <div class="textblock"><code>#include &quot;fftw3.h&quot;</code><br/>
96 </div>
97 <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p>
98 <table class="memberdecls">
99 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
100 Classes</h2></td></tr>
101 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html">OnsetDetectionFunction</a></td></tr>
102 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 </table><table class="memberdecls">
104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
105 Enumerations</h2></td></tr>
106 <tr class="memitem:a36dbf81d14d771e0712d0316ec06612b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a> { <br/>
107 &#160;&#160;<b>EnergyEnvelope</b>,
108 <b>EnergyDifference</b>,
109 <b>SpectralDifference</b>,
110 <b>SpectralDifferenceHWR</b>,
111 <br/>
112 &#160;&#160;<b>PhaseDeviation</b>,
113 <b>ComplexSpectralDifference</b>,
114 <b>ComplexSpectralDifferenceHWR</b>,
115 <b>HighFrequencyContent</b>,
116 <br/>
117 &#160;&#160;<b>HighFrequencySpectralDifference</b>,
118 <b>HighFrequencySpectralDifferenceHWR</b>
119 <br/>
120 }</td></tr>
121 <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2">&#160;</td></tr>
122 <tr class="memitem:a476342970f954b62d70552bcbb5ee509"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a> { <br/>
123 &#160;&#160;<b>RectangularWindow</b>,
124 <b>HanningWindow</b>,
125 <b>HammingWindow</b>,
126 <b>BlackmanWindow</b>,
127 <br/>
128 &#160;&#160;<b>TukeyWindow</b>
129 <br/>
130 }</td></tr>
131 <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 </table>
133 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
134 <div class="textblock"><p>A class for calculating onset detection functions. </p>
135 <dl class="section author"><dt>Author</dt><dd>Adam Stark </dd></dl>
136 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl>
137 <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>
138 <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>
139 <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>
140 </div><h2 class="groupheader">Enumeration Type Documentation</h2>
141 <a class="anchor" id="a36dbf81d14d771e0712d0316ec06612b"></a>
142 <div class="memitem">
143 <div class="memproto">
144 <table class="memname">
145 <tr>
146 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td>
147 </tr>
148 </table>
149 </div><div class="memdoc">
150 <p>The type of onset detection function to calculate </p>
151
152 </div>
153 </div>
154 <a class="anchor" id="a476342970f954b62d70552bcbb5ee509"></a>
155 <div class="memitem">
156 <div class="memproto">
157 <table class="memname">
158 <tr>
159 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td>
160 </tr>
161 </table>
162 </div><div class="memdoc">
163 <p>The type of window to use when calculating onset detection function samples </p>
164
165 </div>
166 </div>
167 </div><!-- contents -->
168 <!-- start footer part -->
169 <hr class="footer"/><address class="footer"><small>
170 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">
171 <img class="footer" src="doxygen.png" alt="doxygen"/>
172 </a> 1.8.2
173 </small></address>
174 </body>
175 </html>