Mercurial > hg > btrack

annotate doc/html/_onset_detection_function_8h.html @ 30:687b8dd41934 develop

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