ProtoTracer  1.0
Real-time 3D rendering and animation engine
Loading...
Searching...
No Matches
VectorKalmanFilter< T > Class Template Reference

Applies Kalman filtering independently to each component of a 3D vector. More...

#include <VectorKalmanFilter.h>

Public Member Functions

 VectorKalmanFilter (T processNoise, T sensorNoise, T errorCovariance)
 Constructs a VectorKalmanFilter with specified parameters.
 
Vector3D Filter (Vector3D input)
 Filters a 3D vector input using the Kalman filter.
 

Private Attributes

KalmanFilter< TX
 Kalman filter for the X component of the vector.
 
KalmanFilter< TY
 Kalman filter for the Y component of the vector.
 
KalmanFilter< TZ
 Kalman filter for the Z component of the vector.
 

Detailed Description

template<typename T>
class VectorKalmanFilter< T >

Applies Kalman filtering independently to each component of a 3D vector.

The VectorKalmanFilter class uses three KalmanFilter instances to process the X, Y, and Z components of a Vector3D, providing a smooth output for noisy 3D data.

Template Parameters
TThe numeric type used for calculations (e.g., float or double).

Definition at line 28 of file VectorKalmanFilter.h.

Constructor & Destructor Documentation

◆ VectorKalmanFilter()

template<typename T >
VectorKalmanFilter ( T  processNoise,
T  sensorNoise,
T  errorCovariance 
)

Constructs a VectorKalmanFilter with specified parameters.

Initializes the Kalman filters for each component with the given process noise, sensor noise, and error covariance.

Parameters
processNoiseThe process noise for the Kalman filter.
sensorNoiseThe sensor noise for the Kalman filter.
errorCovarianceThe initial error covariance for the Kalman filter.

Definition at line 4 of file VectorKalmanFilter.cpp.

Member Function Documentation

◆ Filter()

template<typename T >
Vector3D Filter ( Vector3D  input)

Filters a 3D vector input using the Kalman filter.

Applies Kalman filtering independently to the X, Y, and Z components of the input vector.

Parameters
inputThe input Vector3D to filter.
Returns
The filtered Vector3D.

Definition at line 11 of file VectorKalmanFilter.cpp.

Member Data Documentation

◆ X

template<typename T >
KalmanFilter<T> X
private

Kalman filter for the X component of the vector.

Definition at line 30 of file VectorKalmanFilter.h.

◆ Y

template<typename T >
KalmanFilter<T> Y
private

Kalman filter for the Y component of the vector.

Definition at line 31 of file VectorKalmanFilter.h.

◆ Z

template<typename T >
KalmanFilter<T> Z
private

Kalman filter for the Z component of the vector.

Definition at line 32 of file VectorKalmanFilter.h.


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