lores~
Resonant lowpass filter
Description
lores~ implements an inexpensive lowpass with an adjustment that lets you add a specified resonance. The middle inlet sets a kind of cutoff frequency, but the sharpness of the filter depends on the resonance passed in through the right inlet (0 is a little bit sharp and 1 as sharp as possible).
Arguments
cutoff[number]
optional
A number sets the initial cutoff frequency. The default value is 0. If a signal is connected to the inlet, the argument corresponding to the inlet is ignored.
resonance[number]
optional
A number sets the filter resonance. The default value is 0. If a signal is connected to the inlet, the argument corresponding to the inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
Attributes
cutoff[float]
Sets the initial cutoff frequency.
resonance[float]
Sets the filter resonance. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
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]: 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'
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
int
An int can be sent in the middle or right inlets to change the cutoff frequency or resonance. If a signal is connected one of the inlets, a number received in that inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
- cutoff-frequency/resonance
[int]
float
float can be sent in the middle or right inlets to change the cutoff frequency or resonance. If a signal is connected one of the inlets, a number received in that inlet is ignored. A resonance of 0 is a little bit sharp and 1 is as sharp as possible.
- cutoff-frequency/resonance
[float]
clear
Clears the filter's memory. Since lores~ is a recursive filter, this message may be necessary to recover from blowups.
signal
In left inlet: Any signal to be filtered.
In middle inlet: Sets the lowpass filter cutoff frequency.
In right inlet: Sets a "resonance factor" between 0 (minimum resonance) and 1 (maximum resonance). Values very close to 1 may produce clipping with certain types of input signals.
Output
signal
The filtered input signal. The equation of the filter is
yn = scale * xn - c1 * yn-1 + c2 * yn-2
where scale, c1, and c2 are parameters calculated from the cutoff frequency and resonance factor.
See Also
| Name | Description |
|---|---|
| biquad~ | Two-pole, two-zero filter |
| buffir~ | buffer-based FIR filter |
| comb~ | Apply a comb filter effect |
| cross~ | Third-order crossover filter |
| onepole~ | Single-pole lowpass filter |
| svf~ | State-variable filter with simultaneous outputs |
| reson~ | Resonant bandpass filter |