Mercurial > hg > vamp-website

comparison code-doc/structVamp_1_1Plugin_1_1Feature.html @ 21:cc0be37dc9d3 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Updates for 2.0
author cannam
date Tue, 09 Dec 2008 11:02:57 +0000
parents 351c4ebce5f9
children 0976232e353b
comparison
equal deleted inserted replaced
20:34e758355884 21:cc0be37dc9d3
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title> 3 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css"> 5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body> 6 </head><body>
7 <!-- Generated by Doxygen 1.5.5 --> 7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top"> 8 <div class="navigation" id="top">
9 <div class="tabs"> 9 <div class="tabs">
10 <ul> 10 <ul>
11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
24 </div> 24 </div>
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> 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>
26 </div> 26 </div>
27 </div> 27 </div>
28 <div class="contents"> 28 <div class="contents">
29 <h1>Vamp::Plugin::Feature Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::Feature" --><code>#include &lt;<a class="el" href="Plugin_8h-source.html">Plugin.h</a>&gt;</code> 29 <h1>Vamp::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>
30 <p> 30 <p>
31 31
32 <p> 32 <p>
33 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 33 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
34 34
35 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00318">318</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 35 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00331">331</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
36 <table border="0" cellpadding="0" cellspacing="0"> 36 <table border="0" cellpadding="0" cellspacing="0">
37 <tr><td></td></tr> 37 <tr><td></td></tr>
38 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
39 <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#cd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a> ()</td></tr>
40
38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 41 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
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#98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr> 42 <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#98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr>
40 43
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#98907091d0b6a589720ae35ae588a82b"></a><br></td></tr> 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#98907091d0b6a589720ae35ae588a82b"></a><br></td></tr>
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#caa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr> 45 <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#caa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr>
43 46
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timestamp of the output feature. <a href="#caa605f36839c07e76f4882f5e22d8d7"></a><br></td></tr> 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timestamp of the output feature. <a href="#caa605f36839c07e76f4882f5e22d8d7"></a><br></td></tr>
48 <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#33686757bd4481c72494122e9bfb9fba">hasDuration</a></td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has a specified duration. <a href="#33686757bd4481c72494122e9bfb9fba"></a><br></td></tr>
51 <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#f687c0a7fe041757e922ec296862b115">duration</a></td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Duration of the output feature. <a href="#f687c0a7fe041757e922ec296862b115"></a><br></td></tr>
45 <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#60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr> 54 <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#60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr>
46 55
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#60b9f3057386820dbcaec0eb1189ce71"></a><br></td></tr> 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#60b9f3057386820dbcaec0eb1189ce71"></a><br></td></tr>
48 <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#8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr> 57 <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#8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr>
49 58
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Label for the sample of this feature. <a href="#8eb1fb35f73b247ed13de9527c18f036"></a><br></td></tr> 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Label for the sample of this feature. <a href="#8eb1fb35f73b247ed13de9527c18f036"></a><br></td></tr>
51 </table> 60 </table>
61 <hr><h2>Constructor &amp; Destructor Documentation</h2>
62 <a class="anchor" name="cd4b4cd0d2c31512f4a5df50f8f7a7b8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="cd4b4cd0d2c31512f4a5df50f8f7a7b8" args="()" -->
63 <div class="memitem">
64 <div class="memproto">
65 <table class="memname">
66 <tr>
67 <td class="memname">Vamp::Plugin::Feature::Feature </td>
68 <td>(</td>
69 <td class="paramname"> </td>
70 <td>&nbsp;)&nbsp;</td>
71 <td><code> [inline]</code></td>
72 </tr>
73 </table>
74 </div>
75 <div class="memdoc">
76
77 <p>
78
79 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00376">376</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
80
81 </div>
82 </div><p>
52 <hr><h2>Member Data Documentation</h2> 83 <hr><h2>Member Data Documentation</h2>
53 <a class="anchor" name="98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="98907091d0b6a589720ae35ae588a82b" args="" --> 84 <a class="anchor" name="98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="98907091d0b6a589720ae35ae588a82b" args="" -->
54 <div class="memitem"> 85 <div class="memitem">
55 <div class="memproto"> 86 <div class="memproto">
56 <table class="memname"> 87 <table class="memname">
62 <div class="memdoc"> 93 <div class="memdoc">
63 94
64 <p> 95 <p>
65 True if an output feature has its own timestamp. 96 True if an output feature has its own timestamp.
66 <p> 97 <p>
67 This is mandatory if the output has VariableSampleRate, and is likely to be disregarded otherwise. 98 This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep.
68 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00325">325</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 99 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00339">339</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
69 100
70 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::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> 101 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">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>
71 102
72 </div> 103 </div>
73 </div><p> 104 </div><p>
74 <a class="anchor" name="caa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="caa605f36839c07e76f4882f5e22d8d7" args="" --> 105 <a class="anchor" name="caa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="caa605f36839c07e76f4882f5e22d8d7" args="" -->
75 <div class="memitem"> 106 <div class="memitem">
83 <div class="memdoc"> 114 <div class="memdoc">
84 115
85 <p> 116 <p>
86 Timestamp of the output feature. 117 Timestamp of the output feature.
87 <p> 118 <p>
88 This is mandatory if the output has VariableSampleRate, and is likely to be disregarded otherwise. Undefined if hasTimestamp is false. 119 This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise.
89 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00332">332</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 120 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00347">347</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
90 121
91 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> 122 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">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>
123
124 </div>
125 </div><p>
126 <a class="anchor" name="33686757bd4481c72494122e9bfb9fba"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="33686757bd4481c72494122e9bfb9fba" args="" -->
127 <div class="memitem">
128 <div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a> </td>
132 </tr>
133 </table>
134 </div>
135 <div class="memdoc">
136
137 <p>
138 True if an output feature has a specified duration.
139 <p>
140 This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep.
141 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00355">355</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
142
143 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
144
145 </div>
146 </div><p>
147 <a class="anchor" name="f687c0a7fe041757e922ec296862b115"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="f687c0a7fe041757e922ec296862b115" args="" -->
148 <div class="memitem">
149 <div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#f687c0a7fe041757e922ec296862b115">Vamp::Plugin::Feature::duration</a> </td>
153 </tr>
154 </table>
155 </div>
156 <div class="memdoc">
157
158 <p>
159 Duration of the output feature.
160 <p>
161 This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise.
162 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00362">362</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
163
164 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
92 165
93 </div> 166 </div>
94 </div><p> 167 </div><p>
95 <a class="anchor" name="60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="60b9f3057386820dbcaec0eb1189ce71" args="" --> 168 <a class="anchor" name="60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="60b9f3057386820dbcaec0eb1189ce71" args="" -->
96 <div class="memitem"> 169 <div class="memitem">
105 178
106 <p> 179 <p>
107 Results for a single sample of this feature. 180 Results for a single sample of this feature.
108 <p> 181 <p>
109 If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. 182 If the output hasFixedBinCount, there must be the same number of values as the output's binCount count.
110 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00339">339</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 183 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00369">369</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
111 184
112 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::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> 185 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">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>
113 186
114 </div> 187 </div>
115 </div><p> 188 </div><p>
116 <a class="anchor" name="8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="8eb1fb35f73b247ed13de9527c18f036" args="" --> 189 <a class="anchor" name="8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="8eb1fb35f73b247ed13de9527c18f036" args="" -->
117 <div class="memitem"> 190 <div class="memitem">
126 199
127 <p> 200 <p>
128 Label for the sample of this feature. 201 Label for the sample of this feature.
129 <p> 202 <p>
130 203
131 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00344">344</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p> 204 <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>
132 205
133 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>.</p> 206 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</a>.</p>
134 207
135 </div> 208 </div>
136 </div><p> 209 </div><p>
137 <hr>The documentation for this struct was generated from the following file:<ul> 210 <hr>The documentation for this struct was generated from the following file:<ul>
138 <li><a class="el" href="Plugin_8h-source.html">Plugin.h</a></ul> 211 <li><a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a></ul>
139 </div> 212 </div>
140 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp; 213 <hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:20 2008 for VampPluginSDK by&nbsp;
141 <a href="http://www.doxygen.org/index.html"> 214 <a href="http://www.doxygen.org/index.html">
142 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> 215 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
143 </body> 216 </body>
144 </html> 217 </html>