earthkit.meteo.regimes.Patterns

class earthkit.meteo.regimes.Patterns(labels, grid, xp)

Bases: abc.ABC

Collection/Generator of patterns.

Parameters:
  • labels (Iterable[str]) – Labels for the patterns. The ordering determines the ordering of all outputs.

  • grid (dict) – Specification of the grid on which the patterns live.

  • xp (array_namespace, optional) – Array namespace of the generated patterns.

property grid: dict

The grid on which the patterns live.

Return type:

dict

property labels

Labels of the patterns.

property ndim: int

Number of dimensions/axes in a single pattern.

Return type:

int

abstractmethod patterns(**patterns_extra_coords)

Patterns evaluated for the given coords (if any).

Return type:

collections.abc.Mapping

property shape

Shape of a single pattern.

property size: int

Number of grid points in a single pattern.

Return type:

int

property xp

Array namespace of the generated patterns.