marEx.plotX.PlotXAccessor

class marEx.plotX.PlotXAccessor(xarray_obj)[source]

Bases: object

Xarray accessor for plotX functionality with support for custom dimensions and coordinates.

Initialise the PlotXAccessor.

Parameters:

xarray_obj (DataArray)

__init__(xarray_obj)[source]

Initialise the PlotXAccessor.

Parameters:

xarray_obj (DataArray)

Methods

__init__(xarray_obj)

Initialise the PlotXAccessor.

animate(config, **kwargs)

Create animation with default dimension detection.

multi_plot(config, **kwargs)

Create multiple plots with default dimension detection.

single_plot(config, **kwargs)

Create a single plot with default dimension detection.

__init__(xarray_obj)[source]

Initialise the PlotXAccessor.

Parameters:

xarray_obj (DataArray)

__call__(dimensions=None, coordinates=None)[source]

Create a plotter instance with optional custom dimensions and coordinates.

Parameters:
  • dimensions (Dict[str, str] | None) – Optional mapping of conceptual dimensions to actual dimension names

  • coordinates (Dict[str, str] | None) – Optional mapping of conceptual coordinates to actual coordinate names

Returns:

Appropriate plotter instance for the data structure

Return type:

GriddedPlotter | UnstructuredPlotter

single_plot(config, **kwargs)[source]

Create a single plot with default dimension detection.

Parameters:

config (PlotConfig)

multi_plot(config, **kwargs)[source]

Create multiple plots with default dimension detection.

Parameters:

config (PlotConfig)

animate(config, **kwargs)[source]

Create animation with default dimension detection.

Parameters:

config (PlotConfig)