StrongestLocalMaxima

A peak detection UGen, useful for implementing the auto-correlation based pitch detection method of Paul Boersma (1993). Taking an already calculated auto-correlation of size size, the UGen looks for local maxima within a given range.

The UGen has two outputs. The first output gives the lag times or periods of the n strongest peaks per window (to obtain a frequency, divide the sampling rate by these lag times). The second output gives the intensities of these n candidates. If there are less than n candidates, the empty slots are output as zeroes.

in: the auto-correlation windows
size: the size of the auto-correlation windows. must be at least 2.
minLag: the minimum lag time in sample frames, corresponding to the maximum frequency accepted
maxLag: the maximum lag time in sample frames, corresponding to the minimum frequency accepted
thresh: the "voicing" threshold for considered for local maxima within minLag maxLag.
octaveCost: a factor for favouring higher frequencies. use zero to turn off this feature.
num: number of candidate periods output. This is clipped to be at least 1. see PitchesToViterbi see Viterbi

Linear Supertypes

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

Instance Constructors

new StrongestLocalMaxima(in: GE, size: GE, minLag: GE, maxLag: GE, thresh: GE = 0.0, octaveCost: GE = 0.0, num: GE = 14)

in
the auto-correlation windows
size
the size of the auto-correlation windows. must be at least 2.
minLag
the minimum lag time in sample frames, corresponding to the maximum frequency accepted
maxLag
the maximum lag time in sample frames, corresponding to the minimum frequency accepted
thresh
the "voicing" threshold for considered for local maxima within minLag maxLag.
octaveCost
a factor for favouring higher frequencies. use zero to turn off this feature.
num
number of candidate periods output. This is clipped to be at least 1. see PitchesToViterbi see Viterbi

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val in: GE

the auto-correlation windows
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lags: GE
def makeUGen(args: IndexedSeq[UGenIn])(implicit b: Builder): UGenInLike

Attributes
protected
Definition Classes
StrongestLocalMaxima → UGenSource
def makeUGens(implicit b: Builder): 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
StrongestLocalMaxima → Expander
val maxLag: GE

the maximum lag time in sample frames, corresponding to the minimum frequency accepted
val minLag: GE

the minimum lag time in sample frames, corresponding to the maximum frequency accepted
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 num: GE

number of candidate periods output.
number of candidate periods output. This is clipped to be at least 1. see PitchesToViterbi see Viterbi
val octaveCost: GE

a factor for favouring higher frequencies.
a factor for favouring higher frequencies. use zero to turn off this feature.
val size: GE

the size of the auto-correlation windows.
the size of the auto-correlation windows. must be at least 2.
def strengths: GE
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val thresh: GE

the "voicing" threshold for considered for local maxima within minLag maxLag.
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 Doc: package graph

final case class StrongestLocalMaxima(in: GE, size: GE, minLag: GE, maxLag: GE, thresh: GE = 0.0, octaveCost: GE = 0.0, num: GE = 14) extends MultiOut with Product with Serializable

Instance Constructors

new StrongestLocalMaxima(in: GE, size: GE, minLag: GE, maxLag: GE, thresh: GE = 0.0, octaveCost: GE = 0.0, num: GE = 14)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val in: GE

final def isInstanceOf[T0]: Boolean

def lags: GE

def makeUGen(args: IndexedSeq[UGenIn])(implicit b: Builder): UGenInLike

def makeUGens(implicit b: Builder): UGenInLike

val maxLag: GE

val minLag: GE

final def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val num: GE

val octaveCost: GE

val size: GE

def strengths: GE

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

val thresh: GE

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[IndexedSeq[StreamOut]]

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike, IndexedSeq[StreamOut]]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped