Packages

final case class Convolution(in: D, kernel: D, kernelLen: I, kernelUpdate: B = false, mode: I = 0) extends SingleOut[Double] with Product with Serializable

A UGen that convolves an input signal with a fixed or changing filter kernel. kernelUpdate is read synchronous with in, and while it is zero the most recent kernel is reused (making it possible to use more efficient calculation in the frequency domain). When kernelUpdate becomes 1, a new kernel is polled.

For example, if you want to update the kernel every ten sample frames, then kernelUpdate could be given as Metro(10).tail or Metro(10, 1). If the kernel is never updated, then kernelUpdate could be given as constant zero. If a new kernel is provided for each input sample, the value could be given as constant one.

in

the signal to be filtered

kernel

the filter kernel. This is read in initially and when kernelUpdate is one.

kernelLen

the filter length in sample frames. One value is polled whenever a new kernel is required.

kernelUpdate

a gate value read synchronous with in, specifying whether a new kernel is to be read in (non-zero) after the next frame, or if the previous kernel is to be reused (zero, default).

mode

currently unused; leave at zero

Linear Supertypes
Serializable, SingleOut[Double], SomeOut[Double, StreamOut], GE.Lazy[Double], GE[Double], UGenSource[UGenInLike[Double], StreamOut], Expander[UGenInLike[Double]], Lazy, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Convolution
  2. Serializable
  3. SingleOut
  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 Convolution(in: D, kernel: D, kernelLen: I, kernelUpdate: B = false, mode: I = 0)

    in

    the signal to be filtered

    kernel

    the filter kernel. This is read in initially and when kernelUpdate is one.

    kernelLen

    the filter length in sample frames. One value is polled whenever a new kernel is required.

    kernelUpdate

    a gate value read synchronous with in, specifying whether a new kernel is to be read in (non-zero) after the next frame, or if the previous kernel is to be reused (zero, default).

    mode

    currently unused; leave at zero

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. val kernel: D
  11. val kernelLen: I
  12. val kernelUpdate: B
  13. def makeUGen(args: IndexedSeq[UGenIn[_]])(implicit b: Builder): UGenInLike[Double]
    Attributes
    protected
    Definition Classes
    ConvolutionUGenSource
  14. 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
    ConvolutionExpander
  15. val mode: I
  16. final def name: String
    Definition Classes
    UGenSource
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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 SingleOut[Double]

Inherited from SomeOut[Double, StreamOut]

Inherited from GE.Lazy[Double]

Inherited from GE[Double]

Inherited from UGenSource[UGenInLike[Double], StreamOut]

Inherited from Expander[UGenInLike[Double]]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped