Skip to content

Set Amplitude Controller (of All Modes)

Description

This allows the relative amplitudes of all the modes of an object to be altered dynamically using a controller. Think of it as a 'mode equalizer' (by default mode amplitudes are set to 1.)

(set-amplitude ... )

Syntax and Default Values

The (set-amplitude ... ) function can be called using the following syntax: 

(set-amplitude object_reference controller)

Parameters

The (set-amplitude ... ) function requires two arguments:

  • object_reference: name of the object whose modes' relative amplitudes will be altered.
  • controller: a multi-dimensional controller used to set the individual amplitudes of the object's modes.
modalys.set_amplitude_controller(object,ctrl)

⚠️ The number of dimensions in the controller should correspond to the number of modes in the object, or the remaining mode losses will be set to zero.

Discussion

This function is used to set all the individual mode amplitudes to new values:

(setq my-string (make-object 'mono-string (modes 4)))
(set-amplitude my-string (const 0.2 0.5 0.8 1.0))
This function is not yet implemented for Hybrids; an error message will be displayed if object is of hybrid type.

Options

There are no special options for this function.