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. def adjuncts: List[Adjunct]
    Definition Classes
    Histogram → ProductWithAdjuncts
  2. val bins: I
  3. val hi: GE[A]
  4. val in: GE[A]
  5. val lo: GE[A]
  6. val mode: I
  7. final def name: String
    Definition Classes
    UGenSource
  8. def productElementNames: Iterator[String]
    Definition Classes
    Product
  9. val reset: B