Mercurial > hg > btrack

annotate doc/html/_onset_detection_function_8h.html @ 60:bf256abf1dd4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
rev   line source
adamstark@60 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@60 2 <html xmlns="http://www.w3.org/1999/xhtml">
adamstark@60 3 <head>
adamstark@60 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@60 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
adamstark@60 6 <title>BTrack - A Real-Time Beat Tracker: src/OnsetDetectionFunction.h File Reference</title>
adamstark@60 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@60 8 <script type="text/javascript" src="jquery.js"></script>
adamstark@60 9 <script type="text/javascript" src="dynsections.js"></script>
adamstark@60 10 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@60 11 <script type="text/javascript" src="search/search.js"></script>
adamstark@60 12 <script type="text/javascript">
adamstark@60 13 $(document).ready(function() { searchBox.OnSelectItem(0); });
adamstark@60 14 </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@60 22 <tr style="height: 56px;">
adamstark@60 23 <td style="padding-left: 0.5em;">
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@60 32 <!-- Generated by Doxygen 1.8.2 -->
adamstark@60 33 <script type="text/javascript">
adamstark@60 34 var searchBox = new SearchBox("searchBox", "search",false,'Search');
adamstark@60 35 </script>
adamstark@60 36 <div id="navrow1" class="tabs">
adamstark@60 37 <ul class="tablist">
adamstark@60 38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
adamstark@60 39 <li><a href="annotated.html"><span>Classes</span></a></li>
adamstark@60 40 <li class="current"><a href="files.html"><span>Files</span></a></li>
adamstark@60 41 <li>
adamstark@60 42 <div id="MSearchBox" class="MSearchBoxInactive">
adamstark@60 43 <span class="left">
adamstark@60 44 <img id="MSearchSelect" src="search/mag_sel.png"
adamstark@60 45 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 46 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 47 alt=""/>
adamstark@60 48 <input type="text" id="MSearchField" value="Search" accesskey="S"
adamstark@60 49 onfocus="searchBox.OnSearchFieldFocus(true)"
adamstark@60 50 onblur="searchBox.OnSearchFieldFocus(false)"
adamstark@60 51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
adamstark@60 52 </span><span class="right">
adamstark@60 53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
adamstark@60 54 </span>
adamstark@60 55 </div>
adamstark@60 56 </li>
adamstark@60 57 </ul>
adamstark@60 58 </div>
adamstark@60 59 <div id="navrow2" class="tabs2">
adamstark@60 60 <ul class="tablist">
adamstark@60 61 <li><a href="files.html"><span>File&#160;List</span></a></li>
adamstark@60 62 <li><a href="globals.html"><span>File&#160;Members</span></a></li>
adamstark@60 63 </ul>
adamstark@60 64 </div>
adamstark@60 65 <!-- window showing the filter options -->
adamstark@60 66 <div id="MSearchSelectWindow"
adamstark@60 67 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 68 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 69 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@60 70 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a></div>
adamstark@60 71
adamstark@60 72 <!-- iframe showing the search results (closed by default) -->
adamstark@60 73 <div id="MSearchResultsWindow">
adamstark@60 74 <iframe src="javascript:void(0)" frameborder="0"
adamstark@60 75 name="MSearchResults" id="MSearchResults">
adamstark@60 76 </iframe>
adamstark@60 77 </div>
adamstark@60 78
adamstark@60 79 <div id="nav-path" class="navpath">
adamstark@60 80 <ul>
adamstark@60 81 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
adamstark@60 82 </div>
adamstark@60 83 </div><!-- top -->
adamstark@60 84 <div class="header">
adamstark@60 85 <div class="summary">
adamstark@60 86 <a href="#nested-classes">Classes</a> &#124;
adamstark@60 87 <a href="#enum-members">Enumerations</a> </div>
adamstark@60 88 <div class="headertitle">
adamstark@60 89 <div class="title">OnsetDetectionFunction.h File Reference</div> </div>
adamstark@60 90 </div><!--header-->
adamstark@60 91 <div class="contents">
adamstark@60 92
adamstark@60 93 <p>A class for calculating onset detection functions.
adamstark@60 94 <a href="#details">More...</a></p>
adamstark@60 95 <div class="textblock"><code>#include &quot;fftw3.h&quot;</code><br/>
adamstark@60 96 </div>
adamstark@60 97 <p><a href="_onset_detection_function_8h_source.html">Go to the source code of this file.</a></p>
adamstark@60 98 <table class="memberdecls">
adamstark@60 99 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
adamstark@60 100 Classes</h2></td></tr>
adamstark@60 101 <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 102 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 103 </table><table class="memberdecls">
adamstark@60 104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
adamstark@60 105 Enumerations</h2></td></tr>
adamstark@60 106 <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@60 107 &#160;&#160;<b>EnergyEnvelope</b>,
adamstark@60 108 <b>EnergyDifference</b>,
adamstark@60 109 <b>SpectralDifference</b>,
adamstark@60 110 <b>SpectralDifferenceHWR</b>,
adamstark@60 111 <br/>
adamstark@60 112 &#160;&#160;<b>PhaseDeviation</b>,
adamstark@60 113 <b>ComplexSpectralDifference</b>,
adamstark@60 114 <b>ComplexSpectralDifferenceHWR</b>,
adamstark@60 115 <b>HighFrequencyContent</b>,
adamstark@60 116 <br/>
adamstark@60 117 &#160;&#160;<b>HighFrequencySpectralDifference</b>,
adamstark@60 118 <b>HighFrequencySpectralDifferenceHWR</b>
adamstark@60 119 <br/>
adamstark@60 120 }</td></tr>
adamstark@60 121 <tr class="separator:a36dbf81d14d771e0712d0316ec06612b"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 122 <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@60 123 &#160;&#160;<b>RectangularWindow</b>,
adamstark@60 124 <b>HanningWindow</b>,
adamstark@60 125 <b>HammingWindow</b>,
adamstark@60 126 <b>BlackmanWindow</b>,
adamstark@60 127 <br/>
adamstark@60 128 &#160;&#160;<b>TukeyWindow</b>
adamstark@60 129 <br/>
adamstark@60 130 }</td></tr>
adamstark@60 131 <tr class="separator:a476342970f954b62d70552bcbb5ee509"><td class="memSeparator" colspan="2">&#160;</td></tr>
adamstark@60 132 </table>
adamstark@60 133 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
adamstark@60 134 <div class="textblock"><p>A class for calculating onset detection functions. </p>
adamstark@60 135 <dl class="section author"><dt>Author</dt><dd>Adam Stark </dd></dl>
adamstark@60 136 <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 2008-2014 Queen Mary University of London</dd></dl>
adamstark@60 137 <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 138 <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 139 <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 140 </div><h2 class="groupheader">Enumeration Type Documentation</h2>
adamstark@60 141 <a class="anchor" id="a36dbf81d14d771e0712d0316ec06612b"></a>
adamstark@60 142 <div class="memitem">
adamstark@60 143 <div class="memproto">
adamstark@60 144 <table class="memname">
adamstark@60 145 <tr>
adamstark@60 146 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a36dbf81d14d771e0712d0316ec06612b">OnsetDetectionFunctionType</a></td>
adamstark@60 147 </tr>
adamstark@60 148 </table>
adamstark@60 149 </div><div class="memdoc">
adamstark@60 150 <p>The type of onset detection function to calculate </p>
adamstark@60 151
adamstark@60 152 </div>
adamstark@60 153 </div>
adamstark@60 154 <a class="anchor" id="a476342970f954b62d70552bcbb5ee509"></a>
adamstark@60 155 <div class="memitem">
adamstark@60 156 <div class="memproto">
adamstark@60 157 <table class="memname">
adamstark@60 158 <tr>
adamstark@60 159 <td class="memname">enum <a class="el" href="_onset_detection_function_8h.html#a476342970f954b62d70552bcbb5ee509">WindowType</a></td>
adamstark@60 160 </tr>
adamstark@60 161 </table>
adamstark@60 162 </div><div class="memdoc">
adamstark@60 163 <p>The type of window to use when calculating onset detection function samples </p>
adamstark@60 164
adamstark@60 165 </div>
adamstark@60 166 </div>
adamstark@60 167 </div><!-- contents -->
adamstark@60 168 <!-- start footer part -->
adamstark@60 169 <hr class="footer"/><address class="footer"><small>
adamstark@60 170 Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by &#160;<a href="http://www.doxygen.org/index.html">
adamstark@60 171 <img class="footer" src="doxygen.png" alt="doxygen"/>
adamstark@60 172 </a> 1.8.2
adamstark@60 173 </small></address>
adamstark@60 174 </body>
adamstark@60 175 </html>