qiskit.pulse.Waveform¶

class Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)[source]¶

A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt.

Create new sample pulse command.

Parameters

samples (Union[ndarray, List[complex]]) – Complex array of the samples in the pulse envelope.
name (Optional[str]) – Unique name to identify the pulse.
epsilon (float) – Pulse sample norm tolerance for clipping. If any sample’s norm exceeds unity by less than or equal to epsilon it will be clipped to unit norm. If the sample norm is greater than 1+epsilon an error will be raised.
limit_amplitude (Optional[bool]) – Passed to parent Pulse

__init__(samples, name=None, epsilon=1e-07, limit_amplitude=None)[source]¶

Create new sample pulse command.

Parameters

samples (Union[ndarray, List[complex]]) – Complex array of the samples in the pulse envelope.
name (Optional[str]) – Unique name to identify the pulse.
epsilon (float) – Pulse sample norm tolerance for clipping. If any sample’s norm exceeds unity by less than or equal to epsilon it will be clipped to unit norm. If the sample norm is greater than 1+epsilon an error will be raised.
limit_amplitude (Optional[bool]) – Passed to parent Pulse

Methods

`__init__`(samples[, name, epsilon, …])	Create new sample pulse command.
`assign_parameters`(value_dict)	Return a new pulse with parameters assigned.
`draw`([dt, style, filename, interp_method, …])	Plot the interpolated envelope of pulse.
`is_parameterized`()	Return True iff the instruction is parameterized.

Attributes

`id`	Unique identifier for this pulse.
`limit_amplitude`
`parameters`	Return a dictionary containing the pulse’s parameters.
`samples`	Return sample values.

assign_parameters(value_dict)[source]¶

Return a new pulse with parameters assigned.

Parameters: value_dict (Dict[ParameterExpression, Union[ParameterExpression, float]]) – A mapping from Parameters to either numeric values or another Parameter expression.
Return type: Waveform
Returns: New pulse with updated parameters.

draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=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 :py:class:~`qiskit.visualization.pulse_v2.stylesheets.IQXStandard`, :py:class:~`qiskit.visualization.pulse_v2.stylesheets.IQXSimple`, and :py:class:~`qiskit.visualization.pulse_v2.stylesheets.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.
dt (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.
filename (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object.
interp_method (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.
scale (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.
interactive (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.
draw_title (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

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.

property id¶

Unique identifier for this pulse.

Return type: int

is_parameterized()[source]¶

Return True iff the instruction is parameterized.

Return type: bool

property parameters¶

Return a dictionary containing the pulse’s parameters.

Return type: Dict[str, Any]

property samples¶

Return sample values.

Return type: ndarray