Package MSP

slide~

Filter a signal logarithmically

Description

Use the slide~ object for envelope following and lowpass filtering.

Discussion

The slide~ object filters an input signal logarithmically between changes in signal value. The formula is y (n) = y (n-1) + ((x (n) - y (n-1))/slide).

Arguments

slide-up[float]
optional

Specifies the slide up value. The default is 1. (Also accepts integers for these arguments as well as the associated messages which address these parameter settings.)

slide-down[float]
optional

A second argument specifies the slide down value. The default is 1. (Also accepts integers for these arguments as well as the associated messages which address these parameter settings.)

Attributes

slidedown[float]

The slidedown attribute specifies the slide-down value to be used when an incoming value is less than the current value.

slideup[float]

The slideup attribute specifies the slide-up value to be used when an incoming value is greater than the current value.

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

int

In middle inlet: Use an int to set the slide-up value.

In right inlet: Use an int to set the slide-down value.

Arguments:
  • slide-up/down-value [int]

float

In middle inlet: Use a float to set the slide-up value.

In right inlet: Use a float to set the slide-down value.

Arguments:
  • slide-up/down-value [float]

reset

Sets the current output sample value to 0 (the next incoming value will smoothly transition from that 0).

signal

In left inlet: A signal to be filtered. Whenever a new value is received, slide~ filters the input signal logarithmically between changes in signal value using the formula:

y (n) = y (n-1) + ((x (n) - y (n-1))/slide)

A given sample output from slide~ is equal to the last sample's value plus the difference between the last sample's value and the input divided by the slide value. Given a slide value of 1, the output will therefore always equal the input. Given a slide value of 10, the output will only change 1/10th as quickly as the input. This can be particularly useful for lowpass filtering or envelope following.

In middle inlet: Use a signal to set the slide-up value.

In right inlet: Use a signal to set the slide-down value.

Output

signal

The filtered signal.

See Also

Name Description
rampsmooth~ Smooth an incoming signal