Mercurial > hg > vamp-docs

view code-docs/structVamp_1_1Plugin_1_1Feature.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update code docs to v2.7 SDK
author Chris Cannam
date Fri, 24 Feb 2017 16:44:47 +0000
parents 5c2683745b33
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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">VampPluginSDK
   &#160;<span id="projectnumber">2.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Vamp::Plugin::Feature Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Feature</a> ()</td></tr>
<tr class="separator:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a98907091d0b6a589720ae35ae588a82b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr>
<tr class="memdesc:a98907091d0b6a589720ae35ae588a82b"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has its own timestamp.  <a href="#a98907091d0b6a589720ae35ae588a82b">More...</a><br /></td></tr>
<tr class="separator:a98907091d0b6a589720ae35ae588a82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaa605f36839c07e76f4882f5e22d8d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acaa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr>
<tr class="memdesc:acaa605f36839c07e76f4882f5e22d8d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timestamp of the output feature.  <a href="#acaa605f36839c07e76f4882f5e22d8d7">More...</a><br /></td></tr>
<tr class="separator:acaa605f36839c07e76f4882f5e22d8d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33686757bd4481c72494122e9bfb9fba"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">hasDuration</a></td></tr>
<tr class="memdesc:a33686757bd4481c72494122e9bfb9fba"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if an output feature has a specified duration.  <a href="#a33686757bd4481c72494122e9bfb9fba">More...</a><br /></td></tr>
<tr class="separator:a33686757bd4481c72494122e9bfb9fba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af687c0a7fe041757e922ec296862b115"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#af687c0a7fe041757e922ec296862b115">duration</a></td></tr>
<tr class="memdesc:af687c0a7fe041757e922ec296862b115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duration of the output feature.  <a href="#af687c0a7fe041757e922ec296862b115">More...</a><br /></td></tr>
<tr class="separator:af687c0a7fe041757e922ec296862b115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60b9f3057386820dbcaec0eb1189ce71"><td class="memItemLeft" align="right" valign="top">std::vector&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr>
<tr class="memdesc:a60b9f3057386820dbcaec0eb1189ce71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Results for a single sample of this feature.  <a href="#a60b9f3057386820dbcaec0eb1189ce71">More...</a><br /></td></tr>
<tr class="separator:a60b9f3057386820dbcaec0eb1189ce71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eb1fb35f73b247ed13de9527c18f036"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr>
<tr class="memdesc:a8eb1fb35f73b247ed13de9527c18f036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Label for the sample of this feature.  <a href="#a8eb1fb35f73b247ed13de9527c18f036">More...</a><br /></td></tr>
<tr class="separator:a8eb1fb35f73b247ed13de9527c18f036"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">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>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd4b4cd0d2c31512f4a5df50f8f7a7b8">&#9670;&nbsp;</a></span>Feature()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Vamp::Plugin::Feature::Feature </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00389">389</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a98907091d0b6a589720ae35ae588a82b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98907091d0b6a589720ae35ae588a82b">&#9670;&nbsp;</a></span>hasTimestamp</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::Feature::hasTimestamp</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 class="definition">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 class="reference">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#l00143">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>

</div>
</div>
<a id="acaa605f36839c07e76f4882f5e22d8d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaa605f36839c07e76f4882f5e22d8d7">&#9670;&nbsp;</a></span>timestamp</h2>

<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::Feature::timestamp</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 class="definition">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 class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp_source.html#l00143">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>

</div>
</div>
<a id="a33686757bd4481c72494122e9bfb9fba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33686757bd4481c72494122e9bfb9fba">&#9670;&nbsp;</a></span>hasDuration</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Vamp::Plugin::Feature::hasDuration</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 class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00368">368</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>

</div>
</div>
<a id="af687c0a7fe041757e922ec296862b115"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af687c0a7fe041757e922ec296862b115">&#9670;&nbsp;</a></span>duration</h2>

<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::Feature::duration</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 class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00375">375</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p>

</div>
</div>
<a id="a60b9f3057386820dbcaec0eb1189ce71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60b9f3057386820dbcaec0eb1189ce71">&#9670;&nbsp;</a></span>values</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;float&gt; Vamp::Plugin::Feature::values</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 class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00382">382</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">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#l00143">ZeroCrossing::process()</a>, <a class="el" href="PowerSpectrum_8cpp_source.html#l00136">PowerSpectrum::process()</a>, <a class="el" href="AmplitudeFollower_8cpp_source.html#l00201">AmplitudeFollower::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00226">PercussionOnsetDetector::process()</a>.</p>

</div>
</div>
<a id="a8eb1fb35f73b247ed13de9527c18f036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8eb1fb35f73b247ed13de9527c18f036">&#9670;&nbsp;</a></span>label</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Vamp::Plugin::Feature::label</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Label for the sample of this feature. </p>

<p class="definition">Definition at line <a class="el" href="vamp-sdk_2Plugin_8h_source.html#l00387">387</a> of file <a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a>.</p>

<p class="reference">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><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <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 by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>