3.5 DecayAmplitude object

The DecayAmplitude object defines an amplitude curve using an exponential decay.

The DecayAmplitude 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 DecayAmplitude object.

Path

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

Required arguments

name

A String specifying the repository key.

initial

A Float specifying the constant .

maximum

A Float specifying the coefficient .

start

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

decayTime

A Float specifying the decay time . Possible values are non-negative 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 DecayAmplitude object.

Exceptions

InvalidNameError and RangeError.

This method modifies the DecayAmplitude object.

Required arguments

None.

Optional arguments

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

Return value

None

Exceptions

RangeError.

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