Mercurial > hg > vamp-docs
comparison code-docs/structVamp_1_1Plugin_1_1Feature.html @ 6:27319718b1f8 vamp-plugin-sdk-v2.7
Update code docs to v2.7 SDK
author | Chris Cannam |
---|---|
date | Fri, 24 Feb 2017 16:44:47 +0000 |
parents | 5c2683745b33 |
children |
comparison
equal
deleted
inserted
replaced
5:5c95f546f0b4 | 6:27319718b1f8 |
---|---|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 <html xmlns="http://www.w3.org/1999/xhtml"> | 2 <html xmlns="http://www.w3.org/1999/xhtml"> |
3 <head> | 3 <head> |
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> | 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
6 <meta name="generator" content="Doxygen 1.8.13"/> | |
7 <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
6 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title> | 8 <title>VampPluginSDK: Vamp::Plugin::Feature Struct Reference</title> |
7 | |
8 <link href="tabs.css" rel="stylesheet" type="text/css"/> | 9 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
9 <link href="doxygen.css" rel="stylesheet" type="text/css" /> | 10 <script type="text/javascript" src="jquery.js"></script> |
11 <script type="text/javascript" src="dynsections.js"></script> | |
10 <link href="navtree.css" rel="stylesheet" type="text/css"/> | 12 <link href="navtree.css" rel="stylesheet" type="text/css"/> |
11 <script type="text/javascript" src="jquery.js"></script> | |
12 <script type="text/javascript" src="resize.js"></script> | 13 <script type="text/javascript" src="resize.js"></script> |
14 <script type="text/javascript" src="navtreedata.js"></script> | |
13 <script type="text/javascript" src="navtree.js"></script> | 15 <script type="text/javascript" src="navtree.js"></script> |
14 <script type="text/javascript"> | 16 <script type="text/javascript"> |
15 $(document).ready(initResizable); | 17 $(document).ready(initResizable); |
16 </script> | 18 </script> |
17 | 19 <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
18 | |
19 </head> | 20 </head> |
20 <body> | 21 <body> |
21 <div id="top"><!-- do not remove this div! --> | 22 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
22 | |
23 | |
24 <div id="titlearea"> | 23 <div id="titlearea"> |
25 <table cellspacing="0" cellpadding="0"> | 24 <table cellspacing="0" cellpadding="0"> |
26 <tbody> | 25 <tbody> |
27 <tr style="height: 56px;"> | 26 <tr style="height: 56px;"> |
28 | 27 <td id="projectalign" style="padding-left: 0.5em;"> |
29 | |
30 <td style="padding-left: 0.5em;"> | |
31 <div id="projectname">VampPluginSDK | 28 <div id="projectname">VampPluginSDK |
32  <span id="projectnumber">2.4</span> | 29  <span id="projectnumber">2.7</span> |
33 </div> | 30 </div> |
34 | |
35 </td> | 31 </td> |
36 | |
37 | |
38 | |
39 </tr> | 32 </tr> |
40 </tbody> | 33 </tbody> |
41 </table> | 34 </table> |
42 </div> | 35 </div> |
43 | 36 <!-- end header part --> |
44 <!-- Generated by Doxygen 1.8.0 --> | 37 <!-- Generated by Doxygen 1.8.13 --> |
45 <div id="navrow1" class="tabs"> | 38 <script type="text/javascript" src="menudata.js"></script> |
46 <ul class="tablist"> | 39 <script type="text/javascript" src="menu.js"></script> |
47 <li><a href="index.html"><span>Main Page</span></a></li> | 40 <script type="text/javascript"> |
48 <li><a href="namespaces.html"><span>Namespaces</span></a></li> | 41 $(function() { |
49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> | 42 initMenu('',false,false,'search.php','Search'); |
50 <li><a href="files.html"><span>Files</span></a></li> | 43 }); |
51 <li><a href="dirs.html"><span>Directories</span></a></li> | 44 </script> |
52 </ul> | 45 <div id="main-nav"></div> |
53 </div> | 46 </div><!-- top --> |
54 <div id="navrow2" class="tabs2"> | |
55 <ul class="tablist"> | |
56 <li><a href="annotated.html"><span>Class List</span></a></li> | |
57 <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> | |
58 <li><a href="functions.html"><span>Class Members</span></a></li> | |
59 </ul> | |
60 </div> | |
61 </div> | |
62 <div id="side-nav" class="ui-resizable side-nav-resizable"> | 47 <div id="side-nav" class="ui-resizable side-nav-resizable"> |
63 <div id="nav-tree"> | 48 <div id="nav-tree"> |
64 <div id="nav-tree-contents"> | 49 <div id="nav-tree-contents"> |
50 <div id="nav-sync" class="sync"></div> | |
65 </div> | 51 </div> |
66 </div> | 52 </div> |
67 <div id="splitbar" style="-moz-user-select:none;" | 53 <div id="splitbar" style="-moz-user-select:none;" |
68 class="ui-resizable-handle"> | 54 class="ui-resizable-handle"> |
69 </div> | 55 </div> |
70 </div> | 56 </div> |
71 <script type="text/javascript"> | 57 <script type="text/javascript"> |
72 initNavTree('structVamp_1_1Plugin_1_1Feature.html',''); | 58 $(document).ready(function(){initNavTree('structVamp_1_1Plugin_1_1Feature.html','');}); |
73 </script> | 59 </script> |
74 <div id="doc-content"> | 60 <div id="doc-content"> |
75 <div class="header"> | 61 <div class="header"> |
76 <div class="summary"> | 62 <div class="summary"> |
77 <a href="#pub-methods">Public Member Functions</a> | | 63 <a href="#pub-methods">Public Member Functions</a> | |
78 <a href="#pub-attribs">Public Attributes</a> </div> | 64 <a href="#pub-attribs">Public Attributes</a> | |
65 <a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members</a> </div> | |
79 <div class="headertitle"> | 66 <div class="headertitle"> |
80 <div class="title">Vamp::Plugin::Feature Struct Reference</div> </div> | 67 <div class="title">Vamp::Plugin::Feature Struct Reference</div> </div> |
81 </div><!--header--> | 68 </div><!--header--> |
82 <div class="contents"> | 69 <div class="contents"> |
83 | 70 |
84 <p><code>#include <<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>></code></p> | 71 <p><code>#include <<a class="el" href="vamp-sdk_2Plugin_8h_source.html">Plugin.h</a>></code></p> |
85 | |
86 <p><a href="structVamp_1_1Plugin_1_1Feature-members.html">List of all members.</a></p> | |
87 <table class="memberdecls"> | 72 <table class="memberdecls"> |
88 <tr><td colspan="2"><h2><a name="pub-methods"></a> | 73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
89 Public Member Functions</h2></td></tr> | 74 Public Member Functions</h2></td></tr> |
90 <tr class="memitem:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><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> | 75 <tr class="memitem:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><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> |
91 <tr><td colspan="2"><h2><a name="pub-attribs"></a> | 76 <tr class="separator:acd4b4cd0d2c31512f4a5df50f8f7a7b8"><td class="memSeparator" colspan="2"> </td></tr> |
77 </table><table class="memberdecls"> | |
78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> | |
92 Public Attributes</h2></td></tr> | 79 Public Attributes</h2></td></tr> |
93 <tr class="memitem:a98907091d0b6a589720ae35ae588a82b"><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> | 80 <tr class="memitem:a98907091d0b6a589720ae35ae588a82b"><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> |
94 <tr class="memdesc:a98907091d0b6a589720ae35ae588a82b"><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#a98907091d0b6a589720ae35ae588a82b"></a><br/></td></tr> | 81 <tr class="memdesc:a98907091d0b6a589720ae35ae588a82b"><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has its own timestamp. <a href="#a98907091d0b6a589720ae35ae588a82b">More...</a><br /></td></tr> |
82 <tr class="separator:a98907091d0b6a589720ae35ae588a82b"><td class="memSeparator" colspan="2"> </td></tr> | |
95 <tr class="memitem:acaa605f36839c07e76f4882f5e22d8d7"><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> | 83 <tr class="memitem:acaa605f36839c07e76f4882f5e22d8d7"><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> |
96 <tr class="memdesc:acaa605f36839c07e76f4882f5e22d8d7"><td class="mdescLeft"> </td><td class="mdescRight">Timestamp of the output feature. <a href="#acaa605f36839c07e76f4882f5e22d8d7"></a><br/></td></tr> | 84 <tr class="memdesc:acaa605f36839c07e76f4882f5e22d8d7"><td class="mdescLeft"> </td><td class="mdescRight">Timestamp of the output feature. <a href="#acaa605f36839c07e76f4882f5e22d8d7">More...</a><br /></td></tr> |
85 <tr class="separator:acaa605f36839c07e76f4882f5e22d8d7"><td class="memSeparator" colspan="2"> </td></tr> | |
97 <tr class="memitem:a33686757bd4481c72494122e9bfb9fba"><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> | 86 <tr class="memitem:a33686757bd4481c72494122e9bfb9fba"><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> |
98 <tr class="memdesc:a33686757bd4481c72494122e9bfb9fba"><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has a specified duration. <a href="#a33686757bd4481c72494122e9bfb9fba"></a><br/></td></tr> | 87 <tr class="memdesc:a33686757bd4481c72494122e9bfb9fba"><td class="mdescLeft"> </td><td class="mdescRight">True if an output feature has a specified duration. <a href="#a33686757bd4481c72494122e9bfb9fba">More...</a><br /></td></tr> |
88 <tr class="separator:a33686757bd4481c72494122e9bfb9fba"><td class="memSeparator" colspan="2"> </td></tr> | |
99 <tr class="memitem:af687c0a7fe041757e922ec296862b115"><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> | 89 <tr class="memitem:af687c0a7fe041757e922ec296862b115"><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> |
100 <tr class="memdesc:af687c0a7fe041757e922ec296862b115"><td class="mdescLeft"> </td><td class="mdescRight">Duration of the output feature. <a href="#af687c0a7fe041757e922ec296862b115"></a><br/></td></tr> | 90 <tr class="memdesc:af687c0a7fe041757e922ec296862b115"><td class="mdescLeft"> </td><td class="mdescRight">Duration of the output feature. <a href="#af687c0a7fe041757e922ec296862b115">More...</a><br /></td></tr> |
91 <tr class="separator:af687c0a7fe041757e922ec296862b115"><td class="memSeparator" colspan="2"> </td></tr> | |
101 <tr class="memitem:a60b9f3057386820dbcaec0eb1189ce71"><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> | 92 <tr class="memitem:a60b9f3057386820dbcaec0eb1189ce71"><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> |
102 <tr class="memdesc:a60b9f3057386820dbcaec0eb1189ce71"><td class="mdescLeft"> </td><td class="mdescRight">Results for a single sample of this feature. <a href="#a60b9f3057386820dbcaec0eb1189ce71"></a><br/></td></tr> | 93 <tr class="memdesc:a60b9f3057386820dbcaec0eb1189ce71"><td class="mdescLeft"> </td><td class="mdescRight">Results for a single sample of this feature. <a href="#a60b9f3057386820dbcaec0eb1189ce71">More...</a><br /></td></tr> |
94 <tr class="separator:a60b9f3057386820dbcaec0eb1189ce71"><td class="memSeparator" colspan="2"> </td></tr> | |
103 <tr class="memitem:a8eb1fb35f73b247ed13de9527c18f036"><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> | 95 <tr class="memitem:a8eb1fb35f73b247ed13de9527c18f036"><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> |
104 <tr class="memdesc:a8eb1fb35f73b247ed13de9527c18f036"><td class="mdescLeft"> </td><td class="mdescRight">Label for the sample of this feature. <a href="#a8eb1fb35f73b247ed13de9527c18f036"></a><br/></td></tr> | 96 <tr class="memdesc:a8eb1fb35f73b247ed13de9527c18f036"><td class="mdescLeft"> </td><td class="mdescRight">Label for the sample of this feature. <a href="#a8eb1fb35f73b247ed13de9527c18f036">More...</a><br /></td></tr> |
97 <tr class="separator:a8eb1fb35f73b247ed13de9527c18f036"><td class="memSeparator" colspan="2"> </td></tr> | |
105 </table> | 98 </table> |
106 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | 99 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
107 <div class="textblock"> | 100 <div class="textblock"> |
108 <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> | 101 <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> |
109 </div><hr/><h2>Constructor & Destructor Documentation</h2> | 102 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
110 <a class="anchor" id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a> | 103 <a id="acd4b4cd0d2c31512f4a5df50f8f7a7b8"></a> |
111 <div class="memitem"> | 104 <h2 class="memtitle"><span class="permalink"><a href="#acd4b4cd0d2c31512f4a5df50f8f7a7b8">◆ </a></span>Feature()</h2> |
112 <div class="memproto"> | 105 |
113 <table class="memname"> | 106 <div class="memitem"> |
114 <tr> | 107 <div class="memproto"> |
115 <td class="memname"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html#acd4b4cd0d2c31512f4a5df50f8f7a7b8">Vamp::Plugin::Feature::Feature</a> </td> | 108 <table class="mlabels"> |
109 <tr> | |
110 <td class="mlabels-left"> | |
111 <table class="memname"> | |
112 <tr> | |
113 <td class="memname">Vamp::Plugin::Feature::Feature </td> | |
116 <td>(</td> | 114 <td>(</td> |
117 <td class="paramname"></td><td>)</td> | 115 <td class="paramname"></td><td>)</td> |
118 <td><code> [inline]</code></td> | 116 <td></td> |
119 </tr> | 117 </tr> |
120 </table> | 118 </table> |
121 </div> | 119 </td> |
122 <div class="memdoc"> | 120 <td class="mlabels-right"> |
123 | 121 <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
124 <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> | 122 </tr> |
125 | 123 </table> |
126 </div> | 124 </div><div class="memdoc"> |
127 </div> | 125 |
128 <hr/><h2>Member Data Documentation</h2> | 126 <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> |
129 <a class="anchor" id="a98907091d0b6a589720ae35ae588a82b"></a> | 127 |
130 <div class="memitem"> | 128 </div> |
131 <div class="memproto"> | 129 </div> |
132 <table class="memname"> | 130 <h2 class="groupheader">Member Data Documentation</h2> |
133 <tr> | 131 <a id="a98907091d0b6a589720ae35ae588a82b"></a> |
134 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a98907091d0b6a589720ae35ae588a82b">Vamp::Plugin::Feature::hasTimestamp</a></td> | 132 <h2 class="memtitle"><span class="permalink"><a href="#a98907091d0b6a589720ae35ae588a82b">◆ </a></span>hasTimestamp</h2> |
135 </tr> | 133 |
136 </table> | 134 <div class="memitem"> |
137 </div> | 135 <div class="memproto"> |
138 <div class="memdoc"> | 136 <table class="memname"> |
137 <tr> | |
138 <td class="memname">bool Vamp::Plugin::Feature::hasTimestamp</td> | |
139 </tr> | |
140 </table> | |
141 </div><div class="memdoc"> | |
139 | 142 |
140 <p>True if an output feature has its own timestamp. </p> | 143 <p>True if an output feature has its own timestamp. </p> |
141 <p>This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. </p> | 144 <p>This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. </p> |
142 | 145 |
143 <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> | 146 <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> |
144 | 147 |
145 <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> | 148 <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> |
146 | 149 |
147 </div> | 150 </div> |
148 </div> | 151 </div> |
149 <a class="anchor" id="acaa605f36839c07e76f4882f5e22d8d7"></a> | 152 <a id="acaa605f36839c07e76f4882f5e22d8d7"></a> |
150 <div class="memitem"> | 153 <h2 class="memtitle"><span class="permalink"><a href="#acaa605f36839c07e76f4882f5e22d8d7">◆ </a></span>timestamp</h2> |
151 <div class="memproto"> | 154 |
152 <table class="memname"> | 155 <div class="memitem"> |
153 <tr> | 156 <div class="memproto"> |
154 <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> | 157 <table class="memname"> |
155 </tr> | 158 <tr> |
156 </table> | 159 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Feature::timestamp</td> |
157 </div> | 160 </tr> |
158 <div class="memdoc"> | 161 </table> |
162 </div><div class="memdoc"> | |
159 | 163 |
160 <p>Timestamp of the output feature. </p> | 164 <p>Timestamp of the output feature. </p> |
161 <p>This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. </p> | 165 <p>This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. </p> |
162 | 166 |
163 <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> | 167 <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> |
164 | 168 |
165 <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> | 169 <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> |
166 | 170 |
167 </div> | 171 </div> |
168 </div> | 172 </div> |
169 <a class="anchor" id="a33686757bd4481c72494122e9bfb9fba"></a> | 173 <a id="a33686757bd4481c72494122e9bfb9fba"></a> |
170 <div class="memitem"> | 174 <h2 class="memtitle"><span class="permalink"><a href="#a33686757bd4481c72494122e9bfb9fba">◆ </a></span>hasDuration</h2> |
171 <div class="memproto"> | 175 |
172 <table class="memname"> | 176 <div class="memitem"> |
173 <tr> | 177 <div class="memproto"> |
174 <td class="memname">bool <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a33686757bd4481c72494122e9bfb9fba">Vamp::Plugin::Feature::hasDuration</a></td> | 178 <table class="memname"> |
175 </tr> | 179 <tr> |
176 </table> | 180 <td class="memname">bool Vamp::Plugin::Feature::hasDuration</td> |
177 </div> | 181 </tr> |
178 <div class="memdoc"> | 182 </table> |
183 </div><div class="memdoc"> | |
179 | 184 |
180 <p>True if an output feature has a specified duration. </p> | 185 <p>True if an output feature has a specified duration. </p> |
181 <p>This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. </p> | 186 <p>This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. </p> |
182 | 187 |
183 <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> | 188 <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> |
184 | 189 |
185 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> | 190 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> |
186 | 191 |
187 </div> | 192 </div> |
188 </div> | 193 </div> |
189 <a class="anchor" id="af687c0a7fe041757e922ec296862b115"></a> | 194 <a id="af687c0a7fe041757e922ec296862b115"></a> |
190 <div class="memitem"> | 195 <h2 class="memtitle"><span class="permalink"><a href="#af687c0a7fe041757e922ec296862b115">◆ </a></span>duration</h2> |
191 <div class="memproto"> | 196 |
192 <table class="memname"> | 197 <div class="memitem"> |
193 <tr> | 198 <div class="memproto"> |
194 <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> | 199 <table class="memname"> |
195 </tr> | 200 <tr> |
196 </table> | 201 <td class="memname"><a class="el" href="structVamp_1_1RealTime.html">RealTime</a> Vamp::Plugin::Feature::duration</td> |
197 </div> | 202 </tr> |
198 <div class="memdoc"> | 203 </table> |
204 </div><div class="memdoc"> | |
199 | 205 |
200 <p>Duration of the output feature. </p> | 206 <p>Duration of the output feature. </p> |
201 <p>This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. </p> | 207 <p>This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. </p> |
202 | 208 |
203 <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> | 209 <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> |
204 | 210 |
205 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> | 211 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> |
206 | 212 |
207 </div> | 213 </div> |
208 </div> | 214 </div> |
209 <a class="anchor" id="a60b9f3057386820dbcaec0eb1189ce71"></a> | 215 <a id="a60b9f3057386820dbcaec0eb1189ce71"></a> |
210 <div class="memitem"> | 216 <h2 class="memtitle"><span class="permalink"><a href="#a60b9f3057386820dbcaec0eb1189ce71">◆ </a></span>values</h2> |
211 <div class="memproto"> | 217 |
212 <table class="memname"> | 218 <div class="memitem"> |
213 <tr> | 219 <div class="memproto"> |
214 <td class="memname">std::vector<float> <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a60b9f3057386820dbcaec0eb1189ce71">Vamp::Plugin::Feature::values</a></td> | 220 <table class="memname"> |
215 </tr> | 221 <tr> |
216 </table> | 222 <td class="memname">std::vector<float> Vamp::Plugin::Feature::values</td> |
217 </div> | 223 </tr> |
218 <div class="memdoc"> | 224 </table> |
225 </div><div class="memdoc"> | |
219 | 226 |
220 <p>Results for a single sample of this feature. </p> | 227 <p>Results for a single sample of this feature. </p> |
221 <p>If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. </p> | 228 <p>If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. </p> |
222 | 229 |
223 <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> | 230 <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> |
224 | 231 |
225 <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> | 232 <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> |
226 | 233 |
227 </div> | 234 </div> |
228 </div> | 235 </div> |
229 <a class="anchor" id="a8eb1fb35f73b247ed13de9527c18f036"></a> | 236 <a id="a8eb1fb35f73b247ed13de9527c18f036"></a> |
230 <div class="memitem"> | 237 <h2 class="memtitle"><span class="permalink"><a href="#a8eb1fb35f73b247ed13de9527c18f036">◆ </a></span>label</h2> |
231 <div class="memproto"> | 238 |
232 <table class="memname"> | 239 <div class="memitem"> |
233 <tr> | 240 <div class="memproto"> |
234 <td class="memname">std::string <a class="el" href="structVamp_1_1Plugin_1_1Feature.html#a8eb1fb35f73b247ed13de9527c18f036">Vamp::Plugin::Feature::label</a></td> | 241 <table class="memname"> |
235 </tr> | 242 <tr> |
236 </table> | 243 <td class="memname">std::string Vamp::Plugin::Feature::label</td> |
237 </div> | 244 </tr> |
238 <div class="memdoc"> | 245 </table> |
246 </div><div class="memdoc"> | |
239 | 247 |
240 <p>Label for the sample of this feature. </p> | 248 <p>Label for the sample of this feature. </p> |
241 | 249 |
242 <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> | 250 <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> |
243 | 251 |
244 <p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> | 252 <p class="reference">Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00481">FixedTempoEstimator::D::assembleFeatures()</a>.</p> |
245 | 253 |
246 </div> | 254 </div> |
247 </div> | 255 </div> |
248 <hr/>The documentation for this struct was generated from the following file:<ul> | 256 <hr/>The documentation for this struct was generated from the following file:<ul> |
249 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li> | 257 <li><a class="el" href="vamp-sdk_2Plugin_8h_source.html">vamp-sdk/Plugin.h</a></li> |
250 </ul> | 258 </ul> |
251 </div><!-- contents --> | 259 </div><!-- contents --> |
252 </div> | 260 </div><!-- doc-content --> |
253 <div id="nav-path" class="navpath"> | 261 <!-- start footer part --> |
254 <ul> | 262 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
255 <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> | 263 <ul> |
256 <li class="navelem"><a class="el" href="classVamp_1_1Plugin.html">Plugin</a> </li> | 264 <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> |
257 <li class="navelem"><a class="el" href="structVamp_1_1Plugin_1_1Feature.html">Feature</a> </li> | 265 <li class="footer">Generated by |
258 | |
259 <li class="footer">Generated on Fri Jul 13 2012 13:28:49 for VampPluginSDK by | |
260 <a href="http://www.doxygen.org/index.html"> | 266 <a href="http://www.doxygen.org/index.html"> |
261 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> | 267 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
262 </ul> | 268 </ul> |
263 </div> | 269 </div> |
264 | |
265 | |
266 </body> | 270 </body> |
267 </html> | 271 </html> |