Struct nyx_space::od::estimate::KfEstimate[−][src]

pub struct KfEstimate<T: State> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,  {
    pub nominal_state: T,
    pub state_deviation: VectorN<f64, <T as State>::Size>,
    pub covar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>,
    pub covar_bar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>,
    pub predicted: bool,
    pub stm: MatrixMN<f64, <T as State>::Size, <T as State>::Size>,
    pub epoch_fmt: EpochFormat,
    pub covar_fmt: CovarFormat,
}

Expand description

Kalman filter Estimate

Fields

nominal_state: T

The estimated state

state_deviation: VectorN<f64, <T as State>::Size>

The state deviation

covar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>

The Covariance of this estimate

covar_bar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>

The predicted covariance of this estimate

predicted: bool

Whether or not this is a predicted estimate from a time update, or an estimate from a measurement

stm: MatrixMN<f64, <T as State>::Size, <T as State>::Size>

The STM used to compute this Estimate

epoch_fmt: EpochFormat

The Epoch format upon serialization

covar_fmt: CovarFormat

The covariance format upon serialization

Implementations

impl<T: State> KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

pub fn from_covar(
    nominal_state: T, 
    covar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>
) -> Self

[src]

Trait Implementations

impl<T: Clone + State> Clone for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

fn clone(&self) -> KfEstimate<T>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<T: Debug + State> Debug for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

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

Formats the value using the given formatter. Read more

impl<T: State> Display for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

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

Formats the value using the given formatter. Read more

impl<T: State> Estimate<T> for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

fn zeros(nominal_state: T) -> Self[src]

An empty estimate. This is useful if wanting to store an estimate outside the scope of a filtering loop.

fn nominal_state(&self) -> T[src]

The nominal state as reported by the filter dynamics

fn state_deviation(&self) -> VectorN<f64, <T as State>::Size>[src]

The state deviation as computed by the filter.

fn covar(&self) -> MatrixMN<f64, <T as State>::Size, <T as State>::Size>[src]

The Covariance of this estimate. Will return the predicted covariance if this is a time update/prediction.

fn predicted_covar(
    &self
) -> MatrixMN<f64, <T as State>::Size, <T as State>::Size>

[src]

The predicted covariance of this estimate from the time update

fn predicted(&self) -> bool[src]

Whether or not this is a predicted estimate from a time update, or an estimate from a measurement

fn stm(&self) -> &MatrixMN<f64, <T as State>::Size, <T as State>::Size>[src]

The STM used to compute this Estimate

fn epoch_fmt(&self) -> EpochFormat[src]

The Epoch format upon serialization

fn covar_fmt(&self) -> CovarFormat[src]

The covariance format upon serialization

fn set_state_deviation(&mut self, new_state: VectorN<f64, <T as State>::Size>)[src]

Sets the state deviation.

fn set_covar(
    &mut self, 
    new_covar: MatrixMN<f64, <T as State>::Size, <T as State>::Size>
)

[src]

Sets the Covariance of this estimate

fn epoch(&self) -> Epoch[src]

Epoch of this Estimate

fn set_epoch(&mut self, dt: Epoch)[src]

fn state(&self) -> T[src]

The estimated state

fn within_sigma(&self, sigma: f64) -> bool[src]

Returns whether this estimate is within some bound The 68-95-99.7 rule is a good way to assess whether the filter is operating normally Read more

fn within_3sigma(&self) -> bool[src]

Returns whether this estimate is within 3 sigma, which represent 99.7% for a Normal distribution

fn header(epoch_fmt: EpochFormat, covar_fmt: CovarFormat) -> Vec<String>[src]

Returns the header

fn default_header() -> Vec<String>[src]

Returns the default header

fn covar_ij(&self, i: usize, j: usize) -> f64[src]

Returns the covariance element at position (i, j) formatted with this estimate’s covariance formatter

impl<T: State> LowerExp for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

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

Formats the value using the given formatter.

impl NavSolution<Orbit> for KfEstimate<Orbit>[src]

fn orbital_state(&self) -> Orbit[src]

fn expected_state(&self) -> Orbit[src]

Returns the nominal state as computed by the dynamics

impl<T: PartialEq + State> PartialEq<KfEstimate<T>> for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

fn eq(&self, other: &KfEstimate<T>) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &KfEstimate<T>) -> bool[src]

This method tests for !=.

impl<T: State> Serialize for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

fn serialize<O>(&self, serializer: O) -> Result<O::Ok, O::Error> where
    O: Serializer,

[src]

Serializes the estimate

impl<T: State> StructuralPartialEq for KfEstimate<T> where
    DefaultAllocator: Allocator<f64, <T as State>::Size> + Allocator<f64, <T as State>::Size, <T as State>::Size> + Allocator<usize, <T as State>::Size> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

[src]

Auto Trait Implementations

impl<T> !RefUnwindSafe for KfEstimate<T>

impl<T> !Send for KfEstimate<T>

impl<T> !Sync for KfEstimate<T>

impl<T> !Unpin for KfEstimate<T>

impl<T> !UnwindSafe for KfEstimate<T>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T where
    T: Clone,

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V