hermpy.plotting.panels#

Classes#

MultiPanel

Panel

Base class for all panel types.

TimeseriesPanel

Base class for all panel types.

SpectrogramPanel

A class for drawing 2D panels. We call it SpectrogramPanel, but it is

Module Contents#

class hermpy.plotting.panels.MultiPanel(panels: list[Panel])#
_panels#
__add__(other) MultiPanel#
plot(sharex=True, show=True, figsize: tuple[int, int] | None = None)#
class hermpy.plotting.panels.Panel(time_column: str = 'UTC')#

Bases: abc.ABC

Base class for all panel types.

time_column = 'UTC'#
_ax_set_params: dict#
__add__(other) MultiPanel#
abstractmethod _plot_on(ax)#

Plot panel content on the given axis.

property ax_set_params: dict#
plot(show=True)#

Creates a quick plot for this panel alone.

class hermpy.plotting.panels.TimeseriesPanel(table: astropy.table.QTable, time_column: str = 'UTC')#

Bases: Panel

Base class for all panel types.

table#
property unit: astropy.units.Unit#
_check_units()#

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

_plot_on(ax)#

Plot panel content on the given axis.

class hermpy.plotting.panels.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: Panel

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

data#
time_dim#
y_dim#
y_bin_edges#
yscale = 'log'#
vmin = None#
vmax = None#
cmap = 'viridis'#
cmap_scale = 'log'#
unit = ''#
_plot_on(ax)#

Plot panel content on the given axis.