pysteps.utils.dimension.aggregate_fields_time

pysteps.utils.dimension.aggregate_fields_time(R, metadata, time_window_min, ignore_nan=False)

Aggregate fields in time.

Parameters:
R : array-like

Array of shape (t,m,n) or (l,t,m,n) containing a time series of (ensemble) input fields. They must be evenly spaced in time.

metadata : dict

Metadata dictionary containing the timestamps and unit attributes as described in the documentation of pysteps.io.importers.

time_window_min : float or None

The length in minutes of the time window that is used to aggregate the fields. The time spanned by the t dimension of R must be a multiple of time_window_min. If set to None, it returns a copy of the original R and metadata.

ignore_nan : bool, optional

If True, ignore nan values.

Returns:
outputarray : array-like

The new array of aggregated fields of shape (k,m,n) or (l,k,m,n), where k = t*delta/time_window_min and delta is the time interval between two successive timestamps.

metadata : dict

The metadata with updated attributes.