ModulatedAmplitude object

The ModulatedAmplitude object defines a modulated amplitude curve.

The ModulatedAmplitude object is derived from the Amplitude object.

This page discusses:

Access

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

This method creates a ModulatedAmplitude object.

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

name: A String specifying the repository key.
initial: A Float specifying the constant $A_{0}$ .
magnitude: A Float specifying the coefficient $A$ .
start: A Float specifying the starting time $t_{0}$ . Possible values are non-negative numbers.
frequency1: A Float specifying the circular frequency 1 ( $ω_{1}$ ). Possible values are positive numbers.
frequency2: A Float specifying the circular frequency 2 ( $ω_{2}$ ). Possible values are positive numbers.

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

A ModulatedAmplitude object.

InvalidNameError and RangeError.

This method modifies the ModulatedAmplitude object.

None.

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

None.

RangeError.

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