be.tarsos.util.histogram

Class PitchHistogram

java.lang.Object

be.tarsos.util.histogram.Histogram

be.tarsos.util.histogram.PitchHistogram

All Implemented Interfaces:

java.lang.Cloneable

public final class PitchHistogram
extends Histogram

The PitchHistogram accepts values from 0 to 9600 cents or +- from 16Hz to 40000Hz: the human hearing range is completely covered.
The start and stop values can be configured.
Values outside the defined range are ignored!

Author:

Joren Six

Constructor Summary

Constructors

Constructor and Description
PitchHistogram()

Method Summary

Modifier and Type	Method and Description
static double[]	createAccumulator(java.util.List<Annotation> annotations, double width)
static PitchHistogram	createPitchHistogram(java.util.List<Annotation> annotations, double width) Create a tone scale histogram using a kernel instead of an ordinary count.
PitchClassHistogram	mostEnergyRichOctaves(int numberOfOctaves)
PitchClassHistogram	mostEnergyRitchOctave()
PitchClassHistogram	pitchClassHistogram()
void	valueAddedHook(double value) A hook to intercept added values.

Methods inherited from class be.tarsos.util.histogram.Histogram

add, add, add, addToEachBin, baselineHistogram, clear, clone, correlation, correlation, correlationWithDisplacement, correlationWithDisplacement, displace, displacementForOptimalCorrelation, displacementForOptimalCorrelation, export, exportMatLab, gaussianSmooth, getAbsoluteSumFreq, getClassWidth, getCount, getCountForClass, getCumFreq, getCumPct, getEntropy, getKeyForClass, getMaxBinCount, getMean, getMedian, getNumberOfClasses, getPct, getStart, getStop, getSumFreq, invert, isWrapped, keySet, max, mean, multiply, normalize, raise, setCount, smooth, subtract, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PitchHistogram

public PitchHistogram()

Method Detail

valueAddedHook

public void valueAddedHook(double value)

Description copied from class: Histogram

A hook to intercept added values.

Overrides:

valueAddedHook in class Histogram

Parameters:

value - The value added

mostEnergyRichOctaves

public PitchClassHistogram mostEnergyRichOctaves(int numberOfOctaves)

Parameters:

numberOfOctaves - The number of energy rich octaves

Returns:

a PitchClassHistogram containing only samples from the numberOfOctaves most energy rich octaves.

pitchClassHistogram

public PitchClassHistogram pitchClassHistogram()

Returns:

the ambitus folded to one octave (1200 cents)

mostEnergyRitchOctave

public PitchClassHistogram mostEnergyRitchOctave()

createPitchHistogram

public static PitchHistogram createPitchHistogram(java.util.List<Annotation> annotations,
                                                  double width)

Create a tone scale histogram using a kernel instead of an ordinary count. This construction uses a paradigm described here: http://en.wikipedia.org/wiki/Kernel_density_estimation It uses Gaussian kernels of a defined width. The width should be around the just noticeable threshold of about 7 cents.

Parameters:

annotations - A list of annotations.s

width - The width of each kernel.

Returns:

A histogram build with Gaussian kernels.

createAccumulator

public static double[] createAccumulator(java.util.List<Annotation> annotations,
                                         double width)