Mercurial > hg > vamp-website
view code-doc/structVamp_1_1Plugin_1_1Feature.html @ 128:817c3988afc7 website tip
Add a page about the Vamp Plugin Pack, including links to download mirrors
author | Chris Cannam |
---|---|
date | Tue, 11 Aug 2020 16:41:11 +0100 |
parents | 8260c0f4e05b |
children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('structVamp_1_1Plugin_1_1Feature.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">Vamp::Plugin::Feature Struct Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="Vamp::Plugin::Feature" --> <p><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></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#a98907091d0b6a589720ae35ae588a82b"></a><br/></td></tr> <tr><td class="memItemLeft" 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#acaa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Timestamp of the output feature. <a href="#acaa605f36839c07e76f4882f5e22d8d7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">hasDuration</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has a specified duration. <a href="#a33686757bd4481c72494122e9bfb9fba"></a><br/></td></tr> <tr><td class="memItemLeft" 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#af687c0a7fe041757e922ec296862b115">duration</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Duration of the output feature. <a href="#af687c0a7fe041757e922ec296862b115"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Results for a single sample of this feature. <a href="#a60b9f3057386820dbcaec0eb1189ce71"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Label for the sample of this feature. <a href="#a8eb1fb35f73b247ed13de9527c18f036"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00336">336</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="acd4b4cd0d2c31512f4a5df50f8f7a7b8" 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>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00381">381</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="a98907091d0b6a589720ae35ae588a82b" 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#a98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a></td> </tr> </table> </div> <div class="memdoc"> <p>True if an output feature has its own timestamp. </p> <p>This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. </p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00344">344</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#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p> </div> </div> <a class="anchor" id="acaa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="acaa605f36839c07e76f4882f5e22d8d7" 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#acaa605f36839c07e76f4882f5e22d8d7">Vamp::Plugin::Feature::timestamp</a></td> </tr> </table> </div> <div class="memdoc"> <p>Timestamp of the output feature. </p> <p>This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. </p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00352">352</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#l00481">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> <a class="anchor" id="a33686757bd4481c72494122e9bfb9fba"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="a33686757bd4481c72494122e9bfb9fba" 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#a33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a></td> </tr> </table> </div> <div class="memdoc"> <p>True if an output feature has a specified duration. </p> <p>This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. </p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00360">360</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#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> </div> </div> <a class="anchor" id="af687c0a7fe041757e922ec296862b115"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="af687c0a7fe041757e922ec296862b115" 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#af687c0a7fe041757e922ec296862b115">Vamp::Plugin::Feature::duration</a></td> </tr> </table> </div> <div class="memdoc"> <p>Duration of the output feature. </p> <p>This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. </p> <p>Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00367">367</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#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> </div> </div> <a class="anchor" id="a60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="a60b9f3057386820dbcaec0eb1189ce71" 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#a60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a></td> </tr> </table> </div> <div class="memdoc"> <p>Results for a single sample of this feature. </p> <p>If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. </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#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="SpectralCentroid_8cpp_source.html#l00146">SpectralCentroid::process()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00200">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p> </div> </div> <a class="anchor" id="a8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="a8eb1fb35f73b247ed13de9527c18f036" 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#a8eb1fb35f73b247ed13de9527c18f036">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#l00379">379</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#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> </div> </div> <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></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li> <li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> </li> <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> </ul> </div> </body> </html>