qiskit.pulse.library.Square

qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)

A square wave pulse.

The envelope of the pulse is given by:

f(x) = \text{A}\text{sign}\left[\sin \left(2\pi x\times\text{freq}+\text{phase}\right)\right] , 0 <= x < duration

\text{A} = \text{amp} \times\exp\left(i\times\text{angle}\right)

Deprecated since version 1.3

The function qiskit.pulse.library.symbolic_pulses.Square() 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

Parameters

duration (int | ParameterValueType) – Pulse length in terms of the sampling period dt.
amp (float |ParameterExpression) – The magnitude of the amplitude of the square wave. Wave range is $\left[-\texttt{amp},\texttt{amp}\right]$ .
phase (float |ParameterExpression) – The phase of the square wave (note that this is not equivalent to the angle of the complex amplitude).
freq (float |ParameterExpression | None) – The frequency of the square wave, in terms of 1 over sampling period. If not provided defaults to a single cycle (i.e $\frac{1}{\text{duration}}$ ). The frequency is limited to the range $\left(0,0.5\right]$ (the Nyquist frequency).
angle (float |ParameterExpression | None) – The angle in radians of the complex phase factor uniformly scaling the pulse. Default value 0.
name (str | None) – Display name for this pulse envelope.
limit_amplitude (bool | None) – If True, then limit the amplitude of the waveform to 1. The default is True and the amplitude is constrained to 1.

Returns

ScalableSymbolicPulse instance.

Return type

ScalableSymbolicPulse