ParametricPulse

class ParametricPulse(duration, name=None, limit_amplitude=None)

Bases: qiskit.pulse.library.pulse.Pulse

The abstract superclass for parametric pulses.

Warning

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.

Parameters

duration (Union[int, ParameterExpression]) – Pulse length in terms of the the sampling period dt.
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

ParametricPulse.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]) – 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:

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.

get_waveform

abstract ParametricPulse.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

is_parameterized

ParametricPulse.is_parameterized()

Return True iff the instruction is parameterized.

Return type

bool

validate_parameters

abstract ParametricPulse.validate_parameters()

Validate parameters.

Raises

PulseError – If the parameters passed are not valid.

Return type

None

Attributes

duration

name

id

Unique identifier for this pulse.

Return type

int

limit_amplitude

Default value: True

parameters

Return a dictionary containing the pulse’s parameters.

Return type

Dict[str, Any]

Was this page helpful?

Report a bug or request content on GitHub.