Skip to main content

KalmanState

Struct KalmanState 

Source
pub struct KalmanState {
    pub timestamp: f64,
    pub position_m: [f64; 3],
    pub velocity_ms: [f64; 3],
    pub quaternion: [f64; 4],
    pub accel_bias: [f64; 3],
    pub gyro_bias: [f64; 3],
    pub cov_diagonal: [f64; 15],
}
Expand description

The fused navigation state from a Kalman filter.

State vector: position (3), velocity (3), orientation quaternion (4), accelerometer bias (3), gyroscope bias (3) → total 16 scalars. The covariance diagonal (15 terms) is stored separately.

Fields§

§timestamp: f64

Timestamp in seconds.

§position_m: [f64; 3]

Position [x, y, z] in metres (ECEF or local NED depending on frame).

§velocity_ms: [f64; 3]

Velocity [vx, vy, vz] in m/s.

§quaternion: [f64; 4]

Orientation quaternion [qw, qx, qy, qz] (unit quaternion).

§accel_bias: [f64; 3]

Accelerometer bias estimate [bax, bay, baz] in m/s².

§gyro_bias: [f64; 3]

Gyroscope bias estimate [bgx, bgy, bgz] in rad/s.

§cov_diagonal: [f64; 15]

Diagonal of the 15×15 error covariance matrix.

Implementations§

Source§

impl KalmanState

Source

pub fn identity(timestamp: f64) -> Self

Create a new Kalman state with identity quaternion and zero everything else.

Source

pub fn quaternion_is_unit(&self) -> bool

Check that the quaternion is (approximately) normalised.

Source

pub fn roll_rad(&self) -> f64

Roll angle in radians extracted from the quaternion.

Source

pub fn pitch_rad(&self) -> f64

Pitch angle in radians extracted from the quaternion.

Source

pub fn yaw_rad(&self) -> f64

Yaw angle in radians extracted from the quaternion.

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize to bytes (timestamp 8B + 3+3+4+3+3 f64s + 15 cov f64s = 8+95×8 = 768B).

Source

pub fn from_bytes(data: &[u8]) -> Option<Self>

Deserialize from bytes.

Trait Implementations§

Source§

impl Clone for KalmanState

Source§

fn clone(&self) -> KalmanState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KalmanState

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.