shnitsel.vis.datasheet.figures.energy_bands#

Functions#

plot_energy_bands(per_state, pca_data, state_selection)

Helper function to plot energy band graphs as a function of the principal components in pca_data.

Module Contents#

plot_energy_bands(per_state, pca_data, state_selection, hops_mask=None, fig=None, axs=None, colorbar_label=None, cmap=None, cnorm=None, cscale=None, band_kws=None, hops_kws=None)#

Helper function to plot energy band graphs as a function of the principal components in pca_data.

Parameters:

  • per_state (PerState) – _description_

  • pca_data (xr.DataArray) – _description_

  • state_selection (StateSelection) – _description_

  • hops_mask (xr.DataArray, optional) – _description_. Defaults to None.

  • fig (Figure | SubFigure | None, optional) – _description_. Defaults to None.

  • ax (dict[str, Axes], optional) – _description_. Defaults to None.

  • colorbar_label (str | None, optional) – _description_. Defaults to None.

  • cmap (str | Colormap | None, optional)) – _description_. Defaults to None.

  • cnorm (str | Normalize | None, optional) – _description_. Defaults to None.

  • cscale (_type_, optional)) – _description_. Defaults to None.

  • band_kws (_type_, optional)) – _description_. Defaults to None.

  • hops_kws (_type_, optional) – _description_. Defaults to None.

  • axs (dict[str, matplotlib.axes.Axes] | None)

Returns:

_description_

Return type:

dict[str, Axes]