visualexpplotter.py

This module contains function for plotting virtuals sensor trace summary statistics and uncertainty bounds over simulated experiments.

plot_exp_traces(exp_sim, component, sens_array_num, sim_num, trace_opts=None, plot_opts=None)[source]

Plots time traces for summary statistics of virtual sensor traces over a series of virtual experiments.

Parameters:

  • exp_sim (ExperimentSimulator) – Experiment simulation object containing the set of virtual experiment to be plotted.

  • component (str) – String key for the field component to plot.

  • sens_array_num (int) – List index for the sensor array to plot.

  • sim_num (int) – Index for the simulation to plot.

  • trace_opts (TraceOptsExperiment | None, optional) – Dataclass containing specific options for controlling the plot appearance, by default None. If None the default options are used.

  • plot_opts (PlotOptsGeneral | None, optional) – Dataclass containing general options for formatting plots and visualisations, by default None. If None the default options are used.

Returns:

tuple[Any,Any] – A tuple containing a handle to the matplotlib figure and axis objects: (fig,ax).

Raises:

VisError – There are no virtual experiments or virtuale experiment stats to plot in the ExperimentSimulator object. Call ‘run_experiments’ and ‘calc_stats’.