Mercurial > hg > vamp-website

view code-doc/structVamp_1_1Plugin_1_1Feature.html @ 35:0976232e353b website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* 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::Feature 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;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::Plugin::Feature Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::Feature" --><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h-source.html">Plugin.h</a>&gt;</code>
<p>

<p>
<a href="structVamp_1_1Plugin_1_1Feature-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#3cd6cae91305ae8bcbd6248954a460f8">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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#116bb1b3420a067fc1290b75982fdf62">hasTimestamp</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has its own timestamp.  <a href="#116bb1b3420a067fc1290b75982fdf62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#aaf212bd458dc5e6f441bf7606121311">timestamp</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timestamp of the output feature.  <a href="#aaf212bd458dc5e6f441bf7606121311"></a><br></td></tr>
<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_1Feature.html#2a962f4b26d6417ad1b72ae29949332e">hasDuration</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has a specified duration.  <a href="#2a962f4b26d6417ad1b72ae29949332e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#f09e2624341f81c8f1f9c2d9137b4230">duration</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Duration of the output feature.  <a href="#f09e2624341f81c8f1f9c2d9137b4230"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#106162977cdc92a02146fcb5ed18a34d">values</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Results for a single sample of this feature.  <a href="#106162977cdc92a02146fcb5ed18a34d"></a><br></td></tr>
<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_1Feature.html#14ff2ab7442f508fc3bd3d96c3e85eb5">label</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Label for the sample of this feature.  <a href="#14ff2ab7442f508fc3bd3d96c3e85eb5"></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#l00336">336</a> of file <a class="el" href="vamp-sdk_2Plugin_8h-source.html">vamp-sdk/Plugin.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="3cd6cae91305ae8bcbd6248954a460f8"></a><!-- doxytag: member="Vamp::Plugin::Feature::Feature" ref="3cd6cae91305ae8bcbd6248954a460f8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vamp::Plugin::Plugin::Feature::Feature           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00381">381</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="116bb1b3420a067fc1290b75982fdf62"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="116bb1b3420a067fc1290b75982fdf62" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::Plugin::Feature::hasTimestamp          </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#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#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">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="aaf212bd458dc5e6f441bf7606121311"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="aaf212bd458dc5e6f441bf7606121311" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Plugin::Feature::timestamp          </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#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#l00480">FixedTempoEstimator::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="2a962f4b26d6417ad1b72ae29949332e"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasDuration" ref="2a962f4b26d6417ad1b72ae29949332e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::Plugin::Feature::hasDuration          </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#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#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>.</p>

</div>
</div><p>
<a class="anchor" name="f09e2624341f81c8f1f9c2d9137b4230"></a><!-- doxytag: member="Vamp::Plugin::Feature::duration" ref="f09e2624341f81c8f1f9c2d9137b4230" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Plugin::Feature::duration          </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#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#l00480">FixedTempoEstimator::FixedTempoEstimator::D::assembleFeatures()</a>.</p>

</div>
</div><p>
<a class="anchor" name="106162977cdc92a02146fcb5ed18a34d"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="106162977cdc92a02146fcb5ed18a34d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;float&gt; Vamp::Plugin::Plugin::Feature::values          </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#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::FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00142">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00146">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="14ff2ab7442f508fc3bd3d96c3e85eb5"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="14ff2ab7442f508fc3bd3d96c3e85eb5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::Plugin::Feature::label          </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#l00480">FixedTempoEstimator::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 Thu Sep 24 13:40:14 2009 for VampPluginSDK by&nbsp;
<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>