3.8 PeriodicAmplitude object

The PeriodicAmplitude object defines an amplitude curve using a Fourier series.

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

Path

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

Required arguments

name

A String specifying the repository key.

frequency

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

start

A Float specifying the starting time . Possible values are positive numbers.

a_0

A Float specifying the constant .

data

A sequence of pairs of Floats specifying and pairs.

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 PeriodicAmplitude object.

Exceptions

InvalidNameError and RangeError.

This method modifies the PeriodicAmplitude object.

Required arguments

None.

Optional arguments

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

Return value

None

Exceptions

RangeError.

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