Package MSP

filterdetail

Detail the characteristics of a filter

Description

Use the filterdetail object to produce details from a filter specification provided as input. The filter specification may be generated by the filterdesign object, or by other means. The output includes the impulse response, step response, magnitude and phase responses, as well as phase and group delay.

Arguments

None.

Attributes

numpoints[int]

The resolution of the returned filter characteristics. You may reduce this to reduce the computational intensity of performing the detailing calculations, or increase it to gain greater resolution. By default, a resolution of 512 points is used.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

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

background[int]: 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]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

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

position[2 floats]
write-only

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]: 0

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

presentation_rect[4 floats]: 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]
write-only

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]
write-only

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

Specify a biquad filter using a list of five filter coefficients

Arguments:
  • a0 [float]
  • a1 [float]
  • a2 [float]
  • b1 [float]
  • b2 [float]

dictionary

A filterdesign dictionary specifying a filter in terms of its zeroes, poles, and gain or as a transfer function. The transfer function is expressed as a fraction with the FIR coefficients composing the numerator and the IIR coefficients composing the denominator. The zero-pole-gain representation is preferred because it yields a more numerically accurate result.

Arguments:
  • dictionary-name [symbol]

Output

list

  • leftmost outlet -- magnitude response
  • second outlet -- phase response
  • third outlet -- phase delay
  • fourth outlet -- group delay
  • fifth outlet -- impulse response
  • rightmost outlet -- step response

See Also

Name Description
filterdesign Create a filter specification
plot~ Visualize two-dimensional data
cascade~ Cascaded series of biquad filters
biquad~ Two-pole, two-zero filter