KalmanFilter< T > Class Template Reference

Implements a generic Kalman Filter for 1D data. More...

#include <KalmanFilter.h>

Public Member Functions
	KalmanFilter (T processNoise, T sensorNoise, T errorCovariance)
	Constructs a KalmanFilter with specified noise parameters.
T	Filter (T value)
	Filters the given input value using the Kalman Filter algorithm.

Private Attributes
T	processNoise
	The process noise variance.
T	sensorNoise
	The sensor noise variance.
T	estimation
	The current estimation of the value.
T	errorCovariance
	The error covariance of the estimation.

Detailed Description

template<typename T>
class KalmanFilter< T >

Implements a generic Kalman Filter for 1D data.

This class provides a template-based implementation of a Kalman Filter for filtering noisy data. It estimates the true value by accounting for process noise and sensor noise.

Template Parameters

T	The numeric type for the filter (e.g., float, double).

Definition at line 26 of file KalmanFilter.h.

Constructor & Destructor Documentation

KalmanFilter()

template<typename T >

KalmanFilter	(	T	processNoise,
		T	sensorNoise,
		T	errorCovariance
	)

Constructs a KalmanFilter with specified noise parameters.

Parameters

processNoise	The process noise variance.
sensorNoise	The sensor noise variance.
errorCovariance	The initial error covariance.

Member Function Documentation

Filter()

template<typename T >

T Filter

(

T

value

)

Filters the given input value using the Kalman Filter algorithm.

Parameters

value

The noisy input value to be filtered.

Returns

The filtered estimate of the value.

Referenced by GammaAnimation::Update().

Member Data Documentation

errorCovariance

template<typename T >

T errorCovariance

private

The error covariance of the estimation.

Definition at line 31 of file KalmanFilter.h.

estimation

template<typename T >

T estimation

private

The current estimation of the value.

Definition at line 30 of file KalmanFilter.h.

processNoise

template<typename T >

T processNoise

private

The process noise variance.

Definition at line 28 of file KalmanFilter.h.

sensorNoise

template<typename T >

T sensorNoise

private

The sensor noise variance.

Definition at line 29 of file KalmanFilter.h.

---

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

• KalmanFilter.h