Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1Plugin_1_1Feature.html @ 39:01f34bbd799b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Add VamPy page
author cannam
date Mon, 12 Oct 2009 16:16:52 +0000
parents 0976232e353b
children 8260c0f4e05b
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@35 3 <title>VampPluginSDK: Vamp::Plugin::Plugin::Feature Struct Reference</title>
cannam@35 4 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@35 7 <!-- Generated by Doxygen 1.5.8 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1Plugin.html">Plugin</a>::<a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::Plugin::Plugin::Feature Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::Feature" --><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h-source.html">Plugin.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@35 33 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 34 <tr><td></td></tr>
cannam@21 35 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@35 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#3cd6cae91305ae8bcbd6248954a460f8">Feature</a> ()</td></tr>
cannam@21 37
cannam@0 38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@35 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#116bb1b3420a067fc1290b75982fdf62">hasTimestamp</a></td></tr>
cannam@0 40
cannam@35 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#116bb1b3420a067fc1290b75982fdf62"></a><br></td></tr>
cannam@35 42 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#aaf212bd458dc5e6f441bf7606121311">timestamp</a></td></tr>
cannam@0 43
cannam@35 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timestamp of the output feature. <a href="#aaf212bd458dc5e6f441bf7606121311"></a><br></td></tr>
cannam@35 45 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#2a962f4b26d6417ad1b72ae29949332e">hasDuration</a></td></tr>
cannam@21 46
cannam@35 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has a specified duration. <a href="#2a962f4b26d6417ad1b72ae29949332e"></a><br></td></tr>
cannam@35 48 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#f09e2624341f81c8f1f9c2d9137b4230">duration</a></td></tr>
cannam@21 49
cannam@35 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Duration of the output feature. <a href="#f09e2624341f81c8f1f9c2d9137b4230"></a><br></td></tr>
cannam@35 51 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#106162977cdc92a02146fcb5ed18a34d">values</a></td></tr>
cannam@0 52
cannam@35 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#106162977cdc92a02146fcb5ed18a34d"></a><br></td></tr>
cannam@35 54 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#14ff2ab7442f508fc3bd3d96c3e85eb5">label</a></td></tr>
cannam@0 55
cannam@35 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Label for the sample of this feature. <a href="#14ff2ab7442f508fc3bd3d96c3e85eb5"></a><br></td></tr>
cannam@0 57 </table>
cannam@35 58 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 59
cannam@35 60 <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@21 61 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@35 62 <a class="anchor" name="3cd6cae91305ae8bcbd6248954a460f8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="3cd6cae91305ae8bcbd6248954a460f8" args="()" -->
cannam@21 63 <div class="memitem">
cannam@21 64 <div class="memproto">
cannam@21 65 <table class="memname">
cannam@21 66 <tr>
cannam@35 67 <td class="memname">Vamp::Plugin::Plugin::Feature::Feature </td>
cannam@21 68 <td>(</td>
cannam@21 69 <td class="paramname"> </td>
cannam@21 70 <td>&nbsp;)&nbsp;</td>
cannam@21 71 <td><code> [inline]</code></td>
cannam@21 72 </tr>
cannam@21 73 </table>
cannam@21 74 </div>
cannam@21 75 <div class="memdoc">
cannam@21 76
cannam@21 77 <p>
cannam@21 78
cannam@35 79 <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 80
cannam@21 81 </div>
cannam@21 82 </div><p>
cannam@0 83 <hr><h2>Member Data Documentation</h2>
cannam@35 84 <a class="anchor" name="116bb1b3420a067fc1290b75982fdf62"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="116bb1b3420a067fc1290b75982fdf62" args="" -->
cannam@0 85 <div class="memitem">
cannam@0 86 <div class="memproto">
cannam@0 87 <table class="memname">
cannam@0 88 <tr>
cannam@35 89 <td class="memname">bool Vamp::Plugin::Plugin::Feature::hasTimestamp </td>
cannam@0 90 </tr>
cannam@0 91 </table>
cannam@0 92 </div>
cannam@0 93 <div class="memdoc">
cannam@0 94
cannam@0 95 <p>
cannam@0 96 True if an output feature has its own timestamp.
cannam@0 97 <p>
cannam@21 98 This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep.
cannam@35 99 <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@0 100
cannam@35 101 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">AmplitudeFollower::process()</a>.</p>
cannam@0 102
cannam@0 103 </div>
cannam@0 104 </div><p>
cannam@35 105 <a class="anchor" name="aaf212bd458dc5e6f441bf7606121311"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="aaf212bd458dc5e6f441bf7606121311" args="" -->
cannam@0 106 <div class="memitem">
cannam@0 107 <div class="memproto">
cannam@0 108 <table class="memname">
cannam@0 109 <tr>
cannam@35 110 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Plugin::Feature::timestamp </td>
cannam@0 111 </tr>
cannam@0 112 </table>
cannam@0 113 </div>
cannam@0 114 <div class="memdoc">
cannam@0 115
cannam@0 116 <p>
cannam@0 117 Timestamp of the output feature.
cannam@0 118 <p>
cannam@21 119 This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise.
cannam@35 120 <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@0 121
cannam@35 122 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::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 123
cannam@21 124 </div>
cannam@21 125 </div><p>
cannam@35 126 <a class="anchor" name="2a962f4b26d6417ad1b72ae29949332e"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="2a962f4b26d6417ad1b72ae29949332e" args="" -->
cannam@21 127 <div class="memitem">
cannam@21 128 <div class="memproto">
cannam@21 129 <table class="memname">
cannam@21 130 <tr>
cannam@35 131 <td class="memname">bool Vamp::Plugin::Plugin::Feature::hasDuration </td>
cannam@21 132 </tr>
cannam@21 133 </table>
cannam@21 134 </div>
cannam@21 135 <div class="memdoc">
cannam@21 136
cannam@21 137 <p>
cannam@21 138 True if an output feature has a specified duration.
cannam@21 139 <p>
cannam@21 140 This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep.
cannam@35 141 <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@21 142
cannam@35 143 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>.</p>
cannam@21 144
cannam@21 145 </div>
cannam@21 146 </div><p>
cannam@35 147 <a class="anchor" name="f09e2624341f81c8f1f9c2d9137b4230"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="f09e2624341f81c8f1f9c2d9137b4230" args="" -->
cannam@21 148 <div class="memitem">
cannam@21 149 <div class="memproto">
cannam@21 150 <table class="memname">
cannam@21 151 <tr>
cannam@35 152 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Plugin::Feature::duration </td>
cannam@21 153 </tr>
cannam@21 154 </table>
cannam@21 155 </div>
cannam@21 156 <div class="memdoc">
cannam@21 157
cannam@21 158 <p>
cannam@21 159 Duration of the output feature.
cannam@21 160 <p>
cannam@21 161 This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise.
cannam@35 162 <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@21 163
cannam@35 164 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>.</p>
cannam@0 165
cannam@0 166 </div>
cannam@0 167 </div><p>
cannam@35 168 <a class="anchor" name="106162977cdc92a02146fcb5ed18a34d"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="106162977cdc92a02146fcb5ed18a34d" args="" -->
cannam@0 169 <div class="memitem">
cannam@0 170 <div class="memproto">
cannam@0 171 <table class="memname">
cannam@0 172 <tr>
cannam@35 173 <td class="memname">std::vector&lt;float&gt; Vamp::Plugin::Plugin::Feature::values </td>
cannam@0 174 </tr>
cannam@0 175 </table>
cannam@0 176 </div>
cannam@0 177 <div class="memdoc">
cannam@0 178
cannam@0 179 <p>
cannam@0 180 Results for a single sample of this feature.
cannam@0 181 <p>
cannam@0 182 If the output hasFixedBinCount, there must be the same number of values as the output's binCount count.
cannam@35 183 <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@0 184
cannam@35 185 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">AmplitudeFollower::process()</a>.</p>
cannam@0 186
cannam@0 187 </div>
cannam@0 188 </div><p>
cannam@35 189 <a class="anchor" name="14ff2ab7442f508fc3bd3d96c3e85eb5"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="14ff2ab7442f508fc3bd3d96c3e85eb5" args="" -->
cannam@0 190 <div class="memitem">
cannam@0 191 <div class="memproto">
cannam@0 192 <table class="memname">
cannam@0 193 <tr>
cannam@35 194 <td class="memname">std::string Vamp::Plugin::Plugin::Feature::label </td>
cannam@0 195 </tr>
cannam@0 196 </table>
cannam@0 197 </div>
cannam@0 198 <div class="memdoc">
cannam@0 199
cannam@0 200 <p>
cannam@0 201 Label for the sample of this feature.
cannam@0 202 <p>
cannam@0 203
cannam@35 204 <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 205
cannam@35 206 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>.</p>
cannam@0 207
cannam@0 208 </div>
cannam@0 209 </div><p>
cannam@0 210 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@21 211 <li><a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a></ul>
cannam@0 212 </div>
cannam@35 213 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 214 <a href="http://www.doxygen.org/index.html">
cannam@35 215 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 216 </body>
cannam@0 217 </html>