marEx.plotX.gridded.GriddedPlotter

class marEx.plotX.gridded.GriddedPlotter(xarray_obj, dimensions=None, coordinates=None)

Bases: PlotterBase

Plotter for structured oceanographic data on regular rectangular grids.

Initialise GriddedPlotter.

Parameters:

• xarray_obj (DataArray)

• dimensions (Dict[str, str] | None)

• coordinates (Dict[str, str] | None)

__init__(xarray_obj, dimensions=None, coordinates=None)

Initialise GriddedPlotter.

Parameters:

• xarray_obj (DataArray)

• dimensions (Dict[str, str] | None)

• coordinates (Dict[str, str] | None)

Return type:

None

Methods

__init__(xarray_obj[, dimensions, coordinates])	Initialise GriddedPlotter.
animate(config[, plot_dir, file_name, ...])	Create an animation from time series data
clim_robust(data, issym[, percentiles])	Compute robust colour limits from data percentiles.
multi_plot(config[, col, col_wrap])	Make wrapped subplots with given configuration
plot(ax[, cmap, clim, norm])	Implement plotting for gridded (i.e. regular grid) data.
setup_id_plot_params([cmap])	Set up parameters for plotting IDs
setup_plot_params()	Set up common plotting parameters
single_plot(config[, ax])	Make a single plot with given configuration
wrap_lon(data)	Handle periodic boundary in longitude by adding a column of data.

__init__(xarray_obj, dimensions=None, coordinates=None)

Initialise GriddedPlotter.

Parameters:

• xarray_obj (DataArray)

• dimensions (Dict[str, str] | None)

• coordinates (Dict[str, str] | None)

Return type:

None

wrap_lon(data)

Handle periodic boundary in longitude by adding a column of data.

Parameters:

data (DataArray)

Return type:

DataArray

plot(ax, cmap='viridis', clim=None, norm=None)

Implement plotting for gridded (i.e. regular grid) data.

Parameters:

• ax (Axes)

• cmap (str | Any)

• clim (Tuple[float, float] | None)

• norm (BoundaryNorm | Normalize | None)

Return type:

Tuple[Axes, QuadMesh]