Rejector

Rejector()

Base class for rejection objects.

Methods

Name	Description
apply	Apply this rejection algorithm to an image stack.

apply

Rejector.apply(arr, mask=None, *, validate=True)

Apply this rejection algorithm to an image stack.

Parameters

arr : (ndarray, shape(N, *spatial))

Image stack. Inputs with more than 3 dimensions are flattened internally; output shapes match the trailing spatial dimensions of the input.

mask : ndarray of bool = None

Input mask; True means already masked. Must have the same shape as arr before any internal flattening.

validate : bool = True

If True, validate inputs before calling the kernel.

Returns

: mask_rej, std, low, upp, nit, output_flags : tuple of ndarray

Rejection mask and diagnostics from this rejection algorithm. std is the per-pixel spread used by sigma/CCD clipping and None for rejection algorithms without a spread diagnostic.