Mercurial > hg > btrack

annotate doc/html/class_onset_detection_function.html @ 61:ce806db4468b

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