Mercurial > hg > vamp-website

comparison code-doc/structVamp_1_1Plugin_1_1Feature.html @ 50:8260c0f4e05b website

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