Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1Plugin_1_1Feature.html @ 128:817c3988afc7 website tip

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