swarmpal.toolboxes.tfa.plotting

swarmpal.toolboxes.tfa.plotting#

Attributes#

logger

Functions#

_get_tfa_meta(datatree)

_get_active_dataset_window(datatree[, meta, ...])

Get the dataset, subselected to the analysis window

_add_secondary_x_axes([dataset, ax, varnames, timevar])

Add a number of secondary x-axes at the top of the plot

time_series(datatree[, varname, ax, clip_times, ...])

Plot the time series of the active variable, or any other variable

spectrum(datatree[, ax, clip_times, tlims, log, ...])

Plot the dynamic spectrum of the result of the wavelet transform

_get_wave_index(dataset)

Evaluate wave index from wavelet power

wave_index(datatree[, ax, clip_times, tlims, extra_x])

Plot the index of wave activity

quicklook(datatree[, clip_times, tlims, extra_x])

Returns a figure overviewing relevant contents of the data

Module Contents#

swarmpal.toolboxes.tfa.plotting.logger#
swarmpal.toolboxes.tfa.plotting._get_tfa_meta(datatree)[source]#
swarmpal.toolboxes.tfa.plotting._get_active_dataset_window(datatree, meta=None, clip_times=True, tlims=None)[source]#

Get the dataset, subselected to the analysis window

swarmpal.toolboxes.tfa.plotting._add_secondary_x_axes(dataset=None, ax=None, varnames=('Latitude', 'Longitude'), timevar='Timestamp')[source]#

Add a number of secondary x-axes at the top of the plot

swarmpal.toolboxes.tfa.plotting.time_series(datatree, varname='TFA_Variable', ax=None, clip_times=True, tlims=None, extra_x=('QDLat', 'MLT'), **kwargs)[source]#

Plot the time series of the active variable, or any other variable

Parameters:

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

  • varname (str) – Select a variable from within the dataset

  • ax (AxesSubplot, optional) – Axes onto which to plot

  • clip_times (bool, optional) – Clip to the analysis window, by default True

  • tlims (tuple(str, str), optional) – Tuple of ISO strings to limit the plot to

  • extra_x (tuple(str), optional) – Variables to add as extra x-axes

Return type:

fig, ax

swarmpal.toolboxes.tfa.plotting.spectrum(datatree, ax=None, clip_times=True, tlims=None, log=True, levels=None, extra_x=('QDLat', 'MLT'), **kwargs)[source]#

Plot the dynamic spectrum of the result of the wavelet transform

Parameters:

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

  • ax (AxesSubplot, optional) – Axes onto which to plot

  • clip_times (bool, optional) – Clip to the analysis window, by default True

  • tlims (tuple(str, str), optional) – Tuple of ISO strings to limit the plot to

  • log (bool, optional) – Logarithmic scale, by default True

  • levels (ndarray, optional) – Override the levels used in the colorbar

  • extra_x (tuple(str), optional) – Variables to add as extra x-axes

Return type:

fig, ax

swarmpal.toolboxes.tfa.plotting._get_wave_index(dataset)[source]#

Evaluate wave index from wavelet power

swarmpal.toolboxes.tfa.plotting.wave_index(datatree, ax=None, clip_times=True, tlims=None, extra_x=('QDLat', 'MLT'), **kwargs)[source]#

Plot the index of wave activity

Parameters:

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

  • ax (AxesSubplot, optional) – Axes onto which to plot

  • clip_times (bool, optional) – Clip to the analysis window, by default True

  • tlims (tuple(str, str), optional) – Tuple of ISO strings to limit the plot to

  • extra_x (tuple(str), optional) – Variables to add as extra x-axes

Return type:

fig, ax

swarmpal.toolboxes.tfa.plotting.quicklook(datatree, clip_times=True, tlims=None, extra_x=('QDLat', 'MLT'))[source]#

Returns a figure overviewing relevant contents of the data

Parameters:

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

  • clip_times (bool, optional) – Clip to the analysis window, by default True

  • tlims (tuple(str, str), optional) – Tuple of ISO strings to limit the plot to

  • extra_x (tuple(str), optional) – Variables to add as extra x-axes

Return type:

fig, axes

Contents