Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1Plugin_1_1OutputDescriptor.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::OutputDescriptor 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_1OutputDescriptor.html">OutputDescriptor</a>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@35 29 <h1>Vamp::Plugin::Plugin::OutputDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::OutputDescriptor" --><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_1OutputDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
cannam@0 34 <tr><td></td></tr>
cannam@0 35 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
cannam@35 36 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> { <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead">OneSamplePerStep</a>,
cannam@35 37 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3">FixedSampleRate</a>,
cannam@35 38 <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547">VariableSampleRate</a>
cannam@0 39 }</td></tr>
cannam@0 40
cannam@21 41 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
cannam@35 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ba660cc15254061875cbf9ba932aca95">OutputDescriptor</a> ()</td></tr>
cannam@21 43
cannam@0 44 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@35 45 <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_1OutputDescriptor.html#2e6f77bcb12d4c95da25348ac85b8696">identifier</a></td></tr>
cannam@0 46
cannam@35 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#2e6f77bcb12d4c95da25348ac85b8696"></a><br></td></tr>
cannam@35 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_1OutputDescriptor.html#0992e05ea70425878365ba85663400a7">name</a></td></tr>
cannam@0 49
cannam@35 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The human-readable name of the output. <a href="#0992e05ea70425878365ba85663400a7"></a><br></td></tr>
cannam@35 51 <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_1OutputDescriptor.html#8b44602d8ccea8bb862fd766e74efa1c">description</a></td></tr>
cannam@0 52
cannam@35 53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A human-readable short text describing the output. <a href="#8b44602d8ccea8bb862fd766e74efa1c"></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_1OutputDescriptor.html#52f4b3d8d7070cc9c5ab4aa6ff0c01a0">unit</a></td></tr>
cannam@0 55
cannam@35 56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#52f4b3d8d7070cc9c5ab4aa6ff0c01a0"></a><br></td></tr>
cannam@35 57 <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_1OutputDescriptor.html#0653d3a85fdc226e60fd5e612b399e0c">hasFixedBinCount</a></td></tr>
cannam@0 58
cannam@35 59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the output has the same number of values per sample for every output sample. <a href="#0653d3a85fdc226e60fd5e612b399e0c"></a><br></td></tr>
cannam@35 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#238a4781ebb4151832cbf521feb0fedc">binCount</a></td></tr>
cannam@0 61
cannam@35 62 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of values per result of the output. <a href="#238a4781ebb4151832cbf521feb0fedc"></a><br></td></tr>
cannam@35 63 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#62b6bdd0d36381da4176b27663072b49">binNames</a></td></tr>
cannam@0 64
cannam@35 65 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate. <a href="#62b6bdd0d36381da4176b27663072b49"></a><br></td></tr>
cannam@35 66 <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_1OutputDescriptor.html#4b8d0d88bee613709e91b48402e28c8e">hasKnownExtents</a></td></tr>
cannam@0 67
cannam@35 68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). <a href="#4b8d0d88bee613709e91b48402e28c8e"></a><br></td></tr>
cannam@35 69 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1fc73936c43014393918fe6cce46ac6d">minValue</a></td></tr>
cannam@0 70
cannam@35 71 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum value of the results in the output. <a href="#1fc73936c43014393918fe6cce46ac6d"></a><br></td></tr>
cannam@35 72 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0df82ce301ad1bc337a272cb730426cf">maxValue</a></td></tr>
cannam@0 73
cannam@35 74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum value of the results in the output. <a href="#0df82ce301ad1bc337a272cb730426cf"></a><br></td></tr>
cannam@35 75 <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_1OutputDescriptor.html#43673cd31b2b65af427a8e8b8746b6e8">isQuantized</a></td></tr>
cannam@0 76
cannam@35 77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the output values are quantized to a particular resolution. <a href="#43673cd31b2b65af427a8e8b8746b6e8"></a><br></td></tr>
cannam@35 78 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#674cd333889514cf8408c18762fede12">quantizeStep</a></td></tr>
cannam@0 79
cannam@35 80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#674cd333889514cf8408c18762fede12"></a><br></td></tr>
cannam@35 81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3cd2e0b7a6da19c32bbb6809a83d9adf">sampleType</a></td></tr>
cannam@0 82
cannam@35 83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Positioning in time of the output results. <a href="#3cd2e0b7a6da19c32bbb6809a83d9adf"></a><br></td></tr>
cannam@35 84 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e49cc87dcb0f09b59feb85d2b78e80ef">sampleRate</a></td></tr>
cannam@0 85
cannam@35 86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#e49cc87dcb0f09b59feb85d2b78e80ef"></a><br></td></tr>
cannam@35 87 <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_1OutputDescriptor.html#93cc15894c89a142741c2bd088cdd6af">hasDuration</a></td></tr>
cannam@21 88
cannam@35 89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if the returned results for this output are known to have a duration field. <a href="#93cc15894c89a142741c2bd088cdd6af"></a><br></td></tr>
cannam@0 90 </table>
cannam@35 91 <hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@35 92
cannam@35 93 <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>
cannam@0 94 <hr><h2>Member Enumeration Documentation</h2>
cannam@0 95 <a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::SampleType" ref="bffa9ed50cd756df70fd51f0355f448c" args="" -->
cannam@0 96 <div class="memitem">
cannam@0 97 <div class="memproto">
cannam@0 98 <table class="memname">
cannam@0 99 <tr>
cannam@0 100 <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a> </td>
cannam@0 101 </tr>
cannam@0 102 </table>
cannam@0 103 </div>
cannam@0 104 <div class="memdoc">
cannam@0 105
cannam@0 106 <p>
cannam@0 107 <dl compact><dt><b>Enumerator: </b></dt><dd>
cannam@0 108 <table border="0" cellspacing="2" cellpadding="0">
cannam@35 109 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead"></a><!-- doxytag: member="OneSamplePerStep" ref="bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead" args="" -->OneSamplePerStep</em>&nbsp;</td><td>
cannam@0 110 Results from each <a class="el" href="classVamp_1_1Plugin.html#e4aed3bebfe80a2e2fccd3d37af26996" title="Process a single block of input data.">process()</a> align with that call's block start. </td></tr>
cannam@35 111 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3"></a><!-- doxytag: member="FixedSampleRate" ref="bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3" args="" -->FixedSampleRate</em>&nbsp;</td><td>
cannam@0 112 Results are evenly spaced in time (sampleRate specified below). </td></tr>
cannam@35 113 <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547"></a><!-- doxytag: member="VariableSampleRate" ref="bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547" args="" -->VariableSampleRate</em>&nbsp;</td><td>
cannam@0 114 Results are unevenly spaced and have individual timestamps. </td></tr>
cannam@0 115 </table>
cannam@0 116 </dl>
cannam@0 117
cannam@35 118 <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>
cannam@21 119
cannam@21 120 </div>
cannam@21 121 </div><p>
cannam@21 122 <hr><h2>Constructor &amp; Destructor Documentation</h2>
cannam@35 123 <a class="anchor" name="ba660cc15254061875cbf9ba932aca95"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::OutputDescriptor" ref="ba660cc15254061875cbf9ba932aca95" args="()" -->
cannam@21 124 <div class="memitem">
cannam@21 125 <div class="memproto">
cannam@21 126 <table class="memname">
cannam@21 127 <tr>
cannam@35 128 <td class="memname">Vamp::Plugin::Plugin::OutputDescriptor::OutputDescriptor </td>
cannam@21 129 <td>(</td>
cannam@21 130 <td class="paramname"> </td>
cannam@21 131 <td>&nbsp;)&nbsp;</td>
cannam@21 132 <td><code> [inline]</code></td>
cannam@21 133 </tr>
cannam@21 134 </table>
cannam@21 135 </div>
cannam@21 136 <div class="memdoc">
cannam@21 137
cannam@21 138 <p>
cannam@21 139
cannam@35 140 <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>
cannam@0 141
cannam@0 142 </div>
cannam@0 143 </div><p>
cannam@0 144 <hr><h2>Member Data Documentation</h2>
cannam@35 145 <a class="anchor" name="2e6f77bcb12d4c95da25348ac85b8696"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="2e6f77bcb12d4c95da25348ac85b8696" args="" -->
cannam@0 146 <div class="memitem">
cannam@0 147 <div class="memproto">
cannam@0 148 <table class="memname">
cannam@0 149 <tr>
cannam@35 150 <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::identifier </td>
cannam@0 151 </tr>
cannam@0 152 </table>
cannam@0 153 </div>
cannam@0 154 <div class="memdoc">
cannam@0 155
cannam@0 156 <p>
cannam@0 157 The name of the output, in computer-usable form.
cannam@0 158 <p>
cannam@0 159 Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count"
cannam@35 160 <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>
cannam@0 161
cannam@35 162 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 163
cannam@0 164 </div>
cannam@0 165 </div><p>
cannam@35 166 <a class="anchor" name="0992e05ea70425878365ba85663400a7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="0992e05ea70425878365ba85663400a7" args="" -->
cannam@0 167 <div class="memitem">
cannam@0 168 <div class="memproto">
cannam@0 169 <table class="memname">
cannam@0 170 <tr>
cannam@35 171 <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::name </td>
cannam@0 172 </tr>
cannam@0 173 </table>
cannam@0 174 </div>
cannam@0 175 <div class="memdoc">
cannam@0 176
cannam@0 177 <p>
cannam@0 178 The human-readable name of the output.
cannam@0 179 <p>
cannam@0 180 Example: "Zero Crossing Counts"
cannam@35 181 <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>
cannam@0 182
cannam@35 183 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 184
cannam@0 185 </div>
cannam@0 186 </div><p>
cannam@35 187 <a class="anchor" name="8b44602d8ccea8bb862fd766e74efa1c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="8b44602d8ccea8bb862fd766e74efa1c" args="" -->
cannam@0 188 <div class="memitem">
cannam@0 189 <div class="memproto">
cannam@0 190 <table class="memname">
cannam@0 191 <tr>
cannam@35 192 <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::description </td>
cannam@0 193 </tr>
cannam@0 194 </table>
cannam@0 195 </div>
cannam@0 196 <div class="memdoc">
cannam@0 197
cannam@0 198 <p>
cannam@0 199 A human-readable short text describing the output.
cannam@0 200 <p>
cannam@0 201 May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block"
cannam@35 202 <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>
cannam@0 203
cannam@35 204 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 205
cannam@0 206 </div>
cannam@0 207 </div><p>
cannam@35 208 <a class="anchor" name="52f4b3d8d7070cc9c5ab4aa6ff0c01a0"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="52f4b3d8d7070cc9c5ab4aa6ff0c01a0" args="" -->
cannam@0 209 <div class="memitem">
cannam@0 210 <div class="memproto">
cannam@0 211 <table class="memname">
cannam@0 212 <tr>
cannam@35 213 <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::unit </td>
cannam@0 214 </tr>
cannam@0 215 </table>
cannam@0 216 </div>
cannam@0 217 <div class="memdoc">
cannam@0 218
cannam@0 219 <p>
cannam@0 220 The unit of the output, in human-readable form.
cannam@0 221 <p>
cannam@0 222
cannam@35 223 <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>
cannam@0 224
cannam@35 225 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 226
cannam@0 227 </div>
cannam@0 228 </div><p>
cannam@35 229 <a class="anchor" name="0653d3a85fdc226e60fd5e612b399e0c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="0653d3a85fdc226e60fd5e612b399e0c" args="" -->
cannam@0 230 <div class="memitem">
cannam@0 231 <div class="memproto">
cannam@0 232 <table class="memname">
cannam@0 233 <tr>
cannam@35 234 <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount </td>
cannam@0 235 </tr>
cannam@0 236 </table>
cannam@0 237 </div>
cannam@0 238 <div class="memdoc">
cannam@0 239
cannam@0 240 <p>
cannam@0 241 True if the output has the same number of values per sample for every output sample.
cannam@0 242 <p>
cannam@0 243 Outputs for which this is false are unlikely to be very useful in a general-purpose host.
cannam@35 244 <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>
cannam@0 245
cannam@35 246 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 247
cannam@0 248 </div>
cannam@0 249 </div><p>
cannam@35 250 <a class="anchor" name="238a4781ebb4151832cbf521feb0fedc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="238a4781ebb4151832cbf521feb0fedc" args="" -->
cannam@0 251 <div class="memitem">
cannam@0 252 <div class="memproto">
cannam@0 253 <table class="memname">
cannam@0 254 <tr>
cannam@35 255 <td class="memname">size_t Vamp::Plugin::Plugin::OutputDescriptor::binCount </td>
cannam@0 256 </tr>
cannam@0 257 </table>
cannam@0 258 </div>
cannam@0 259 <div class="memdoc">
cannam@0 260
cannam@0 261 <p>
cannam@0 262 The number of values per result of the output.
cannam@0 263 <p>
cannam@0 264 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).
cannam@35 265 <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>
cannam@0 266
cannam@35 267 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 268
cannam@0 269 </div>
cannam@0 270 </div><p>
cannam@35 271 <a class="anchor" name="62b6bdd0d36381da4176b27663072b49"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="62b6bdd0d36381da4176b27663072b49" args="" -->
cannam@0 272 <div class="memitem">
cannam@0 273 <div class="memproto">
cannam@0 274 <table class="memname">
cannam@0 275 <tr>
cannam@35 276 <td class="memname">std::vector&lt;std::string&gt; Vamp::Plugin::Plugin::OutputDescriptor::binNames </td>
cannam@0 277 </tr>
cannam@0 278 </table>
cannam@0 279 </div>
cannam@0 280 <div class="memdoc">
cannam@0 281
cannam@0 282 <p>
cannam@0 283 The (human-readable) names of each of the bins, if appropriate.
cannam@0 284 <p>
cannam@0 285 This is always optional.
cannam@35 286 <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>
cannam@0 287
cannam@0 288 </div>
cannam@0 289 </div><p>
cannam@35 290 <a class="anchor" name="4b8d0d88bee613709e91b48402e28c8e"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="4b8d0d88bee613709e91b48402e28c8e" args="" -->
cannam@0 291 <div class="memitem">
cannam@0 292 <div class="memproto">
cannam@0 293 <table class="memname">
cannam@0 294 <tr>
cannam@35 295 <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents </td>
cannam@0 296 </tr>
cannam@0 297 </table>
cannam@0 298 </div>
cannam@0 299 <div class="memdoc">
cannam@0 300
cannam@0 301 <p>
cannam@0 302 True if the results in each output bin fall within a fixed numeric range (minimum and maximum values).
cannam@0 303 <p>
cannam@0 304 Undefined if binCount is zero.
cannam@35 305 <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>
cannam@0 306
cannam@35 307 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 308
cannam@0 309 </div>
cannam@0 310 </div><p>
cannam@35 311 <a class="anchor" name="1fc73936c43014393918fe6cce46ac6d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="1fc73936c43014393918fe6cce46ac6d" args="" -->
cannam@0 312 <div class="memitem">
cannam@0 313 <div class="memproto">
cannam@0 314 <table class="memname">
cannam@0 315 <tr>
cannam@35 316 <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::minValue </td>
cannam@0 317 </tr>
cannam@0 318 </table>
cannam@0 319 </div>
cannam@0 320 <div class="memdoc">
cannam@0 321
cannam@0 322 <p>
cannam@0 323 Minimum value of the results in the output.
cannam@0 324 <p>
cannam@0 325 Undefined if hasKnownExtents is false or binCount is zero.
cannam@35 326 <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>
cannam@0 327
cannam@35 328 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
cannam@0 329
cannam@0 330 </div>
cannam@0 331 </div><p>
cannam@35 332 <a class="anchor" name="0df82ce301ad1bc337a272cb730426cf"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="0df82ce301ad1bc337a272cb730426cf" args="" -->
cannam@0 333 <div class="memitem">
cannam@0 334 <div class="memproto">
cannam@0 335 <table class="memname">
cannam@0 336 <tr>
cannam@35 337 <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::maxValue </td>
cannam@0 338 </tr>
cannam@0 339 </table>
cannam@0 340 </div>
cannam@0 341 <div class="memdoc">
cannam@0 342
cannam@0 343 <p>
cannam@0 344 Maximum value of the results in the output.
cannam@0 345 <p>
cannam@0 346 Undefined if hasKnownExtents is false or binCount is zero.
cannam@35 347 <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>
cannam@0 348
cannam@35 349 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
cannam@0 350
cannam@0 351 </div>
cannam@0 352 </div><p>
cannam@35 353 <a class="anchor" name="43673cd31b2b65af427a8e8b8746b6e8"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="43673cd31b2b65af427a8e8b8746b6e8" args="" -->
cannam@0 354 <div class="memitem">
cannam@0 355 <div class="memproto">
cannam@0 356 <table class="memname">
cannam@0 357 <tr>
cannam@35 358 <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::isQuantized </td>
cannam@0 359 </tr>
cannam@0 360 </table>
cannam@0 361 </div>
cannam@0 362 <div class="memdoc">
cannam@0 363
cannam@0 364 <p>
cannam@0 365 True if the output values are quantized to a particular resolution.
cannam@0 366 <p>
cannam@0 367 Undefined if binCount is zero.
cannam@35 368 <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>
cannam@0 369
cannam@35 370 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 371
cannam@0 372 </div>
cannam@0 373 </div><p>
cannam@35 374 <a class="anchor" name="674cd333889514cf8408c18762fede12"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="674cd333889514cf8408c18762fede12" args="" -->
cannam@0 375 <div class="memitem">
cannam@0 376 <div class="memproto">
cannam@0 377 <table class="memname">
cannam@0 378 <tr>
cannam@35 379 <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::quantizeStep </td>
cannam@0 380 </tr>
cannam@0 381 </table>
cannam@0 382 </div>
cannam@0 383 <div class="memdoc">
cannam@0 384
cannam@0 385 <p>
cannam@0 386 Quantization resolution of the output values (e.g.
cannam@0 387 <p>
cannam@0 388 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero.
cannam@35 389 <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>
cannam@0 390
cannam@35 391 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
cannam@0 392
cannam@0 393 </div>
cannam@0 394 </div><p>
cannam@35 395 <a class="anchor" name="3cd2e0b7a6da19c32bbb6809a83d9adf"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="3cd2e0b7a6da19c32bbb6809a83d9adf" args="" -->
cannam@0 396 <div class="memitem">
cannam@0 397 <div class="memproto">
cannam@0 398 <table class="memname">
cannam@0 399 <tr>
cannam@35 400 <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> Vamp::Plugin::Plugin::OutputDescriptor::sampleType </td>
cannam@0 401 </tr>
cannam@0 402 </table>
cannam@0 403 </div>
cannam@0 404 <div class="memdoc">
cannam@0 405
cannam@0 406 <p>
cannam@0 407 Positioning in time of the output results.
cannam@0 408 <p>
cannam@0 409
cannam@35 410 <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>
cannam@0 411
cannam@35 412 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00121">SpectralCentroid::getOutputDescriptors()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00108">PowerSpectrum::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p>
cannam@0 413
cannam@0 414 </div>
cannam@0 415 </div><p>
cannam@35 416 <a class="anchor" name="e49cc87dcb0f09b59feb85d2b78e80ef"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="e49cc87dcb0f09b59feb85d2b78e80ef" args="" -->
cannam@0 417 <div class="memitem">
cannam@0 418 <div class="memproto">
cannam@0 419 <table class="memname">
cannam@0 420 <tr>
cannam@35 421 <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::sampleRate </td>
cannam@0 422 </tr>
cannam@0 423 </table>
cannam@0 424 </div>
cannam@0 425 <div class="memdoc">
cannam@0 426
cannam@0 427 <p>
cannam@0 428 Sample rate of the output results, as samples per second.
cannam@0 429 <p>
cannam@0 430 Undefined if sampleType is OneSamplePerStep.<p>
cannam@0 431 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.
cannam@35 432 <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>
cannam@0 433
cannam@35 434 <p>Referenced by <a class="el" href="ZeroCrossing_8cpp-source.html#l00111">ZeroCrossing::getOutputDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00196">PercussionOnsetDetector::getOutputDescriptors()</a>, and <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
cannam@21 435
cannam@21 436 </div>
cannam@21 437 </div><p>
cannam@35 438 <a class="anchor" name="93cc15894c89a142741c2bd088cdd6af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasDuration" ref="93cc15894c89a142741c2bd088cdd6af" args="" -->
cannam@21 439 <div class="memitem">
cannam@21 440 <div class="memproto">
cannam@21 441 <table class="memname">
cannam@21 442 <tr>
cannam@35 443 <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasDuration </td>
cannam@21 444 </tr>
cannam@21 445 </table>
cannam@21 446 </div>
cannam@21 447 <div class="memdoc">
cannam@21 448
cannam@21 449 <p>
cannam@21 450 True if the returned results for this output are known to have a duration field.
cannam@21 451 <p>
cannam@21 452
cannam@35 453 <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>
cannam@21 454
cannam@35 455 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p>
cannam@0 456
cannam@0 457 </div>
cannam@0 458 </div><p>
cannam@0 459 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@21 460 <li><a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a></ul>
cannam@0 461 </div>
cannam@35 462 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
cannam@0 463 <a href="http://www.doxygen.org/index.html">
cannam@35 464 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
cannam@0 465 </body>
cannam@0 466 </html>