43 lines
1.6 KiB
Plaintext
43 lines
1.6 KiB
Plaintext
---
|
||
title: sech
|
||
description: API reference for qiskit.pulse.library.sech
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: function
|
||
python_api_name: qiskit.pulse.library.sech
|
||
---
|
||
|
||
# qiskit.pulse.library.sech
|
||
|
||
<Function id="qiskit.pulse.library.sech" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.21/qiskit/pulse/library/discrete.py" signature="sech(duration, amp, sigma, name=None, zero_ends=True)">
|
||
Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform").
|
||
|
||
For $A=$ `amp` and $\sigma=$ `sigma`, applies the `midpoint` sampling strategy to generate a discrete pulse sampled from the continuous function:
|
||
|
||
$$
|
||
f(x) = A\text{sech}\left(\frac{x-\mu}{\sigma} \right)
|
||
$$
|
||
|
||
with the center $\mu=$ `duration/2`.
|
||
|
||
If `zero_ends==True`, each output sample $y$ is modified according to:
|
||
|
||
$$
|
||
y \mapsto A\frac{y-y^*}{A-y^*},
|
||
$$
|
||
|
||
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`](qiskit.pulse.library.Waveform "qiskit.pulse.library.waveform.Waveform")
|
||
</Function>
|
||
|