Pitch

An autocorrelation based pitch following UGen. It is more accurate than ZeroCrossing , but more also more CPU costly. For most purposes the default settings can be used and only in needs to be supplied.

The UGen has two outputs: The first output is the frequency estimate in Hertz, the second output is a toggle hasFreq , which tells whether a pitch was found (1) or not (0). If the clarify argument is used, hasFreq has more fine grained information.

The pitch follower executes periodically at the rate specified by execFreq in cps. First it detects whether the input peak to peak amplitude is above the ampThresh . If it is not then no pitch estimation is performed, the hasFreq output is set to zero and the freq output is held at its previous value. Otherwise, the autocorrelation is calculated, and the first peak after the peak around the lag of zero that is above peakThresh times the amplitude of the peak at lag zero is reported.

in: The signal to be analyzed.
initFreq: The initial value of the freq output, until the first valid pitch is found. (init-time only)
minFreq: The minimum frequency in Hertz to be considered for reporting. (init-time only)
maxFreq: The maximum frequency in Hertz to be considered for reporting. (init-time only)
execFreq: The frequency at which the pitch is estimated. This will be automatically clipped to be between minFreq and maxFreq . (init-time only)
binsPerOct: A value which guides the search for the peak frequency in the first coarse step. Its setting does *not* affect the final pitch resolution; setting it larger will cause the coarse search to take longer, and setting it smaller will cause the fine search to take longer. (init-time only)
median: This specifies the length of a median filter applied to the frequency output estimation. With the default value of 1 the filter is defeated. Median filtering can help eliminating single spikes and jitter. This will however add latency to the output. (init-time only)
ampThresh: The minimum amplitude threshold above which the pitch follower operates. An input signal below this threshold is not analyzed. (init-time only)
peakThresh: This is a threshold used to find the first peak in the autocorrelation signal which gives the reported frequency. It is a factor of the energy of the signal (autocorrelation coefficient at zero). Set this value higher (e.g. to 1 ) to eliminate false frequencies corresponding to overtones. (init-time only)
downSample: An integer factor by which the input signal is down sampled to reduce CPU overhead. This will also reduce the pitch resolution. The default value of 1 means that the input signal is not down sampled. (init-time only)
clarity: If the clarity argument is greater than zero (it is zero by default) then the hasFreq output is given additional detail. Rather than simply being 1 when a pitch is detected, it is a "clarity" measure in the range between zero and one. (Technically, it's the height of the autocorrelation peak normalised by the height of the zero-lag peak.) It therefore gives a kind of measure of "purity" of the pitched signal. (init-time only)

Linear Supertypes

Serializable, Serializable, MultiOut, SomeOut, GE.Lazy, GE, UGenSource[UGenInLike], Expander[UGenInLike], Lazy, Product, Equals, AnyRef, Any

Instance Constructors

new Pitch(rate: Rate, in: GE, initFreq: GE = 440.0f, minFreq: GE = 60.0f, maxFreq: GE = 4000.0f, execFreq: GE = 100.0f, binsPerOct: GE = 16, median: GE = 1, ampThresh: GE = 0.01f, peakThresh: GE = 0.5f, downSample: GE = 1, clarity: GE = 0)

in
The signal to be analyzed.
initFreq
The initial value of the freq output, until the first valid pitch is found. (init-time only)
minFreq
The minimum frequency in Hertz to be considered for reporting. (init-time only)
maxFreq
The maximum frequency in Hertz to be considered for reporting. (init-time only)
execFreq
The frequency at which the pitch is estimated. This will be automatically clipped to be between minFreq and maxFreq . (init-time only)
binsPerOct
A value which guides the search for the peak frequency in the first coarse step. Its setting does *not* affect the final pitch resolution; setting it larger will cause the coarse search to take longer, and setting it smaller will cause the fine search to take longer. (init-time only)
median
This specifies the length of a median filter applied to the frequency output estimation. With the default value of 1 the filter is defeated. Median filtering can help eliminating single spikes and jitter. This will however add latency to the output. (init-time only)
ampThresh
The minimum amplitude threshold above which the pitch follower operates. An input signal below this threshold is not analyzed. (init-time only)
peakThresh
This is a threshold used to find the first peak in the autocorrelation signal which gives the reported frequency. It is a factor of the energy of the signal (autocorrelation coefficient at zero). Set this value higher (e.g. to 1 ) to eliminate false frequencies corresponding to overtones. (init-time only)
downSample
An integer factor by which the input signal is down sampled to reduce CPU overhead. This will also reduce the pitch resolution. The default value of 1 means that the input signal is not down sampled. (init-time only)
clarity
If the clarity argument is greater than zero (it is zero by default) then the hasFreq output is given additional detail. Rather than simply being 1 when a pitch is detected, it is a "clarity" measure in the range between zero and one. (Technically, it's the height of the autocorrelation peak normalised by the height of the zero-lag peak.) It therefore gives a kind of measure of "purity" of the pitched signal. (init-time only)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val ampThresh: GE

The minimum amplitude threshold above which the pitch follower operates.
The minimum amplitude threshold above which the pitch follower operates. An input signal below this threshold is not analyzed. (init-time only)
final def asInstanceOf[T0]: T0

Definition Classes
Any
val binsPerOct: GE

A value which guides the search for the peak frequency in the first coarse step.
A value which guides the search for the peak frequency in the first coarse step. Its setting does *not* affect the final pitch resolution; setting it larger will cause the coarse search to take longer, and setting it smaller will cause the fine search to take longer. (init-time only)
val clarity: GE

If the clarity argument is greater than zero (it is zero by default) then the hasFreq output is given additional detail.
If the clarity argument is greater than zero (it is zero by default) then the hasFreq output is given additional detail. Rather than simply being 1 when a pitch is detected, it is a "clarity" measure in the range between zero and one. (Technically, it's the height of the autocorrelation peak normalised by the height of the zero-lag peak.) It therefore gives a kind of measure of "purity" of the pitched signal. (init-time only)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val downSample: GE

An integer factor by which the input signal is down sampled to reduce CPU overhead.
An integer factor by which the input signal is down sampled to reduce CPU overhead. This will also reduce the pitch resolution. The default value of 1 means that the input signal is not down sampled. (init-time only)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val execFreq: GE

The frequency at which the pitch is estimated.
The frequency at which the pitch is estimated. This will be automatically clipped to be between minFreq and maxFreq . (init-time only)
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def freq: GE
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasFreq: GE
val in: GE

The signal to be analyzed.
val initFreq: GE

The initial value of the freq output, until the first valid pitch is found.
The initial value of the freq output, until the first valid pitch is found. (init-time only)
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def makeUGens: UGenInLike

Abstract method which must be implemented by creating the actual UGens during expansion.
Abstract method which must be implemented by creating the actual UGens during expansion. This method is at most called once during graph expansion
returns
the expanded object (depending on the type parameter U)

Attributes
protected
Definition Classes
Pitch → Expander
val maxFreq: GE

The maximum frequency in Hertz to be considered for reporting.
The maximum frequency in Hertz to be considered for reporting. (init-time only)
val median: GE

This specifies the length of a median filter applied to the frequency output estimation.
This specifies the length of a median filter applied to the frequency output estimation. With the default value of 1 the filter is defeated. Median filtering can help eliminating single spikes and jitter. This will however add latency to the output. (init-time only)
val minFreq: GE

The minimum frequency in Hertz to be considered for reporting.
The minimum frequency in Hertz to be considered for reporting. (init-time only)
final def name: String

Definition Classes
UGenSource
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val peakThresh: GE

This is a threshold used to find the first peak in the autocorrelation signal which gives the reported frequency.
This is a threshold used to find the first peak in the autocorrelation signal which gives the reported frequency. It is a factor of the energy of the signal (autocorrelation coefficient at zero). Set this value higher (e.g. to 1 ) to eliminate false frequencies corresponding to overtones. (init-time only)
val rate: Rate

Definition Classes
Pitch → GE
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Pitch | package ugen

Instance Constructors

new Pitch(rate: Rate, in: GE, initFreq: GE = 440.0f, minFreq: GE = 60.0f, maxFreq: GE = 4000.0f, execFreq: GE = 100.0f, binsPerOct: GE = 16, median: GE = 1, ampThresh: GE = 0.01f, peakThresh: GE = 0.5f, downSample: GE = 1, clarity: GE = 0)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val ampThresh: GE

final def asInstanceOf[T0]: T0

val binsPerOct: GE

val clarity: GE

def clone(): AnyRef

val downSample: GE

final def eq(arg0: AnyRef): Boolean

val execFreq: GE

def finalize(): Unit

def freq: GE

final def getClass(): Class[_]

def hasFreq: GE

val in: GE

val initFreq: GE

final def isInstanceOf[T0]: Boolean

def makeUGens: UGenInLike

val maxFreq: GE

val median: GE

val minFreq: GE

final def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val peakThresh: GE

val rate: Rate

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from MultiOut

Inherited from SomeOut

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped