perturbopy.postproc.utils.plot_tools.plot_vals_on_bands

perturbopy.postproc.utils.plot_tools.plot_vals_on_bands(ax, path, energies, energy_units, values, cmap='YlOrRd', label='values', log=False, energy_window=None)

Method to plot normalized colormap overlaid on the dispersion (phonon dispersion or band structure).

Parameters:

• ax (matplotlib.axes.Axes) – Axis on which to plot the dispersion

• path (array_like) – The array or list of path coordinates to be plotted on the x-axis

• energies (dict) – Dictionary of arrays of energies to plot, with keys labelling the band number or phonon mode.

• energy_units (str)

• values (dict) – Dictionary of arrays of values to plot on the bands by color

• cmap (str) – Matplotlib cmap for plotting values.

• label (str) – Label for the values mapped on the colormap

• log (bool, optional) – If true, values will be normalized using log scale. If false, values will be normalized using linear scale. By default, true.

• energy_window (tuple, optional) – Tuple with the lower and upper bound of the chosen energy window

Returns:

ax – Axis with the plotted dispesion

Return type:

matplotlib.axes.Axes