Mercurial > hg > btrack

annotate doc/html/class_onset_detection_function.html @ 24:deb49a2590f3 develop

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