Packages

final case class StrongestLocalMaxima(in: D, size: I, minLag: I, maxLag: I, thresh: D = 0.0, octaveCost: D = 0.0, num: I = 14) extends MultiOut[Double] with Product with Serializable

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, MultiOut[Double], SomeOut[Double, IndexedSeq[StreamOut]], GE.Lazy[Double], GE[Double], UGenSource[UGenInLike[Double], IndexedSeq[StreamOut]], Expander[UGenInLike[Double]], Lazy, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StrongestLocalMaxima
  2. Serializable
  3. MultiOut
  4. SomeOut
  5. Lazy
  6. GE
  7. UGenSource
  8. Expander
  9. Lazy
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StrongestLocalMaxima(in: D, size: I, minLag: I, maxLag: I, thresh: D = 0.0, octaveCost: D = 0.0, num: I = 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. val in: D
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. def lags: D
  11. def makeUGen(args: IndexedSeq[UGenIn[_]])(implicit b: Builder): UGenInLike[Double]
    Attributes
    protected
    Definition Classes
    StrongestLocalMaximaUGenSource
  12. def makeUGens(implicit b: Builder): UGenInLike[Double]

    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
    StrongestLocalMaximaExpander
  13. val maxLag: I
  14. val minLag: I
  15. final def name: String
    Definition Classes
    UGenSource
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. val num: I
  20. val octaveCost: D
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val size: I
  23. def strengths: D
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. val thresh: D
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from MultiOut[Double]

Inherited from SomeOut[Double, IndexedSeq[StreamOut]]

Inherited from GE.Lazy[Double]

Inherited from GE[Double]

Inherited from UGenSource[UGenInLike[Double], IndexedSeq[StreamOut]]

Inherited from Expander[UGenInLike[Double]]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped