Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version


sech(duration, amp, sigma, name=None, zero_ends=True)

GitHub(opens in a new tab)

Generates unnormalized sech Waveform.

For A=A= amp and σ=\sigma= sigma, applies the midpoint sampling strategy to generate a discrete pulse sampled from the continuous function:

f(x)=Asech(xμσ)f(x) = A\text{sech}\left(\frac{x-\mu}{\sigma} \right)

with the center μ=\mu= duration/2.

If zero_ends==True, each output sample yy is modified according to:

yAyyAy,y \mapsto A\frac{y-y^*}{A-y^*},

where yy^* is the value of the endpoint samples. This sets the endpoints to 00 while preserving the amplitude at the center. If A=yA=y^*, yy is set to 11. By default, the endpoints are at x = -1, x = duration + 1.


  • duration (int) – Duration of pulse. Must be greater than zero.
  • amp (complex) – Pulse amplitude at duration/2.
  • sigma (float) – Width (standard deviation) of pulse.
  • name (Optional[str]) – Name of pulse.
  • zero_ends (bool) – If True, zero ends at x = -1, x = duration + 1, but rescale to preserve amp.

Return type


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