Struct WhiteNoise

pub struct WhiteNoise {
    pub mean: f64,
    pub sigma: f64,
}

White noise is an uncorrelated random variable.

Fields

mean: f64

Mean value of this white noise

sigma: f64

Process noise as a one-sigma of the Normal distribution.

Implementations

impl WhiteNoise

pub fn new(process_noise: f64, integration_time: Duration) -> Self

Initializes a new random walk stochastic noise model from the process noise and the integration time. This will compute the process noise per second automatically.

pub fn constant_white_noise(process_noise: f64) -> Self

Initializes a new random walk stochastic noise model from the provided process noise, assuming that the noise level is fixed regardless of the integration time.

pub fn from_pr_n0(pr_n0: f64, bandwidth_hz: f64) -> Self

Trait Implementations

impl Clone for WhiteNoise

fn clone(&self) -> WhiteNoise

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WhiteNoise

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

Formats the value using the given formatter.

impl Default for WhiteNoise

fn default() -> WhiteNoise

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WhiteNoise

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WhiteNoise

fn eq(&self, other: &WhiteNoise) -> 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 Serialize for WhiteNoise

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Stochastics for WhiteNoise

fn covariance(&self, _epoch: Epoch) -> f64

Return the variance of this stochastic noise model at a given time.

fn sample<R: Rng>(&mut self, _epoch: Epoch, rng: &mut R) -> f64

Returns a new sample of these stochastics

impl Copy for WhiteNoise

impl StructuralPartialEq for WhiteNoise