hermpy.plotting.panels
======================

.. py:module:: hermpy.plotting.panels


Classes
-------

.. autoapisummary::

   hermpy.plotting.panels.MultiPanel
   hermpy.plotting.panels.Panel
   hermpy.plotting.panels.TimeseriesPanel
   hermpy.plotting.panels.SpectrogramPanel


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

.. py:class:: MultiPanel(panels: list[Panel])

   .. py:attribute:: _panels


   .. py:method:: __add__(other) -> MultiPanel


   .. py:method:: plot(sharex=True, show=True, figsize: tuple[int, int] | None = None)


.. py:class:: Panel(time_column: str = 'UTC')

   Bases: :py:obj:`abc.ABC`


   Base class for all panel types.


   .. py:attribute:: time_column
      :value: 'UTC'



   .. py:attribute:: _ax_set_params
      :type:  dict


   .. py:method:: __add__(other) -> MultiPanel


   .. py:method:: _plot_on(ax)
      :abstractmethod:


      Plot panel content on the given axis.



   .. py:property:: ax_set_params
      :type: dict



   .. py:method:: plot(show=True)

      Creates a quick plot for this panel alone.



.. py:class:: TimeseriesPanel(table: astropy.table.QTable, time_column: str = 'UTC')

   Bases: :py:obj:`Panel`


   Base class for all panel types.


   .. py:attribute:: table


   .. py:property:: unit
      :type: astropy.units.Unit



   .. py:method:: _check_units()

      Tests if the units of each variable in the panel are matching, and
      hence can be plotted together.



   .. py:method:: _plot_on(ax)

      Plot panel content on the given axis.



.. py:class:: SpectrogramPanel(data: xarray.DataArray, time_dim: str, y_dim: str, y_bin_edges: list[float | int] | None = None, yscale='log', vmin=None, vmax=None, cmap='viridis', cmap_scale='log', unit='')

   Bases: :py:obj:`Panel`


   A class for drawing 2D panels. We call it SpectrogramPanel, but it is
   general to any channel variable, e.g. energy, frequency, etc.


   .. py:attribute:: data


   .. py:attribute:: time_dim


   .. py:attribute:: y_dim


   .. py:attribute:: y_bin_edges


   .. py:attribute:: yscale
      :value: 'log'



   .. py:attribute:: vmin
      :value: None



   .. py:attribute:: vmax
      :value: None



   .. py:attribute:: cmap
      :value: 'viridis'



   .. py:attribute:: cmap_scale
      :value: 'log'



   .. py:attribute:: unit
      :value: ''



   .. py:method:: _plot_on(ax)

      Plot panel content on the given axis.