deltakit.decode.utils.VisDecodingGraph3D.plot_3d

VisDecodingGraph3D.plot_3d(syndrome: OrderedSyndrome | None = None, correction_edges: OrderedDecodingEdges | None = None, error_edges: OrderedDecodingEdges | None = None, logicals: list[set[DecodingEdge]] | None = None, categorise_edges: bool = False, show: bool = True) → Figure

Plots the DecodingGraph in 3D based on the coordinates (h, v, t) of the nodes of the graph.

Parameters:

• syndrome (Optional[OrderedSyndrome], optional) – Optional syndrome to visualise by highlighting nodes on the graph.

• correction_edges (Optional[OrderedDecodingEdges], optional) – Optional set of edges that represent a correction from a decoder, to be highlighted in the graph.

• error_edges (Optional[OrderedDecodingEdges], optional) – Optional set of edges that represent an error mechanism, to be highlighted in the graph.

• logicals (Optional[List[Set[DecodingEdge]]], optional) – Optional list of sets of edges that define the logicals observables on the decoding graph, to be highlighted.

• categorise_edges (bool) – Whether to split the edges in timelike, spacelike and hooks. By default, False.

• show (bool, optional) – If the figure is shown or just returned. Default True.