Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@1: VampPluginSDK: Vamp::Plugin::Feature Struct Reference Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@3:  2.4 Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@3: Chris@1: Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Public Member Functions | Chris@1: Public Attributes
Chris@1:
Chris@1:
Vamp::Plugin::Feature Struct Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

#include <Plugin.h>

Chris@1: Chris@1:

List of all members.

Chris@1: Chris@1: Chris@3: Chris@1: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@3: Chris@1:

Chris@1: Public Member Functions

 Feature ()

Chris@1: 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.
Chris@1:

Detailed Description

Chris@1:
Chris@1:

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

Chris@1:

Constructor & Destructor Documentation

Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@3: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Vamp::Plugin::Feature::Feature () [inline]
Chris@1:
Chris@1:
Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@1:

Member Data Documentation

Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool Vamp::Plugin::Feature::hasTimestamp
Chris@1:
Chris@1:
Chris@1: Chris@1:

True if an output feature has its own timestamp.

Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
RealTime Vamp::Plugin::Feature::timestamp
Chris@1:
Chris@1:
Chris@1: Chris@1:

Timestamp of the output feature.

Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool Vamp::Plugin::Feature::hasDuration
Chris@1:
Chris@1:
Chris@1: Chris@1:

True if an output feature has a specified duration.

Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
RealTime Vamp::Plugin::Feature::duration
Chris@1:
Chris@1:
Chris@1: Chris@1:

Duration of the output feature.

Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
std::vector<float> Vamp::Plugin::Feature::values
Chris@1:
Chris@1:
Chris@1: Chris@1:

Results for a single sample of this feature.

Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@3: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
std::string Vamp::Plugin::Feature::label
Chris@1:
Chris@1:
Chris@1: Chris@1:

Label for the sample of this feature.

Chris@1: Chris@1:

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

Chris@1: Chris@1:

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

Chris@1: Chris@1:
Chris@1:
Chris@1:
The documentation for this struct was generated from the following file: Chris@3:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: