CustomWaveform

class pulser.waveforms.CustomWaveform(samples)

A custom waveform.

Parameters:: samples (ArrayLike | pm.TensorLike) – The modulation values at each time step. The number of samples dictates the duration, in ns.

Attributes

`duration`	The duration of the pulse (in ns).
`first_value`	The first value in the waveform.
`integral`	Integral of the waveform (in [waveform units].µs).
`last_value`	The last value in the waveform.
`samples`	The value at each time step that describes the waveform.

Methods

`change_duration`	Returns a new waveform with modified duration.
`draw`	Draws the waveform.
`modulated_samples`	The waveform samples as output of a given channel.
`modulation_buffers`	The minimal buffers needed around a modulated waveform.

Signatures

change_duration(new_duration)

Returns a new waveform with modified duration.

draw(output_channel=None, ylabel=None)

Draws the waveform.

Parameters:

output_channel (Channel | None, default: None) – The output channel. If given, will draw the modulated waveform on top of the input one.
ylabel (str | None, default: None) – An optional label for the y-axis of the plot.

Return type:

None

modulated_samples(channel, eom=False)

The waveform samples as output of a given channel.

This duration is adjusted according to the minimal buffer times.

Parameters:

Return type:

AbstractArray

Returns:

The array of samples after modulation.

modulation_buffers(channel, eom=False)

The minimal buffers needed around a modulated waveform.

Parameters:

channel (Channel) – The channel modulating the waveform.
eom (bool, default: False) – Whether to calculate the modulation buffers with the EOM bandwidth.

Return type:

tuple[int, int]

Returns:

The minimum buffer times at the start and end of the samples, in ns.

property integral: float: Integral of the waveform (in [waveform units].µs).

property samples: AbstractArray

The value at each time step that describes the waveform.