Convolution

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, Serializable, SingleOut, SomeOut[StreamOut], GE.Lazy, GE, UGenSource[UGenInLike, StreamOut], Expander[UGenInLike], Lazy, Product, Equals, AnyRef, Any

Instance Constructors

new Convolution(in: GE, kernel: GE, kernelLen: GE, kernelUpdate: GE = 0, mode: GE = 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

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 signal to be filtered
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val kernel: GE

the filter kernel.
the filter kernel. This is read in initially and when kernelUpdate is one.
val kernelLen: GE

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

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).
def makeUGen(args: IndexedSeq[UGenIn])(implicit b: Builder): UGenInLike

Attributes
protected
Definition Classes
Convolution → 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
Convolution → Expander
val mode: GE

currently unused; leave at zero
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 Convolution(in: GE, kernel: GE, kernelLen: GE, kernelUpdate: GE = 0, mode: GE = 0) extends SingleOut with Product with Serializable

Instance Constructors

new Convolution(in: GE, kernel: GE, kernelLen: GE, kernelUpdate: GE = 0, mode: GE = 0)

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

val kernel: GE

val kernelLen: GE

val kernelUpdate: GE

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

def makeUGens(implicit b: Builder): UGenInLike

val mode: GE

final def name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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 SingleOut

Inherited from SomeOut[StreamOut]

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike, StreamOut]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped