ParametricPulse
class qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)
Bases: Pulse
The abstract superclass for parametric pulses.
This class was superseded by SymbolicPulse
and is deprecated. It will be removed in Qiskit 1.0 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.
The class qiskit.pulse.library.parametric_pulses.ParametricPulse
is deprecated as of qiskit-terra 0.46. It will be removed in Qiskit 1.0. Instead, use SymbolicPulse because of QPY serialization support. See qiskit.pulse.library.symbolic_pulses for details.
Parameters
- 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 isTrue
and the amplitude is constrained to 1.
Attributes
duration
name
id
Unique identifier for this pulse.
limit_amplitude
Default value: True
parameters
Return a dictionary containing the pulse’s parameters.
Methods
draw
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 (Dict[str, Any] | None) – Stylesheet options. This can be dictionary or preset stylesheet classes. See
IQXStandard
,IQXSimple
, andIQXDebugging
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
orns
. The unit ofns
is available only whenbackend
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.
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 get_waveform()
Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains.
Return type
is_parameterized
validate_parameters
abstract validate_parameters()
Validate parameters.
Raises
PulseError – If the parameters passed are not valid.