Mercurial > hg > btrack
diff doc/html/_onset_detection_function_8h.html @ 60:bf256abf1dd4
Did more commenting. Added documentation.
| author | Adam Stark <adamstark@users.noreply.github.com> |
|---|---|
| date | Sat, 25 Jan 2014 18:17:51 +0000 |
| parents | |
| children | deb49a2590f3 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/_onset_detection_function_8h.html Sat Jan 25 18:17:51 2014 +0000 @@ -0,0 +1,175 @@ +<!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"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<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/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> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">BTrack - A Real-Time Beat Tracker + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.2 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</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> +<!-- 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></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> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <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><!--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/> +</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> +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> +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/> + }</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/> +  <b>TukeyWindow</b> +<br/> + }</td></tr> +<tr class="separator:a476342970f954b62d70552bcbb5ee509"><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> +<dl class="section author"><dt>Author</dt><dd>Adam Stark </dd></dl> +<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl> +<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> +<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> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>The type of onset detection function to calculate </p> + +</div> +</div> +<a class="anchor" id="a476342970f954b62d70552bcbb5ee509"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td> + </tr> + </table> +</div><div class="memdoc"> +<p>The type of window to use when calculating onset detection function samples </p> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Sat Jan 25 2014 18:11:17 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 +</small></address> +</body> +</html>