Struct common::routines::Calibration

pub struct Calibration<F> {
    pub slope: F,
    pub offset: F,
    pub rms: Option<F>,
    pub rsq: Option<F>,
}

Calibration struct as a convenience wrapper.

This includes optional elements for goodness of fit variables. The calibration model is linear, i.e. $y = m x + c$

Fields

slope: F

offset: F

rms: Option<F>

rsq: Option<F>

Implementations

impl<F> Calibration<F> where
    F: Copy, 

pub fn new(
    slope: F,
    offset: F,
    rms: Option<F>,
    rsq: Option<F>
) -> Calibration<F>

pub fn with_slope(&self, slope: F) -> Calibration<F>

Modifies the slope

pub fn with_offset(&self, offset: F) -> Calibration<F>

Trait Implementations

impl<'a, M: Copy + Default, F: Copy + ApproxEq<Margin = M>> ApproxEq for &'a Calibration<F>

Implements ApproxEq trait for Calibration struct

type Margin = M

This type type defines a margin within which two values are to be considered approximately equal. It must implement Default so that approx_eq() can be called on unknown types.

fn approx_eq<T: Into<Self::Margin>>(self, other: Self, margin: T) -> bool

This method tests that the self and other values are equal within margin of each other.

fn approx_ne<M>(self, other: Self, margin: M) -> bool where
    M: Into<Self::Margin>, 

This method tests that the self and other values are not within margin of each other.

impl<F> Default for Calibration<F> where
    F: Default, 

fn default() -> Self

Returns the “default value” for a type.