pyorc.Velocimetry.mask.rolling#

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

Mask values for strongly deviating values from neighbours over rolling length.

Deviation is measured by tolerance.

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

  • tolerance (float, optional) – tolerance as relative deviation from mean of values, including value itself (default: 0.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