47 lines
1.9 KiB
Plaintext
47 lines
1.9 KiB
Plaintext
---
|
||
title: Gaussian
|
||
description: API reference for qiskit.pulse.library.Gaussian
|
||
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} github="https://github.com/Qiskit/qiskit/tree/stable/1.1/qiskit/pulse/library/symbolic_pulses.py" 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.12)")
|
||
|
||
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)$.
|
||
|
||
Create new pulse instance.
|
||
|
||
**Parameters**
|
||
|
||
* **duration** – Pulse length in terms of the sampling period dt.
|
||
* **amp** – The magnitude of the amplitude of the Gaussian envelope.
|
||
* **sigma** – A measure of how wide or narrow the Gaussian peak is; described mathematically in the class docstring.
|
||
* **angle** – The angle of the complex amplitude of the Gaussian envelope. Default value 0.
|
||
* **name** – Display name for this pulse envelope.
|
||
* **limit\_amplitude** – 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.
|
||
|
||
## Attributes
|
||
|
||
### alias
|
||
|
||
<Attribute id="qiskit.pulse.library.Gaussian.alias" attributeValue="'Gaussian'" />
|
||
</Class>
|
||
|