Skip to main contentIBM Quantum Documentation Mirror

qiskit.pulse.library.Sawtooth

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

GitHub

A sawtooth pulse.

The envelope of the pulse is given by:

f(x)=2A[g(x)−⌊g(x)+12⌋]f(x) = 2\text{A}\left[g\left(x\right)- \lfloor g\left(x\right)+\frac{1}{2}\rfloor\right]

where A=amp×exp⁡(i×angle)\text{A} = \text{amp} \times\exp\left(i\times\text{angle}\right), g(x)=x×freq+phase2πg\left(x\right)=x\times\text{freq}+\frac{\text{phase}}{2\pi}, and ⌊...⌋\lfloor ...\rfloor is the floor operation.

Deprecated since version 1.3

The function qiskit.pulse.library.symbolic_pulses.Sawtooth() 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 |ParameterExpression) – Pulse length in terms of the sampling period dt.
  • amp (float |ParameterExpression) – The magnitude of the amplitude of the sawtooth wave. Wave range is [-amp,`amp`].
  • phase (float |ParameterExpression) – The phase of the sawtooth wave (note that this is not equivalent to the angle of the complex amplitude)
  • freq (float |ParameterExpression | None) – The frequency of the sawtooth wave, in terms of 1 over sampling period. If not provided defaults to a single cycle (i.e :math:’frac{1}{text{duration}}’). The frequency is limited to the range (0,0.5]\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