trough
Max Reference
Open Help

trough

Output a number if it is less than previous numbers

Description

Compares an input value to the stored value and, if it's smaller it sends the input to the output and sets it as the new trough.

Examples

Find the smallest in a series of numbers... Number in right inlet always sets a new trough

Arguments

value [float]

Optional

The initial value stored in trough is 128 . Providing a float argument will cause trough to operate on floating-point values instead of integers.

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

In left inlet: Sends the currently stored minimum value out the left outlet.

int

Arguments

input [int]
In left inlet: If the input is less than the value currently stored in trough, it is stored as the new minimum value and is sent out.

  (inlet1)

Arguments

trough [int]
In right inlet: The input is stored in trough as the new minimum value, and is sent out.

float

Arguments

input [float]
In left inlet: If the input is less than the value currently stored in trough, it is stored as the new minimum value and is sent out.

  (inlet1)

Arguments

trough [float]
In right inlet: The input is stored in trough as the new minimum value, and is sent out.

Output

int

Out left outlet: New minimum values are sent out. (Numbers received in the right inlet are always the new minimum value.)

Out middle outlet: If the number received is a new minimum value, the output is 1 . If the number received in the left inlet is not a new minimum value, the output is 0 .

Out right outlet: If the number received is a new minimum value, the output is 0 . If the number received in the left inlet is not a new minimum value, the output is 1 .

See Also

Name Description
minimum Output the smallest value
peak Output larger numbers
< Compare numbers for less than condition
Max Data Tutorial 2: Data Scaling Max Data Tutorial 2: Data Scaling