cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: VampPluginSDK: Vamp::Plugin::Feature Struct Reference cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
VampPluginSDK cannam@50:  2.1 cannam@50:
cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@50: cannam@50:
cannam@50:
cannam@50: cannam@50:
cannam@0:
cannam@0:
cannam@50: cannam@50:
cannam@50:
cannam@50:
cannam@50: Public Member Functions | cannam@50: Public Attributes
cannam@50:
cannam@50:
Vamp::Plugin::Feature Struct Reference
cannam@50:
cannam@0:
cannam@50: cannam@50:

#include <Plugin.h>

cannam@0: cannam@50:

List of all members.

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

cannam@50: Public Member Functions

 Feature ()

cannam@50: 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@50:

Detailed Description

cannam@50:
cannam@50:

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

cannam@50:

Constructor & Destructor Documentation

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

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

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

Member Data Documentation

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

True if an output feature has its own timestamp.

cannam@50:

This is mandatory if the output has VariableSampleRate, optional if the output has FixedSampleRate, and unused if the output has OneSamplePerStep.

cannam@0: cannam@50:

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

cannam@50: cannam@50:

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

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

Timestamp of the output feature.

cannam@50:

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

cannam@0: cannam@50:

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

cannam@50: cannam@50:

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

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

True if an output feature has a specified duration.

cannam@50:

This is optional if the output has VariableSampleRate or FixedSampleRate, and and unused if the output has OneSamplePerStep.

cannam@21: cannam@50:

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

cannam@50: cannam@50:

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

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

Duration of the output feature.

cannam@50:

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

cannam@21: cannam@50:

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

cannam@50: cannam@50:

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

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

Results for a single sample of this feature.

cannam@50:

If the output hasFixedBinCount, there must be the same number of values as the output's binCount count.

cannam@0: cannam@50:

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

cannam@50: cannam@50:

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

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

Label for the sample of this feature.

cannam@0: cannam@50:

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

cannam@0: cannam@50:

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

cannam@0: cannam@0:
cannam@0:
cannam@50:
The documentation for this struct was generated from the following file: cannam@50:
cannam@50:
cannam@50: cannam@50: cannam@50: cannam@0: cannam@0: