pyorc.Velocimetry.mask.outliers

Velocimetry.mask.outliers(tolerance=1.0, mode='or')

Mask outliers measured by amount of standard deviations from the mean.

Parameters:

• tolerance (float) – amount of standard deviations allowed from the mean

• mode (str) – can be “and” or “or” (default). If “or” (“and”), then only one (both) of two vector components need(s) to be within tolerance.

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