Mercurial > hg > btrack

annotate doc/html/_onset_detection_function_8h.html @ 117:ca2d83d29814 tip master

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge branch 'release/1.0.5'
author Adam Stark <adamstark.uk@gmail.com>
date Fri, 18 Aug 2023 20:07:33 +0200
parents d6d9df2db3e1
children
rev   line source
adamstark@114 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@114 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
adamstark@60 3 <head>
adamstark@60 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@114 5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
adamstark@114 6 <meta name="generator" content="Doxygen 1.9.7"/>
adamstark@114 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
adamstark@60 8 <title>BTrack - A Real-Time Beat Tracker: src/OnsetDetectionFunction.h File Reference</title>
adamstark@60 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@60 10 <script type="text/javascript" src="jquery.js"></script>
adamstark@60 11 <script type="text/javascript" src="dynsections.js"></script>
adamstark@60 12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@114 13 <script type="text/javascript" src="search/searchdata.js"></script>
adamstark@60 14 <script type="text/javascript" src="search/search.js"></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@114 22 <tr id="projectrow">
adamstark@114 23 <td id="projectalign">
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@114 32 <!-- Generated by Doxygen 1.9.7 -->
adamstark@60 33 <script type="text/javascript">
adamstark@114 34 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 35 var searchBox = new SearchBox("searchBox", "search/",'.html');
adamstark@114 36 /* @license-end */
adamstark@60 37 </script>
adamstark@114 38 <script type="text/javascript" src="menudata.js"></script>
adamstark@114 39 <script type="text/javascript" src="menu.js"></script>
adamstark@114 40 <script type="text/javascript">
adamstark@114 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 42 $(function() {
adamstark@114 43 initMenu('',true,false,'search.php','Search');
adamstark@114 44 $(document).ready(function() { init_search(); });
adamstark@114 45 });
adamstark@114 46 /* @license-end */
adamstark@114 47 </script>
adamstark@114 48 <div id="main-nav"></div>
adamstark@60 49 <!-- window showing the filter options -->
adamstark@60 50 <div id="MSearchSelectWindow"
adamstark@60 51 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 52 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 53 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@114 54 </div>
adamstark@60 55
adamstark@60 56 <!-- iframe showing the search results (closed by default) -->
adamstark@60 57 <div id="MSearchResultsWindow">
adamstark@114 58 <div id="MSearchResults">
adamstark@114 59 <div class="SRPage">
adamstark@114 60 <div id="SRIndex">
adamstark@114 61 <div id="SRResults"></div>
adamstark@114 62 <div class="SRStatus" id="Loading">Loading...</div>
adamstark@114 63 <div class="SRStatus" id="Searching">Searching...</div>
adamstark@114 64 <div class="SRStatus" id="NoMatches">No Matches</div>
adamstark@114 65 </div>
adamstark@114 66 </div>
adamstark@114 67 </div>
adamstark@60 68 </div>
adamstark@60 69
adamstark@60 70 <div id="nav-path" class="navpath">
adamstark@60 71 <ul>
adamstark@60 72 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
adamstark@60 73 </div>
adamstark@60 74 </div><!-- top -->
adamstark@60 75 <div class="header">
adamstark@60 76 <div class="summary">
adamstark@60 77 <a href="#nested-classes">Classes</a> &#124;
adamstark@60 78 <a href="#enum-members">Enumerations</a> </div>
adamstark@114 79 <div class="headertitle"><div class="title">OnsetDetectionFunction.h File Reference</div></div>
adamstark@60 80 </div><!--header-->
adamstark@60 81 <div class="contents">
adamstark@60 82
adamstark@60 83 <p>A class for calculating onset detection functions.
adamstark@60 84 <a href="#details">More...</a></p>
adamstark@114 85 <div class="textblock"><code>#include &lt;vector&gt;</code><br />
adamstark@60 86 </div>
adamstark@60 87 <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p>
adamstark@60 88 <table class="memberdecls">
adamstark@114 89 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
adamstark@60 90 Classes</h2></td></tr>
adamstark@60 91 <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>
adamstark@60 92 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 93 </table><table class="memberdecls">
adamstark@114 94 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
adamstark@60 95 Enumerations</h2></td></tr>
adamstark@114 96 <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 />
adamstark@114 97 &#160;&#160;<b>EnergyEnvelope</b>
adamstark@114 98 , <b>EnergyDifference</b>
adamstark@114 99 , <b>SpectralDifference</b>
adamstark@114 100 , <b>SpectralDifferenceHWR</b>
adamstark@114 101 , <br />
adamstark@114 102 &#160;&#160;<b>PhaseDeviation</b>
adamstark@114 103 , <b>ComplexSpectralDifference</b>
adamstark@114 104 , <b>ComplexSpectralDifferenceHWR</b>
adamstark@114 105 , <b>HighFrequencyContent</b>
adamstark@114 106 , <br />
adamstark@114 107 &#160;&#160;<b>HighFrequencySpectralDifference</b>
adamstark@114 108 , <b>HighFrequencySpectralDifferenceHWR</b>
adamstark@114 109 <br />
adamstark@60 110 }</td></tr>
adamstark@60 111 <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@114 112 <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 />
adamstark@114 113 &#160;&#160;<b>RectangularWindow</b>
adamstark@114 114 , <b>HanningWindow</b>
adamstark@114 115 , <b>HammingWindow</b>
adamstark@114 116 , <b>BlackmanWindow</b>
adamstark@114 117 , <br />
adamstark@60 118 &#160;&#160;<b>TukeyWindow</b>
adamstark@114 119 <br />
adamstark@60 120 }</td></tr>
adamstark@60 121 <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 122 </table>
adamstark@60 123 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
adamstark@60 124 <div class="textblock"><p>A class for calculating onset detection functions. </p>
adamstark@60 125 <dl class="section author"><dt>Author</dt><dd>Adam Stark </dd></dl>
adamstark@60 126 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl>
adamstark@60 127 <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>
adamstark@60 128 <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>
adamstark@60 129 <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>
adamstark@60 130 </div><h2 class="groupheader">Enumeration Type Documentation</h2>
adamstark@114 131 <a id="a36dbf81d14d771e0712d0316ec06612b" name="a36dbf81d14d771e0712d0316ec06612b"></a>
adamstark@114 132 <h2 class="memtitle"><span class="permalink"><a href="#a36dbf81d14d771e0712d0316ec06612b">&#9670;&#160;</a></span>OnsetDetectionFunctionType</h2>
adamstark@114 133
adamstark@60 134 <div class="memitem">
adamstark@60 135 <div class="memproto">
adamstark@60 136 <table class="memname">
adamstark@60 137 <tr>
adamstark@60 138 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td>
adamstark@60 139 </tr>
adamstark@60 140 </table>
adamstark@60 141 </div><div class="memdoc">
adamstark@60 142 <p>The type of onset detection function to calculate </p>
adamstark@60 143
adamstark@60 144 </div>
adamstark@60 145 </div>
adamstark@114 146 <a id="a476342970f954b62d70552bcbb5ee509" name="a476342970f954b62d70552bcbb5ee509"></a>
adamstark@114 147 <h2 class="memtitle"><span class="permalink"><a href="#a476342970f954b62d70552bcbb5ee509">&#9670;&#160;</a></span>WindowType</h2>
adamstark@114 148
adamstark@60 149 <div class="memitem">
adamstark@60 150 <div class="memproto">
adamstark@60 151 <table class="memname">
adamstark@60 152 <tr>
adamstark@60 153 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td>
adamstark@60 154 </tr>
adamstark@60 155 </table>
adamstark@60 156 </div><div class="memdoc">
adamstark@60 157 <p>The type of window to use when calculating onset detection function samples </p>
adamstark@60 158
adamstark@60 159 </div>
adamstark@60 160 </div>
adamstark@60 161 </div><!-- contents -->
adamstark@60 162 <!-- start footer part -->
adamstark@60 163 <hr class="footer"/><address class="footer"><small>
adamstark@114 164 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
adamstark@60 165 </small></address>
adamstark@60 166 </body>
adamstark@60 167 </html>