3.7 ModulatedAmplitude object

The ModulatedAmplitude object defines a modulated amplitude curve.

The ModulatedAmplitude object is derived from the Amplitude object.

Access

import amplitude
mdb.models[name].amplitudes[name]
import odbAmplitude
session.odbs[name].amplitudes[name]

This method creates a ModulatedAmplitude object.

Path

mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude

Required arguments

name

A String specifying the repository key.

initial

A Float specifying the constant .

magnitude

A Float specifying the coefficient .

start

A Float specifying the starting time . Possible values are non-negative numbers.

frequency1

A Float specifying the circular frequency 1 (). Possible values are positive numbers.

frequency2

A Float specifying the circular frequency 2 (). Possible values are positive numbers.

Optional argument

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Return value

A ModulatedAmplitude object.

Exceptions

InvalidNameError and RangeError.

This method modifies the ModulatedAmplitude object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the ModulatedAmplitude method, except for the name argument.

Return value

None

Exceptions

RangeError.

The ModulatedAmplitude object has members with the same names and descriptions as the arguments to the ModulatedAmplitude method.