Function reference

1 Pipeline API

Stateful Combiner object and rejection objects.

Combiner Stateful pipeline holder for (scale/zero, reject, combine) workflows.
SigClip Iterative sigma-clipping rejection.
CcdClip CCD noise-model clipping.
LinearClip Center-relative linear clipping.
MinMaxClip Reject the smallest and largest unmasked values at each pixel.
PClip IRAF-style percentile clipping.
Rejector Base class for rejection objects.
SampleFlags Per-sample rejection/provenance flags.
OutputFlags Per-output rejection status flags.
resolve_zero_scale Resolve a numeric, string, or callable zero/scale input.

2 Kernel API

Advanced one-operation primitives for custom pipeline layers.

kernels.mean Return the NaN-aware mean along the stack axis.
kernels.median Return the NaN-aware median along the stack axis.
kernels.lmedian IRAF-style lower median along the stack axis.
kernels.summation Return the NaN-aware sum along the stack axis.
kernels.minimum Return the NaN-aware minimum along the stack axis.
kernels.maximum Return the NaN-aware maximum along the stack axis.
kernels.variance Return the NaN-aware variance along the stack axis.
kernels.weighted_average Return the NaN-aware weighted average along the stack axis.
kernels.mean_1d Return the NaN-aware mean of a 1-D value vector.
kernels.median_1d Return the NaN-aware median of a 1-D value vector.
kernels.lmedian_1d Return the NaN-aware lower median of a 1-D value vector.
kernels.sum_1d Return the NaN-aware sum of a 1-D value vector.
kernels.min_1d Return the NaN-aware minimum of a 1-D value vector.
kernels.max_1d Return the NaN-aware maximum of a 1-D value vector.
kernels.var_1d Return the NaN-aware variance of a 1-D value vector.
kernels.wvg_1d Return the NaN-aware weighted average of a 1-D value vector.
kernels.grow_mask Dilate a stack mask over spatial axes by an exact Euclidean radius.
kernels.sigclip Sigma-clipping rejection.
kernels.sigclip_1d Sigma-clipping rejection for a 1-D value vector.
kernels.sigclip_mask Return only the sigma-clipping rejection mask.
kernels.sigclip_combine Return an output-only sigma-clipped mean or median.
kernels.sigclip_combine_1d Return a 1-D sigma-clipped mean or median.
kernels.ccdclip CCD noise-model clipping.
kernels.ccdclip_1d CCD noise-model clipping for a 1-D value vector.
kernels.ccdclip_mask Return only the CCD-clipping rejection mask.
kernels.ccdclip_mask_1d Return only the CCD-clipping rejection mask for a 1-D value vector.
kernels.ccdclip_combine Return an output-only CCD-clipped mean or median.
kernels.ccdclip_combine_1d Return a 1-D CCD-clipped mean or median.
kernels.linearclip Center-relative linear clipping (low + low_scale * center <= value <= upp + upp_scale * center).
kernels.linearclip_1d Reject values outside center-relative linear bounds in a 1-D vector.
kernels.minmax Reject the n_min smallest and n_max largest unmasked values at each pixel. Single-pass.
kernels.minmax_1d Reject tail-ranked unmasked values in a 1-D value vector.
kernels.minmax_mask Return only the minmax rejection mask.
kernels.minmax_mask_1d Return only the minmax rejection mask for a 1-D value vector.
kernels.minmax_combine Return an output-only minmax-rejected mean or median.
kernels.minmax_combine_1d Return a 1-D minmax-rejected mean or median.
kernels.pclip IRAF-style percentile clipping at each pixel.
kernels.pclip_1d IRAF-style percentile clipping for a 1-D value vector.
kernels.pclip_mask Return only the IRAF-style pclip rejection mask.
kernels.pclip_mask_1d Return only the IRAF-style pclip rejection mask for a 1-D value vector.
kernels.pclip_combine Return an output-only pclip-rejected mean or median.
kernels.pclip_combine_1d Return a 1-D pclip-rejected mean or median.

3 Compatibility API

IRAF-style compact wrapper.

ndcombine Combine an image stack with optional normalization and rejection.
place_into_padded Place N-D arrays into a padded stack using integer offsets.

4 Parallel Controls

Runtime controls for Rayon worker count and serial/parallel cutoff.

get_rayon_num_threads Return the size of Rayon global worker pool.
set_rayon_num_threads Set the Rayon global worker-pool size.
get_parallel_threshold Return the output-element threshold where kernels switch to Rayon.
set_parallel_threshold Set the output-element threshold where kernels switch to Rayon.
get_minmax_1d_parallel_threshold Return the vector length where 1-D min/max switch to Rayon.
set_minmax_1d_parallel_threshold Set the vector length where 1-D min/max switch to Rayon.