Packages

final case class Histogram[A](in: GE[A], bins: I, lo: GE[A] = 0, hi: GE[A] = 1, mode: I = 0, reset: B = false)(implicit num: Num[A]) extends SingleOut[Int] with ProductWithAdjuncts with Product with Serializable

A UGen that calculates running histogram of an input signal with given boundaries and bin-size. The bins are divided linearly, if another mapping (e.g. exponential) is needed, it must be pre-applied to the input signal.

Note: currently parameter modulation (bin, lo, hi, mode, reset) is not working correctly.

in

the input signal

bins

the number of bins. this is read at initialization time only or when reset fires

lo

the lowest bin boundary. input values below this value are clipped. this value may be updated (although that is seldom useful).

hi

the highest bin boundary. input values above this value are clipped. this value may be updated (although that is seldom useful).

mode

if 0 (default), outputs only after in has finished, if 1 outputs the entire histogram for every input sample.

reset

when greater than zero, resets the count.

See also

NormalizeWindow

Linear Supertypes
Serializable, ProductWithAdjuncts, SingleOut[Int], SomeOut[Int, StreamOut], GE.Lazy[Int], GE[Int], UGenSource[UGenInLike[Int], StreamOut], Expander[UGenInLike[Int]], Lazy, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Histogram
  2. Serializable
  3. ProductWithAdjuncts
  4. SingleOut
  5. SomeOut
  6. Lazy
  7. GE
  8. UGenSource
  9. Expander
  10. Lazy
  11. Product
  12. Equals
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Histogram(in: GE[A], bins: I, lo: GE[A] = 0, hi: GE[A] = 1, mode: I = 0, reset: B = false)(implicit num: Num[A])

    in

    the input signal

    bins

    the number of bins. this is read at initialization time only or when reset fires

    lo

    the lowest bin boundary. input values below this value are clipped. this value may be updated (although that is seldom useful).

    hi

    the highest bin boundary. input values above this value are clipped. this value may be updated (although that is seldom useful).

    mode

    if 0 (default), outputs only after in has finished, if 1 outputs the entire histogram for every input sample.

    reset

    when greater than zero, resets the count.

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. def adjuncts: List[Adjunct]
    Definition Classes
    HistogramProductWithAdjuncts
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val bins: I
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. val hi: GE[A]
  11. val in: GE[A]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val lo: GE[A]
  14. def makeUGen(args: IndexedSeq[UGenIn[_]])(implicit b: Builder): UGenInLike[Int]
    Attributes
    protected
    Definition Classes
    HistogramUGenSource
  15. def makeUGens(implicit b: Builder): UGenInLike[Int]

    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
    HistogramExpander
  16. val mode: I
  17. final def name: String
    Definition Classes
    UGenSource
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val reset: B
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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 ProductWithAdjuncts

Inherited from SingleOut[Int]

Inherited from SomeOut[Int, StreamOut]

Inherited from GE.Lazy[Int]

Inherited from GE[Int]

Inherited from UGenSource[UGenInLike[Int], StreamOut]

Inherited from Expander[UGenInLike[Int]]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped