-
Delay — An empty waveform.
-
Ramp — A ramp that linearly interpolates between an initial and final value.
-
Constant — A constant waveform over a given duration.
-
PiecewiseLinear — A piecewise linear waveform.
-
Sin — An arbitrary sine over a given duration.
qoolqit.waveforms.waveforms
module
qoolqit.waveforms.waveforms
Classes
class
Delay
(duration: float, *args: float, **kwargs: float)
Bases : Waveform
An empty waveform.
Initializes the Waveform.
Parameters
-
duration : float — the total duration of the waveform.
Attributes
-
duration : float — Returns the duration of the waveform.
-
params : dict[str, float] — Dictonary of parameters used by the waveform.
Methods
method
function
(t: float) → float
method
max
() → float
method
min
() → float
class
Ramp
(duration: float, initial_value: float, final_value: float)
Bases : Waveform
A ramp that linearly interpolates between an initial and final value.
Parameters
-
duration : float — the total duration.
-
initial_value : float — the initial value at t = 0.
-
final_value : float — the final value at t = duration.
Attributes
-
duration : float — Returns the duration of the waveform.
-
params : dict[str, float] — Dictonary of parameters used by the waveform.
Methods
method
function
(t: float) → float
method
max
() → float
method
min
() → float
class
Constant
(duration: float, value: float)
Bases : Waveform
A constant waveform over a given duration.
Parameters
-
duration : float — the total duration.
-
value : float — the value to take during the duration.
Attributes
-
duration : float — Returns the duration of the waveform.
-
params : dict[str, float] — Dictonary of parameters used by the waveform.
Methods
method
function
(t: float) → float
method
max
() → float
method
min
() → float
class
PiecewiseLinear
(durations: list | tuple, values: list | tuple)
Bases : CompositeWaveform
A piecewise linear waveform.
Creates a composite waveform of N ramps that linearly interpolate through the given N+1 values.
Parameters
-
durations : list | tuple — list or tuple of N duration values.
-
values : list | tuple — list or tuple of N+1 waveform values.
Attributes
-
duration : float — Returns the duration of the waveform.
-
params : dict[str, float] — Dictonary of parameters used by the waveform.
-
durations : list[float] — Returns the list of durations of each individual waveform.
-
times : list[float] — Returns the list of times when each individual waveform starts.
-
waveforms : list[Waveform] — Returns a list of the individual waveforms.
-
n_waveforms : int — Returns the number of waveforms.
class
Sin
(duration: float, amplitude: float = 1.0, omega: float = 1.0, phi: float = 0.0, shift: float = 0.0)
Bases : Waveform
An arbitrary sine over a given duration.
Parameters
-
duration : float — the total duration.
-
amplitude : float — the amplitude of the sine wave.
-
omega : float — the frequency of the sine wave.
-
phi : float — the phase of the sine wave.
-
shift : float — the vertical shift of the sine wave.
Attributes
-
duration : float — Returns the duration of the waveform.
-
params : dict[str, float] — Dictonary of parameters used by the waveform.
Methods