Mercurial > hg > vamp-website
view code-doc/structVamp_1_1Plugin_1_1Feature.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::Feature 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_1Feature.html">Feature</a> </div> </div> <div class="contents"> <h1>Vamp::Plugin::Feature Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::Feature" --><code>#include <<a class="el" href="vamp-sdk_2Plugin_8h-source.html">Plugin.h</a>></code> <p> <p> <a href="structVamp_1_1Plugin_1_1Feature-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#l00331">331</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 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_1Feature.html#cd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a> ()</td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></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_1Feature.html#98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#98907091d0b6a589720ae35ae588a82b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Timestamp of the output feature. <a href="#caa605f36839c07e76f4882f5e22d8d7"></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_1Feature.html#33686757bd4481c72494122e9bfb9fba">hasDuration</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has a specified duration. <a href="#33686757bd4481c72494122e9bfb9fba"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#f687c0a7fe041757e922ec296862b115">duration</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Duration of the output feature. <a href="#f687c0a7fe041757e922ec296862b115"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Results for a single sample of this feature. <a href="#60b9f3057386820dbcaec0eb1189ce71"></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_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Label for the sample of this feature. <a href="#8eb1fb35f73b247ed13de9527c18f036"></a><br></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="cd4b4cd0d2c31512f4a5df50f8f7a7b8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="cd4b4cd0d2c31512f4a5df50f8f7a7b8" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Vamp::Plugin::Feature::Feature </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#l00376">376</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="98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="98907091d0b6a589720ae35ae588a82b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a> </td> </tr> </table> </div> <div class="memdoc"> <p> True if an output feature has its own timestamp. <p> This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00339">339</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#l00480">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">AmplitudeFollower::process()</a>.</p> </div> </div><p> <a class="anchor" name="caa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="caa605f36839c07e76f4882f5e22d8d7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#caa605f36839c07e76f4882f5e22d8d7">Vamp::Plugin::Feature::timestamp</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Timestamp of the output feature. <p> This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00347">347</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#l00480">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p> </div> </div><p> <a class="anchor" name="33686757bd4481c72494122e9bfb9fba"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="33686757bd4481c72494122e9bfb9fba" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a> </td> </tr> </table> </div> <div class="memdoc"> <p> True if an output feature has a specified duration. <p> This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00355">355</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#l00480">FixedTempoEstimator::D::assembleFeatures()</a>.</p> </div> </div><p> <a class="anchor" name="f687c0a7fe041757e922ec296862b115"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="f687c0a7fe041757e922ec296862b115" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#f687c0a7fe041757e922ec296862b115">Vamp::Plugin::Feature::duration</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Duration of the output feature. <p> This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00362">362</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#l00480">FixedTempoEstimator::D::assembleFeatures()</a>.</p> </div> </div><p> <a class="anchor" name="60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="60b9f3057386820dbcaec0eb1189ce71" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::vector<float> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Results for a single sample of this feature. <p> If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00369">369</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#l00480">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00141">SpectralCentroid::process()</a>, <a class="el" href="PowerSpectrum_8cpp-source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00200">AmplitudeFollower::process()</a>.</p> </div> </div><p> <a class="anchor" name="8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="8eb1fb35f73b247ed13de9527c18f036" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">Vamp::Plugin::Feature::label</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Label for the sample of this feature. <p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h-source.html#l00374">374</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p> <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00480">FixedTempoEstimator::D::assembleFeatures()</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>