Skip to main content
IBM Quantum Platform

GaussianSquare

class qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)

Bases: object

A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero.

Exactly one of the risefall_sigma_ratio and width parameters has to be specified.

If risefall_sigma_ratio is not None and width is None:

risefall=risefall_sigma_ratio×sigmawidth=duration−2×risefall\begin{aligned} \text{risefall} &= \text{risefall\_sigma\_ratio} \times \text{sigma}\\ \text{width} &= \text{duration} - 2 \times \text{risefall} \end{aligned}

If width is not None and risefall_sigma_ratio is None:

risefall=duration−width2\text{risefall} = \frac{\text{duration} - \text{width}}{2}

In both cases, the lifted gaussian square pulse f′(x)f'(x) is defined as:

f′(x)={exp⁡(−12(x−risefall)2sigma2)x<risefall1risefall≤x<risefall+widthexp⁡(−12(x−(risefall+width))2sigma2)risefall+width≤xf(x)=A×f′(x)−f′(−1)1−f′(−1),0≤x<duration\begin{aligned} f'(x) &= \begin{cases} \exp\biggl(-\frac12 \frac{(x - \text{risefall})^2}{\text{sigma}^2}\biggr) & x < \text{risefall}\\ 1 & \text{risefall} \le x < \text{risefall} + \text{width}\\ \exp\biggl(-\frac12 \frac{{\bigl(x - (\text{risefall} + \text{width})\bigr)}^2} {\text{sigma}^2} \biggr) & \text{risefall} + \text{width} \le x \end{cases}\\ f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration} \end{aligned}

where f′(x)f'(x) is the gaussian square waveform without lifting or amplitude scaling, and A=amp×exp⁡(i×angle)\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right).

Deprecated since version 1.3

The class qiskit.pulse.library.symbolic_pulses.GaussianSquare is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics

Attributes

alias

Default value: 'GaussianSquare'

Was this page helpful?
Report a bug or request content on GitHub.