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

lookup~

Transfer function lookup table

Description

lookup~ allows you to use a table of samples (buffer~ object) to do waveshaping on a signal, in which the Y values of an input signal are used as X values to look up new signal values. Input values of -1 to +1 are mapped to table values between 0 (or the specified sample offset) and the size of the table.

Examples

Arguments

buffer-name [symbol]

Names the buffer~ object whose sample memory is used by lookup~ for table lookup.

sample-offset [int]

Optional

After the buffer~ name, you may specify the sample offset in the sample memory of the buffer~ used for a signal value of -1. The default offset is 0. The offset value is followed by an optional table size that defaults to 512. Note that the actual lookup~ table size is equal to the table size (set using the second argument) minus the offset (set using first argument), so raising the offset value will decrease the table size. The lookup~ object always uses the first channel in a multi-channel buffer~. The

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

Arguments

offset [int]
table-size [int]
The settings of offset and table size can be changed with a number in the middle or right inlets. If a signal is connected to one of these inlets, a number in the corresponding inlet is ignored.

float

Arguments

offset [int]
table-size [int]
The settings of offset and table size can be changed with an number in the middle or right inlets. If a signal is connected to one of these inlets, a number in the corresponding inlet is ignored.

(mouse)

Double-clicking on lookup~ opens an editing window where you can vieW the contents of its associated buffer~ object.

set

Arguments

buffer-name [symbol]
The word set, followed by a symbol, changes the associated buffer~ object.

signal

In left inlet: Signal values are mapped by amplitude to values stored in a buffer~. Each sample in the incoming signal within the range -1 to 1 is mapped to a corresponding value in the current table size number of samples of the buffer~. Signal values between -1 and 0 are mapped to the first half of the total number of samples after the current sample offset. Signal values between 0 and 1 are mapped to the next half of the samples. Input amplitude exceeding the range from -1 to 1 results in an output of 0.

In middle inlet: Sets the offset into the sample memory of a buffer~ used to map samples coming in the left inlet. The sample at the specified offset corresponds to an input value of -1.

In right inlet: Sets the number of samples in a buffer~ used for the table. Samples coming in the left inlet between -1 and 1 will be mapped by amplitude to the specified range of samples. The default value is 512. lookup~ changes the table size before it computes each vector but not within a vector. It uses the first sample in a signal vector coming in the right inlet as the table size.

Output

signal

Each sample in the incoming signal within the range -1 to 1 is mapped to a corresponding position in the current table size number of samples of the named buffer~ object, and the stored value is sent out.

See Also

Name Description
buffer~ Store audio samples
peek~ Read and write sample values
Sampling Tutorial 5: Waveshaping Sampling Tutorial 5: Waveshaping