Enum Background 

pub enum Background {
    None,
    Constant,
    Linear,
    Strip {
        width: usize,
        niterations: usize,
        factor: f64,
    },
    Snip {
        width: usize,
    },
    Polynomial {
        degree: usize,
    },
}

A selectable background theory (silx bgtheories.THEORY).

Variants

None

No background (silx “No Background”): zero everywhere.

Constant

Constant background (silx “Constant”): min(y).

Linear

Linear background (silx “Linear”): a least-squares line fitted to the strip background of the data.

Strip

Strip filter background (silx “Strip”): see strip_background.

Fields

width: usize

Operator half-distance in samples.

niterations: usize

Number of stripping iterations.

factor: f64

Threshold scaling factor.

Snip

SNIP filter background (silx “Snip”): see snip_background.

Fields

width: usize

Snip operator width in samples.

Polynomial

Polynomial background (silx “Internal” poly theories): a least-squares polynomial of degree fitted to the strip background of the data (silx EstimatePolyOnStrip = True).

Fields

degree: usize

Polynomial degree (silx ships 2–5).

Implementations

impl Background

pub fn strip() -> Self

A strip background with silx’s default parameters.

pub fn snip() -> Self

A SNIP background with silx’s default width.

pub fn name(self) -> &'static str

Display name (silx theory name).

pub fn compute(self, x: &[f64], y: &[f64]) -> Vec<f64>

Compute the background curve sampled at x for the data y.

x is used only by the Linear / Polynomial theories (which fit a curve in x); the strip/snip/constant theories ignore it. Falls back to zeros when a polynomial fit is not solvable (e.g. mismatched lengths).

pub fn subtract(self, x: &[f64], y: &[f64]) -> Vec<f64>

Subtract the background from y, returning y - background(x, y).

Trait Implementations

impl Clone for Background

fn clone(&self) -> Background

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Background

impl Debug for Background

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Background

fn eq(&self, other: &Background) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Background