Mercurial > hg > vamp-website
view code-doc/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 35:0976232e353b website
* Update for 2.1 release; add wiki link
| author | cannam |
|---|---|
| date | Fri, 25 Sep 2009 15:40:18 +0000 |
| parents | cc0be37dc9d3 |
| children | 8260c0f4e05b |
line wrap: on
line source
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VampPluginSDK: Vamp::Plugin::Plugin::OutputDescriptor Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.8 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <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> </div> </div> <div class="contents"> <h1>Vamp::Plugin::Plugin::OutputDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::OutputDescriptor" --><code>#include <<a class="el" href="vamp-sdk_2Plugin_8h-source.html">Plugin.h</a>></code> <p> <p> <a href="structVamp_1_1Plugin_1_1OutputDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </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>, <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3">FixedSampleRate</a>, <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547">VariableSampleRate</a> }</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#ba660cc15254061875cbf9ba932aca95">OutputDescriptor</a> ()</td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#2e6f77bcb12d4c95da25348ac85b8696">identifier</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#2e6f77bcb12d4c95da25348ac85b8696"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0992e05ea70425878365ba85663400a7">name</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The human-readable name of the output. <a href="#0992e05ea70425878365ba85663400a7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#8b44602d8ccea8bb862fd766e74efa1c">description</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A human-readable short text describing the output. <a href="#8b44602d8ccea8bb862fd766e74efa1c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#52f4b3d8d7070cc9c5ab4aa6ff0c01a0">unit</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#52f4b3d8d7070cc9c5ab4aa6ff0c01a0"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0653d3a85fdc226e60fd5e612b399e0c">hasFixedBinCount</a></td></tr> <tr><td class="mdescLeft"> </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> <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#238a4781ebb4151832cbf521feb0fedc">binCount</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of values per result of the output. <a href="#238a4781ebb4151832cbf521feb0fedc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#62b6bdd0d36381da4176b27663072b49">binNames</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The (human-readable) names of each of the bins, if appropriate. <a href="#62b6bdd0d36381da4176b27663072b49"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#4b8d0d88bee613709e91b48402e28c8e">hasKnownExtents</a></td></tr> <tr><td class="mdescLeft"> </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> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1fc73936c43014393918fe6cce46ac6d">minValue</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value of the results in the output. <a href="#1fc73936c43014393918fe6cce46ac6d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0df82ce301ad1bc337a272cb730426cf">maxValue</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of the results in the output. <a href="#0df82ce301ad1bc337a272cb730426cf"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#43673cd31b2b65af427a8e8b8746b6e8">isQuantized</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">True if the output values are quantized to a particular resolution. <a href="#43673cd31b2b65af427a8e8b8746b6e8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#674cd333889514cf8408c18762fede12">quantizeStep</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#674cd333889514cf8408c18762fede12"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3cd2e0b7a6da19c32bbb6809a83d9adf">sampleType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Positioning in time of the output results. <a href="#3cd2e0b7a6da19c32bbb6809a83d9adf"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e49cc87dcb0f09b59feb85d2b78e80ef">sampleRate</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#e49cc87dcb0f09b59feb85d2b78e80ef"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#93cc15894c89a142741c2bd088cdd6af">hasDuration</a></td></tr> <tr><td class="mdescLeft"> </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> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <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> <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::SampleType" ref="bffa9ed50cd756df70fd51f0355f448c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">Vamp::Plugin::OutputDescriptor::SampleType</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead"></a><!-- doxytag: member="OneSamplePerStep" ref="bffa9ed50cd756df70fd51f0355f448c8915f78de285a79dd415e0c6012d1ead" args="" -->OneSamplePerStep</em> </td><td> 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> <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3"></a><!-- doxytag: member="FixedSampleRate" ref="bffa9ed50cd756df70fd51f0355f448cecfd91605a3f11c716e822dc696c27a3" args="" -->FixedSampleRate</em> </td><td> Results are evenly spaced in time (sampleRate specified below). </td></tr> <tr><td valign="top"><em><a class="anchor" name="bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547"></a><!-- doxytag: member="VariableSampleRate" ref="bffa9ed50cd756df70fd51f0355f448c95be613508cf4009a7dc2f70ddf99547" args="" -->VariableSampleRate</em> </td><td> Results are unevenly spaced and have individual timestamps. </td></tr> </table> </dl> <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> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="ba660cc15254061875cbf9ba932aca95"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::OutputDescriptor" ref="ba660cc15254061875cbf9ba932aca95" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Vamp::Plugin::Plugin::OutputDescriptor::OutputDescriptor </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <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> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="2e6f77bcb12d4c95da25348ac85b8696"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="2e6f77bcb12d4c95da25348ac85b8696" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::identifier </td> </tr> </table> </div> <div class="memdoc"> <p> The name of the output, in computer-usable form. <p> Should be reasonably short and without whitespace or punctuation, using the characters [a-zA-Z0-9_-] only. Example: "zero_crossing_count" <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> <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> </div> </div><p> <a class="anchor" name="0992e05ea70425878365ba85663400a7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="0992e05ea70425878365ba85663400a7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::name </td> </tr> </table> </div> <div class="memdoc"> <p> The human-readable name of the output. <p> Example: "Zero Crossing Counts" <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> <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> </div> </div><p> <a class="anchor" name="8b44602d8ccea8bb862fd766e74efa1c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="8b44602d8ccea8bb862fd766e74efa1c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::description </td> </tr> </table> </div> <div class="memdoc"> <p> A human-readable short text describing the output. <p> May be empty if the name has said it all already. Example: "The number of zero crossing points per processing block" <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> <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> </div> </div><p> <a class="anchor" name="52f4b3d8d7070cc9c5ab4aa6ff0c01a0"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="52f4b3d8d7070cc9c5ab4aa6ff0c01a0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Vamp::Plugin::Plugin::OutputDescriptor::unit </td> </tr> </table> </div> <div class="memdoc"> <p> The unit of the output, in human-readable form. <p> <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> <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> </div> </div><p> <a class="anchor" name="0653d3a85fdc226e60fd5e612b399e0c"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="0653d3a85fdc226e60fd5e612b399e0c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasFixedBinCount </td> </tr> </table> </div> <div class="memdoc"> <p> True if the output has the same number of values per sample for every output sample. <p> Outputs for which this is false are unlikely to be very useful in a general-purpose host. <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> <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> </div> </div><p> <a class="anchor" name="238a4781ebb4151832cbf521feb0fedc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="238a4781ebb4151832cbf521feb0fedc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t Vamp::Plugin::Plugin::OutputDescriptor::binCount </td> </tr> </table> </div> <div class="memdoc"> <p> The number of values per result of the output. <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>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> <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> </div> </div><p> <a class="anchor" name="62b6bdd0d36381da4176b27663072b49"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="62b6bdd0d36381da4176b27663072b49" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::vector<std::string> Vamp::Plugin::Plugin::OutputDescriptor::binNames </td> </tr> </table> </div> <div class="memdoc"> <p> The (human-readable) names of each of the bins, if appropriate. <p> This is always optional. <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> </div> </div><p> <a class="anchor" name="4b8d0d88bee613709e91b48402e28c8e"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="4b8d0d88bee613709e91b48402e28c8e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasKnownExtents </td> </tr> </table> </div> <div class="memdoc"> <p> True if the results in each output bin fall within a fixed numeric range (minimum and maximum values). <p> Undefined if binCount is zero. <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> <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> </div> </div><p> <a class="anchor" name="1fc73936c43014393918fe6cce46ac6d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="1fc73936c43014393918fe6cce46ac6d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::minValue </td> </tr> </table> </div> <div class="memdoc"> <p> Minimum value of the results in the output. <p> Undefined if hasKnownExtents is false or binCount is zero. <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> <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="0df82ce301ad1bc337a272cb730426cf"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="0df82ce301ad1bc337a272cb730426cf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::maxValue </td> </tr> </table> </div> <div class="memdoc"> <p> Maximum value of the results in the output. <p> Undefined if hasKnownExtents is false or binCount is zero. <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> <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="43673cd31b2b65af427a8e8b8746b6e8"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="43673cd31b2b65af427a8e8b8746b6e8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::isQuantized </td> </tr> </table> </div> <div class="memdoc"> <p> True if the output values are quantized to a particular resolution. <p> Undefined if binCount is zero. <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> <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> </div> </div><p> <a class="anchor" name="674cd333889514cf8408c18762fede12"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="674cd333889514cf8408c18762fede12" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::quantizeStep </td> </tr> </table> </div> <div class="memdoc"> <p> Quantization resolution of the output values (e.g. <p> 1.0 if they are all integers). Undefined if isQuantized is false or binCount is zero. <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> <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> </div> </div><p> <a class="anchor" name="3cd2e0b7a6da19c32bbb6809a83d9adf"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="3cd2e0b7a6da19c32bbb6809a83d9adf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c">SampleType</a> Vamp::Plugin::Plugin::OutputDescriptor::sampleType </td> </tr> </table> </div> <div class="memdoc"> <p> Positioning in time of the output results. <p> <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> <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> </div> </div><p> <a class="anchor" name="e49cc87dcb0f09b59feb85d2b78e80ef"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="e49cc87dcb0f09b59feb85d2b78e80ef" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float Vamp::Plugin::Plugin::OutputDescriptor::sampleRate </td> </tr> </table> </div> <div class="memdoc"> <p> Sample rate of the output results, as samples per second. <p> Undefined if sampleType is OneSamplePerStep.<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>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> <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> </div> </div><p> <a class="anchor" name="93cc15894c89a142741c2bd088cdd6af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasDuration" ref="93cc15894c89a142741c2bd088cdd6af" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Vamp::Plugin::Plugin::OutputDescriptor::hasDuration </td> </tr> </table> </div> <div class="memdoc"> <p> True if the returned results for this output are known to have a duration field. <p> <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> <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00189">FixedTempoEstimator::FixedTempoEstimator::D::getOutputDescriptors()</a>.</p> </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> </body> </html>