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

slide

Smooth values logarithmically

Description

Filters an input value logarithmically between changes. It's particularly useful for envelope following and lowpass filtering to smooth a stream of continuous data.

Examples

slide performs logarithmic smoothing of an input

Discussion

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.

slide-down-value [float]

Optional

A second argument specifies the slide down value. The default is 1.

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

bang

Performs the same function as float using the last input value.

int

Arguments

input [int]
Converted to float.

float

Arguments

input [float]
In left inlet: An input value to be filtered. When a new value is received, object filters an input value logarithmically between changes 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 value plus the difference between the last 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.

  (inlet1)

Arguments

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

  (inlet2)

Arguments

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

set

Arguments

input [int]
The word set followed by a number will set the current input value to the given number without causing output (bang can be used to cause successive output).

reset

Resets the current output sample to 0.

Output

float

The filtered input value.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
Working with OpenGL Working with OpenGL
expr Evaluate a mathematical expression
Max Data Tutorial 2: Data Scaling Max Data Tutorial 2: Data Scaling