Chris@1: Chris@1: Chris@1: Chris@1: Chris@3: Chris@6: Chris@6: Chris@1: VampPluginSDK: Vamp::Plugin::Feature Struct Reference Chris@1: Chris@6: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@6:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@6: Chris@1: Chris@1: Chris@1:
Chris@1:
VampPluginSDK Chris@6:  2.7 Chris@1:
Chris@1:
Chris@1:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Chris@1:
Chris@1:
Chris@1:
Chris@1: Public Member Functions | Chris@6: Public Attributes | Chris@6: List of all members
Chris@1:
Chris@1:
Vamp::Plugin::Feature Struct Reference
Chris@3:
Chris@1:
Chris@3: Chris@1:

#include <Plugin.h>

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

Chris@1: Public Member Functions

 Feature ()
 
Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@3: Chris@6: Chris@6: Chris@1:

Chris@1: Public Attributes

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

Detailed Description

Chris@1:
Chris@6:

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

Chris@6:

Constructor & Destructor Documentation

Chris@6: Chris@6:

◆ Feature()

Chris@6: Chris@6:
Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6: Chris@6:
Vamp::Plugin::Feature::Feature ()
Chris@6: 		Chris@6: inline
Chris@6:
Chris@6: Chris@6:

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

Chris@6: Chris@6:
Chris@6:
Chris@6:

Member Data Documentation

Chris@6: Chris@6:

◆ hasTimestamp

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

True if an output feature has its own timestamp.

Chris@6:

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

Chris@6: Chris@6:

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

Chris@6: Chris@6:

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

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

◆ timestamp

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

Timestamp of the output feature.

Chris@6:

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

Chris@1: Chris@6:

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

Chris@1: Chris@6:

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

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

◆ hasDuration

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

True if an output feature has a specified duration.

Chris@6:

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

Chris@1: Chris@6:

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

Chris@1: Chris@6:

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

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

◆ duration

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

Duration of the output feature.

Chris@6:

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

Chris@1: Chris@6:

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

Chris@1: Chris@6:

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

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

◆ values

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

Results for a single sample of this feature.

Chris@6:

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

Chris@1: Chris@6:

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

Chris@1: Chris@6:

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

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

◆ label

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

Label for the sample of this feature.

Chris@1: Chris@6:

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

Chris@1: Chris@6:

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