pyorc.Velocimetry.mask.minmax

Velocimetry.mask.minmax(s_min=0.1, s_max=5.0)

Masks values if the velocity scalar lies outside a user-defined valid range.

s_minfloat, optional

minimum scalar velocity [m s-1] (default: 0.1)

s_maxfloat, optional

maximum scalar velocity [m s-1] (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