pyorc.Velocimetry.mask.variance

Velocimetry.mask.variance(tolerance=5, mode='and')

Mask locations if their variance (std/mean in time) is above a tolerance level.

This is calculated for either or both x and y direction.

tolerancefloat

amount of standard deviations allowed from the mean

modestr

can be “and” (default) or “or”. 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