OpenCV for Unity  2.6.0
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.9.0/index.html ) for the details of the argument of the method.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OpenCVForUnity.VideoModule.KalmanFilter Class Reference

Kalman filter class. More...

Inheritance diagram for OpenCVForUnity.VideoModule.KalmanFilter:
OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject

Public Member Functions

IntPtr getNativeObjAddr ()
 
 KalmanFilter ()
 
 KalmanFilter (int dynamParams, int measureParams, int controlParams, int type)
 
 KalmanFilter (int dynamParams, int measureParams, int controlParams)
 
 KalmanFilter (int dynamParams, int measureParams)
 
Mat predict (Mat control)
 Computes a predicted state. More...
 
Mat predict ()
 Computes a predicted state. More...
 
Mat correct (Mat measurement)
 Updates the predicted state from the measurement. More...
 
Mat get_statePre ()
 
void set_statePre (Mat statePre)
 
Mat get_statePost ()
 
void set_statePost (Mat statePost)
 
Mat get_transitionMatrix ()
 
void set_transitionMatrix (Mat transitionMatrix)
 
Mat get_controlMatrix ()
 
void set_controlMatrix (Mat controlMatrix)
 
Mat get_measurementMatrix ()
 
void set_measurementMatrix (Mat measurementMatrix)
 
Mat get_processNoiseCov ()
 
void set_processNoiseCov (Mat processNoiseCov)
 
Mat get_measurementNoiseCov ()
 
void set_measurementNoiseCov (Mat measurementNoiseCov)
 
Mat get_errorCovPre ()
 
void set_errorCovPre (Mat errorCovPre)
 
Mat get_gain ()
 
void set_gain (Mat gain)
 
Mat get_errorCovPost ()
 
void set_errorCovPost (Mat errorCovPost)
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 
void ThrowIfDisposed ()
 

Static Public Member Functions

static KalmanFilter __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 
 DisposableOpenCVObject (IntPtr ptr)
 
 DisposableOpenCVObject (bool isEnabledDispose)
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 
 DisposableObject (bool isEnabledDispose)
 

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

Kalman filter class.

The class implements a standard Kalman filter <http://en.wikipedia.org/wiki/Kalman_filter&gt;, [Welch95] . However, you can modify transitionMatrix, controlMatrix, and measurementMatrix to get an extended Kalman filter functionality.

Note
In C API when CvKalman* kalmanFilter structure is not needed anymore, it should be released with cvReleaseKalman(&kalmanFilter)

Constructor & Destructor Documentation

◆ KalmanFilter() [1/4]

OpenCVForUnity.VideoModule.KalmanFilter.KalmanFilter ( )

◆ KalmanFilter() [2/4]

OpenCVForUnity.VideoModule.KalmanFilter.KalmanFilter ( int  dynamParams,
int  measureParams,
int  controlParams,
int  type 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
dynamParamsDimensionality of the state.
measureParamsDimensionality of the measurement.
controlParamsDimensionality of the control vector.
typeType of the created matrices that should be CV_32F or CV_64F.

◆ KalmanFilter() [3/4]

OpenCVForUnity.VideoModule.KalmanFilter.KalmanFilter ( int  dynamParams,
int  measureParams,
int  controlParams 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
dynamParamsDimensionality of the state.
measureParamsDimensionality of the measurement.
controlParamsDimensionality of the control vector.
typeType of the created matrices that should be CV_32F or CV_64F.

◆ KalmanFilter() [4/4]

OpenCVForUnity.VideoModule.KalmanFilter.KalmanFilter ( int  dynamParams,
int  measureParams 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
dynamParamsDimensionality of the state.
measureParamsDimensionality of the measurement.
controlParamsDimensionality of the control vector.
typeType of the created matrices that should be CV_32F or CV_64F.

Member Function Documentation

◆ __fromPtr__()

static KalmanFilter OpenCVForUnity.VideoModule.KalmanFilter.__fromPtr__ ( IntPtr  addr)
static

◆ correct()

Mat OpenCVForUnity.VideoModule.KalmanFilter.correct ( Mat  measurement)

Updates the predicted state from the measurement.

Parameters
measurementThe measured system parameters

◆ Dispose()

override void OpenCVForUnity.VideoModule.KalmanFilter.Dispose ( bool  disposing)
protectedvirtual

◆ get_controlMatrix()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_controlMatrix ( )

◆ get_errorCovPost()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_errorCovPost ( )

◆ get_errorCovPre()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_errorCovPre ( )

◆ get_gain()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_gain ( )

◆ get_measurementMatrix()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_measurementMatrix ( )

◆ get_measurementNoiseCov()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_measurementNoiseCov ( )

◆ get_processNoiseCov()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_processNoiseCov ( )

◆ get_statePost()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_statePost ( )

◆ get_statePre()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_statePre ( )

◆ get_transitionMatrix()

Mat OpenCVForUnity.VideoModule.KalmanFilter.get_transitionMatrix ( )

◆ getNativeObjAddr()

IntPtr OpenCVForUnity.VideoModule.KalmanFilter.getNativeObjAddr ( )

◆ predict() [1/2]

Mat OpenCVForUnity.VideoModule.KalmanFilter.predict ( Mat  control)

Computes a predicted state.

Parameters
controlThe optional input control

◆ predict() [2/2]

Mat OpenCVForUnity.VideoModule.KalmanFilter.predict ( )

Computes a predicted state.

Parameters
controlThe optional input control

◆ set_controlMatrix()

void OpenCVForUnity.VideoModule.KalmanFilter.set_controlMatrix ( Mat  controlMatrix)

◆ set_errorCovPost()

void OpenCVForUnity.VideoModule.KalmanFilter.set_errorCovPost ( Mat  errorCovPost)

◆ set_errorCovPre()

void OpenCVForUnity.VideoModule.KalmanFilter.set_errorCovPre ( Mat  errorCovPre)

◆ set_gain()

void OpenCVForUnity.VideoModule.KalmanFilter.set_gain ( Mat  gain)

◆ set_measurementMatrix()

void OpenCVForUnity.VideoModule.KalmanFilter.set_measurementMatrix ( Mat  measurementMatrix)

◆ set_measurementNoiseCov()

void OpenCVForUnity.VideoModule.KalmanFilter.set_measurementNoiseCov ( Mat  measurementNoiseCov)

◆ set_processNoiseCov()

void OpenCVForUnity.VideoModule.KalmanFilter.set_processNoiseCov ( Mat  processNoiseCov)

◆ set_statePost()

void OpenCVForUnity.VideoModule.KalmanFilter.set_statePost ( Mat  statePost)

◆ set_statePre()

void OpenCVForUnity.VideoModule.KalmanFilter.set_statePre ( Mat  statePre)

◆ set_transitionMatrix()

void OpenCVForUnity.VideoModule.KalmanFilter.set_transitionMatrix ( Mat  transitionMatrix)

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