Mercurial > hg > vamp-website

annotate code-doc/structVamp_1_1Plugin_1_1Feature.html @ 0:351c4ebce5f9 website

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Move website from vamp-website/trunk to plain website
author cannam
date Mon, 22 Sep 2008 13:01:46 +0000
parents
children cc0be37dc9d3
rev   line source
cannam@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@0 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
cannam@0 3 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title>
cannam@0 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@0 5 <link href="tabs.css" rel="stylesheet" type="text/css">
cannam@0 6 </head><body>
cannam@0 7 <!-- Generated by Doxygen 1.5.5 -->
cannam@0 8 <div class="navigation" id="top">
cannam@0 9 <div class="tabs">
cannam@0 10 <ul>
cannam@0 11 <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
cannam@0 12 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
cannam@0 13 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
cannam@0 14 <li><a href="files.html"><span>Files</span></a></li>
cannam@0 15 <li><a href="dirs.html"><span>Directories</span></a></li>
cannam@0 16 </ul>
cannam@0 17 </div>
cannam@0 18 <div class="tabs">
cannam@0 19 <ul>
cannam@0 20 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
cannam@0 21 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
cannam@0 22 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
cannam@0 23 </ul>
cannam@0 24 </div>
cannam@0 25 <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>
cannam@0 26 </div>
cannam@0 27 </div>
cannam@0 28 <div class="contents">
cannam@0 29 <h1>Vamp::Plugin::Feature Struct Reference</h1><!-- doxytag: class="Vamp::Plugin::Feature" --><code>#include &lt;<a class="el" href="Plugin_8h-source.html">Plugin.h</a>&gt;</code>
cannam@0 30 <p>
cannam@0 31
cannam@0 32 <p>
cannam@0 33 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@0 34
cannam@0 35 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00318">318</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 36 <table border="0" cellpadding="0" cellspacing="0">
cannam@0 37 <tr><td></td></tr>
cannam@0 38 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
cannam@0 39 <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#98907091d0b6a589720ae35ae588a82b">hasTimestamp</a></td></tr>
cannam@0 40
cannam@0 41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#98907091d0b6a589720ae35ae588a82b"></a><br></td></tr>
cannam@0 42 <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#caa605f36839c07e76f4882f5e22d8d7">timestamp</a></td></tr>
cannam@0 43
cannam@0 44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timestamp of the output feature. <a href="#caa605f36839c07e76f4882f5e22d8d7"></a><br></td></tr>
cannam@0 45 <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#60b9f3057386820dbcaec0eb1189ce71">values</a></td></tr>
cannam@0 46
cannam@0 47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Results for a single sample of this feature. <a href="#60b9f3057386820dbcaec0eb1189ce71"></a><br></td></tr>
cannam@0 48 <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#8eb1fb35f73b247ed13de9527c18f036">label</a></td></tr>
cannam@0 49
cannam@0 50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Label for the sample of this feature. <a href="#8eb1fb35f73b247ed13de9527c18f036"></a><br></td></tr>
cannam@0 51 </table>
cannam@0 52 <hr><h2>Member Data Documentation</h2>
cannam@0 53 <a class="anchor" name="98907091d0b6a589720ae35ae588a82b"></a><!-- doxytag: member="Vamp::Plugin::Feature::hasTimestamp" ref="98907091d0b6a589720ae35ae588a82b" args="" -->
cannam@0 54 <div class="memitem">
cannam@0 55 <div class="memproto">
cannam@0 56 <table class="memname">
cannam@0 57 <tr>
cannam@0 58 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a> </td>
cannam@0 59 </tr>
cannam@0 60 </table>
cannam@0 61 </div>
cannam@0 62 <div class="memdoc">
cannam@0 63
cannam@0 64 <p>
cannam@0 65 True if an output feature has its own timestamp.
cannam@0 66 <p>
cannam@0 67 This is mandatory if the output has VariableSampleRate, and is likely to be disregarded otherwise.
cannam@0 68 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00325">325</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 69
cannam@0 70 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::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>
cannam@0 71
cannam@0 72 </div>
cannam@0 73 </div><p>
cannam@0 74 <a class="anchor" name="caa605f36839c07e76f4882f5e22d8d7"></a><!-- doxytag: member="Vamp::Plugin::Feature::timestamp" ref="caa605f36839c07e76f4882f5e22d8d7" args="" -->
cannam@0 75 <div class="memitem">
cannam@0 76 <div class="memproto">
cannam@0 77 <table class="memname">
cannam@0 78 <tr>
cannam@0 79 <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>
cannam@0 80 </tr>
cannam@0 81 </table>
cannam@0 82 </div>
cannam@0 83 <div class="memdoc">
cannam@0 84
cannam@0 85 <p>
cannam@0 86 Timestamp of the output feature.
cannam@0 87 <p>
cannam@0 88 This is mandatory if the output has VariableSampleRate, and is likely to be disregarded otherwise. Undefined if hasTimestamp is false.
cannam@0 89 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00332">332</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 90
cannam@0 91 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, and <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00226">PercussionOnsetDetector::process()</a>.</p>
cannam@0 92
cannam@0 93 </div>
cannam@0 94 </div><p>
cannam@0 95 <a class="anchor" name="60b9f3057386820dbcaec0eb1189ce71"></a><!-- doxytag: member="Vamp::Plugin::Feature::values" ref="60b9f3057386820dbcaec0eb1189ce71" args="" -->
cannam@0 96 <div class="memitem">
cannam@0 97 <div class="memproto">
cannam@0 98 <table class="memname">
cannam@0 99 <tr>
cannam@0 100 <td class="memname">std::vector&lt;float&gt; <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a> </td>
cannam@0 101 </tr>
cannam@0 102 </table>
cannam@0 103 </div>
cannam@0 104 <div class="memdoc">
cannam@0 105
cannam@0 106 <p>
cannam@0 107 Results for a single sample of this feature.
cannam@0 108 <p>
cannam@0 109 If the output hasFixedBinCount, there must be the same number of values as the output's binCount count.
cannam@0 110 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00339">339</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 111
cannam@0 112 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>, <a class="el" href="ZeroCrossing_8cpp-source.html#l00141">ZeroCrossing::process()</a>, <a class="el" href="SpectralCentroid_8cpp-source.html#l00137">SpectralCentroid::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>
cannam@0 113
cannam@0 114 </div>
cannam@0 115 </div><p>
cannam@0 116 <a class="anchor" name="8eb1fb35f73b247ed13de9527c18f036"></a><!-- doxytag: member="Vamp::Plugin::Feature::label" ref="8eb1fb35f73b247ed13de9527c18f036" args="" -->
cannam@0 117 <div class="memitem">
cannam@0 118 <div class="memproto">
cannam@0 119 <table class="memname">
cannam@0 120 <tr>
cannam@0 121 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#8eb1fb35f73b247ed13de9527c18f036">Vamp::Plugin::Feature::label</a> </td>
cannam@0 122 </tr>
cannam@0 123 </table>
cannam@0 124 </div>
cannam@0 125 <div class="memdoc">
cannam@0 126
cannam@0 127 <p>
cannam@0 128 Label for the sample of this feature.
cannam@0 129 <p>
cannam@0 130
cannam@0 131 <p>Definition at line <a class="el" href="Plugin_8h-source.html#l00344">344</a> of file <a class="el" href="Plugin_8h-source.html">Plugin.h</a>.</p>
cannam@0 132
cannam@0 133 <p>Referenced by <a class="el" href="PluginHostAdapter_8cpp-source.html#l00385">Vamp::PluginHostAdapter::convertFeatures()</a>.</p>
cannam@0 134
cannam@0 135 </div>
cannam@0 136 </div><p>
cannam@0 137 <hr>The documentation for this struct was generated from the following file:<ul>
cannam@0 138 <li><a class="el" href="Plugin_8h-source.html">Plugin.h</a></ul>
cannam@0 139 </div>
cannam@0 140 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:09 2008 for VampPluginSDK by&nbsp;
cannam@0 141 <a href="http://www.doxygen.org/index.html">
cannam@0 142 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
cannam@0 143 </body>
cannam@0 144 </html>