grogupy.viz.plot_pairs

grogupy.viz.plot_pairs(pairs: Builder | list[Pair] | PairList, group: bool = True, connect: bool = False, tags: None | list[str] = None, colors: None | list[str] = None, marker_size: float = 10, marker_opacity: float = 0.5, show_cell: bool = True, width: int = 800, height: int = 500, title: None | str = None, legend: bool = True) → Figure

Creates a plot from a list of pairs.

Parameters

pairsUnion[Builder, list[Pair], PairList]

The pairs that contain the tags and coordinates

groupbool, optional

Whether to group the pairs by their first magnetic entity, by default True

groupbool, optional

Whether to connect the pairs or not not, by default False

tagsUnion[None, list[str]], optional

The tags of the markers, if None, then it is autogenerated, by default None

colors: Union[None, list[str]], optional

The colors of the markers, if None, then it is autogenerated, by default None

marker_sizefloat, optional

Size of the markers, by default 10

marker_opacityfloat, optional

Opacity of the markers, by default 1

show_cellbool, optional

Whether to show the cell or not, by default True

widthint, optional

Width of the figure, by default 800

heightint, optional

Height of the figure, by default 500

titleUnion[None, str], optional

Title of the figure, if set to None, then title is not generated, by default None

legendbool, optional

Whether to show the legend, by default True

Returns

plotly.graph_objs.go.Figure

The created figure