zmap Reference

Maps input range of values to output range

zmap

Description

Maps an input range of values and to an output range of values. Similar to scale, but clips values to the ranges, and does not allow inverted scaling.

Examples

An example of how to map an integer slider into a useful range of floating-point values and back again

Arguments

minimum-input [number]

The minimum input value. If the low values is higher than the corresponding high value, the two values are reversed to preserve the high-low relationship.

maximum-input [number]

The maximum input value. If the low values is higher than the corresponding high value, the two values are reversed to preserve the high-low relationship.

minimum-output [number]

The minimum output value. If the low values is higher than the corresponding high value, the two values are reversed to preserve the high-low relationship. The zmap object will clip to the boundaries of the output range.

maximum-output [number]

The maximum output value. If the low values is higher than the corresponding high value, the two values are reversed to preserve the high-low relationship. The zmap object will clip to the boundaries of the output range.

Attributes

Common Box Attributes

Messages

int

Arguments

input [int]
Converted to float.

float

Arguments

input [float]
In left inlet: The incoming value is scaled according to the mapping provided by the arguments, or values received in the other inlets.
Note: The preservation of the high-low relationship is different from the behavior of the scale object, which lets you do reverse scaling. Also, note that the zmap object will clip to the boundaries of the output range.

  (inlet1)

Arguments

minimum-input [float]
In second inlet: Sets the low input value. If the value is higher than the high input value, the two values are reversed to preserve the high-low relationship.

  (inlet2)

Arguments

maximum-input [float]
In third inlet: Sets the high input value. If the value is lower than the low input value, the two values are reversed to preserve the high-low relationship.

  (inlet3)

Arguments

minimum-output [float]
In fourth inlet: Sets the low output value. If the value is higher than the high output value, the two values are reversed to preserve the high-low relationship.

  (inlet4)

Arguments

maximum-output [float]
In right inlet: Sets the high output value. If the value is higher than the high output value, the two values are reversed to preserve the high-low relationship.

list

Arguments

input [list]
In left inlet: A list of numbers sent to the left inlet will trigger the output of a list consisting of the results of performing the specified scaling operation on each item in the input list.

Output

float

When zmap receives a value in its leftmost inlet, that value is scaled to the indicated output range of values.

See Also

Name Description
scale
expr