qiskit.pulse.library.sech

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

Generates unnormalized sech Waveform.

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

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

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

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

Parameters

• 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

Waveform