qlibs::smootherKLMN Class Reference

A scalar Kalman filter. More...

#include <smoother.hpp>

Inheritance diagram for qlibs::smootherKLMN:

Public Member Functions
virtual	~smootherKLMN ()
bool	setup (const real_t processNoiseCov, const real_t measureNoiseCov, const real_t estErrorCov)
	Setup an initialize the scalar Kalman filter.
real_t	smooth (const real_t x) override
	Perform the smooth operation recursively for the input signal x.
Public Member Functions inherited from qlibs::smoother
virtual	~smoother ()
bool	isInitialized (void) const
	Check if the smoother filter is initialized.
bool	reset (void)
	Reset the the smoother filter.

Detailed Description

A scalar Kalman filter.

Constructor & Destructor Documentation

~smootherKLMN()

virtual qlibs::smootherKLMN::~smootherKLMN ( )

inlinevirtual

Member Function Documentation

setup()

bool smootherKLMN::setup	(	const real_t	processNoiseCov,
		const real_t	measureNoiseCov,
		const real_t	estErrorCov )

Setup an initialize the scalar Kalman filter.

Parameters

[in]	processNoiseCov	Process(predict) noise covariance
[in]	measureNoiseCov	Measure noise covariance
[in]	estErrorCov	Initial estimated error covariance

Returns

true on success, otherwise return false.

smooth()

real_t smootherKLMN::smooth ( const real_t x )

overridevirtual

Perform the smooth operation recursively for the input signal x.

Precondition

Instance must be previously initialized

Parameters

[in]

x

A sample of the input signal.

Returns

The smoothed output.

Implements qlibs::smoother.