quant_met.plotting.

scatter_into_bz

quant_met.plotting.scatter_into_bz(bz_corners, k_points, data=None, data_label=None, fig_in=None, ax_in=None)

Scatter a list of points into the brillouin zone.

Parameters:

bz_cornerslist[numpy.ndarray]

Corner points defining the brillouin zone.

k_pointsnumpy.ndarray

List of k points.

datanumpy.ndarray, optional

Data to put on the k points.

data_labelstr, optional

Label for the data.

fig_inmatplotlib.figure.Figure, optional

Figure that holds the axes. If not provided, a new figure and ax is created.

ax_inmatplotlib.axes.Axes, optional

Ax to plot the data in. If not provided, a new figure and ax is created.

Returns:

matplotlib.figure.Figure

Figure with the data plotted onto the axis.