Skip to main content

Rust API

The Rust API reference is generated by rustdoc, separately from the Python API pages generated by quartodoc.

The crate-level Rust API is also published on docs.rs/reducers.

The crate also exposes a Python-independent sigma-clipping API in reducers::sigma_clip. It provides a finite-only 1-D kernel and a caller-owned reusable Workspace for image-stack adapters and other Rust consumers. See the sigma-clipping performance notes for the implementation techniques used by the Python adapter.

reducers::reject provides IRAF imcombine-style per-sample rejection (CCD noise model, linear thresholds, min/max ranks, and percentile clipping) with the same workspace pattern, for image-stack and moving-window callers.

For local tests, make docs-build to build local docs and try rustdoc/reducers/index.html (or Rust-only case, make docs-rust and check target/doc/reducers/index.html).