swarmpal.experimental.dsecs_plotting

Functions

plot_analysed_pass(datatree, output_dataset[, ...])	Plot a figure showing currents from one orbital pass
quicklook_subtree(datatree, output_dataset[, frame_select])	Returns figures overviewing the outputs of the analysis for a specific subtree in a datatree.
quicklook(datatree[, frame_select])
quicklook_animated(datatree[, frame_select])	Creates an animation of quicklook plots, using ipywidgets

Module Contents

swarmpal.experimental.dsecs_plotting.plot_analysed_pass(datatree, output_dataset, pass_no=0, extent='global')

Plot a figure showing currents from one orbital pass

Parameters:

• datatree (DataTree) – A datatree processed with the DSECS toolbox

• output_dataset (String) – The subtree in datatree to plot; should be an output produced by the DSECS toolbox.

• pass_no (int) – A number between 0 and x, specifying the pass to plot

• extent (str | tuple, default "global") – “global” or “automatic”, or a tuple to be provided to ax.set_extent()

Return type:

matplotlib.figure.Figure

swarmpal.experimental.dsecs_plotting.quicklook_subtree(datatree, output_dataset, frame_select='all')

Returns figures overviewing the outputs of the analysis for a specific subtree in a datatree.

Parameters:

• datatree (DataTree) – A datatree from the DSECS toolbox

• output_dataset (String) – The subtree in datatree to plot; should be an output produced by the DSECS toolbox.

• frame_select (str, default "all") – “all”, “odd”, “even” to limit the frame numbers displayed

Return type:

dict[int, matplotlib.figure.Figure]

swarmpal.experimental.dsecs_plotting.quicklook(datatree, frame_select='all')

swarmpal.experimental.dsecs_plotting.quicklook_animated(datatree, frame_select='all')

Creates an animation of quicklook plots, using ipywidgets

Parameters:

• datatree (DataTree) – A datatree from the DSECS toolbox

• frame_select (str, default "all") – “all”, “odd”, “even” to limit the frame numbers displayed