Skip to main contentIBM Quantum Documentation

qiskit.pulse.library.Triangle

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

GitHub

A triangle wave pulse.

The envelope of the pulse is given by:

f(x)=A[sawtooth(x)],0<=x<durationf(x) = \text{A}\left[\text{sawtooth}\left(x\right)\right] , 0 <= x < duration

where A=amp×exp(i×angle)\text{A} = \text{amp} \times\exp\left(i\times\text{angle}\right), and sawtooth(x)\text{sawtooth}\left(x\right) is a sawtooth wave with the same frequency as the triangle wave, but a phase shifted by π2\frac{\pi}{2}.

Deprecated since version 1.3

The function qiskit.pulse.library.symbolic_pulses.Triangle() 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 triangle wave. Wave range is [-amp,`amp`].
  • phase (float |ParameterExpression) – The phase of the triangle wave (note that this is not equivalent to the angle of the complex amplitude)
  • freq (float |ParameterExpression | None) – The frequency of the triangle 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

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