shnitsel.vis.datasheet.figures.time

Functions

plot_time_interstate_error(data, ax)

Function to plot the error bars/confidence intervals on time series interstate plots.

plot_populations_graph(pops, ax)

Plot a graph of populations to the provided axes.

plot_timeplots(pops, delta_E, fig[, fosc_time, axs])

Function to generate all time plots, involving population plots and state-transition plots.

Module Contents

plot_time_interstate_error(data, ax)

Function to plot the error bars/confidence intervals on time series interstate plots.

Uses the upper, lower and mean variables of

Parameters:

  • data (Dataset) – Interstate Dataset containing the upper, lower and mean variables generated by a confidence interval calculation. Data must have the appropriate unit as conversion is not possible without knowing the target dimension or unit. You can set the units in the unit attribute of the data. Similarly, you can specify the y-axis label with the tex attribute of the data. The time will, however, be converted to fs if not yet converted.

  • ax (Axes) – Axes object to plot the graph to.

Returns:

The axes that have been plotted to

Return type:

Axes

plot_populations_graph(pops, ax)

Plot a graph of populations to the provided axes.

Parameters:

  • pops (xr.Dataset) – The per-state population Dataset. We expect the time data to be in fs. If it can be converted, it will be converted to fs.

  • ax (Axes) – The Axes object to plot the population graph into

Returns:

The resulting Axes object after the plot

Return type:

Axes

plot_timeplots(pops, delta_E, fig, fosc_time=None, axs=None)

Function to generate all time plots, involving population plots and state-transition plots.

Parameters:

  • pops (xr.DataArray) – DataArray containing state population data with a time coordinate

  • delta_E (xr.DataArray) – DataArray containing the energy delta per state combination.

  • fig (Figure| SubFigure) – A figure, consumed by the autmatic axes generation. Not used by the function itself.

  • fosc_time (xr.DataArray, optional) – The oscillation frequency in a DataArray groupable by time

  • axs (dict[str, Axes], optional) – The dictionary of named Axes objects to plot the inidividual graphs into. Defaults to None.

Returns:

The axes dictionary after plotting.

Return type:

dict[str, Axes]