swarmpal.experimental.dsecs_plotting
====================================

.. py:module:: swarmpal.experimental.dsecs_plotting


Functions
---------

.. autoapisummary::

   swarmpal.experimental.dsecs_plotting.plot_analysed_pass
   swarmpal.experimental.dsecs_plotting.quicklook_subtree
   swarmpal.experimental.dsecs_plotting.quicklook
   swarmpal.experimental.dsecs_plotting.quicklook_animated


Module Contents
---------------

.. py:function:: plot_analysed_pass(datatree, output_dataset, pass_no=0, extent='global')

   Plot a figure showing currents from one orbital pass

   :param datatree: A datatree processed with the DSECS toolbox
   :type datatree: DataTree
   :param output_dataset: The subtree in datatree to plot; should be an output produced by the DSECS toolbox.
   :type output_dataset: String
   :param pass_no: A number between 0 and x, specifying the pass to plot
   :type pass_no: int
   :param extent: "global" or "automatic", or a tuple to be provided to ax.set_extent()
   :type extent: str | tuple, default "global"

   :rtype: matplotlib.figure.Figure


.. py:function:: quicklook_subtree(datatree, output_dataset, frame_select='all')

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

   :param datatree: A datatree from the DSECS toolbox
   :type datatree: DataTree
   :param output_dataset: The subtree in datatree to plot; should be an output produced by the DSECS toolbox.
   :type output_dataset: String
   :param frame_select: "all", "odd", "even" to limit the frame numbers displayed
   :type frame_select: str, default "all"

   :rtype: dict[int, matplotlib.figure.Figure]


.. py:function:: quicklook(datatree, frame_select='all')

.. py:function:: quicklook_animated(datatree, frame_select='all')

   Creates an animation of quicklook plots, using ipywidgets

   :param datatree: A datatree from the DSECS toolbox
   :type datatree: DataTree
   :param frame_select: "all", "odd", "even" to limit the frame numbers displayed
   :type frame_select: str, default "all"