be.hogent.tarsos.sampled.pitch
Enum PitchDetectionMode

java.lang.Object
  java.lang.Enum<PitchDetectionMode>
      be.hogent.tarsos.sampled.pitch.PitchDetectionMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PitchDetectionMode>

public enum PitchDetectionMode
extends java.lang.Enum<PitchDetectionMode>

The pitch detection mode defines which algorithm is used to detect pitch.

Author:

Joren Six

Enum Constant Summary

IPEM_ONE
The IPEM pitch tracker outputs only one pitch candidates.

IPEM_SIX
The IPEM pitch tracker outputs six weighted pitch candidates.

POLYPHON

SWIPE

SWIPE_OCTAVE

TARSOS_DYNAMIC_WAVELET

TARSOS_FAST_MPM

TARSOS_FAST_YIN
The pure java YIN implementation of Tarsos, with parameters set for speed (less accurate).

TARSOS_FFT_YIN

TARSOS_MPM
The pure java MPM (Tartini pitch tracker) implementation of Tarsos.

TARSOS_YIN
The pure java YIN implementation of Tarsos.

VAMP_CONSTANT_Q_200
Spectral comb.

VAMP_CONSTANT_Q_400
Spectral comb.

VAMP_FAST_HARMONIC_COMB
Fast harmonic comb.

VAMP_MAZURKA_PITCH
Uses a basic estimate of the pitch extracted from the spectrum.

VAMP_SCHMITT
Schmitt trigger.

VAMP_SPECTRAL_COMB
Spectral comb.

VAMP_YIN
The AUBIO_YIN algorithm.

VAMP_YIN_FFT
A faster version of AUBIO_YIN: spectral AUBIO_YIN.

Method Summary

java.lang.String	getDetectionModeName()
java.lang.String	getParametername()
PitchDetector	getPitchDetector(AudioFile audioFile) Returns a pitch detector for an audio file.
static java.util.List<PitchDetectionMode>	selected()
static PitchDetectionMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PitchDetectionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VAMP_YIN

public static final PitchDetectionMode VAMP_YIN

The AUBIO_YIN algorithm.

VAMP_YIN_FFT

public static final PitchDetectionMode VAMP_YIN_FFT

A faster version of AUBIO_YIN: spectral AUBIO_YIN. It should yield very similar results as AUBIO_YIN, only faster.

VAMP_FAST_HARMONIC_COMB

public static final PitchDetectionMode VAMP_FAST_HARMONIC_COMB

Fast harmonic comb.

VAMP_MAZURKA_PITCH

public static final PitchDetectionMode VAMP_MAZURKA_PITCH

Uses a basic estimate of the pitch extracted from the spectrum. The pitch estimate needs elaboration, just finding the max at the moment but need to correct for sub-harmonics which are really the fundamental. See http://www.mazurka.org.uk/software/sv/plugin/MzHarmonicSpectrum/

VAMP_SCHMITT

public static final PitchDetectionMode VAMP_SCHMITT

Schmitt trigger.

VAMP_SPECTRAL_COMB

public static final PitchDetectionMode VAMP_SPECTRAL_COMB

Spectral comb.

VAMP_CONSTANT_Q_200

public static final PitchDetectionMode VAMP_CONSTANT_Q_200

Spectral comb.

VAMP_CONSTANT_Q_400

public static final PitchDetectionMode VAMP_CONSTANT_Q_400

Spectral comb.

IPEM_SIX

public static final PitchDetectionMode IPEM_SIX

The IPEM pitch tracker outputs six weighted pitch candidates.

IPEM_ONE

public static final PitchDetectionMode IPEM_ONE

The IPEM pitch tracker outputs only one pitch candidates.

TARSOS_YIN

public static final PitchDetectionMode TARSOS_YIN

The pure java YIN implementation of Tarsos.

TARSOS_FAST_YIN

public static final PitchDetectionMode TARSOS_FAST_YIN

The pure java YIN implementation of Tarsos, with parameters set for speed (less accurate).

TARSOS_MPM

public static final PitchDetectionMode TARSOS_MPM

The pure java MPM (Tartini pitch tracker) implementation of Tarsos.

TARSOS_FAST_MPM

public static final PitchDetectionMode TARSOS_FAST_MPM

TARSOS_DYNAMIC_WAVELET

public static final PitchDetectionMode TARSOS_DYNAMIC_WAVELET

SWIPE

public static final PitchDetectionMode SWIPE

POLYPHON

public static final PitchDetectionMode POLYPHON

SWIPE_OCTAVE

public static final PitchDetectionMode SWIPE_OCTAVE

TARSOS_FFT_YIN

public static final PitchDetectionMode TARSOS_FFT_YIN

Method Detail

values

public static PitchDetectionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PitchDetectionMode c : PitchDetectionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PitchDetectionMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getParametername

public java.lang.String getParametername()

Returns:

The name used in the (aubio) command to execute the pitch detector.

getPitchDetector

public PitchDetector getPitchDetector(AudioFile audioFile)

Returns a pitch detector for an audio file.

Parameters:

audioFile - the audioFile to detect pitch for.

Returns:

A pitch detector for the audio file.

getDetectionModeName

public java.lang.String getDetectionModeName()

selected

public static java.util.List<PitchDetectionMode> selected()

Returns:

An array of pitch detection modes which are configured to be used.