Skip to main content

EKFLocalizer

Struct EKFLocalizer 

Source
pub struct EKFLocalizer { /* private fields */ }
Expand description

Extended Kalman Filter for robot localization

Implementations§

Source§

impl EKFLocalizer

Source

pub fn new(config: EKFConfig) -> Self

Create a new EKF localizer

Source

pub fn try_new(config: EKFConfig) -> RoboticsResult<Self>

Create a new validated EKF localizer

Source

pub fn with_defaults() -> Self

Create with default configuration

Source

pub fn with_initial_state(initial_state: EKFState, config: EKFConfig) -> Self

Create with initial state

Source

pub fn try_with_initial_state( initial_state: EKFState, config: EKFConfig, ) -> RoboticsResult<Self>

Create with validated initial state

Source

pub fn with_initial_state_2d( initial_state: State2D, config: EKFConfig, ) -> RoboticsResult<Self>

Create with common State2D type

Source

pub fn get_covariance_matrix(&self) -> &Matrix4<f64>

Get reference to state covariance

Source

pub fn state_2d(&self) -> State2D

Get current estimate as State2D

Source

pub fn set_process_noise(&mut self, q: Matrix4<f64>)

Set process noise covariance

Source

pub fn try_set_process_noise(&mut self, q: Matrix4<f64>) -> RoboticsResult<()>

Set process noise covariance with validation

Source

pub fn set_measurement_noise(&mut self, r: Matrix2<f64>)

Set measurement noise covariance

Source

pub fn try_set_measurement_noise( &mut self, r: Matrix2<f64>, ) -> RoboticsResult<()>

Set measurement noise covariance with validation

Source

pub fn estimate( &mut self, measurement: &EKFMeasurement, control: &EKFControl, dt: f64, ) -> Result<&EKFState, RoboticsError>

Full EKF estimation step (predict + update)

Source

pub fn estimate_state( &mut self, measurement: Point2D, control: ControlInput, dt: f64, ) -> RoboticsResult<State2D>

EKF estimate step using common crate types

Source

pub fn ekf_estimation( x_est: EKFState, p_est: Matrix4<f64>, z: EKFMeasurement, u: EKFControl, q: Matrix4<f64>, r: Matrix2<f64>, dt: f64, ) -> (EKFState, Matrix4<f64>)

Legacy interface for EKF estimation (standalone function style)

Trait Implementations§

Source§

impl StateEstimator for EKFLocalizer

Source§

type State = Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>

State type used by this estimator
Source§

type Measurement = Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>

Measurement type used by this estimator
Source§

type Control = Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>

Control input type
Source§

fn predict(&mut self, control: &Self::Control, dt: f64)

Prediction step
Source§

fn update(&mut self, measurement: &Self::Measurement)

Update step with measurement
Source§

fn get_state(&self) -> &Self::State

Get current state estimate
Source§

fn get_covariance(&self) -> Option<&DMatrix<f64>>

Get current covariance estimate (if applicable)

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

impl<SS, SP> SupersetOf<SS> for SP
where 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, 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.
§

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

§

fn vzip(self) -> V