earthkit.meteo.regimes.project¶
- earthkit.meteo.regimes.project(fields, patterns, weights, patterns_coords=None)¶
Project onto the given patterns.
- Parameters:
fields (
xarray.DataArray | array_like) – Input field(s) to project. The patterns are projected onto the trailing dimensions of the input fields.patterns (
earthkit.meteo.regimes.Patterns) – Patterns to project on.weights (
xarray.DataArray | array_like) – Weights for the summation in the projection. Weights are normalised before application so the sum of weights over the domain equals 1.patterns_coords (
Mapping[str,Any] | Sequence[str], optional) – Coordinates for the pattern generation function. Consult the individual implementations on the interpretation.
- Returns:
The projection(s) for each pattern.
- Return type:
xarray.DataArray | array_like
Implementations
Depending on the type of argument fields, this function calls:
earthkit.meteo.regimes.xarray.project()forxarray.DataArrayearthkit.meteo.regimes.array.project()forarray_like
The function returns an object of the same type as the input argument.