annotate doc/html/functions_func.html @ 67:ae3ec9b14092

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 Stark <adamstark@users.noreply.github.com>
date Tue, 28 Jan 2014 01:07:44 +0000
parents 105999275c2e
children d6d9df2db3e1
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: Class Members - Functions</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
adamstark@60 40 <li><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="annotated.html"><span>Class&#160;List</span></a></li>
adamstark@60 62 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
adamstark@60 63 <li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
adamstark@60 64 </ul>
adamstark@60 65 </div>
adamstark@60 66 <div id="navrow3" class="tabs2">
adamstark@60 67 <ul class="tablist">
adamstark@60 68 <li><a href="functions.html"><span>All</span></a></li>
adamstark@60 69 <li class="current"><a href="functions_func.html"><span>Functions</span></a></li>
adamstark@60 70 </ul>
adamstark@60 71 </div>
adamstark@60 72 </div><!-- top -->
adamstark@60 73 <!-- window showing the filter options -->
adamstark@60 74 <div id="MSearchSelectWindow"
adamstark@60 75 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 76 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 77 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@61 78 <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@60 79
adamstark@60 80 <!-- iframe showing the search results (closed by default) -->
adamstark@60 81 <div id="MSearchResultsWindow">
adamstark@60 82 <iframe src="javascript:void(0)" frameborder="0"
adamstark@60 83 name="MSearchResults" id="MSearchResults">
adamstark@60 84 </iframe>
adamstark@60 85 </div>
adamstark@60 86
adamstark@60 87 <div class="contents">
adamstark@60 88 &#160;<ul>
adamstark@60 89 <li>beatDueInCurrentFrame()
adamstark@60 90 : <a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a>
adamstark@60 91 </li>
adamstark@60 92 <li>BTrack()
adamstark@60 93 : <a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a>
adamstark@60 94 </li>
adamstark@60 95 <li>calculateOnsetDetectionFunctionSample()
adamstark@60 96 : <a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a>
adamstark@60 97 </li>
adamstark@60 98 <li>doNotFixTempo()
adamstark@60 99 : <a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a>
adamstark@60 100 </li>
adamstark@60 101 <li>fixTempo()
adamstark@60 102 : <a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a>
adamstark@60 103 </li>
adamstark@60 104 <li>getBeatTimeInSeconds()
adamstark@60 105 : <a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a>
adamstark@60 106 </li>
adamstark@60 107 <li>getCurrentTempoEstimate()
adamstark@60 108 : <a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a>
adamstark@60 109 </li>
adamstark@60 110 <li>getHopSize()
adamstark@60 111 : <a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a>
adamstark@60 112 </li>
adamstark@60 113 <li>getLatestCumulativeScoreValue()
adamstark@60 114 : <a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a>
adamstark@60 115 </li>
adamstark@60 116 <li>initialise()
adamstark@67 117 : <a class="el" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">OnsetDetectionFunction</a>
adamstark@60 118 </li>
adamstark@60 119 <li>OnsetDetectionFunction()
adamstark@67 120 : <a class="el" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a>
adamstark@60 121 </li>
adamstark@60 122 <li>processAudioFrame()
adamstark@60 123 : <a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a>
adamstark@60 124 </li>
adamstark@60 125 <li>processOnsetDetectionFunctionSample()
adamstark@60 126 : <a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a>
adamstark@60 127 </li>
adamstark@60 128 <li>setOnsetDetectionFunctionType()
adamstark@60 129 : <a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">OnsetDetectionFunction</a>
adamstark@60 130 </li>
adamstark@60 131 <li>setTempo()
adamstark@60 132 : <a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a>
adamstark@60 133 </li>
adamstark@65 134 <li>updateHopAndFrameSize()
adamstark@65 135 : <a class="el" href="class_b_track.html#a70244e9a5aa8f860533fa56f942b7ede">BTrack</a>
adamstark@65 136 </li>
adamstark@60 137 <li>~OnsetDetectionFunction()
adamstark@60 138 : <a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a>
adamstark@60 139 </li>
adamstark@60 140 </ul>
adamstark@60 141 </div><!-- contents -->
adamstark@60 142 <!-- start footer part -->
adamstark@60 143 <hr class="footer"/><address class="footer"><small>
adamstark@67 144 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@60 145 <img class="footer" src="doxygen.png" alt="doxygen"/>
adamstark@60 146 </a> 1.8.2
adamstark@60 147 </small></address>
adamstark@60 148 </body>
adamstark@60 149 </html>