Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
DiscreteFilter Class Reference

Estimator that can be used to estimate discrete states. The update is applied according to Bayes. No propagation has been included in this class, but the propagate method can simply be overloaded in a specialized class. More...

#include <DiscreteFilter.h>

Inheritance diagram for DiscreteFilter:
Inheritance graph
[legend]

Public Member Functions

virtual DiscreteFilterclone () const
 
 DiscreteFilter ()
 
 DiscreteFilter (const DiscreteFilter &orig)
 
virtual const pbl::PDFgetValue () const
 Returns the current estimated state value. More...
 
virtual void propagate (const mhf::Time &time)
 Propagates the internal state to Time time. More...
 
virtual void reset ()
 Resets the internal state of the estimator to its initial value. More...
 
virtual void update (const pbl::PDF &z, const mhf::Time &time)
 Updates the internal state based on measurement z. More...
 
virtual ~DiscreteFilter ()
 
- Public Member Functions inherited from mhf::IStateEstimator
virtual bool setParameter (const std::string &param, const std::string &s)
 
virtual bool setParameter (const std::string &param, bool b)
 
virtual bool setParameter (const std::string &param, double v)
 
virtual ~IStateEstimator ()
 

Static Public Attributes

static int N_DISCRETEKALMAN_FILTER = 0
 

Protected Attributes

pbl::PMF pmf_
 

Detailed Description

Estimator that can be used to estimate discrete states. The update is applied according to Bayes. No propagation has been included in this class, but the propagate method can simply be overloaded in a specialized class.

Definition at line 50 of file DiscreteFilter.h.

Constructor & Destructor Documentation

DiscreteFilter::DiscreteFilter ( )

Definition at line 41 of file DiscreteFilter.cpp.

DiscreteFilter::DiscreteFilter ( const DiscreteFilter orig)

Definition at line 45 of file DiscreteFilter.cpp.

DiscreteFilter::~DiscreteFilter ( )
virtual

Definition at line 49 of file DiscreteFilter.cpp.

Member Function Documentation

DiscreteFilter * DiscreteFilter::clone ( ) const
virtual

Implements mhf::IStateEstimator.

Definition at line 53 of file DiscreteFilter.cpp.

const pbl::PDF & DiscreteFilter::getValue ( ) const
virtual

Returns the current estimated state value.

Returns
The current state, i.e., the current attribute value represented as probability density function

Implements mhf::IStateEstimator.

Definition at line 70 of file DiscreteFilter.cpp.

void DiscreteFilter::propagate ( const mhf::Time time)
virtual

Propagates the internal state to Time time.

Parameters
timeThe time to which the internal state is propagated

Implements mhf::IStateEstimator.

Definition at line 57 of file DiscreteFilter.cpp.

void DiscreteFilter::reset ( )
virtual

Resets the internal state of the estimator to its initial value.

Implements mhf::IStateEstimator.

Definition at line 66 of file DiscreteFilter.cpp.

void DiscreteFilter::update ( const pbl::PDF z,
const mhf::Time time 
)
virtual

Updates the internal state based on measurement z.

Parameters
zThe measurement with which to update. z should be a discrete distribution (PMF)
timeThe time to which the internal state is propagated before updating

Implements mhf::IStateEstimator.

Definition at line 60 of file DiscreteFilter.cpp.

Member Data Documentation

int DiscreteFilter::N_DISCRETEKALMAN_FILTER = 0
static

Definition at line 54 of file DiscreteFilter.h.

pbl::PMF DiscreteFilter::pmf_
protected

Definition at line 90 of file DiscreteFilter.h.


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


wire_state_estimators
Author(s): Sjoerd van den Dries, Jos Elfring
autogenerated on Fri Apr 16 2021 02:32:34