wulfric.PlotlyEngine.plot_kpoints#
method
- PlotlyEngine.plot_kpoints(kp, color='#000000', shift=(0.0, 0.0, 0.0), legend_label=None, legend_group=None, scale=1, only_from_kpath=False, row=1, col=1)[source]#
Plots high-symmetry k-points in the reciprocal space.
- Parameters:
- kp
Kpoints K-points and k-path.
- colorstr, default "#000000"
Colour for the plot. Any value that is supported by Plotly.
- shift(3, ) array-like, default (0, 0, 0)
Absolute coordinates of the shift in reciprocal space.
- 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.- scalefloat, default 1
Scale for the size of point's markers and text labels. Use
scale>1to increase the size.- only_from_kpathbool, default False
Whether to plot all pre-defined points or only the ones that included into the predefined k-path.
- rowint, default 1
Row of the subplot.
- colint, default 1
Column of the subplot.
- kp