0.29.1
Languages
English
Japanese
German
Korean
Portuguese, Brazilian
French
Tamil
Previous Releases
0.19
0.24
0.25
0.26
0.27
0.28
0.29
Table of Contents
Shortcuts

qiskit.pulse.Schedule.draw

Schedule.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, plot_all=None, plot_range=None, interactive=None, table=None, label=None, framechange=None, channels=None, show_framechange_channels=None, draw_title=None, backend=None, time_range=None, time_unit='dt', disable_channels=None, show_snapshot=True, show_framechange=True, show_waveform_info=True, show_barrier=True, plotter='mpl2d', axis=None)

Plot the schedule.

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.

  • disable_channels (Optional[List[Channel]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image.

  • show_snapshot (bool) – Show snapshot instructions.

  • show_framechange (bool) – Show frame change instructions. The frame change represents instructions that modulate phase or frequency of pulse channels.

  • show_waveform_info (bool) – Show additional information about waveforms such as their name.

  • show_barrier (bool) – Show barrier lines.

  • 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.

  • channel_scales (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • plot_all (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • plot_range (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.

  • table (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • label (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • framechange (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • channels (Optional[Any]) – Deprecated. This argument is used by the legacy pulse drawer.

  • show_framechange_channels (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.