Mercurial > hg > vamp-docs

comparison code-docs/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 1:3c430ef1ed66 vamp-plugin-sdk-v2.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add code docs from SDK 2.3
author Chris Cannam
date Tue, 04 Oct 2011 14:56:07 +0100
parents
children 5c2683745b33
comparison
equal deleted inserted replaced
0:895ae8fffdb7 1:3c430ef1ed66
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>VampPluginSDK: Vamp::Plugin::OutputDescriptor Struct Reference</title>
6
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="doxygen.css" rel="stylesheet" type="text/css" />
9 <link href="navtree.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
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>
47 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
48 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
49 <li><a href="files.html"><span>Files</span></a></li>
50 <li><a href="dirs.html"><span>Directories</span></a></li>
51 </ul>
52 </div>
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_1OutputDescriptor.html','');
72 </script>
73 <div id="doc-content">
74 <div class="header">
75 <div class="summary">
76 <a href="#pub-types">Public Types</a> &#124;
77 <a href="#pub-methods">Public Member Functions</a> &#124;
78 <a href="#pub-attribs">Public Attributes</a> </div>
79 <div class="headertitle">
80 <div class="title">Vamp::Plugin::OutputDescriptor Struct Reference</div> </div>
81 </div>
82 <div class="contents">
83 <!-- doxytag: class="Vamp::Plugin::OutputDescriptor" -->
84 <p><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>&gt;</code></p>
85
86 <p><a href="structVamp_1_1Plugin_1_1OutputDescriptor-members.html">List of all members.</a></p>
87 <table class="memberdecls">
88 <tr><td colspan="2"><h2><a name="pub-types"></a>
89 Public Types</h2></td></tr>
90 <tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> { <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca">OneSamplePerStep</a>,
91 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>,
92 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e">VariableSampleRate</a>
93 }</td></tr>
94 <tr><td colspan="2"><h2><a name="pub-methods"></a>
95 Public Member Functions</h2></td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1ebf91cc3f60e4cbba818c10591cd344">OutputDescriptor</a> ()</td></tr>
97 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
98 Public Attributes</h2></td></tr>
99 <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_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">identifier</a></td></tr>
100 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#ae2c893ddb1860589517ab7eaa989a18b"></a><br/></td></tr>
101 <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_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">name</a></td></tr>
102 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The human-readable name of the output. <a href="#ab824b2b34ee50f897a30901c620e8d87"></a><br/></td></tr>
103 <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_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">description</a></td></tr>
104 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A human-readable short text describing the output. <a href="#af9b4fe8f78e7126ead820ba5dc55efd1"></a><br/></td></tr>
105 <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_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">unit</a></td></tr>
106 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#aa057a8833fa037f06ac9f7b85b85d5e4"></a><br/></td></tr>
107 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">hasFixedBinCount</a></td></tr>
108 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the output has the same number of values per sample for every output sample. <a href="#af0e577e1a256ff6eed6ea42133fec77d"></a><br/></td></tr>
109 <tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">binCount</a></td></tr>
110 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of values per result of the output. <a href="#afdd006959a995e40ef7d565a3a4df6dc"></a><br/></td></tr>
111 <tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">binNames</a></td></tr>
112 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate. <a href="#a31d9b79e2d8241344f551a22fcb5c8c7"></a><br/></td></tr>
113 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">hasKnownExtents</a></td></tr>
114 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). <a href="#ae9ccb65f99f477096b65dd031f4c5e31"></a><br/></td></tr>
115 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">minValue</a></td></tr>
116 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value of the results in the output. <a href="#ac9f5924c0be7571bba8e7ae7e7a921f4"></a><br/></td></tr>
117 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">maxValue</a></td></tr>
118 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value of the results in the output. <a href="#a907b4e8fbb48a46ac5a05f880d72719f"></a><br/></td></tr>
119 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">isQuantized</a></td></tr>
120 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the output values are quantized to a particular resolution. <a href="#a1b4858928d23bfd7d5bc557c82a83fb4"></a><br/></td></tr>
121 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">quantizeStep</a></td></tr>
122 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#a3bed37153067b625b95acb40b60dbf0b"></a><br/></td></tr>
123 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a></td></tr>
124 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Positioning in time of the output results. <a href="#a0d1194980d44e31b25ef3b4b070d6b5d"></a><br/></td></tr>
125 <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">sampleRate</a></td></tr>
126 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#add0cbbdfa9c91764037c39365b1d42af"></a><br/></td></tr>
127 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">hasDuration</a></td></tr>
128 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the returned results for this output are known to have a duration field. <a href="#ab0d7cc6ab19e53b5bd12ee234f549ea3"></a><br/></td></tr>
129 </table>
130 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
131 <div class="textblock">
132 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00206">206</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
133 </div><hr/><h2>Member Enumeration Documentation</h2>
134 <a class="anchor" id="abffa9ed50cd756df70fd51f0355f448c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::SampleType" ref="abffa9ed50cd756df70fd51f0355f448c" args="" -->
135 <div class="memitem">
136 <div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a></td>
140 </tr>
141 </table>
142 </div>
143 <div class="memdoc">
144 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
145 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca"></a><!-- doxytag: member="OneSamplePerStep" ref="abffa9ed50cd756df70fd51f0355f448ca0459d5d0d2198d21e8bc90abe4fdccca" args="" -->OneSamplePerStep</em>&nbsp;</td><td>
146 <p>Results from each <a class="el" href="classVamp_1_1Plugin.html#ae4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> align with that call's block start. </p>
147 </td></tr>
148 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629"></a><!-- doxytag: member="FixedSampleRate" ref="abffa9ed50cd756df70fd51f0355f448ca4c74bd2fc96dfe2815623f94b40e5629" args="" -->FixedSampleRate</em>&nbsp;</td><td>
149 <p>Results are evenly spaced in time (sampleRate specified below) </p>
150 </td></tr>
151 <tr><td valign="top"><em><a class="anchor" id="abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e"></a><!-- doxytag: member="VariableSampleRate" ref="abffa9ed50cd756df70fd51f0355f448cadea995a737867f7b22b52f1c43c5432e" args="" -->VariableSampleRate</em>&nbsp;</td><td>
152 <p>Results are unevenly spaced and have individual timestamps. </p>
153 </td></tr>
154 </table>
155 </dd>
156 </dl>
157
158 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00287">287</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
159
160 </div>
161 </div>
162 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
163 <a class="anchor" id="a1ebf91cc3f60e4cbba818c10591cd344"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::OutputDescriptor" ref="a1ebf91cc3f60e4cbba818c10591cd344" args="()" -->
164 <div class="memitem">
165 <div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">Vamp::Plugin::OutputDescriptor::OutputDescriptor </td>
169 <td>(</td>
170 <td class="paramname"></td><td>)</td>
171 <td><code> [inline]</code></td>
172 </tr>
173 </table>
174 </div>
175 <div class="memdoc">
176
177 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00322">322</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
178
179 </div>
180 </div>
181 <hr/><h2>Member Data Documentation</h2>
182 <a class="anchor" id="ae2c893ddb1860589517ab7eaa989a18b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="ae2c893ddb1860589517ab7eaa989a18b" args="" -->
183 <div class="memitem">
184 <div class="memproto">
185 <table class="memname">
186 <tr>
187 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae2c893ddb1860589517ab7eaa989a18b">Vamp::Plugin::OutputDescriptor::identifier</a></td>
188 </tr>
189 </table>
190 </div>
191 <div class="memdoc">
192
193 <p>The name of the output, in computer-usable form. </p>
194 <p>Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" </p>
195
196 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00214">214</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
197
198 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
199
200 </div>
201 </div>
202 <a class="anchor" id="ab824b2b34ee50f897a30901c620e8d87"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="ab824b2b34ee50f897a30901c620e8d87" args="" -->
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab824b2b34ee50f897a30901c620e8d87">Vamp::Plugin::OutputDescriptor::name</a></td>
208 </tr>
209 </table>
210 </div>
211 <div class="memdoc">
212
213 <p>The human-readable name of the output. </p>
214 <p>Example: "Zero Crossing Counts" </p>
215
216 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00220">220</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
217
218 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
219
220 </div>
221 </div>
222 <a class="anchor" id="af9b4fe8f78e7126ead820ba5dc55efd1"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="af9b4fe8f78e7126ead820ba5dc55efd1" args="" -->
223 <div class="memitem">
224 <div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af9b4fe8f78e7126ead820ba5dc55efd1">Vamp::Plugin::OutputDescriptor::description</a></td>
228 </tr>
229 </table>
230 </div>
231 <div class="memdoc">
232
233 <p>A human-readable short text describing the output. </p>
234 <p>May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" </p>
235
236 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00227">227</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
237
238 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
239
240 </div>
241 </div>
242 <a class="anchor" id="aa057a8833fa037f06ac9f7b85b85d5e4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="aa057a8833fa037f06ac9f7b85b85d5e4" args="" -->
243 <div class="memitem">
244 <div class="memproto">
245 <table class="memname">
246 <tr>
247 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#aa057a8833fa037f06ac9f7b85b85d5e4">Vamp::Plugin::OutputDescriptor::unit</a></td>
248 </tr>
249 </table>
250 </div>
251 <div class="memdoc">
252
253 <p>The unit of the output, in human-readable form. </p>
254
255 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00232">232</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
256
257 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
258
259 </div>
260 </div>
261 <a class="anchor" id="af0e577e1a256ff6eed6ea42133fec77d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="af0e577e1a256ff6eed6ea42133fec77d" args="" -->
262 <div class="memitem">
263 <div class="memproto">
264 <table class="memname">
265 <tr>
266 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#af0e577e1a256ff6eed6ea42133fec77d">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a></td>
267 </tr>
268 </table>
269 </div>
270 <div class="memdoc">
271
272 <p>True if the output has the same number of values per sample for every output sample. </p>
273 <p>Outputs for which this is false are unlikely to be very useful in a general-purpose host. </p>
274
275 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00239">239</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
276
277 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
278
279 </div>
280 </div>
281 <a class="anchor" id="afdd006959a995e40ef7d565a3a4df6dc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="afdd006959a995e40ef7d565a3a4df6dc" args="" -->
282 <div class="memitem">
283 <div class="memproto">
284 <table class="memname">
285 <tr>
286 <td class="memname">size_t <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#afdd006959a995e40ef7d565a3a4df6dc">Vamp::Plugin::OutputDescriptor::binCount</a></td>
287 </tr>
288 </table>
289 </div>
290 <div class="memdoc">
291
292 <p>The number of values per result of the output. </p>
293 <p>Undefined if hasFixedBinCount is false. If this is zero, the output is point data (i.e. only the time of each output is of interest, the value list will be empty). </p>
294
295 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00247">247</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
296
297 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
298
299 </div>
300 </div>
301 <a class="anchor" id="a31d9b79e2d8241344f551a22fcb5c8c7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="a31d9b79e2d8241344f551a22fcb5c8c7" args="" -->
302 <div class="memitem">
303 <div class="memproto">
304 <table class="memname">
305 <tr>
306 <td class="memname">std::vector&lt;std::string&gt; <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a31d9b79e2d8241344f551a22fcb5c8c7">Vamp::Plugin::OutputDescriptor::binNames</a></td>
307 </tr>
308 </table>
309 </div>
310 <div class="memdoc">
311
312 <p>The (human-readable) names of each of the bins, if appropriate. </p>
313 <p>This is always optional. </p>
314
315 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00253">253</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
316
317 </div>
318 </div>
319 <a class="anchor" id="ae9ccb65f99f477096b65dd031f4c5e31"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="ae9ccb65f99f477096b65dd031f4c5e31" args="" -->
320 <div class="memitem">
321 <div class="memproto">
322 <table class="memname">
323 <tr>
324 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ae9ccb65f99f477096b65dd031f4c5e31">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a></td>
325 </tr>
326 </table>
327 </div>
328 <div class="memdoc">
329
330 <p>True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). </p>
331 <p>Undefined if binCount is zero. </p>
332
333 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00260">260</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
334
335 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
336
337 </div>
338 </div>
339 <a class="anchor" id="ac9f5924c0be7571bba8e7ae7e7a921f4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="ac9f5924c0be7571bba8e7ae7e7a921f4" args="" -->
340 <div class="memitem">
341 <div class="memproto">
342 <table class="memname">
343 <tr>
344 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ac9f5924c0be7571bba8e7ae7e7a921f4">Vamp::Plugin::OutputDescriptor::minValue</a></td>
345 </tr>
346 </table>
347 </div>
348 <div class="memdoc">
349
350 <p>Minimum value of the results in the output. </p>
351 <p>Undefined if hasKnownExtents is false or binCount is zero. </p>
352
353 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00266">266</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
354
355 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
356
357 </div>
358 </div>
359 <a class="anchor" id="a907b4e8fbb48a46ac5a05f880d72719f"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="a907b4e8fbb48a46ac5a05f880d72719f" args="" -->
360 <div class="memitem">
361 <div class="memproto">
362 <table class="memname">
363 <tr>
364 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a907b4e8fbb48a46ac5a05f880d72719f">Vamp::Plugin::OutputDescriptor::maxValue</a></td>
365 </tr>
366 </table>
367 </div>
368 <div class="memdoc">
369
370 <p>Maximum value of the results in the output. </p>
371 <p>Undefined if hasKnownExtents is false or binCount is zero. </p>
372
373 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00272">272</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
374
375 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
376
377 </div>
378 </div>
379 <a class="anchor" id="a1b4858928d23bfd7d5bc557c82a83fb4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="a1b4858928d23bfd7d5bc557c82a83fb4" args="" -->
380 <div class="memitem">
381 <div class="memproto">
382 <table class="memname">
383 <tr>
384 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a1b4858928d23bfd7d5bc557c82a83fb4">Vamp::Plugin::OutputDescriptor::isQuantized</a></td>
385 </tr>
386 </table>
387 </div>
388 <div class="memdoc">
389
390 <p>True if the output values are quantized to a particular resolution. </p>
391 <p>Undefined if binCount is zero. </p>
392
393 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00278">278</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
394
395 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
396
397 </div>
398 </div>
399 <a class="anchor" id="a3bed37153067b625b95acb40b60dbf0b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="a3bed37153067b625b95acb40b60dbf0b" args="" -->
400 <div class="memitem">
401 <div class="memproto">
402 <table class="memname">
403 <tr>
404 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a3bed37153067b625b95acb40b60dbf0b">Vamp::Plugin::OutputDescriptor::quantizeStep</a></td>
405 </tr>
406 </table>
407 </div>
408 <div class="memdoc">
409
410 <p>Quantization resolution of the output values (e.g. </p>
411 <p>1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. </p>
412
413 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00285">285</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
414
415 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
416
417 </div>
418 </div>
419 <a class="anchor" id="a0d1194980d44e31b25ef3b4b070d6b5d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="a0d1194980d44e31b25ef3b4b070d6b5d" args="" -->
420 <div class="memitem">
421 <div class="memproto">
422 <table class="memname">
423 <tr>
424 <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#abffa9ed50cd756df70fd51f0355f448c">SampleType</a> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a0d1194980d44e31b25ef3b4b070d6b5d">Vamp::Plugin::OutputDescriptor::sampleType</a></td>
425 </tr>
426 </table>
427 </div>
428 <div class="memdoc">
429
430 <p>Positioning in time of the output results. </p>
431
432 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00302">302</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
433
434 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
435
436 </div>
437 </div>
438 <a class="anchor" id="add0cbbdfa9c91764037c39365b1d42af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="add0cbbdfa9c91764037c39365b1d42af" args="" -->
439 <div class="memitem">
440 <div class="memproto">
441 <table class="memname">
442 <tr>
443 <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#add0cbbdfa9c91764037c39365b1d42af">Vamp::Plugin::OutputDescriptor::sampleRate</a></td>
444 </tr>
445 </table>
446 </div>
447 <div class="memdoc">
448
449 <p>Sample rate of the output results, as samples per second. </p>
450 <p>Undefined if sampleType is OneSamplePerStep.</p>
451 <p>If sampleType is VariableSampleRate and this value is non-zero, then it may be used to calculate a resolution for the output (i.e. the "duration" of each sample, in time, will be 1/sampleRate seconds). It's recommended to set this to zero if that behaviour is not desired. </p>
452
453 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00314">314</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
454
455 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>.</p>
456
457 </div>
458 </div>
459 <a class="anchor" id="ab0d7cc6ab19e53b5bd12ee234f549ea3"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasDuration" ref="ab0d7cc6ab19e53b5bd12ee234f549ea3" args="" -->
460 <div class="memitem">
461 <div class="memproto">
462 <table class="memname">
463 <tr>
464 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ab0d7cc6ab19e53b5bd12ee234f549ea3">Vamp::Plugin::OutputDescriptor::hasDuration</a></td>
465 </tr>
466 </table>
467 </div>
468 <div class="memdoc">
469
470 <p>True if the returned results for this output are known to have a duration field. </p>
471
472 <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00320">320</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>
473
474 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00190">FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
475
476 </div>
477 </div>
478 <hr/>The documentation for this struct was generated from the following file:<ul>
479 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li>
480 </ul>
481 </div>
482 </div>
483 <div id="nav-path" class="navpath">
484 <ul>
485 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li>
486 <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li>
487 <li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html">OutputDescriptor</a> </li>
488
489 <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by
490 <a href="http://www.doxygen.org/index.html">
491 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
492 </ul>
493 </div>
494
495
496 </body>
497 </html>