glidertools.cleaning.outlier_bounds_std

glidertools.cleaning.outlier_bounds_std(arr, multiplier=3)

Mask values outside the upper and lower outlier limits by standard deviation

\(\mu \pm 3\sigma\)

the multiplier [3] can be adjusted by the user returns the lower_limit, upper_limit

Parameters:
  • arr (np.array|xr.DataArray, dtype=float, shape=[n, ]) – the full timeseries of the entire dataset

  • multiplier (float=1.5) – sets the standard deviation multiplier

Returns:

arr – A data object where values outside the limits are masked. Metdata will be preserved if the original input array is xr.DataArray

Return type:

array | xarray.DataArray