pyorc.Velocimetry.mask.rolling#

Velocimetry.mask.rolling(wdw=5, tolerance=0.5)#

Masks values if neighbours over a certain rolling length before and after, have a significantly higher velocity than value under consideration, measured by tolerance.

Parameters:

wdw (int, optional) – amount of time steps in rolling window (centred) (default: 5)

Returns:

mask – mask applicable to input dataset with ds.velocimetry.filter(mask). If inplace=True, the dataset will be returned masked with mask.

Return type:

xr.DataArray