Mercurial > hg > btrack

view doc/html/class_onset_detection_function.html @ 114:d6d9df2db3e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 source
<!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=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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">BTrack - A Real-Time Beat Tracker
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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&amp;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)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<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 -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<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><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a>&gt;</code></p>
<table class="memberdecls">
<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:a507e6258c5e703c989a6a58d2d8f4dcb"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<tr class="memitem:a89f96562c098e118eb879672b43d4ed0"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<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>
<tr class="separator:aa01f8125c950f3def45154878107e503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a527d4f433d4f7bcd098b54190ee89297"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a3fb3c827993aa854b85f4d4c44460a29"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<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>
<tr class="separator:a7b8fffe6221d3bd4f6cac82c17db0e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac607feee669f3d3f4015662eec717f6a"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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 &amp; Destructor Documentation</h2>
<a id="a507e6258c5e703c989a6a58d2d8f4dcb" name="a507e6258c5e703c989a6a58d2d8f4dcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a507e6258c5e703c989a6a58d2d8f4dcb">&#9670;&#160;</a></span>OnsetDetectionFunction() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hopSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>frameSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </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>
  <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>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a89f96562c098e118eb879672b43d4ed0" name="a89f96562c098e118eb879672b43d4ed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89f96562c098e118eb879672b43d4ed0">&#9670;&#160;</a></span>OnsetDetectionFunction() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OnsetDetectionFunction::OnsetDetectionFunction </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hopSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>frameSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>onsetDetectionFunctionType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>windowType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
    <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
    <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa01f8125c950f3def45154878107e503" name="aa01f8125c950f3def45154878107e503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa01f8125c950f3def45154878107e503">&#9670;&#160;</a></span>~OnsetDetectionFunction()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OnsetDetectionFunction::~OnsetDetectionFunction </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7b8fffe6221d3bd4f6cac82c17db0e92" name="a7b8fffe6221d3bd4f6cac82c17db0e92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b8fffe6221d3bd4f6cac82c17db0e92">&#9670;&#160;</a></span>calculateOnsetDetectionFunctionSample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double OnsetDetectionFunction::calculateOnsetDetectionFunctionSample </td>
          <td>(</td>
          <td class="paramtype">double *&#160;</td>
          <td class="paramname"><em>buffer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the onset detection function sample </dd></dl>

</div>
</div>
<a id="a527d4f433d4f7bcd098b54190ee89297" name="a527d4f433d4f7bcd098b54190ee89297"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a527d4f433d4f7bcd098b54190ee89297">&#9670;&#160;</a></span>initialise() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OnsetDetectionFunction::initialise </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hopSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>frameSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </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>
  <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>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3fb3c827993aa854b85f4d4c44460a29" name="a3fb3c827993aa854b85f4d4c44460a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fb3c827993aa854b85f4d4c44460a29">&#9670;&#160;</a></span>initialise() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OnsetDetectionFunction::initialise </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hopSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>frameSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>onsetDetectionFunctionType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>windowType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
    <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
    <tr><td class="paramname">windowType</td><td>the type of window to use (see WindowType) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac607feee669f3d3f4015662eec717f6a" name="ac607feee669f3d3f4015662eec717f6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac607feee669f3d3f4015662eec717f6a">&#9670;&#160;</a></span>setOnsetDetectionFunctionType()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OnsetDetectionFunction::setOnsetDetectionFunctionType </td>
          <td>(</td>
          <td class="paramtype">int&#160;</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>
  <table class="params">
    <tr><td class="paramname">onsetDetectionFunctionType_</td><td>the type of onset detection function to use - (see OnsetDetectionFunctionType) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="_onset_detection_function_8h_source.html">OnsetDetectionFunction.h</a></li>
<li>src/<a class="el" href="_onset_detection_function_8cpp.html">OnsetDetectionFunction.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>