wulfric.PlotlyEngine.plot_brillouin_zone#

method

PlotlyEngine.plot_brillouin_zone(cell, plot_vectors=True, vector_label='b', color='#FF4D67', shift=(0.0, 0.0, 0.0), legend_label=None, legend_group=None, row=1, col=1)[source]#

Plots Brillouin zone.

Parameters:

cell(3, 3) array-like: Matrix of a cell, rows are interpreted as vectors.
plot_vectorsbool, default True: Whether to plot lattice vectors.
vector_labelstr, default "b": Vector's label, ignored if plot_vectors = False.
colorstr, default "#FF4D67": Colour for the Brillouin zone and labels. Any value that is supported by Plotly.
shift(3, ) array-like, default (0.0, 0.0, 0.0): Absolute coordinates of the center of the Brillouin zone.
legend_labelstr, optional: Label for the legend. Entry in legend only showed if legend_label is not None.
legend_groupstr, optional: Legend's group. If None, then defaults to the random string of 10 characters.
rowint, default 1: Row of the subplot.
colint, default 1: Column of the subplot.