grogupy.viz.plot_contour

grogupy.viz.plot_contour(contour: Contour, marker_size: float = 10, marker_opacity: float = 1, width: int = 800, height: int = 500, title: None | str = None, legend: bool = True) → Figure

Creates a plot from the contour sample points.

If there are too many eigenvalues, then they are subsamled for the plot.

Parameters

contourContour

Contour class that contains the energy samples and weights

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