ParametricPulse#

class qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)[source]#

Bases : Pulse

The abstract superclass for parametric pulses.

Avertissement

This class is superseded by SymbolicPulse and will be deprecated and eventually removed in the future because of the poor flexibility for defining a new waveform type and serializing it through the qiskit.qpy framework.

Create a parametric pulse and validate the input parameters.

Obsolète depuis la version 0.22_pending: The class qiskit.pulse.library.parametric_pulses.ParametricPulse is pending deprecation as of qiskit-terra 0.22. It will be marked deprecated in a future release, and then removed no earlier than 3 months after the release date. Instead, use SymbolicPulse because of QPY serialization support. See qiskit.pulse.library.symbolic_pulses for details.

Paramètres:

duration (int | ParameterExpression) – Pulse length in terms of the sampling period dt.
name (str | None) – Display name for this pulse envelope.
limit_amplitude (bool | None) – If True, then limit the amplitude of the waveform to 1. The default is True and the amplitude is constrained to 1.

Attributes

duration#

name#

id#: Unique identifier for this pulse.

limit_amplitude = True#

parameters#: Return a dictionary containing the pulse’s parameters.

Methods

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.

Paramètres:

style (Dict[str, Any] | None) – Stylesheet options. This can be dictionary or preset stylesheet classes. See IQXStandard, IQXSimple, and IQXDebugging for details of preset stylesheets.
backend (Optional[BaseBackend]) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware.
time_range (Tuple[int, int] | None) – 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:

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 (Any | None) – 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.

Renvoie:

Visualization output data. The returned data type depends on the plotter. If matplotlib family is specified, this will be a matplotlib.pyplot.Figure data.

abstract get_waveform()[source]#

Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains.

Type renvoyé:: Waveform

is_parameterized()[source]#

Return True iff the instruction is parameterized.

Type renvoyé:: bool

abstract validate_parameters()[source]#

Validate parameters.

Lève:: PulseError – If the parameters passed are not valid.