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

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: File List</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 class="current"><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 </div><!-- top -->
adamstark@23 66 <!-- window showing the filter options -->
adamstark@23 67 <div id="MSearchSelectWindow"
adamstark@23 68 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@23 69 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@23 70 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@24 71 <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 72
adamstark@23 73 <!-- iframe showing the search results (closed by default) -->
adamstark@23 74 <div id="MSearchResultsWindow">
adamstark@23 75 <iframe src="javascript:void(0)" frameborder="0"
adamstark@23 76 name="MSearchResults" id="MSearchResults">
adamstark@23 77 </iframe>
adamstark@23 78 </div>
adamstark@23 79
adamstark@23 80 <div class="header">
adamstark@23 81 <div class="headertitle">
adamstark@23 82 <div class="title">File List</div> </div>
adamstark@23 83 </div><!--header-->
adamstark@23 84 <div class="contents">
adamstark@23 85 <div class="textblock">Here is a list of all documented files with brief descriptions:</div><div class="directory">
adamstark@23 86 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
adamstark@23 87 <tr id="row_0_" class="even"><td class="entry"><img id="arr_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('0_')"/><img id="img_0_" src="ftv2folderopen.png" alt="-" width="24" height="22" onclick="toggleFolder('0_')"/><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html" target="_self">src</a></td><td class="desc"></td></tr>
adamstark@23 88 <tr id="row_0_0_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="_b_track_8cpp.html" target="_self">BTrack.cpp</a></td><td class="desc"><a class="el" href="class_b_track.html">BTrack</a> - a real-time beat tracker</td></tr>
adamstark@23 89 <tr id="row_0_1_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a href="_b_track_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="_b_track_8h.html" target="_self">BTrack.h</a></td><td class="desc"><a class="el" href="class_b_track.html">BTrack</a> - a real-time beat tracker</td></tr>
adamstark@23 90 <tr id="row_0_2_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2doc.png" alt="*" width="24" height="22" /><a class="el" href="_onset_detection_function_8cpp.html" target="_self">OnsetDetectionFunction.cpp</a></td><td class="desc">A class for calculating onset detection functions</td></tr>
adamstark@23 91 <tr id="row_0_3_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a href="_onset_detection_function_8h_source.html"><img src="ftv2doc.png" alt="*" width="24" height="22" /></a><a class="el" href="_onset_detection_function_8h.html" target="_self">OnsetDetectionFunction.h</a></td><td class="desc">A class for calculating onset detection functions</td></tr>
adamstark@23 92 </table>
adamstark@23 93 </div><!-- directory -->
adamstark@23 94 </div><!-- contents -->
adamstark@23 95 <!-- start footer part -->
adamstark@23 96 <hr class="footer"/><address class="footer"><small>
adamstark@30 97 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 98 <img class="footer" src="doxygen.png" alt="doxygen"/>
adamstark@23 99 </a> 1.8.2
adamstark@23 100 </small></address>
adamstark@23 101 </body>
adamstark@23 102 </html>