/  Basic Filter UGens

FilterBasic

LPF

HPF

BPF

BRF

BiQuad

ResonZ

OnePole

OneZero

TwoPole

TwoZero

PoleZero

Basic filter unit generators.

FilterBasic

inherits : UGen : Object

Base class for basic filters with a notion of center/cutoff frequency and Q.

constructors

FilterBasic()

Default constructor for FilterBasic.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter cutoff/center frequency.

float freq()

Get filter cutoff/center frequency.

void set(float freq, float Q)

Set filter frequency and resonance at the same time.


LPF

inherits : FilterBasic : UGen : Object

A resonant low-pass filter (2nd order Butterworth).

examples

constructors

LPF()

Default constructor for LPF.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter cutoff frequency.

float freq()

Get filter cutoff frequency.

void set(float freq, float Q)

Set filter frequency and resonance at the same time.


HPF

inherits : FilterBasic : UGen : Object

A resonant high-pass filter (2nd order Butterworth).

examples

constructors

HPF()

Default constructor for HPF.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter cutoff frequency.

float freq()

Get filter cutoff frequency.

void set(float freq, float Q)

Set filter frequency and resonance at the same time.


BPF

inherits : FilterBasic : UGen : Object

A bandpass filter (2nd order Butterworth).

examples

constructors

BPF()

Default constructor for BPF.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter center frequency.

float freq()

Set filter center frequency.

void set(float freq, float Q)

Get filter frequency and resonance at the same time.


BRF

inherits : FilterBasic : UGen : Object

A band-reject filter (2nd order Butterworth).

examples

constructors

BRF()

Default constructor for BRF.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter center frequency.

float freq()

Get filter center frequency.

void set(float freq, float Q)

Set filter frequency and resonance at the same time.


BiQuad

inherits : UGen : Object

A BiQuad (two-pole, two-zero) filter section from STK. A method is provided for creating a resonance in the frequency response while maintaining a constant filter gain.

examples

constructors

BiQuad()

Default constructor for BiQuad.

member functions

float a0(float value)

Set filter coefficient.

float a0()

Get filter coefficient.

float a1(float value)

Set filter coefficient.

float a1()

Get filter coefficient.

float a2(float value)

Set filter coefficient.

float a2()

Get filter coefficient.

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float b1(float value)

Set filter coefficient.

float b1()

Get filter coefficient.

float b2(float value)

Set filter coefficient.

float b2()

Get filter coefficient.

int eqzs(int value)

Enable equal-gain zeroes.

int norm(int value)

Toggle normalization.

int norm()

Get normalization setting.

float pfreq(float freq)

Set resonance frequency (poles).

float pfreq()

Get resonance frequency (poles).

float prad(float value)

Set Pole radius (values greater than 1 will be unstable).

float prad()

Get pole radius.

float pregain(float level)

Set pregain.

float pregain()

Get pregain.

float zfreq(float freq)

Set notch frequency.

float zfreq()

Get notch frequency.

float zrad(float value)

Set zero radius.

float zrad()

Get zero radius.


ResonZ

inherits : FilterBasic : UGen : Object

A resonance filter with equal-gain zeros; keeps gain under control independent of frequency.

examples

constructors

ResonZ()

Default constructor for ResonZ.

member functions

float Q(float val)

Set filter resonance.

float Q()

Get filter resonance.

float freq(float val)

Set filter center frequency.

float freq()

Get filter center frequency.

void set(float freq, float Q)

Set filter frequency and resonance at the same time.


OnePole

inherits : UGen : Object

This Filter subclass implements a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain. by Perry R. Cook and Gary P. Scavone, 1995 - 2002.

examples

constructors

OnePole()

Default constructor for OnePole.

member functions

float a1(float value)

Set filter coefficient.

float a1()

Get filter coefficient.

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float pole(float value)

Set pole position along real axis of z-plane.

float pole()

Get pole position along real axis of z-plane.


OneZero

inherits : UGen : Object

This Filter subclass implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain. by Perry R. Cook and Gary P. Scavone, 1995 - 2002.

examples

constructors

OneZero()

Default constructor for OneZero.

member functions

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float b1(float value)

Set filter coefficient.

float b1()

Get filter coefficient.

float zero(float value)

Set zero position.

float zero()

Get zero position.


TwoPole

inherits : UGen : Object

This Filter subclass implements a two-pole digital filter. A method is provided for creating a resonance in the frequency response while maintaining a nearly constant filter gain. by Perry R. Cook and Gary P. Scavone, 1995 - 2002.

examples

constructors

TwoPole()

Default constructor for TwoPole.

member functions

float a1(float value)

Set filter coefficient.

float a1()

Get filter coefficient.

float a2(float value)

Set filter coefficient.

float a2()

Get filter coefficient.

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float freq(float value)

Set filter resonance frequency.

float freq()

Get filter resonance frequency.

int norm(int value)

Set filter normalization.

int norm()

Get filter normalization.

float radius(float value)

Set filter radius resonance.

float radius()

Get filter radius resonance.


TwoZero

inherits : UGen : Object

This Filter subclass implements a two-zero digital filter. A method is provided for creating a 'notch' in the frequency response while maintaining a constant filter gain. by Perry R. Cook and Gary P. Scavone, 1995 - 2002.

examples

constructors

TwoZero()

Default constructor for TwoZero.

member functions

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float b1(float value)

Set filter coefficient.

float b1()

Get filter coefficient.

float b2(float value)

Set filter coefficient.

float b2()

Get filter coefficient.

float freq(float value)

Set filter notch frequency.

float freq()

Get filter notch frequency.

float radius(float value)

Set filter notch radius.

float radius()

Get filter notch radius.


PoleZero

inherits : UGen : Object

A one-pole, one-zero digital filter. A method is provided for creating an allpass filter with a given coefficient. Another method is provided to create a DC blocking filter. by Perry R. Cook and Gary P. Scavone, 1995 - 2002.

examples

constructors

PoleZero()

Default constructor for PoleZero.

member functions

float a1(float value)

Set filter coefficient.

float a1()

Get filter coefficient.

float allpass(float value)

Set allpass filter with given coefficient.

float allpass()

Get allpass filter with given coefficient.

float b0(float value)

Set filter coefficient.

float b0()

Get filter coefficient.

float b1(float value)

Set filter coefficient.

float b1()

Get filter coefficient.

float blockZero(float value)

Set DC blocking filter with given pole position.

float blockZero()

Get DC blocking filter with given pole position.