grogupy.viz.plot_kspace

grogupy.viz.plot_kspace(kspace: Kspace, marker_size: float = 10, marker_opacity: float = 1, colorscale: str = 'Viridis', width: int = 800, height: int = 500, title: None | str = None, legend: bool = True) → Figure

Creates a plot from the Brillouin zone sample points.

Parameters

kspaceKspace

Kspace class that contains the Brillouin-zone samples and weights

colorscalestr, optional

The colorscale of the weights, by default Viridis

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