Mercurial > hg > btrack

comparison doc/html/functions.html @ 114:d6d9df2db3e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Adam Stark <adamstark.uk@gmail.com>
date Fri, 18 Aug 2023 10:48:26 +0200
parents ae3ec9b14092
children
comparison
equal deleted inserted replaced
113:1fb8df379f2d 114:d6d9df2db3e1
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"> 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3 <head> 3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
6 <meta name="generator" content="Doxygen 1.9.7"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
6 <title>BTrack - A Real-Time Beat Tracker: Class Members</title> 8 <title>BTrack - A Real-Time Beat Tracker: Class Members</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="jquery.js"></script> 10 <script type="text/javascript" src="jquery.js"></script>
9 <script type="text/javascript" src="dynsections.js"></script> 11 <script type="text/javascript" src="dynsections.js"></script>
10 <link href="search/search.css" rel="stylesheet" type="text/css"/> 12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
11 <script type="text/javascript" src="search/search.js"></script> 14 <script type="text/javascript" src="search/search.js"></script>
12 <script type="text/javascript">
13 $(document).ready(function() { searchBox.OnSelectItem(0); });
14 </script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head> 16 </head>
17 <body> 17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea"> 19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0"> 20 <table cellspacing="0" cellpadding="0">
21 <tbody> 21 <tbody>
22 <tr style="height: 56px;"> 22 <tr id="projectrow">
23 <td style="padding-left: 0.5em;"> 23 <td id="projectalign">
24 <div id="projectname">BTrack - A Real-Time Beat Tracker 24 <div id="projectname">BTrack - A Real-Time Beat Tracker
25 </div> 25 </div>
26 </td> 26 </td>
27 </tr> 27 </tr>
28 </tbody> 28 </tbody>
29 </table> 29 </table>
30 </div> 30 </div>
31 <!-- end header part --> 31 <!-- end header part -->
32 <!-- Generated by Doxygen 1.8.2 --> 32 <!-- Generated by Doxygen 1.9.7 -->
33 <script type="text/javascript"> 33 <script type="text/javascript">
34 var searchBox = new SearchBox("searchBox", "search",false,'Search'); 34 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35 var searchBox = new SearchBox("searchBox", "search/",'.html');
36 /* @license-end */
35 </script> 37 </script>
36 <div id="navrow1" class="tabs"> 38 <script type="text/javascript" src="menudata.js"></script>
37 <ul class="tablist"> 39 <script type="text/javascript" src="menu.js"></script>
38 <li><a href="index.html"><span>Main&#160;Page</span></a></li> 40 <script type="text/javascript">
39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
40 <li><a href="files.html"><span>Files</span></a></li> 42 $(function() {
41 <li> 43 initMenu('',true,false,'search.php','Search');
42 <div id="MSearchBox" class="MSearchBoxInactive"> 44 $(document).ready(function() { init_search(); });
43 <span class="left"> 45 });
44 <img id="MSearchSelect" src="search/mag_sel.png" 46 /* @license-end */
45 onmouseover="return searchBox.OnSearchSelectShow()" 47 </script>
46 onmouseout="return searchBox.OnSearchSelectHide()" 48 <div id="main-nav"></div>
47 alt=""/>
48 <input type="text" id="MSearchField" value="Search" accesskey="S"
49 onfocus="searchBox.OnSearchFieldFocus(true)"
50 onblur="searchBox.OnSearchFieldFocus(false)"
51 onkeyup="searchBox.OnSearchFieldChange(event)"/>
52 </span><span class="right">
53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
54 </span>
55 </div>
56 </li>
57 </ul>
58 </div>
59 <div id="navrow2" class="tabs2">
60 <ul class="tablist">
61 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
62 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
63 <li class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
64 </ul>
65 </div>
66 <div id="navrow3" class="tabs2">
67 <ul class="tablist">
68 <li class="current"><a href="functions.html"><span>All</span></a></li>
69 <li><a href="functions_func.html"><span>Functions</span></a></li>
70 </ul>
71 </div>
72 </div><!-- top --> 49 </div><!-- top -->
73 <!-- window showing the filter options --> 50 <!-- window showing the filter options -->
74 <div id="MSearchSelectWindow" 51 <div id="MSearchSelectWindow"
75 onmouseover="return searchBox.OnSearchSelectShow()" 52 onmouseover="return searchBox.OnSearchSelectShow()"
76 onmouseout="return searchBox.OnSearchSelectHide()" 53 onmouseout="return searchBox.OnSearchSelectHide()"
77 onkeydown="return searchBox.OnSearchSelectKey(event)"> 54 onkeydown="return searchBox.OnSearchSelectKey(event)">
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> 55 </div>
79 56
80 <!-- iframe showing the search results (closed by default) --> 57 <!-- iframe showing the search results (closed by default) -->
81 <div id="MSearchResultsWindow"> 58 <div id="MSearchResultsWindow">
82 <iframe src="javascript:void(0)" frameborder="0" 59 <div id="MSearchResults">
83 name="MSearchResults" id="MSearchResults"> 60 <div class="SRPage">
84 </iframe> 61 <div id="SRIndex">
62 <div id="SRResults"></div>
63 <div class="SRStatus" id="Loading">Loading...</div>
64 <div class="SRStatus" id="Searching">Searching...</div>
65 <div class="SRStatus" id="NoMatches">No Matches</div>
66 </div>
67 </div>
68 </div>
85 </div> 69 </div>
86 70
87 <div class="contents"> 71 <div class="contents">
88 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul> 72 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul>
89 <li>beatDueInCurrentFrame() 73 <li>addSampleToEnd()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">CircularBuffer</a></li>
90 : <a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a> 74 <li>beatDueInCurrentFrame()&#160;:&#160;<a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a></li>
91 </li> 75 <li>BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a></li>
92 <li>BTrack() 76 <li>calculateOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a></li>
93 : <a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> 77 <li>CircularBuffer()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer</a></li>
94 </li> 78 <li>doNotFixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a></li>
95 <li>calculateOnsetDetectionFunctionSample() 79 <li>fixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a></li>
96 : <a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a> 80 <li>getBeatTimeInSeconds()&#160;:&#160;<a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a></li>
97 </li> 81 <li>getCurrentTempoEstimate()&#160;:&#160;<a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a></li>
98 <li>doNotFixTempo() 82 <li>getHopSize()&#160;:&#160;<a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a></li>
99 : <a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a> 83 <li>getLatestCumulativeScoreValue()&#160;:&#160;<a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a></li>
100 </li> 84 <li>initialise()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a527d4f433d4f7bcd098b54190ee89297">OnsetDetectionFunction</a></li>
101 <li>fixTempo() 85 <li>OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a507e6258c5e703c989a6a58d2d8f4dcb">OnsetDetectionFunction</a></li>
102 : <a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a> 86 <li>operator[]()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">CircularBuffer</a></li>
103 </li> 87 <li>processAudioFrame()&#160;:&#160;<a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a></li>
104 <li>getBeatTimeInSeconds() 88 <li>processOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a></li>
105 : <a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a> 89 <li>resize()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">CircularBuffer</a></li>
106 </li> 90 <li>setOnsetDetectionFunctionType()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#ac607feee669f3d3f4015662eec717f6a">OnsetDetectionFunction</a></li>
107 <li>getCurrentTempoEstimate() 91 <li>setTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a></li>
108 : <a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a> 92 <li>size()&#160;:&#160;<a class="el" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">CircularBuffer</a></li>
109 </li> 93 <li>updateHopAndFrameSize()&#160;:&#160;<a class="el" href="class_b_track.html#adda9c1b3a9e3fc02accfacc9d144e33d">BTrack</a></li>
110 <li>getHopSize() 94 <li>~BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a386413d90e57d0a2cf7f18413338bbaf">BTrack</a></li>
111 : <a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a> 95 <li>~OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a></li>
112 </li>
113 <li>getLatestCumulativeScoreValue()
114 : <a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a>
115 </li>
116 <li>initialise()
117 : <a class="el" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">OnsetDetectionFunction</a>
118 </li>
119 <li>OnsetDetectionFunction()
120 : <a class="el" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a>
121 </li>
122 <li>processAudioFrame()
123 : <a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a>
124 </li>
125 <li>processOnsetDetectionFunctionSample()
126 : <a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a>
127 </li>
128 <li>setOnsetDetectionFunctionType()
129 : <a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">OnsetDetectionFunction</a>
130 </li>
131 <li>setTempo()
132 : <a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a>
133 </li>
134 <li>updateHopAndFrameSize()
135 : <a class="el" href="class_b_track.html#a70244e9a5aa8f860533fa56f942b7ede">BTrack</a>
136 </li>
137 <li>~OnsetDetectionFunction()
138 : <a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a>
139 </li>
140 </ul> 96 </ul>
141 </div><!-- contents --> 97 </div><!-- contents -->
142 <!-- start footer part --> 98 <!-- start footer part -->
143 <hr class="footer"/><address class="footer"><small> 99 <hr class="footer"/><address class="footer"><small>
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"> 100 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
145 <img class="footer" src="doxygen.png" alt="doxygen"/>
146 </a> 1.8.2
147 </small></address> 101 </small></address>
148 </body> 102 </body>
149 </html> 103 </html>