earthkit.meteo.regimes.ConstantPatterns

class earthkit.meteo.regimes.ConstantPatterns(labels, grid, patterns, xp=None)

Bases: Patterns

Collection of constant/fixed patterns.

Parameters:
  • labels (Iterable[str]) – Labels for the patterns.

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

  • patterns (array_like) – The patterns (one for each label, stacked into a single array).

  • xp (array_namespace, optional) – The array namespace used for the patterns and their generation. By default, it is inferred from the type of base_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

patterns()

All patterns.

Returns:

Mapping from labels to patterns.

Return type:

dict[str,array_like]

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.