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, ) -> Result<Self, ConfigError>

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 duplicate 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<'__der_lifetime> DecodeValue<'__der_lifetime> for WhiteNoise

fn decode_value<R: Reader<'__der_lifetime>>( reader: &mut R, header: Header, ) -> Result<Self>

Attempt to decode this message using the provided [Reader].

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<'__der_lifetime> EncodeValue for WhiteNoise

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans [Tag]+[Length] header) when encoded as ASN.1 DER.

fn encode_value(&self, writer: &mut impl Writer) -> Result<()>

Encode value (sans [Tag]+[Length] header) as ASN.1 DER using the provided [Writer].

fn header(&self) -> Result<Header, Error>

where Self: Tagged,

Get the [Header] used to encode this value.

impl<'a, 'py> FromPyObject<'a, 'py> for WhiteNoise

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for WhiteNoise

type Target = WhiteNoise

The Python output type

type Output = Bound<'py, <WhiteNoise as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl Mul<f64> for WhiteNoise

fn mul(self, rhs: f64) -> Self::Output

Scale the white noise sigmas by a constant.

type Output = WhiteNoise

The resulting type after applying the * operator.

impl MulAssign<f64> for WhiteNoise

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

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 PyClass for WhiteNoise

const NAME: &str = "WhiteNoise"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for WhiteNoise

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// White noise is an uncorrelated random variable.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<WhiteNoise as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<WhiteNoise>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForWhiteNoise

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyTypeInfo for WhiteNoise

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

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 DerefToPyAny for WhiteNoise

impl<'__der_lifetime> Sequence<'__der_lifetime> for WhiteNoise

impl StructuralPartialEq for WhiteNoise