qiskit_ibm_runtime.visualization.draw_layer_error_map

draw_layer_error_map(layer_error, embedding, colorscale='Bluered', color_no_data='lightgray', color_out_of_scale='lightgreen', num_edge_segments=16, edge_width=4, height=500, highest_rate=None, background_color='white', radius=0.25, width=800)[source]

Draw a map view of a LayerError.

Parameters:

  • layer_error (LayerError) – The LayerError to draw.

  • embedding (Union[Embedding, BackendV2]) – An Embedding object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an Embedding for.

  • colorscale (str) – The colorscale used to show the rates of layer_error.

  • color_no_data (str) – The color used for qubits and edges for which no data is available.

  • color_out_of_scale (str) – The color used for rates with value greater than highest_rate.

  • num_edge_segments (int) – The number of equal-sized segments that edges are made of.

  • edge_width (float) – The line width of the edges in pixels.

  • height (int) – The height of the returned figure.

  • highest_rate (Optional[float]) – The highest rate, used to normalize all other rates before choosing their colors. If None, it defaults to the highest value found in the layer_error.

  • background_color (str) – The background color.

  • radius (float) – The radius of the pie charts representing the qubits.

  • width (int) – The width of the returned figure.

Raises:

  • ValueError – If the given coordinates are incompatible with the specified backend.

  • ValueError – If backend has no coupling map.

Return type:

PlotlyFigure