Skip to main contentIBM Quantum Documentation
Qiskit IBM Provider is deprecated. See the migration guide to use Qiskit Runtime.

iplot_error_map

iplot_error_map(backend, figsize=(800, 500), show_title=True, remove_badcal_edges=True, background_color='white', as_widget=False)

GitHub(opens in a new tab)

Plot the error map of a device.

Parameters

  • backend (IBMBackend) – Plot the error map for this backend.
  • figsize (Tuple[int]) – Figure size in pixels.
  • show_title (bool) – Whether to show figure title.
  • remove_badcal_edges (bool) – Whether to remove bad CX gate calibration data.
  • background_color (str) – Background color, either ‘white’ or ‘black’.
  • as_widget (bool) – True if the figure is to be returned as a PlotlyWidget. Otherwise the figure is to be returned as a PlotlyFigure.

Return type

Union[PlotlyFigure, PlotlyWidget]

Returns

The error map figure.

Raises

  • VisualizationValueError – If an invalid input is received.
  • VisualizationTypeError – If the specified backend is a simulator.

Example

from qiskit_ibm_provider.test.ibm_provider_mock import mock_get_backend
# Generate a mock provider for the sake of this example.
# This line will allow the mocked ``IBMProvider`` to return
# a fake backend in the following cell.
mock_get_backend('FakeOpenPulse2Q')
from qiskit_ibm_provider import IBMProvider
from qiskit_ibm_provider.visualization import iplot_error_map
 
provider = IBMProvider(group='open', project='main')
# Note that this is a mock provider, replace ``FakeOpenPulse2Q``
# with any of the currently available IBM devices.
backend = provider.get_backend('FakeOpenPulse2Q')
 
iplot_error_map(backend, as_widget=True)
Was this page helpful?
Report a bug or request content on GitHub.