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

slide~

Filter a signal logarithmically

Description

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

Examples

slide~ performs logarithmic smoothing of an input signal

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

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.

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 [float]

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

textjustification [int]

Text Justification

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

Arguments

current-output-sample [int]
Sets the current output sample value (the value from which the next incoming value will smoothly transition from).

float

Arguments

current-output-sample [float]
Sets the current output sample value (the value from which the next incoming value will smoothly transition from).

  (inlet1)

Arguments

slide-up [float]
In middle inlet: Specifies the slide up value to be used when an incoming value is greater than the current value.

  (inlet2)

Arguments

slide-down [float]
In right inlet: Specifies the slide down value to be used when an incoming value is less than the current value.

signal

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.

slide_down

Arguments

slide-down [float]
The message slide_down followed by a float will specify the slide-down value to be used when an incoming value is less than the current value.

slide_up

Arguments

slide-up [float]
The message slide_up followed by a float will specify the slide-up value to be used when an incoming value is greater than the current value.

reset

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

Output

signal

The filtered signal.

See Also

Name Description
rampsmooth~ Smooth an incoming signal
Audio Filtering Audio Filtering