ViSP  2.9.0
vpKalmanFilter.h
1 /****************************************************************************
2  *
3  * $Id: vpKalmanFilter.h 4649 2014-02-07 14:57:11Z fspindle $
4  *
5  * This file is part of the ViSP software.
6  * Copyright (C) 2005 - 2014 by INRIA. All rights reserved.
7  *
8  * This software is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * ("GPL") version 2 as published by the Free Software Foundation.
11  * See the file LICENSE.txt at the root directory of this source
12  * distribution for additional information about the GNU GPL.
13  *
14  * For using ViSP with software that can not be combined with the GNU
15  * GPL, please contact INRIA about acquiring a ViSP Professional
16  * Edition License.
17  *
18  * See http://www.irisa.fr/lagadic/visp/visp.html for more information.
19  *
20  * This software was developed at:
21  * INRIA Rennes - Bretagne Atlantique
22  * Campus Universitaire de Beaulieu
23  * 35042 Rennes Cedex
24  * France
25  * http://www.irisa.fr/lagadic
26  *
27  * If you have questions regarding the use of this file, please contact
28  * INRIA at visp@inria.fr
29  *
30  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
31  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
32  *
33  *
34  * Description:
35  * Kalman filtering.
36  *
37  * Authors:
38  * Eric Marchand
39  * Fabien Spindler
40  *
41  *****************************************************************************/
42 
43 #ifndef vpKalmanFilter_h
44 #define vpKalmanFilter_h
45 
46 #include <visp/vpMatrix.h>
47 #include <visp/vpColVector.h>
48 
49 #include <math.h>
50 
111 class VISP_EXPORT vpKalmanFilter
112 {
113 protected :
114  //bool init_done ;
115 
117  long iter ;
118 
120  unsigned int size_state ;
122  unsigned int size_measure ;
124  unsigned int nsignal ;
125 
128 
129 public:
130  vpKalmanFilter() ;
131  vpKalmanFilter(unsigned int n_signal) ;
132  vpKalmanFilter(unsigned int size_state, unsigned int size_measure, unsigned int n_signal) ;
134  virtual ~vpKalmanFilter() {};
138  void setNumberOfSignal(unsigned int n_signal)
139  {
140  this->nsignal = n_signal;
141  }
142 
143  // int init() { return init_done ; }
144  void init(unsigned int size_state, unsigned int size_measure, unsigned int n_signal) ;
145  void prediction() ;
146  void filtering(vpColVector &z) ;
150  unsigned int getStateSize() { return size_state; };
154  unsigned int getMeasureSize() { return size_measure; };
158  unsigned int getNumberOfSignal() { return nsignal; };
162  int getIteration() { return iter ; }
168  void verbose(bool on) { verbose_mode = on;};
169 
170 public:
176  vpColVector Xest ;
184 
187 
195  double dt ;
196 
197 protected:
204 
211 
218 
221 } ;
222 
223 
224 
225 #endif
Definition of the vpMatrix class.
Definition: vpMatrix.h:98
unsigned int getStateSize()
long iter
Filter step or iteration. When set to zero, initialize the filter.
unsigned int size_state
Size of the state vector .
vpMatrix R
Measurement noise covariance matrix .
unsigned int size_measure
Size of the measure vector .
vpMatrix I
Identity matrix .
unsigned int nsignal
Number of signal to filter.
void setNumberOfSignal(unsigned int n_signal)
unsigned int getNumberOfSignal()
Class that provides a data structure for the column vectors as well as a set of operations on these v...
Definition: vpColVector.h:72
vpColVector Xpre
unsigned int getMeasureSize()
vpMatrix F
Transition matrix that describes the evolution of the state.
vpMatrix H
Matrix that describes the evolution of the measurements.
bool verbose_mode
When set to true, print the content of internal variables during filtering() and prediction().
This class provides a generic Kalman filtering algorithm along with some specific state model (consta...
vpMatrix Q
Process noise covariance matrix .
virtual ~vpKalmanFilter()