cannam@0: cannam@0: cannam@0: VampPluginSDK: Vamp::Plugin::Feature Struct Reference cannam@0: cannam@0: cannam@0: cannam@21: cannam@0: cannam@0:
cannam@21:

Vamp::Plugin::Feature Struct Reference

#include <Plugin.h> cannam@0:

cannam@0: cannam@0:

cannam@0: List of all members.


Detailed Description

cannam@0: cannam@21:

Definition at line 331 of file vamp-sdk/Plugin.h.

cannam@0: cannam@0: cannam@21: cannam@21: cannam@21: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:

Public Member Functions

 Feature ()

Public Attributes

bool hasTimestamp
 True if an output feature has its own timestamp.
RealTime timestamp
 Timestamp of the output feature.
bool hasDuration
 True if an output feature has a specified duration.
RealTime duration
 Duration of the output feature.
std::vector< float > values
 Results for a single sample of this feature.
std::string label
 Label for the sample of this feature.
cannam@21:

Constructor & Destructor Documentation

cannam@21: cannam@21:
cannam@21:
cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21: cannam@21:
Vamp::Plugin::Feature::Feature (  )  [inline]
cannam@21:
cannam@21:
cannam@21: cannam@21:

cannam@21: cannam@21:

Definition at line 376 of file vamp-sdk/Plugin.h.

cannam@21: cannam@21:
cannam@21:

cannam@0:


Member Data Documentation

cannam@0: cannam@0:
cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
bool Vamp::Plugin::Feature::hasTimestamp
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: True if an output feature has its own timestamp. cannam@0:

cannam@21: This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep. cannam@21:

Definition at line 339 of file vamp-sdk/Plugin.h.

cannam@0: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures(), ZeroCrossing::process(), SpectralCentroid::process(), PowerSpectrum::process(), PercussionOnsetDetector::process(), and AmplitudeFollower::process().

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
RealTime Vamp::Plugin::Feature::timestamp
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Timestamp of the output feature. cannam@0:

cannam@21: This is mandatory if the output has VariableSampleRate or if the output has FixedSampleRate and hasTimestamp is true, and unused otherwise. cannam@21:

Definition at line 347 of file vamp-sdk/Plugin.h.

cannam@0: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures(), ZeroCrossing::process(), and PercussionOnsetDetector::process().

cannam@21: cannam@21:
cannam@21:

cannam@21: cannam@21:

cannam@21:
cannam@21: cannam@21: cannam@21: cannam@21: cannam@21:
bool Vamp::Plugin::Feature::hasDuration
cannam@21:
cannam@21:
cannam@21: cannam@21:

cannam@21: True if an output feature has a specified duration. cannam@21:

cannam@21: This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep. cannam@21:

Definition at line 355 of file vamp-sdk/Plugin.h.

cannam@21: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures().

cannam@21: cannam@21:
cannam@21:

cannam@21: cannam@21:

cannam@21:
cannam@21: cannam@21: cannam@21: cannam@21: cannam@21:
RealTime Vamp::Plugin::Feature::duration
cannam@21:
cannam@21:
cannam@21: cannam@21:

cannam@21: Duration of the output feature. cannam@21:

cannam@21: This is mandatory if the output has VariableSampleRate or FixedSampleRate and hasDuration is true, and unused otherwise. cannam@21:

Definition at line 362 of file vamp-sdk/Plugin.h.

cannam@21: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures().

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
std::vector<float> Vamp::Plugin::Feature::values
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Results for a single sample of this feature. cannam@0:

cannam@0: If the output hasFixedBinCount, there must be the same number of values as the output's binCount count. cannam@21:

Definition at line 369 of file vamp-sdk/Plugin.h.

cannam@0: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures(), ZeroCrossing::process(), SpectralCentroid::process(), PowerSpectrum::process(), PercussionOnsetDetector::process(), and AmplitudeFollower::process().

cannam@0: cannam@0:
cannam@0:

cannam@0: cannam@0:

cannam@0:
cannam@0: cannam@0: cannam@0: cannam@0: cannam@0:
std::string Vamp::Plugin::Feature::label
cannam@0:
cannam@0:
cannam@0: cannam@0:

cannam@0: Label for the sample of this feature. cannam@0:

cannam@0: cannam@21:

Definition at line 374 of file vamp-sdk/Plugin.h.

cannam@0: cannam@21:

Referenced by FixedTempoEstimator::D::assembleFeatures().

cannam@0: cannam@0:
cannam@0:

cannam@0:


The documentation for this struct was generated from the following file: cannam@0:
cannam@21:
Generated on Mon Dec 8 14:37:20 2008 for VampPluginSDK by  cannam@0: cannam@21: doxygen 1.5.6
cannam@0: cannam@0: