Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1Plugin_1_1Feature.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
rev   line source
Chris@1 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Chris@1 2 <html xmlns="http://www.w3.org/1999/xhtml">
Chris@1 3 <head>
Chris@1 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Chris@1 5 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title>
Chris@1 6
Chris@1 7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@1 8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 10 <script type="text/javascript" src="jquery.js"></script>
Chris@1 11 <script type="text/javascript" src="resize.js"></script>
Chris@1 12 <script type="text/javascript" src="navtree.js"></script>
Chris@1 13 <script type="text/javascript">
Chris@1 14 $(document).ready(initResizable);
Chris@1 15 </script>
Chris@1 16
Chris@1 17
Chris@1 18 </head>
Chris@1 19 <body>
Chris@1 20 <div id="top"><!-- do not remove this div! -->
Chris@1 21
Chris@1 22
Chris@1 23 <div id="titlearea">
Chris@1 24 <table cellspacing="0" cellpadding="0">
Chris@1 25 <tbody>
Chris@1 26 <tr style="height: 56px;">
Chris@1 27
Chris@1 28
Chris@1 29 <td style="padding-left: 0.5em;">
Chris@1 30 <div id="projectname">VampPluginSDK
Chris@1 31 &#160;<span id="projectnumber">2.1</span>
Chris@1 32 </div>
Chris@1 33
Chris@1 34 </td>
Chris@1 35
Chris@1 36
Chris@1 37
Chris@1 38 </tr>
Chris@1 39 </tbody>
Chris@1 40 </table>
Chris@1 41 </div>
Chris@1 42
Chris@1 43 <!-- Generated by Doxygen 1.7.5.1 -->
Chris@1 44 <div id="navrow1" class="tabs">
Chris@1 45 <ul class="tablist">
Chris@1 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
Chris@1 47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
Chris@1 48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
Chris@1 49 <li><a href="files.html"><span>Files</span></a></li>
Chris@1 50 <li><a href="dirs.html"><span>Directories</span></a></li>
Chris@1 51 </ul>
Chris@1 52 </div>
Chris@1 53 <div id="navrow2" class="tabs2">
Chris@1 54 <ul class="tablist">
Chris@1 55 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
Chris@1 56 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
Chris@1 57 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
Chris@1 58 </ul>
Chris@1 59 </div>
Chris@1 60 </div>
Chris@1 61 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 62 <div id="nav-tree">
Chris@1 63 <div id="nav-tree-contents">
Chris@1 64 </div>
Chris@1 65 </div>
Chris@1 66 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 67 class="ui-resizable-handle">
Chris@1 68 </div>
Chris@1 69 </div>
Chris@1 70 <script type="text/javascript">
Chris@1 71 initNavTree('structVamp_1_1Plugin_1_1Feature.html','');
Chris@1 72 </script>
Chris@1 73 <div id="doc-content">
Chris@1 74 <div class="header">
Chris@1 75 <div class="summary">
Chris@1 76 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@1 77 <a href="#pub-attribs">Public Attributes</a> </div>
Chris@1 78 <div class="headertitle">
Chris@1 79 <div class="title">Vamp::Plugin::Feature Struct Reference</div> </div>
Chris@1 80 </div>
Chris@1 81 <div class="contents">
Chris@1 82 <!-- doxytag: class="Vamp::Plugin::Feature" -->
Chris@1 83 <p><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>&gt;</code></p>
Chris@1 84
Chris@1 85 <p><a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a></p>
Chris@1 86 <table class="memberdecls">
Chris@1 87 <tr><td colspan="2"><h2><a name="pub-methods"></a>
Chris@1 88 Public Member Functions</h2></td></tr>
Chris@1 89 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a> ()</td></tr>
Chris@1 90 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
Chris@1 91 Public Attributes</h2></td></tr>
Chris@1 92 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr>
Chris@1 93 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#a98907091d0b6a589720ae35ae588a82b"></a><br/></td></tr>
Chris@1 94 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr>
Chris@1 95 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Timestamp of the output feature. <a href="#acaa605f36839c07e76f4882f5e22d8d7"></a><br/></td></tr>
Chris@1 96 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">hasDuration</a></td></tr>
Chris@1 97 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has a specified duration. <a href="#a33686757bd4481c72494122e9bfb9fba"></a><br/></td></tr>
Chris@1 98 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">duration</a></td></tr>
Chris@1 99 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration of the output feature. <a href="#af687c0a7fe041757e922ec296862b115"></a><br/></td></tr>
Chris@1 100 <tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr>
Chris@1 101 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#a60b9f3057386820dbcaec0eb1189ce71"></a><br/></td></tr>
Chris@1 102 <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr>
Chris@1 103 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Label for the sample of this feature. <a href="#a8eb1fb35f73b247ed13de9527c18f036"></a><br/></td></tr>
Chris@1 104 </table>
Chris@1 105 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
Chris@1 106 <div class="textblock">
Chris@1 107 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00336">336</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 108 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
Chris@1 109 <a class="anchor" id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="acd4b4cd0d2c31512f4a5df50f8f7a7b8" args="()" -->
Chris@1 110 <div class="memitem">
Chris@1 111 <div class="memproto">
Chris@1 112 <table class="memname">
Chris@1 113 <tr>
Chris@1 114 <td class="memname">Vamp::Plugin::Feature::Feature </td>
Chris@1 115 <td>(</td>
Chris@1 116 <td class="paramname"></td><td>)</td>
Chris@1 117 <td><code> [inline]</code></td>
Chris@1 118 </tr>
Chris@1 119 </table>
Chris@1 120 </div>
Chris@1 121 <div class="memdoc">
Chris@1 122
Chris@1 123 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00381">381</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 124
Chris@1 125 </div>
Chris@1 126 </div>
Chris@1 127 <hr/><h2>Member Data Documentation</h2>
Chris@1 128 <a class="anchor" id="a98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="a98907091d0b6a589720ae35ae588a82b" args="" -->
Chris@1 129 <div class="memitem">
Chris@1 130 <div class="memproto">
Chris@1 131 <table class="memname">
Chris@1 132 <tr>
Chris@1 133 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a></td>
Chris@1 134 </tr>
Chris@1 135 </table>
Chris@1 136 </div>
Chris@1 137 <div class="memdoc">
Chris@1 138
Chris@1 139 <p>True if an output feature has its own timestamp. </p>
Chris@1 140 <p>This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. </p>
Chris@1 141
Chris@1 142 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">344</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 143
Chris@1 144 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 145
Chris@1 146 </div>
Chris@1 147 </div>
Chris@1 148 <a class="anchor" id="acaa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="acaa605f36839c07e76f4882f5e22d8d7" args="" -->
Chris@1 149 <div class="memitem">
Chris@1 150 <div class="memproto">
Chris@1 151 <table class="memname">
Chris@1 152 <tr>
Chris@1 153 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">Vamp::Plugin::Feature::timestamp</a></td>
Chris@1 154 </tr>
Chris@1 155 </table>
Chris@1 156 </div>
Chris@1 157 <div class="memdoc">
Chris@1 158
Chris@1 159 <p>Timestamp of the output feature. </p>
Chris@1 160 <p>This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. </p>
Chris@1 161
Chris@1 162 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">352</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 163
Chris@1 164 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 165
Chris@1 166 </div>
Chris@1 167 </div>
Chris@1 168 <a class="anchor" id="a33686757bd4481c72494122e9bfb9fba"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="a33686757bd4481c72494122e9bfb9fba" args="" -->
Chris@1 169 <div class="memitem">
Chris@1 170 <div class="memproto">
Chris@1 171 <table class="memname">
Chris@1 172 <tr>
Chris@1 173 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a></td>
Chris@1 174 </tr>
Chris@1 175 </table>
Chris@1 176 </div>
Chris@1 177 <div class="memdoc">
Chris@1 178
Chris@1 179 <p>True if an output feature has a specified duration. </p>
Chris@1 180 <p>This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. </p>
Chris@1 181
Chris@1 182 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00360">360</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 183
Chris@1 184 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 185
Chris@1 186 </div>
Chris@1 187 </div>
Chris@1 188 <a class="anchor" id="af687c0a7fe041757e922ec296862b115"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="af687c0a7fe041757e922ec296862b115" args="" -->
Chris@1 189 <div class="memitem">
Chris@1 190 <div class="memproto">
Chris@1 191 <table class="memname">
Chris@1 192 <tr>
Chris@1 193 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">Vamp::Plugin::Feature::duration</a></td>
Chris@1 194 </tr>
Chris@1 195 </table>
Chris@1 196 </div>
Chris@1 197 <div class="memdoc">
Chris@1 198
Chris@1 199 <p>Duration of the output feature. </p>
Chris@1 200 <p>This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. </p>
Chris@1 201
Chris@1 202 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00367">367</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 203
Chris@1 204 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 205
Chris@1 206 </div>
Chris@1 207 </div>
Chris@1 208 <a class="anchor" id="a60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="a60b9f3057386820dbcaec0eb1189ce71" args="" -->
Chris@1 209 <div class="memitem">
Chris@1 210 <div class="memproto">
Chris@1 211 <table class="memname">
Chris@1 212 <tr>
Chris@1 213 <td class="memname">std::vector&lt;float&gt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a></td>
Chris@1 214 </tr>
Chris@1 215 </table>
Chris@1 216 </div>
Chris@1 217 <div class="memdoc">
Chris@1 218
Chris@1 219 <p>Results for a single sample of this feature. </p>
Chris@1 220 <p>If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. </p>
Chris@1 221
Chris@1 222 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00374">374</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 223
Chris@1 224 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 225
Chris@1 226 </div>
Chris@1 227 </div>
Chris@1 228 <a class="anchor" id="a8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="a8eb1fb35f73b247ed13de9527c18f036" args="" -->
Chris@1 229 <div class="memitem">
Chris@1 230 <div class="memproto">
Chris@1 231 <table class="memname">
Chris@1 232 <tr>
Chris@1 233 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">Vamp::Plugin::Feature::label</a></td>
Chris@1 234 </tr>
Chris@1 235 </table>
Chris@1 236 </div>
Chris@1 237 <div class="memdoc">
Chris@1 238
Chris@1 239 <p>Label for the sample of this feature. </p>
Chris@1 240
Chris@1 241 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00379">379</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 242
Chris@1 243 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 244
Chris@1 245 </div>
Chris@1 246 </div>
Chris@1 247 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 248 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li>
Chris@1 249 </ul>
Chris@1 250 </div>
Chris@1 251 </div>
Chris@1 252 <div id="nav-path" class="navpath">
Chris@1 253 <ul>
Chris@1 254 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
Chris@1 255 <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li>
Chris@1 256 <li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> </li>
Chris@1 257
Chris@1 258 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
Chris@1 259 <a href="http://www.doxygen.org/index.html">
Chris@1 260 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
Chris@1 261 </ul>
Chris@1 262 </div>
Chris@1 263
Chris@1 264
Chris@1 265 </body>
Chris@1 266 </html>