sigmaClip

exovetter.utils.sigmaClip(y, nSigma, maxIter=10000.0, initialClip=None)[source]

Iteratively find and remove outliers

Find outliers by identifiny all points more than nSigma from the mean value. The recalculate the mean and std and repeat until no more outliers found.

Parameters:
yndarray

Array to be cleaned

nSigmafloat

Threshold to cut at. 5 is typically a good value for most arrays found in practice.

maxIterint, optional

Maximum number of iterations

initialClipndarray, optional

1D boolean array. If an element of initialClip is set to True, that value is treated as a bad value in the first iteration, and not included in the computation of the mean and std.

Returns:
idxndarray

1d numpy array. Where set to True, the corresponding element of y is an outlier.