grogupy.viz.plot_DM_distance

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

Plots the magnitude of DM vectors as a function of distance.

Parameters

pairsUnion[Builder, list[Pair], PairList]

The pairs that contain the DM vectors and positions

groupbool, optional

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

normalisebool, optional

To return the norm of the DM vector or just the elements, by default True

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

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