Mercurial > hg > vamp-docs

annotate code-docs/structVamp_1_1Plugin_1_1Feature.html @ 7:66d125fb8b42 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag vamp-plugin-sdk-v2.7 for changeset 27319718b1f8
author Chris Cannam
date Fri, 24 Feb 2017 16:45:00 +0000
parents 27319718b1f8
children
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@6 6 <meta name="generator" content="Doxygen 1.8.13"/>
Chris@6 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
Chris@1 8 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title>
Chris@1 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
Chris@6 10 <script type="text/javascript" src="jquery.js"></script>
Chris@6 11 <script type="text/javascript" src="dynsections.js"></script>
Chris@1 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
Chris@1 13 <script type="text/javascript" src="resize.js"></script>
Chris@6 14 <script type="text/javascript" src="navtreedata.js"></script>
Chris@1 15 <script type="text/javascript" src="navtree.js"></script>
Chris@1 16 <script type="text/javascript">
Chris@1 17 $(document).ready(initResizable);
Chris@1 18 </script>
Chris@6 19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
Chris@1 20 </head>
Chris@1 21 <body>
Chris@6 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
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@6 27 <td id="projectalign" style="padding-left: 0.5em;">
Chris@1 28 <div id="projectname">VampPluginSDK
Chris@6 29 &#160;<span id="projectnumber">2.7</span>
Chris@1 30 </div>
Chris@1 31 </td>
Chris@1 32 </tr>
Chris@1 33 </tbody>
Chris@1 34 </table>
Chris@1 35 </div>
Chris@6 36 <!-- end header part -->
Chris@6 37 <!-- Generated by Doxygen 1.8.13 -->
Chris@6 38 <script type="text/javascript" src="menudata.js"></script>
Chris@6 39 <script type="text/javascript" src="menu.js"></script>
Chris@6 40 <script type="text/javascript">
Chris@6 41 $(function() {
Chris@6 42 initMenu('',false,false,'search.php','Search');
Chris@6 43 });
Chris@6 44 </script>
Chris@6 45 <div id="main-nav"></div>
Chris@6 46 </div><!-- top -->
Chris@1 47 <div id="side-nav" class="ui-resizable side-nav-resizable">
Chris@1 48 <div id="nav-tree">
Chris@1 49 <div id="nav-tree-contents">
Chris@6 50 <div id="nav-sync" class="sync"></div>
Chris@1 51 </div>
Chris@1 52 </div>
Chris@1 53 <div id="splitbar" style="-moz-user-select:none;"
Chris@1 54 class="ui-resizable-handle">
Chris@1 55 </div>
Chris@1 56 </div>
Chris@1 57 <script type="text/javascript">
Chris@6 58 $(document).ready(function(){initNavTree('structVamp_1_1Plugin_1_1Feature.html','');});
Chris@1 59 </script>
Chris@1 60 <div id="doc-content">
Chris@1 61 <div class="header">
Chris@1 62 <div class="summary">
Chris@1 63 <a href="#pub-methods">Public Member Functions</a> &#124;
Chris@6 64 <a href="#pub-attribs">Public Attributes</a> &#124;
Chris@6 65 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members</a> </div>
Chris@1 66 <div class="headertitle">
Chris@1 67 <div class="title">Vamp::Plugin::Feature Struct Reference</div> </div>
Chris@3 68 </div><!--header-->
Chris@1 69 <div class="contents">
Chris@3 70
Chris@1 71 <p><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>&gt;</code></p>
Chris@1 72 <table class="memberdecls">
Chris@6 73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Chris@1 74 Public Member Functions</h2></td></tr>
Chris@3 75 <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@6 76 <tr class="separator:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@6 77 </table><table class="memberdecls">
Chris@6 78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Chris@1 79 Public Attributes</h2></td></tr>
Chris@3 80 <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@6 81 <tr class="memdesc:a98907091d0b6a589720ae35ae588a82b"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#a98907091d0b6a589720ae35ae588a82b">More...</a><br /></td></tr>
Chris@6 82 <tr class="separator:a98907091d0b6a589720ae35ae588a82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 83 <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@6 84 <tr class="memdesc:acaa605f36839c07e76f4882f5e22d8d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timestamp of the output feature. <a href="#acaa605f36839c07e76f4882f5e22d8d7">More...</a><br /></td></tr>
Chris@6 85 <tr class="separator:acaa605f36839c07e76f4882f5e22d8d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 86 <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@6 87 <tr class="memdesc:a33686757bd4481c72494122e9bfb9fba"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has a specified duration. <a href="#a33686757bd4481c72494122e9bfb9fba">More...</a><br /></td></tr>
Chris@6 88 <tr class="separator:a33686757bd4481c72494122e9bfb9fba"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 89 <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@6 90 <tr class="memdesc:af687c0a7fe041757e922ec296862b115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration of the output feature. <a href="#af687c0a7fe041757e922ec296862b115">More...</a><br /></td></tr>
Chris@6 91 <tr class="separator:af687c0a7fe041757e922ec296862b115"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 92 <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@6 93 <tr class="memdesc:a60b9f3057386820dbcaec0eb1189ce71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#a60b9f3057386820dbcaec0eb1189ce71">More...</a><br /></td></tr>
Chris@6 94 <tr class="separator:a60b9f3057386820dbcaec0eb1189ce71"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@3 95 <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@6 96 <tr class="memdesc:a8eb1fb35f73b247ed13de9527c18f036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Label for the sample of this feature. <a href="#a8eb1fb35f73b247ed13de9527c18f036">More...</a><br /></td></tr>
Chris@6 97 <tr class="separator:a8eb1fb35f73b247ed13de9527c18f036"><td class="memSeparator" colspan="2">&#160;</td></tr>
Chris@1 98 </table>
Chris@6 99 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Chris@1 100 <div class="textblock">
Chris@6 101 <p class="definition">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@6 102 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
Chris@6 103 <a id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a>
Chris@6 104 <h2 class="memtitle"><span class="permalink"><a href="#acd4b4cd0d2c31512f4a5df50f8f7a7b8">&#9670;&nbsp;</a></span>Feature()</h2>
Chris@6 105
Chris@6 106 <div class="memitem">
Chris@6 107 <div class="memproto">
Chris@6 108 <table class="mlabels">
Chris@6 109 <tr>
Chris@6 110 <td class="mlabels-left">
Chris@6 111 <table class="memname">
Chris@6 112 <tr>
Chris@6 113 <td class="memname">Vamp::Plugin::Feature::Feature </td>
Chris@6 114 <td>(</td>
Chris@6 115 <td class="paramname"></td><td>)</td>
Chris@6 116 <td></td>
Chris@6 117 </tr>
Chris@6 118 </table>
Chris@6 119 </td>
Chris@6 120 <td class="mlabels-right">
Chris@6 121 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
Chris@6 122 </tr>
Chris@6 123 </table>
Chris@6 124 </div><div class="memdoc">
Chris@6 125
Chris@6 126 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00389">389</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@6 127
Chris@6 128 </div>
Chris@6 129 </div>
Chris@6 130 <h2 class="groupheader">Member Data Documentation</h2>
Chris@6 131 <a id="a98907091d0b6a589720ae35ae588a82b"></a>
Chris@6 132 <h2 class="memtitle"><span class="permalink"><a href="#a98907091d0b6a589720ae35ae588a82b">&#9670;&nbsp;</a></span>hasTimestamp</h2>
Chris@6 133
Chris@1 134 <div class="memitem">
Chris@1 135 <div class="memproto">
Chris@1 136 <table class="memname">
Chris@1 137 <tr>
Chris@6 138 <td class="memname">bool Vamp::Plugin::Feature::hasTimestamp</td>
Chris@1 139 </tr>
Chris@1 140 </table>
Chris@6 141 </div><div class="memdoc">
Chris@1 142
Chris@6 143 <p>True if an output feature has its own timestamp. </p>
Chris@6 144 <p>This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. </p>
Chris@6 145
Chris@6 146 <p class="definition">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@6 147
Chris@6 148 <p class="reference">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#l00143">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 149
Chris@1 150 </div>
Chris@1 151 </div>
Chris@6 152 <a id="acaa605f36839c07e76f4882f5e22d8d7"></a>
Chris@6 153 <h2 class="memtitle"><span class="permalink"><a href="#acaa605f36839c07e76f4882f5e22d8d7">&#9670;&nbsp;</a></span>timestamp</h2>
Chris@6 154
Chris@1 155 <div class="memitem">
Chris@1 156 <div class="memproto">
Chris@1 157 <table class="memname">
Chris@1 158 <tr>
Chris@6 159 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Feature::timestamp</td>
Chris@1 160 </tr>
Chris@1 161 </table>
Chris@6 162 </div><div class="memdoc">
Chris@1 163
Chris@6 164 <p>Timestamp of the output feature. </p>
Chris@6 165 <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 166
Chris@6 167 <p class="definition">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 168
Chris@6 169 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 170
Chris@1 171 </div>
Chris@1 172 </div>
Chris@6 173 <a id="a33686757bd4481c72494122e9bfb9fba"></a>
Chris@6 174 <h2 class="memtitle"><span class="permalink"><a href="#a33686757bd4481c72494122e9bfb9fba">&#9670;&nbsp;</a></span>hasDuration</h2>
Chris@6 175
Chris@1 176 <div class="memitem">
Chris@1 177 <div class="memproto">
Chris@1 178 <table class="memname">
Chris@1 179 <tr>
Chris@6 180 <td class="memname">bool Vamp::Plugin::Feature::hasDuration</td>
Chris@1 181 </tr>
Chris@1 182 </table>
Chris@6 183 </div><div class="memdoc">
Chris@1 184
Chris@6 185 <p>True if an output feature has a specified duration. </p>
Chris@6 186 <p>This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. </p>
Chris@1 187
Chris@6 188 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00368">368</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 189
Chris@6 190 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 191
Chris@1 192 </div>
Chris@1 193 </div>
Chris@6 194 <a id="af687c0a7fe041757e922ec296862b115"></a>
Chris@6 195 <h2 class="memtitle"><span class="permalink"><a href="#af687c0a7fe041757e922ec296862b115">&#9670;&nbsp;</a></span>duration</h2>
Chris@6 196
Chris@1 197 <div class="memitem">
Chris@1 198 <div class="memproto">
Chris@1 199 <table class="memname">
Chris@1 200 <tr>
Chris@6 201 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Feature::duration</td>
Chris@1 202 </tr>
Chris@1 203 </table>
Chris@6 204 </div><div class="memdoc">
Chris@1 205
Chris@6 206 <p>Duration of the output feature. </p>
Chris@6 207 <p>This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. </p>
Chris@1 208
Chris@6 209 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00375">375</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 210
Chris@6 211 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 212
Chris@1 213 </div>
Chris@1 214 </div>
Chris@6 215 <a id="a60b9f3057386820dbcaec0eb1189ce71"></a>
Chris@6 216 <h2 class="memtitle"><span class="permalink"><a href="#a60b9f3057386820dbcaec0eb1189ce71">&#9670;&nbsp;</a></span>values</h2>
Chris@6 217
Chris@1 218 <div class="memitem">
Chris@1 219 <div class="memproto">
Chris@1 220 <table class="memname">
Chris@1 221 <tr>
Chris@6 222 <td class="memname">std::vector&lt;float&gt; Vamp::Plugin::Feature::values</td>
Chris@1 223 </tr>
Chris@1 224 </table>
Chris@6 225 </div><div class="memdoc">
Chris@1 226
Chris@6 227 <p>Results for a single sample of this feature. </p>
Chris@6 228 <p>If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. </p>
Chris@1 229
Chris@6 230 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 231
Chris@6 232 <p class="reference">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#l00143">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
Chris@1 233
Chris@1 234 </div>
Chris@1 235 </div>
Chris@6 236 <a id="a8eb1fb35f73b247ed13de9527c18f036"></a>
Chris@6 237 <h2 class="memtitle"><span class="permalink"><a href="#a8eb1fb35f73b247ed13de9527c18f036">&#9670;&nbsp;</a></span>label</h2>
Chris@6 238
Chris@1 239 <div class="memitem">
Chris@1 240 <div class="memproto">
Chris@1 241 <table class="memname">
Chris@1 242 <tr>
Chris@6 243 <td class="memname">std::string Vamp::Plugin::Feature::label</td>
Chris@1 244 </tr>
Chris@1 245 </table>
Chris@6 246 </div><div class="memdoc">
Chris@1 247
Chris@1 248 <p>Label for the sample of this feature. </p>
Chris@1 249
Chris@6 250 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
Chris@1 251
Chris@6 252 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
Chris@1 253
Chris@1 254 </div>
Chris@1 255 </div>
Chris@1 256 <hr/>The documentation for this struct was generated from the following file:<ul>
Chris@1 257 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li>
Chris@1 258 </ul>
Chris@3 259 </div><!-- contents -->
Chris@6 260 </div><!-- doc-content -->
Chris@6 261 <!-- start footer part -->
Chris@6 262 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Chris@6 263 <ul>
Chris@6 264 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a></li><li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a></li><li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a></li>
Chris@6 265 <li class="footer">Generated by
Chris@6 266 <a href="http://www.doxygen.org/index.html">
Chris@6 267 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Chris@6 268 </ul>
Chris@1 269 </div>
Chris@1 270 </body>
Chris@1 271 </html>