Mercurial > hg > btrack
diff doc/html/class_onset_detection_function.html @ 114:d6d9df2db3e1
Update documentation
author | Adam Stark <adamstark.uk@gmail.com> |
---|---|
date | Fri, 18 Aug 2023 10:48:26 +0200 |
parents | ae3ec9b14092 |
children |
line wrap: on
line diff
--- a/doc/html/class_onset_detection_function.html Fri Aug 18 10:44:50 2023 +0200 +++ b/doc/html/class_onset_detection_function.html Fri Aug 18 10:48:26 2023 +0200 @@ -1,17 +1,17 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.7"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> <title>BTrack - A Real-Time Beat Tracker: OnsetDetectionFunction Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -19,8 +19,8 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> + <tr id="projectrow"> + <td id="projectalign"> <div id="projectname">BTrack - A Real-Time Beat Tracker </div> </td> @@ -29,52 +29,42 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> +<!-- Generated by Doxygen 1.9.7 --> <script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); +/* @license-end */ </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="classes.html"><span>Class Index</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> - </ul> - </div> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> -<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> +</div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<div id="MSearchResults"> +<div class="SRPage"> +<div id="SRIndex"> +<div id="SRResults"></div> +<div class="SRStatus" id="Loading">Loading...</div> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +</div> +</div> +</div> </div> </div><!-- top --> @@ -82,34 +72,35 @@ <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="class_onset_detection_function-members.html">List of all members</a> </div> - <div class="headertitle"> -<div class="title">OnsetDetectionFunction Class Reference</div> </div> + <div class="headertitle"><div class="title">OnsetDetectionFunction Class Reference</div></div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a>></code></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> Public Member Functions</h2></td></tr> -<tr class="memitem:a1af5db39698d413cbb892b3a6de7aee5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a> (int hopSize_, int frameSize_)</td></tr> -<tr class="separator:a1af5db39698d413cbb892b3a6de7aee5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad2c23f2d1ac346da8289712df173b190"><td class="memItemLeft" align="right" valign="top"> </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> -<tr class="separator:ad2c23f2d1ac346da8289712df173b190"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a507e6258c5e703c989a6a58d2d8f4dcb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a507e6258c5e703c989a6a58d2d8f4dcb">OnsetDetectionFunction</a> (int hopSize, int frameSize)</td></tr> +<tr class="separator:a507e6258c5e703c989a6a58d2d8f4dcb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a89f96562c098e118eb879672b43d4ed0"><td class="memItemLeft" align="right" valign="top"> </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> +<tr class="separator:a89f96562c098e118eb879672b43d4ed0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa01f8125c950f3def45154878107e503"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">~OnsetDetectionFunction</a> ()</td></tr> <tr class="separator:aa01f8125c950f3def45154878107e503"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab3379d150c375e4a7e525f326ce5a2e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">initialise</a> (int hopSize_, int frameSize_)</td></tr> -<tr class="separator:ab3379d150c375e4a7e525f326ce5a2e6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a4f9e1352bfdcd032bdd8193cc72489ba"><td class="memItemLeft" align="right" valign="top">void </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> -<tr class="separator:a4f9e1352bfdcd032bdd8193cc72489ba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a527d4f433d4f7bcd098b54190ee89297"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a527d4f433d4f7bcd098b54190ee89297">initialise</a> (int hopSize, int frameSize)</td></tr> +<tr class="separator:a527d4f433d4f7bcd098b54190ee89297"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3fb3c827993aa854b85f4d4c44460a29"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="separator:a3fb3c827993aa854b85f4d4c44460a29"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">calculateOnsetDetectionFunctionSample</a> (double *buffer)</td></tr> <tr class="separator:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a51fdab443155aaaa935956645e8f9131"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">setOnsetDetectionFunctionType</a> (int onsetDetectionFunctionType_)</td></tr> -<tr class="separator:a51fdab443155aaaa935956645e8f9131"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac607feee669f3d3f4015662eec717f6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html#ac607feee669f3d3f4015662eec717f6a">setOnsetDetectionFunctionType</a> (int onsetDetectionFunctionType)</td></tr> +<tr class="separator:ac607feee669f3d3f4015662eec717f6a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A class for calculating onset detection functions. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a class="anchor" id="a1af5db39698d413cbb892b3a6de7aee5"></a> +<a id="a507e6258c5e703c989a6a58d2d8f4dcb" name="a507e6258c5e703c989a6a58d2d8f4dcb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a507e6258c5e703c989a6a58d2d8f4dcb">◆ </a></span>OnsetDetectionFunction() <span class="overload">[1/2]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -117,13 +108,13 @@ <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em> </td> + <td class="paramname"><em>frameSize</em> </td> </tr> <tr> <td></td> @@ -132,8 +123,7 @@ </tr> </table> </div><div class="memdoc"> -<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> +<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> <table class="params"> <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr> @@ -143,7 +133,9 @@ </div> </div> -<a class="anchor" id="ad2c23f2d1ac346da8289712df173b190"></a> +<a id="a89f96562c098e118eb879672b43d4ed0" name="a89f96562c098e118eb879672b43d4ed0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a89f96562c098e118eb879672b43d4ed0">◆ </a></span>OnsetDetectionFunction() <span class="overload">[2/2]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -151,25 +143,25 @@ <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em>, </td> + <td class="paramname"><em>frameSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td> + <td class="paramname"><em>onsetDetectionFunctionType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>windowType_</em> </td> + <td class="paramname"><em>windowType</em> </td> </tr> <tr> <td></td> @@ -178,8 +170,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Constructor </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr> @@ -191,7 +182,9 @@ </div> </div> -<a class="anchor" id="aa01f8125c950f3def45154878107e503"></a> +<a id="aa01f8125c950f3def45154878107e503" name="aa01f8125c950f3def45154878107e503"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa01f8125c950f3def45154878107e503">◆ </a></span>~OnsetDetectionFunction()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -208,7 +201,9 @@ </div> </div> <h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="a7b8fffe6221d3bd4f6cac82c17db0e92"></a> +<a id="a7b8fffe6221d3bd4f6cac82c17db0e92" name="a7b8fffe6221d3bd4f6cac82c17db0e92"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7b8fffe6221d3bd4f6cac82c17db0e92">◆ </a></span>calculateOnsetDetectionFunctionSample()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -221,8 +216,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Process input frame and calculate detection function sample </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Process input frame and calculate detection function sample </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">buffer</td><td>a pointer to an array containing the audio samples to be processed </td></tr> </table> @@ -232,7 +226,9 @@ </div> </div> -<a class="anchor" id="ab3379d150c375e4a7e525f326ce5a2e6"></a> +<a id="a527d4f433d4f7bcd098b54190ee89297" name="a527d4f433d4f7bcd098b54190ee89297"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a527d4f433d4f7bcd098b54190ee89297">◆ </a></span>initialise() <span class="overload">[1/2]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -240,13 +236,13 @@ <td class="memname">void OnsetDetectionFunction::initialise </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em> </td> + <td class="paramname"><em>frameSize</em> </td> </tr> <tr> <td></td> @@ -255,8 +251,7 @@ </tr> </table> </div><div class="memdoc"> -<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> +<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> <table class="params"> <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr> @@ -266,7 +261,9 @@ </div> </div> -<a class="anchor" id="a4f9e1352bfdcd032bdd8193cc72489ba"></a> +<a id="a3fb3c827993aa854b85f4d4c44460a29" name="a3fb3c827993aa854b85f4d4c44460a29"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3fb3c827993aa854b85f4d4c44460a29">◆ </a></span>initialise() <span class="overload">[2/2]</span></h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -274,25 +271,25 @@ <td class="memname">void OnsetDetectionFunction::initialise </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>hopSize_</em>, </td> + <td class="paramname"><em>hopSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>frameSize_</em>, </td> + <td class="paramname"><em>frameSize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>onsetDetectionFunctionType_</em>, </td> + <td class="paramname"><em>onsetDetectionFunctionType</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> - <td class="paramname"><em>windowType_</em> </td> + <td class="paramname"><em>windowType</em> </td> </tr> <tr> <td></td> @@ -301,8 +298,7 @@ </tr> </table> </div><div class="memdoc"> -<p>Initialisation Function </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Initialisation Function </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">hopSize_</td><td>the hop size in audio samples </td></tr> <tr><td class="paramname">frameSize_</td><td>the frame size in audio samples </td></tr> @@ -314,7 +310,9 @@ </div> </div> -<a class="anchor" id="a51fdab443155aaaa935956645e8f9131"></a> +<a id="ac607feee669f3d3f4015662eec717f6a" name="ac607feee669f3d3f4015662eec717f6a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac607feee669f3d3f4015662eec717f6a">◆ </a></span>setOnsetDetectionFunctionType()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -322,13 +320,12 @@ <td class="memname">void OnsetDetectionFunction::setOnsetDetectionFunctionType </td> <td>(</td> <td class="paramtype">int </td> - <td class="paramname"><em>onsetDetectionFunctionType_</em></td><td>)</td> + <td class="paramname"><em>onsetDetectionFunctionType</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Set the detection function type </p> -<dl class="params"><dt>Parameters</dt><dd> +<p>Set the detection function type </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr> </table> @@ -344,9 +341,7 @@ </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -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"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.2 +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 </small></address> </body> </html>