shnitsel.vis.datasheet.figures.dip_trans_hist

Functions

single_hist(interstate, sc, color[, bins, ax, cmap, cnorm])

Function to plot a single histogram of interstate data.

plot_dip_trans_histograms(inter_state[, axs, cnorm])

function to plot all relevant histograms for the provided inter_state data

plot_spectra(spectra[, ax, cmap, cnorm, mark_peaks])

Create the spectra plot of the system denoted by the results in spectra.

plot_separated_spectra_and_hists(inter_state, sgroups)

plot_separated_spectra_and_hists_groundstate(...[, ...])

Function to plot separated spectra and histograms of ground state data only.

Module Contents

single_hist(interstate, sc, color, bins=100, ax=None, cmap=None, cnorm=None)

Function to plot a single histogram of interstate data.

Parameters:

  • interstate (InterState) – Inter-state Dataset

  • sc (tuple[int,int]) – State combination tuple

  • color (str) – Color for the histogram of this state combination.

  • bins (int, optional) – Number of bins for the histogram. Defaults to 100.

  • ax (Axes, optional) – Axes object to plot into. Defaults to None.

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

  • cnorm (str, optional) – Norming method to apply to the colormap. Defaults to None.

Returns:

The result of ax.hist2d will be returned

Return type:

?

plot_dip_trans_histograms(inter_state, axs=None, cnorm=None)

function to plot all relevant histograms for the provided inter_state data

Parameters:

  • inter_state (InterState) – _description_

  • axs (Axes, optional) – Axes objects to plot into. If not provided, will be created.

  • cnorm (str, optional) – Optional specification of a colormap norm method. Defaults to None.

Returns:

The list of the results of hist2d() calls for the provided data in inter_state

Return type:

list

plot_spectra(spectra, ax=None, cmap=None, cnorm=None, mark_peaks=False)

Create the spectra plot of the system denoted by the results in spectra.

Parameters:

  • spectra (SpectraDictType) – The spectra (t, state combination) -> fosc data to plot

  • ax (Axes, optional) – Axis object to plot into. If not provided, will be created.

  • cmap (str | Colormap, optional) – Optional specification of a desired colormap. Defaults to None.

  • cnorm (str | Normalize, optional) – Optional specification of a colormap norm method. Defaults to None.

  • mark_peaks (bool, optional) – Flag whether peaks should be clearly marked. Defaults to False.

Returns:

The axes object into which the graph was plotted

Return type:

Axes

plot_separated_spectra_and_hists(inter_state, sgroups, fig=None, axs=None, cb_spec_vlines=True)
plot_separated_spectra_and_hists_groundstate(inter_state, spectra_groups, fig=None, axs=None, cb_spec_vlines=True, scmap=plt.get_cmap('turbo'))

Function to plot separated spectra and histograms of ground state data only.

Parameters:

  • inter_state (InterState) – Inter-State dataset containing energy differences

  • spectra_groups (tuple[SpectraDictType, SpectraDictType]) – Tuple holding the spectra groups of ground-state transitions and excited-state transitions.

  • fig (Figure | SubFigure | None, optional) – Figure to plot the graphs to. Defaults to None.

  • axs (dict[str, Axes] | None, optional) – Dict of named axes to plot to. Defaults to None.

  • cb_spec_vlines (bool, optional) – Flag to enable vertical lines in the time-dependent spectra. Defaults to True.

  • scmap (Colormap, optional) – State combination colormap. Defaults to plt.get_cmap(‘turbo’).

Raises:

ValueError – _description_

Returns:

_description_

Return type:

dict[str, Axes]