earthkit.meteo.regimes.array.project

earthkit.meteo.regimes.array.project(field, patterns, weights, **patterns_extra_coords)

Project onto the given regime patterns.

Parameters:

• field (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 (array_like) – Weights for the summation in the projection. Weights are normalised before application so the sum of weights over the domain equals 1. Must have shape of the patterns.

• **patterns_coords (dict[str,Any], optional) – Keyword arguments for the pattern generation. E.g., a sequence of dates for date-modulated patterns. Must have the shape of field without the trailing dimensions onto which the patterns are projected.

Returns:

Results of the projection. One item per pattern label, output fields have same shape as input field except for the dimensions reduced during the projection (i.e., the spatial dimensions of the patterns are missing on the right).

Return type:

dict[str,array_like]