Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1Plugin_1_1Feature.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

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