A newer version of Max is available. Click here to access the latest version of the documentation

cascade~ Reference

Cascaded series of biquad filters

cascade~

Description

Use the cascade~ to filter an input signal using a series of biquad filters.

Examples

Use cascade~ with filtergraph~ in multi-filter mode to efficiently process a complex parametric filter

Arguments

None.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text.

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

list

Arguments

filter-coefficients [list]
The filter coefficients can be provided as a list in the left or right inlet. The coefficients should be in sets of five, each set corresponding to a second-order section or biquad. The first five coefficients in the list are used for the first second-order section in the series, the next five for the second, and so on.

bypass

Arguments

operational-flag [int]
The word bypass followed by a nonzero number will turn bypass mode on and cause the dry unfiltered signal to pass through to the object's outlet; followed by a 0 will output the filtered signal.

clear

Resets all coefficients and sample-memory to 0.

dictionary

Arguments

dictionary-name [symbol]
The word dictionary, followed by a symbol that references a named filterdesign object dictionary (set via the name attribute), will cause the cascade~ object to use the dictionary values for filter coefficients.

signal

In left inlet: Signal to be filtered. The signal is filtered by a series of two-pole two-zero (i.e. biquad) filters, often referred to as "second order sections".

zero

Arguments

operational-flag [int]
The word zero followed by a nonzero number will cause the filtered signal to be muted; followed by a 0 will output the filtered signal (this will not prevent the unfiltered signal from appearing at the outlet when bypass mode is turned on).

Output

signal

The filtered signal.

See Also

Name Description
Sound Processing Techniques Sound Processing Techniques
biquad~ Two-pole, two-zero filter
buffir~ buffer-based FIR filter
comb~ Apply a comb filter effect
filtergraph~ Filter editor
lores~ Resonant lowpass filter
onepole~ Single-pole lowpass filter
reson~ Resonant bandpass filter
teeth~ Comb filter with feedforward and feedback delay control
Audio Filtering Audio Filtering