Struct nyx_space::od::estimate::KfEstimate

source · 
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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,{
    pub nominal_state: T,
    pub state_deviation: OVector<f64, <T as State>::Size>,
    pub covar: OMatrix<f64, <T as State>::Size, <T as State>::Size>,
    pub covar_bar: OMatrix<f64, <T as State>::Size, <T as State>::Size>,
    pub predicted: bool,
    pub stm: OMatrix<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: OVector<f64, <T as State>::Size>

The state deviation

§covar: OMatrix<f64, <T as State>::Size, <T as State>::Size>

The Covariance of this estimate

§covar_bar: OMatrix<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: OMatrix<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§

source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source

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

Trait Implementations§

source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

fn clone(&self) -> KfEstimate<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

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

Formats the value using the given formatter. Read more
source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

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

Formats the value using the given formatter. Read more
source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

fn zeros(nominal_state: T) -> Self

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

fn nominal_state(&self) -> T

The nominal state as reported by the filter dynamics
source§

fn state_deviation(&self) -> OVector<f64, <T as State>::Size>

The state deviation as computed by the filter.
source§

fn covar(&self) -> OMatrix<f64, <T as State>::Size, <T as State>::Size>

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

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

The predicted covariance of this estimate from the time update
source§

fn predicted(&self) -> bool

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

fn stm(&self) -> &OMatrix<f64, <T as State>::Size, <T as State>::Size>

The STM used to compute this Estimate
source§

fn epoch_fmt(&self) -> EpochFormat

The Epoch format upon serialization
source§

fn covar_fmt(&self) -> CovarFormat

The covariance format upon serialization
source§

fn set_state_deviation(&mut self, new_state: OVector<f64, <T as State>::Size>)

Sets the state deviation.
source§

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

Sets the Covariance of this estimate
source§

fn epoch(&self) -> Epoch

Epoch of this Estimate
source§

fn set_epoch(&mut self, dt: Epoch)

source§

fn state(&self) -> T

The estimated state
source§

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

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
source§

fn within_3sigma(&self) -> bool

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

fn header(epoch_fmt: EpochFormat, covar_fmt: CovarFormat) -> Vec<String> ⓘ

Returns the header
source§

fn default_header() -> Vec<String> ⓘ

Returns the default header
source§

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

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

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

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

Formats the value using the given formatter.
source§

impl NavSolution<Orbit> for KfEstimate<Orbit>

source§

fn orbital_state(&self) -> Orbit

source§

fn expected_state(&self) -> Orbit

Returns the nominal state as computed by the dynamics
source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

source§

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

Serializes the estimate

source§

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<f64, <T as State>::VecLength> + Allocator<usize, <T as State>::Size, <T as State>::Size>,

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§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Printing<T> for Twhere T: Display,

§

fn to_str(self) -> String

Method to serialize. Decorates Vecs with square brackets and tuples with round ones. Implementation code is in printing.rs.
§

fn to_plainstr(self) -> String

Method to serialize in minimal form (space separated, no brackets) Implementation code is in printing.rs.
§

fn rd(self) -> String

Printable in red
§

fn gr(self) -> String

Printable in green
§

fn bl(self) -> String

Printable in blue
§

fn yl(self) -> String

Printable in yellow
§

fn mg(self) -> String

Printable in magenta
§

fn cy(self) -> String

Printable in cyan
§

fn wvec(self, f: &mut File) -> Result<(), Error>

Method to write vector(s) to file f (space separated, without brackets). Passes up io errors
§

fn pvec(self)

Method to print vector(s) to stdout (space separated,without brackets).
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

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

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq<T> + Debug,