36 lines
1.5 KiB
Plaintext
36 lines
1.5 KiB
Plaintext
---
|
|
title: Gaussian (v1.4)
|
|
description: API reference for qiskit.pulse.library.Gaussian in qiskit v1.4
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit.pulse.library.Gaussian
|
|
---
|
|
|
|
# Gaussian
|
|
|
|
<Class id="qiskit.pulse.library.Gaussian" isDedicatedPage={true} signature="qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)" modifiers="class">
|
|
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")
|
|
|
|
A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2):
|
|
|
|
$$
|
|
\begin{aligned}
|
|
f'(x) &= \exp\Bigl( -\frac12 \frac{{(x - \text{duration}/2)}^2}{\text{sigma}^2} \Bigr)\\
|
|
f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration}
|
|
\end{aligned}
|
|
$$
|
|
|
|
where $f'(x)$ is the gaussian waveform without lifting or amplitude scaling, and $\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right)$.
|
|
|
|
<Admonition title="Deprecated since version 1.3" type="danger">
|
|
The class `qiskit.pulse.library.symbolic_pulses.Gaussian` 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](https://github.com/qiskit-community/qiskit-dynamics)
|
|
</Admonition>
|
|
|
|
## Attributes
|
|
|
|
### alias
|
|
|
|
<Attribute id="qiskit.pulse.library.Gaussian.alias" attributeValue="'Gaussian'" />
|
|
</Class>
|
|
|