Mercurial > hg > btrack
diff doc/html/_onset_detection_function_8h.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/_onset_detection_function_8h.html Fri Aug 18 10:44:50 2023 +0200 +++ b/doc/html/_onset_detection_function_8h.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: src/OnsetDetectionFunction.h File 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,51 +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><a href="annotated.html"><span>Classes</span></a></li> - <li class="current"><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="files.html"><span>File List</span></a></li> - <li><a href="globals.html"><span>File 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 id="nav-path" class="navpath"> @@ -85,49 +76,47 @@ <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#enum-members">Enumerations</a> </div> - <div class="headertitle"> -<div class="title">OnsetDetectionFunction.h File Reference</div> </div> + <div class="headertitle"><div class="title">OnsetDetectionFunction.h File Reference</div></div> </div><!--header--> <div class="contents"> <p>A class for calculating onset detection functions. <a href="#details">More...</a></p> -<div class="textblock"><code>#include "fftw3.h"</code><br/> -<code>#include <vector></code><br/> +<div class="textblock"><code>#include <vector></code><br /> </div> <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_onset_detection_function.html">OnsetDetectionFunction</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> Enumerations</h2></td></tr> -<tr class="memitem:a36dbf81d14d771e0712d0316ec06612b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a> { <br/> -  <b>EnergyEnvelope</b>, -<b>EnergyDifference</b>, -<b>SpectralDifference</b>, -<b>SpectralDifferenceHWR</b>, -<br/> -  <b>PhaseDeviation</b>, -<b>ComplexSpectralDifference</b>, -<b>ComplexSpectralDifferenceHWR</b>, -<b>HighFrequencyContent</b>, -<br/> -  <b>HighFrequencySpectralDifference</b>, -<b>HighFrequencySpectralDifferenceHWR</b> -<br/> +<tr class="memitem:a36dbf81d14d771e0712d0316ec06612b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a> { <br /> +  <b>EnergyEnvelope</b> +, <b>EnergyDifference</b> +, <b>SpectralDifference</b> +, <b>SpectralDifferenceHWR</b> +, <br /> +  <b>PhaseDeviation</b> +, <b>ComplexSpectralDifference</b> +, <b>ComplexSpectralDifferenceHWR</b> +, <b>HighFrequencyContent</b> +, <br /> +  <b>HighFrequencySpectralDifference</b> +, <b>HighFrequencySpectralDifferenceHWR</b> +<br /> }</td></tr> <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a476342970f954b62d70552bcbb5ee509"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a> { <br/> -  <b>RectangularWindow</b>, -<b>HanningWindow</b>, -<b>HammingWindow</b>, -<b>BlackmanWindow</b>, -<br/> +<tr class="memitem:a476342970f954b62d70552bcbb5ee509"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a> { <br /> +  <b>RectangularWindow</b> +, <b>HanningWindow</b> +, <b>HammingWindow</b> +, <b>BlackmanWindow</b> +, <br />   <b>TukeyWindow</b> -<br/> +<br /> }</td></tr> <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2"> </td></tr> </table> @@ -139,7 +128,9 @@ <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> <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> </div><h2 class="groupheader">Enumeration Type Documentation</h2> -<a class="anchor" id="a36dbf81d14d771e0712d0316ec06612b"></a> +<a id="a36dbf81d14d771e0712d0316ec06612b" name="a36dbf81d14d771e0712d0316ec06612b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a36dbf81d14d771e0712d0316ec06612b">◆ </a></span>OnsetDetectionFunctionType</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -152,7 +143,9 @@ </div> </div> -<a class="anchor" id="a476342970f954b62d70552bcbb5ee509"></a> +<a id="a476342970f954b62d70552bcbb5ee509" name="a476342970f954b62d70552bcbb5ee509"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a476342970f954b62d70552bcbb5ee509">◆ </a></span>WindowType</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -168,9 +161,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>