Struct StrapdownState

Source
pub struct StrapdownState {
    pub position: Vector3<f64>,
    pub velocity: Vector3<f64>,
    pub attitude: Rotation3<f64>,
}
Expand description

Basic structure for holding the strapdown mechanization state in the form of position, velocity, and attitude.

Attitude is stored in matrix form (rotation or direction cosine matrix) and position and velocity are stored as vectors. The order or the states depends on the coordinate system used. The struct does not care, but the coordinate system used will determine which functions you should use. Default is NED but nonetheless must be assigned. For computational simplicity, latitude and longitude are stored as radians.

Fields§

§position: Vector3<f64>§velocity: Vector3<f64>§attitude: Rotation3<f64>

Implementations§

Source§

impl StrapdownState

Source

pub fn new() -> StrapdownState

Create a new StrapdownState with all zeros

Source

pub fn new_from( position: Vector3<f64>, velocity: Vector3<f64>, attitude: Vector3<f64>, in_degrees: bool, ) -> StrapdownState

Create a new StrapdownState from a position, velocity, and attitude vectors.

This function initializes a new StrapdownState instance with the given position, velocity, and attitude vectors. The position is in the form of latitude, longitude, and altitude (meters). The corresponding velocities are in the NED/ENU frame (meters per second) and the attitude is given as roll, pitch, and yaw angles. These angles (both attitude angles, latitude, and longitude) can be specified in either degrees or radians using the in_degrees parameter. Note that internally, the angles are converted to radians for calculations.

§Arguments
  • position - A Vector3 representing the position in the form of latitude (degrees), longitude (degrees), and altitude (meters).
  • velocity - A Vector3 representing the velocity in the NED/ENU frame (meters per second).
  • attitude - A Vector3 representing the attitude in the form of roll, pitch, and yaw angles (degrees).
§Returns
  • A StrapdownState instance containing the position, velocity, and attitude.
§Example
use strapdown::StrapdownState;
use nalgebra::Vector3;
let position = Vector3::new(37.7749, -122.4194, 0.0); // San Francisco coordinates
let velocity = Vector3::new(0.0, 0.0, 0.0); // No initial velocity
let attitude = Vector3::new(0.0, 0.0, 0.0); // No initial attitude
let state = StrapdownState::new_from(position, velocity, attitude, false);
Source

pub fn new_from_vector( state: SVector<f64, 9>, in_degrees: bool, ) -> StrapdownState

Create a StrapdownState from a vector of states

Creates a StrapdownState object from a cannoincal strapdown state vector. The vector is in the form of: $\left(p_n, p_e, p_d, v_n, v_e, v_d, \phi, \theta, \psi\right)$. Radian or degree mode can be toggled via the in_degrees parameter.

§Arguments
  • state - A SVector of shape (9,) representing the strapdown state vector.
  • in_degrees - A boolean indicating whether the angles are in degrees (true) or radians (false).
§Returns
  • A StrapdownState instance containing the position, velocity, and attitude.
§Example
use strapdown::StrapdownState;
use nalgebra::SVector;

let state_vector: SVector<f64, 9> = SVector::from_vec(vec![37.7749, -122.4194, 0.0, 10.0, 0.0, 0.0, 0.0, 45.0, 0.0]); // Example state vector
let strapdown_state = StrapdownState::new_from_vector(state_vector, true);
Source

pub fn forward(&mut self, imu_data: &IMUData, dt: f64)

NED form of the forward kinematics equations. Corresponds to section 5.4 Local-Navigation Frame Equations from the book Principles of GNSS, Inertial, and Multisensor Integrated Navigation Systems, Second Edition by Paul D. Groves; Second Edition.

This function implements the forward kinematics equations for the strapdown navigation system. It takes the IMU data and the time step as inputs and updates the position, velocity, and attitude of the system. The IMU data is assumed to be pre-processed and ready for use in the mechanization equations (i.e. the gravity vector has already been filtered out and the data represents relative motion).

§Arguments
  • imu_data - A reference to an IMUData instance containing the acceleration and gyro data in the body frame.
  • dt - A f64 representing the time step in seconds.
§Example
use strapdown::{StrapdownState, IMUData};
use nalgebra::Vector3;
let mut state = StrapdownState::new();
let imu_data = IMUData::new_from_vector(
   Vector3::new(0.0, 0.0, -9.81), // free fall acceleration in m/s^2
   Vector3::new(0.0, 0.0, 0.0) // No rotation
);
let dt = 0.1; // Example time step in seconds
state.forward(&imu_data, dt);
Source

pub fn to_vector(&self, in_degrees: bool) -> SVector<f64, 9>

Convert the StrapdownState to a one dimensional vector, nalgebra style

StrapdownState internally stores the attitude as a direction cosine matrix (DCM) and the position and velocity as vectors. Outside of this object, it is useful to have the navigation state in a traditional cannonical vector form for use in various filters and algorithms. This function converts the internal state to a one dimensional vector in the form of: $\left[p_n, p_e, p_d, v_n, v_e, v_d, \phi, \theta, \psi \right]$

§Arguments
  • in_degrees - A boolean indicating whether to return the angles in degrees (true) or radians (false).
§Returns
  • An SVector of shape (9,) representing the strapdown state vector.
Source

pub fn to_vec(&self, in_degrees: bool) -> Vec<f64>

Convert the StrapdownState to a one dimensional vector, native vec (list) style

StrapdownState internally stores the attitude as a direction cosine matrix (DCM) and the position and velocity as vectors. Outside of this object, it is useful to have the navigation state in a traditional cannonical vector form for use in various filters and algorithms. This function converts the internal state to a one dimensional vector in the form of: $\left[p_n, p_e, p_d, v_n, v_e, v_d, \phi, \theta, \psi \right]$

§Arguments
  • in_degrees - A boolean indicating whether to return the angles in degrees (true) or radians (false).
§Returns
  • An SVector of shape (9,) representing the strapdown state vector.

Trait Implementations§

Source§

impl Clone for StrapdownState

Source§

fn clone(&self) -> StrapdownState

Returns a duplicate 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 Debug for StrapdownState

Source§

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

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

impl Default for StrapdownState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for StrapdownState

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<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.
Source§

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

Source§

fn vzip(self) -> V