shnitsel.vis.datasheet.figures.socs_hist#

Functions#

plot_socs_histograms(inter_state, hops_mask, ...[, ...])

Plot 2D histograms of NACS vs delta_E or dip_trans

Module Contents#

plot_socs_histograms(inter_state, hops_mask, state_selection, fig=None, axs=None)#

Plot 2D histograms of NACS vs delta_E or dip_trans

Parameters:

  • inter_state (InterState) – The dataset containing inter-state data including NACs

  • hop_idxs – Argument to specify, which frames should be selected for the histograms.

  • state_selection (StateSelection) – State selection object to limit the states included in plotting and to provide state names.

  • fig (Figure | SubFigure, optional) – Unused figure provided to the plot. Consumed by the figaxs_defaults decorator.

  • axs (dict[str, Axes]) – Axes objects to plot to with the respective keys of the plot. Defaults to None.

  • hops_mask (xarray.DataArray)

Returns:

The axes used for plotting indexed by the subfigure name

Return type:

dict[str, Axes]