Mercurial > hg > vamp-website
view code-doc/structVamp_1_1Plugin_1_1OutputDescriptor.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | 351c4ebce5f9 |
| children | 0976232e353b |
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::OutputDescriptor Struct Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <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::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><hr><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00201">201</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> <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#bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca">OneSamplePerStep</a>, <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629">FixedSampleRate</a>, <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e">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#1ebf91cc3f60e4cbba818c10591cd344">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#e2c893ddb1860589517ab7eaa989a18b">identifier</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the output, in computer-usable form. <a href="#e2c893ddb1860589517ab7eaa989a18b"></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#b824b2b34ee50f897a30901c620e8d87">name</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The human-readable name of the output. <a href="#b824b2b34ee50f897a30901c620e8d87"></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#f9b4fe8f78e7126ead820ba5dc55efd1">description</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A human-readable short text describing the output. <a href="#f9b4fe8f78e7126ead820ba5dc55efd1"></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#a057a8833fa037f06ac9f7b85b85d5e4">unit</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The unit of the output, in human-readable form. <a href="#a057a8833fa037f06ac9f7b85b85d5e4"></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#f0e577e1a256ff6eed6ea42133fec77d">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="#f0e577e1a256ff6eed6ea42133fec77d"></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#fdd006959a995e40ef7d565a3a4df6dc">binCount</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of values per result of the output. <a href="#fdd006959a995e40ef7d565a3a4df6dc"></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#31d9b79e2d8241344f551a22fcb5c8c7">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="#31d9b79e2d8241344f551a22fcb5c8c7"></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#e9ccb65f99f477096b65dd031f4c5e31">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="#e9ccb65f99f477096b65dd031f4c5e31"></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#c9f5924c0be7571bba8e7ae7e7a921f4">minValue</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value of the results in the output. <a href="#c9f5924c0be7571bba8e7ae7e7a921f4"></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#907b4e8fbb48a46ac5a05f880d72719f">maxValue</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value of the results in the output. <a href="#907b4e8fbb48a46ac5a05f880d72719f"></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#1b4858928d23bfd7d5bc557c82a83fb4">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="#1b4858928d23bfd7d5bc557c82a83fb4"></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#3bed37153067b625b95acb40b60dbf0b">quantizeStep</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution of the output values (e.g. <a href="#3bed37153067b625b95acb40b60dbf0b"></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#0d1194980d44e31b25ef3b4b070d6b5d">sampleType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Positioning in time of the output results. <a href="#0d1194980d44e31b25ef3b4b070d6b5d"></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#dd0cbbdfa9c91764037c39365b1d42af">sampleRate</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sample rate of the output results, as samples per second. <a href="#dd0cbbdfa9c91764037c39365b1d42af"></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#b0d7cc6ab19e53b5bd12ee234f549ea3">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="#b0d7cc6ab19e53b5bd12ee234f549ea3"></a><br></td></tr> </table> <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="bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca"></a><!-- doxytag: member="OneSamplePerStep" ref="bffa9ed50cd756df70fd51f0355f448c0459d5d0d2198d21e8bc90abe4fdccca" 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="bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629"></a><!-- doxytag: member="FixedSampleRate" ref="bffa9ed50cd756df70fd51f0355f448c4c74bd2fc96dfe2815623f94b40e5629" 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="bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e"></a><!-- doxytag: member="VariableSampleRate" ref="bffa9ed50cd756df70fd51f0355f448cdea995a737867f7b22b52f1c43c5432e" 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#l00282">282</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="1ebf91cc3f60e4cbba818c10591cd344"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::OutputDescriptor" ref="1ebf91cc3f60e4cbba818c10591cd344" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Vamp::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#l00317">317</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="e2c893ddb1860589517ab7eaa989a18b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::identifier" ref="e2c893ddb1860589517ab7eaa989a18b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e2c893ddb1860589517ab7eaa989a18b">Vamp::Plugin::OutputDescriptor::identifier</a> </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#l00209">209</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="b824b2b34ee50f897a30901c620e8d87"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::name" ref="b824b2b34ee50f897a30901c620e8d87" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b824b2b34ee50f897a30901c620e8d87">Vamp::Plugin::OutputDescriptor::name</a> </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#l00215">215</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="f9b4fe8f78e7126ead820ba5dc55efd1"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::description" ref="f9b4fe8f78e7126ead820ba5dc55efd1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f9b4fe8f78e7126ead820ba5dc55efd1">Vamp::Plugin::OutputDescriptor::description</a> </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#l00222">222</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="a057a8833fa037f06ac9f7b85b85d5e4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::unit" ref="a057a8833fa037f06ac9f7b85b85d5e4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#a057a8833fa037f06ac9f7b85b85d5e4">Vamp::Plugin::OutputDescriptor::unit</a> </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#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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="f0e577e1a256ff6eed6ea42133fec77d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasFixedBinCount" ref="f0e577e1a256ff6eed6ea42133fec77d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#f0e577e1a256ff6eed6ea42133fec77d">Vamp::Plugin::OutputDescriptor::hasFixedBinCount</a> </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#l00234">234</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="fdd006959a995e40ef7d565a3a4df6dc"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binCount" ref="fdd006959a995e40ef7d565a3a4df6dc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#fdd006959a995e40ef7d565a3a4df6dc">Vamp::Plugin::OutputDescriptor::binCount</a> </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#l00242">242</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="31d9b79e2d8241344f551a22fcb5c8c7"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::binNames" ref="31d9b79e2d8241344f551a22fcb5c8c7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::vector<std::string> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#31d9b79e2d8241344f551a22fcb5c8c7">Vamp::Plugin::OutputDescriptor::binNames</a> </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#l00248">248</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="e9ccb65f99f477096b65dd031f4c5e31"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasKnownExtents" ref="e9ccb65f99f477096b65dd031f4c5e31" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#e9ccb65f99f477096b65dd031f4c5e31">Vamp::Plugin::OutputDescriptor::hasKnownExtents</a> </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#l00255">255</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="c9f5924c0be7571bba8e7ae7e7a921f4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::minValue" ref="c9f5924c0be7571bba8e7ae7e7a921f4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#c9f5924c0be7571bba8e7ae7e7a921f4">Vamp::Plugin::OutputDescriptor::minValue</a> </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#l00261">261</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::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="907b4e8fbb48a46ac5a05f880d72719f"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::maxValue" ref="907b4e8fbb48a46ac5a05f880d72719f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#907b4e8fbb48a46ac5a05f880d72719f">Vamp::Plugin::OutputDescriptor::maxValue</a> </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#l00267">267</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::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="1b4858928d23bfd7d5bc557c82a83fb4"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::isQuantized" ref="1b4858928d23bfd7d5bc557c82a83fb4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#1b4858928d23bfd7d5bc557c82a83fb4">Vamp::Plugin::OutputDescriptor::isQuantized</a> </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#l00273">273</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="3bed37153067b625b95acb40b60dbf0b"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::quantizeStep" ref="3bed37153067b625b95acb40b60dbf0b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#3bed37153067b625b95acb40b60dbf0b">Vamp::Plugin::OutputDescriptor::quantizeStep</a> </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#l00280">280</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::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="0d1194980d44e31b25ef3b4b070d6b5d"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleType" ref="0d1194980d44e31b25ef3b4b070d6b5d" 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> <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#0d1194980d44e31b25ef3b4b070d6b5d">Vamp::Plugin::OutputDescriptor::sampleType</a> </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#l00297">297</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#l00116">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::D::getOutputDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00128">AmplitudeFollower::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="dd0cbbdfa9c91764037c39365b1d42af"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::sampleRate" ref="dd0cbbdfa9c91764037c39365b1d42af" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#dd0cbbdfa9c91764037c39365b1d42af">Vamp::Plugin::OutputDescriptor::sampleRate</a> </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#l00309">309</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::D::getOutputDescriptors()</a>.</p> </div> </div><p> <a class="anchor" name="b0d7cc6ab19e53b5bd12ee234f549ea3"></a><!-- doxytag: member="Vamp::Plugin::OutputDescriptor::hasDuration" ref="b0d7cc6ab19e53b5bd12ee234f549ea3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1OutputDescriptor.html#b0d7cc6ab19e53b5bd12ee234f549ea3">Vamp::Plugin::OutputDescriptor::hasDuration</a> </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#l00315">315</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::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 Mon Dec 8 14:37:20 2008 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>