be.tarsos.sampled.pitch

Class VampPitchDetection

java.lang.Object

be.tarsos.sampled.pitch.VampPitchDetection

All Implemented Interfaces:

PitchDetector

public final class VampPitchDetection
extends java.lang.Object
implements PitchDetector

Field Summary

Fields

Modifier and Type	Field and Description
double[][]	constantQValues

Constructor Summary

Constructors

Constructor and Description
VampPitchDetection(AudioFile audioFile, PitchDetectionMode pitchDetectionMode)

Method Summary

Modifier and Type	Method and Description
java.util.List<Annotation>	executePitchDetection() Execute the pitch detection process.
java.util.List<Annotation>	getAnnotations()
java.lang.String	getName()
double	progress() Calculate and return an indicator for progress.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

constantQValues

public double[][] constantQValues

Constructor Detail

VampPitchDetection

public VampPitchDetection(AudioFile audioFile,
                          PitchDetectionMode pitchDetectionMode)

Method Detail

executePitchDetection

public java.util.List<Annotation> executePitchDetection()

Description copied from interface: PitchDetector

Execute the pitch detection process.

Specified by:

executePitchDetection in interface PitchDetector

Returns:

Returns a list of detected pitches, encapsulated in an annotation object.

getAnnotations

public java.util.List<Annotation> getAnnotations()

Specified by:

getAnnotations in interface PitchDetector

Returns:

a list of annotated samples

getName

public java.lang.String getName()

Specified by:

getName in interface PitchDetector

Returns:

the name of the detector possibly with parameters e.g. aubio_YIN

progress

public double progress()

Description copied from interface: PitchDetector

Calculate and return an indicator for progress.

Specified by:

progress in interface PitchDetector

Returns:

A value between 0.0 and 100. Indicating the progress made in percentage. Or -1 if the task has an indeterminate duration.