173 lines
6.6 KiB
Plaintext
173 lines
6.6 KiB
Plaintext
---
|
||
title: Drag
|
||
description: API reference for qiskit.pulse.library.Drag
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.pulse.library.Drag
|
||
---
|
||
|
||
# Drag
|
||
|
||
<Class id="qiskit.pulse.library.Drag" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.20/qiskit/pulse/library/parametric_pulses.py" signature="Drag(duration, amp, sigma, beta, name=None, limit_amplitude=None)" modifiers="class">
|
||
Bases: `qiskit.pulse.library.parametric_pulses.ParametricPulse`
|
||
|
||
The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied.
|
||
|
||
It is designed to reduce the frequency spectrum of a normal gaussian pulse near the $|1\rangle\leftrightarrow|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state.
|
||
|
||
$$
|
||
\begin{split}g(x) &= \exp\Bigl(-\frac12 \frac{(x - \text{duration}/2)^2}{\text{sigma}^2}\Bigr)\\
|
||
f'(x) &= g(x) + 1j \times \text{beta} \times \frac{\mathrm d}{\mathrm{d}x} g(x)\\
|
||
&= g(x) + 1j \times \text{beta} \times \Bigl(-\frac{x - \text{duration}/2}{\text{sigma}^2}\Bigr)g(x)\\
|
||
f(x) &= \text{amp}\times\frac{f'(x)-f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration}\end{split}
|
||
$$
|
||
|
||
where $g(x)$ is a standard unlifted gaussian waveform and $f'(x)$ is the DRAG waveform without lifting or amplitude scaling.
|
||
|
||
This pulse would be more accurately named as `LiftedDrag`, however, for historical and practical DSP reasons it has the name `Drag`.
|
||
|
||
**References**
|
||
|
||
1. [*Gambetta, J. M., Motzoi, F., Merkel, S. T. & Wilhelm, F. K. Analytic control methods for high-fidelity unitary operations in a weakly nonlinear oscillator. Phys. Rev. A 83, 012308 (2011).*](https://link.aps.org/doi/10.1103/PhysRevA.83.012308)
|
||
|
||
2. [*F. Motzoi, J. M. Gambetta, P. Rebentrost, and F. K. Wilhelm Phys. Rev. Lett. 103, 110501 – Published 8 September 2009.*](https://link.aps.org/doi/10.1103/PhysRevLett.103.110501)
|
||
|
||
Initialize the drag pulse.
|
||
|
||
**Parameters**
|
||
|
||
* **duration** (`Union`\[`int`, `ParameterExpression`]) – Pulse length in terms of the the sampling period dt.
|
||
* **amp** (`Union`\[`complex`, `ParameterExpression`]) – The amplitude of the Drag envelope.
|
||
* **sigma** (`Union`\[`float`, `ParameterExpression`]) – A measure of how wide or narrow the Gaussian peak is; described mathematically in the class docstring.
|
||
* **beta** (`Union`\[`float`, `ParameterExpression`]) – The correction amplitude.
|
||
* **name** (`Optional`\[`str`]) – Display name for this pulse envelope.
|
||
* **limit\_amplitude** (`Optional`\[`bool`]) – If `True`, then limit the amplitude of the waveform to 1. The default is `True` and the amplitude is constrained to 1.
|
||
|
||
## Methods
|
||
|
||
### draw
|
||
|
||
<Function id="qiskit.pulse.library.Drag.draw" signature="Drag.draw(style=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)">
|
||
Plot the interpolated envelope of pulse.
|
||
|
||
**Parameters**
|
||
|
||
* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See `IQXStandard`, `IQXSimple`, and `IQXDebugging` for details of preset stylesheets.
|
||
|
||
* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware.
|
||
|
||
* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`.
|
||
|
||
* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided.
|
||
|
||
* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms.
|
||
|
||
* **plotter** (`str`) –
|
||
|
||
Name of plotter API to generate an output image. One of following APIs should be specified:
|
||
|
||
```python
|
||
mpl2d: Matplotlib API for 2D image generation.
|
||
Matplotlib API to generate 2D image. Charts are placed along y axis with
|
||
vertical offset. This API takes matplotlib.axes.Axes as `axis` input.
|
||
```
|
||
|
||
axis and style kwargs may depend on the plotter.
|
||
|
||
* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details.
|
||
|
||
**Returns**
|
||
|
||
Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data.
|
||
</Function>
|
||
|
||
### get\_waveform
|
||
|
||
<Function id="qiskit.pulse.library.Drag.get_waveform" signature="Drag.get_waveform()">
|
||
Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains.
|
||
|
||
**Return type**
|
||
|
||
`Waveform`
|
||
</Function>
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.pulse.library.Drag.is_parameterized" signature="Drag.is_parameterized()">
|
||
Return True iff the instruction is parameterized.
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
</Function>
|
||
|
||
### validate\_parameters
|
||
|
||
<Function id="qiskit.pulse.library.Drag.validate_parameters" signature="Drag.validate_parameters()">
|
||
Validate parameters.
|
||
|
||
**Raises**
|
||
|
||
[**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid.
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### amp
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.amp">
|
||
The Gaussian amplitude.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`complex`, `ParameterExpression`]
|
||
</Attribute>
|
||
|
||
### beta
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.beta">
|
||
The weighing factor for the Gaussian derivative component of the waveform.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`float`, `ParameterExpression`]
|
||
</Attribute>
|
||
|
||
### id
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.id">
|
||
Unique identifier for this pulse.
|
||
|
||
**Return type**
|
||
|
||
`int`
|
||
</Attribute>
|
||
|
||
### limit\_amplitude
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.limit_amplitude" attributeValue="True" />
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.parameters">
|
||
**Return type**
|
||
|
||
`Dict`\[`str`, `Any`]
|
||
</Attribute>
|
||
|
||
### sigma
|
||
|
||
<Attribute id="qiskit.pulse.library.Drag.sigma">
|
||
The Gaussian standard deviation of the pulse width.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`float`, `ParameterExpression`]
|
||
</Attribute>
|
||
</Class>
|
||
|