waveforms

Waveform definitions.

Full path: iqm.models.playlist.waveforms

Module Attributes

CanonicalWaveform

Alias for Waveform to emphasize the fact the waveforms defined in this module have their own serialisation.

Functions

is_canonical(waveform)	Returns True if waveform is a canonical waveform else False
register_canonical_waveform(cls)	Decorator for making a Waveform into a canonical waveform.
to_canonical(waveform)	Convert the waveform into a canonical version of itself, e.g. for serialization.

Classes

CanonicalWaveform	Alias for Waveform to emphasize the fact the waveforms defined in this module have their own serialisation.
Constant	Constant waveform.
CosineRiseFall	Waveform that has a sinusoidal rise and fall, and a constant part in between.
Gaussian	Gaussian pulse.
GaussianDerivative	Derivative of a gaussian pulse.
GaussianSmoothedSquare	Convolution of a square pulse and a gaussian pulse.
Samples	Custom pre-sampled waveform.
TruncatedGaussian	Gaussian pulse, where the decaying tails are removed by offsetting, truncating, and then rescaling the pulse slightly, so that the resulting waveform is zero where the original waveform reaches the threshold level, and beyond, while still reaching the same maximal pulse amplitude.
TruncatedGaussianDerivative	Derivative of a gaussian pulse, where the decaying tails are removed by offsetting, truncating, and then rescaling the pulse slightly, so that the resulting waveform is zero where the original waveform reaches the threshold level, and beyond, while still reaching the same maximal pulse amplitude.
TruncatedGaussianSmoothedSquare	Convolution of a square pulse and a gaussian pulse, offset and truncated so that it has finite support.
Waveform	Describes the normalized shape of a real-valued control pulse.