stateObservation::IMUMagnetometerDynamicalSystem Class Reference

The class is an implementation of the dynamical system defined by an inertial measurement unit (IMU) fixed on a rigid body. The state is the position velocity and acceleration and the orientation and rotation velocity and acceleration. The sensors are the accelerometer, the gyrometer and the magnetometer. More...

#include <state-observation/dynamical-system/imu-magnetometer-dynamical-system.hpp>

Inheritance diagram for stateObservation::IMUMagnetometerDynamicalSystem:
Collaboration diagram for stateObservation::IMUMagnetometerDynamicalSystem:

Public Member Functions

 IMUMagnetometerDynamicalSystem ()
 The constructor. More...
 
virtual ~IMUMagnetometerDynamicalSystem ()
 The virtual destructor. More...
 
virtual Vector stateDynamics (const Vector &x, const Vector &u, TimeIndex k)
 Description of the state dynamics. More...
 
virtual Vector measureDynamics (const Vector &x, const Vector &u, TimeIndex k)
 Description of the sensor's dynamics. More...
 
virtual void setProcessNoise (NoiseBase *)
 Sets a noise which disturbs the state dynamics. More...
 
virtual void resetProcessNoise ()
 Removes the process noise. More...
 
virtual NoiseBasegetProcessNoise () const
 Gets the process noise. More...
 
virtual void setMeasurementNoise (NoiseBase *)
 Sets a noise which disturbs the measurements. More...
 
virtual void resetMeasurementNoise ()
 Removes the measurement noise. More...
 
virtual NoiseBasegetMeasurementNoise () const
 Gets a pointer on the measurement noise. More...
 
virtual void setSamplingPeriod (double dt)
 Set the period of the time discretization. More...
 
virtual Index getStateSize () const
 Gets the state size. More...
 
virtual Index getInputSize () const
 Gets the input size. More...
 
virtual Index getMeasurementSize () const
 Gets the measurement size. More...
 
- Public Member Functions inherited from stateObservation::DynamicalSystemFunctorBase
 DynamicalSystemFunctorBase ()
 
virtual ~DynamicalSystemFunctorBase ()
 
virtual void reset ()
 
virtual bool checkStateVector (const Vector &)
 Gives a boolean answer on whether or not the vector is correctly sized to be a state vector. More...
 
virtual bool checkInputvector (const Vector &)
 Gives a boolean answer on whether or not the vector is correctly sized to be an input vector. More...
 

Protected Types

typedef kine::indexes< kine::rotationVectorindexes
 

Protected Member Functions

Quaternion computeQuaternion_ (const Vector3 &x)
 
- Protected Member Functions inherited from stateObservation::DynamicalSystemFunctorBase
void assertStateVector_ (const Vector &v)
 
void assertInputVector_ (const Vector &v)
 

Protected Attributes

AccelerometerGyrometerMagnetometer sensor_
 
NoiseBaseprocessNoise_
 
double dt_
 
Vector3Unaligned orientationVector_
 
QuaternionUnaligned quaternion_
 

Static Protected Attributes

static const Index stateSize_ = 18
 
static const Index inputSize_ = 0
 
static const Index measurementSize_ = 9
 

Detailed Description

The class is an implementation of the dynamical system defined by an inertial measurement unit (IMU) fixed on a rigid body. The state is the position velocity and acceleration and the orientation and rotation velocity and acceleration. The sensors are the accelerometer, the gyrometer and the magnetometer.

Member Typedef Documentation

◆ indexes

Constructor & Destructor Documentation

◆ IMUMagnetometerDynamicalSystem()

stateObservation::IMUMagnetometerDynamicalSystem::IMUMagnetometerDynamicalSystem ( )

The constructor.

◆ ~IMUMagnetometerDynamicalSystem()

virtual stateObservation::IMUMagnetometerDynamicalSystem::~IMUMagnetometerDynamicalSystem ( )
virtual

The virtual destructor.

Member Function Documentation

◆ computeQuaternion_()

Quaternion stateObservation::IMUMagnetometerDynamicalSystem::computeQuaternion_ ( const Vector3 x)
protected

◆ getInputSize()

virtual Index stateObservation::IMUMagnetometerDynamicalSystem::getInputSize ( ) const
virtual

Gets the input size.

Implements stateObservation::DynamicalSystemFunctorBase.

◆ getMeasurementNoise()

virtual NoiseBase* stateObservation::IMUMagnetometerDynamicalSystem::getMeasurementNoise ( ) const
virtual

Gets a pointer on the measurement noise.

◆ getMeasurementSize()

virtual Index stateObservation::IMUMagnetometerDynamicalSystem::getMeasurementSize ( ) const
virtual

Gets the measurement size.

Implements stateObservation::DynamicalSystemFunctorBase.

◆ getProcessNoise()

virtual NoiseBase* stateObservation::IMUMagnetometerDynamicalSystem::getProcessNoise ( ) const
virtual

Gets the process noise.

◆ getStateSize()

virtual Index stateObservation::IMUMagnetometerDynamicalSystem::getStateSize ( ) const
virtual

Gets the state size.

Implements stateObservation::DynamicalSystemFunctorBase.

◆ measureDynamics()

virtual Vector stateObservation::IMUMagnetometerDynamicalSystem::measureDynamics ( const Vector x,
const Vector u,
TimeIndex  k 
)
virtual

Description of the sensor's dynamics.

Implements stateObservation::DynamicalSystemFunctorBase.

◆ resetMeasurementNoise()

virtual void stateObservation::IMUMagnetometerDynamicalSystem::resetMeasurementNoise ( )
virtual

Removes the measurement noise.

◆ resetProcessNoise()

virtual void stateObservation::IMUMagnetometerDynamicalSystem::resetProcessNoise ( )
virtual

Removes the process noise.

◆ setMeasurementNoise()

virtual void stateObservation::IMUMagnetometerDynamicalSystem::setMeasurementNoise ( NoiseBase )
virtual

Sets a noise which disturbs the measurements.

◆ setProcessNoise()

virtual void stateObservation::IMUMagnetometerDynamicalSystem::setProcessNoise ( NoiseBase )
virtual

Sets a noise which disturbs the state dynamics.

◆ setSamplingPeriod()

virtual void stateObservation::IMUMagnetometerDynamicalSystem::setSamplingPeriod ( double  dt)
virtual

Set the period of the time discretization.

◆ stateDynamics()

virtual Vector stateObservation::IMUMagnetometerDynamicalSystem::stateDynamics ( const Vector x,
const Vector u,
TimeIndex  k 
)
virtual

Description of the state dynamics.

Implements stateObservation::DynamicalSystemFunctorBase.

Member Data Documentation

◆ dt_

double stateObservation::IMUMagnetometerDynamicalSystem::dt_
protected

◆ inputSize_

const Index stateObservation::IMUMagnetometerDynamicalSystem::inputSize_ = 0
staticprotected

◆ measurementSize_

const Index stateObservation::IMUMagnetometerDynamicalSystem::measurementSize_ = 9
staticprotected

◆ orientationVector_

Vector3Unaligned stateObservation::IMUMagnetometerDynamicalSystem::orientationVector_
protected

◆ processNoise_

NoiseBase* stateObservation::IMUMagnetometerDynamicalSystem::processNoise_
protected

◆ quaternion_

QuaternionUnaligned stateObservation::IMUMagnetometerDynamicalSystem::quaternion_
protected

◆ sensor_

AccelerometerGyrometerMagnetometer stateObservation::IMUMagnetometerDynamicalSystem::sensor_
protected

◆ stateSize_

const Index stateObservation::IMUMagnetometerDynamicalSystem::stateSize_ = 18
staticprotected

The documentation for this class was generated from the following file: