qiskit.pulse.library.gaussian_square
gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)
Generates gaussian square Waveform
.
For duration
, amp
, sigma
, and risefall
, applies the midpoint
sampling strategy to generate a discrete pulse sampled from the continuous function:
where is the Gaussian function sampled from in gaussian()
with amp
, , and sigma
. I.e. represents a square pulse with smooth Gaussian edges.
If zero_ends == True
, the samples for the Gaussian ramps are remapped as in gaussian()
.
Parameters
- duration (int) – Duration of pulse. Must be greater than zero.
- amp (complex) – Pulse amplitude.
- sigma (float) – Width (standard deviation) of Gaussian rise/fall portion of the pulse.
- risefall (float | None) – Number of samples over which pulse rise and fall happen. Width of square portion of pulse will be
duration-2*risefall
. - width (float | None) – The duration of the embedded square pulse. Only one of
width
orrisefall
should be specified as the functional form requireswidth = duration - 2 * risefall
. - name (str | None) – Name of pulse.
- zero_ends (bool) – If True, zero ends at
x = -1, x = duration + 1
, but rescale to preserve amp.
Raises
PulseError – If risefall
and width
arguments are inconsistent or not enough info.
Return type
Was this page helpful?
Report a bug or request content on GitHub.