Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Motion Analysis and Object Tracking » cvKalmanFilter

cvKalmanFilter

Standard Kalman filter.

	Name	Type	Range	Description
	inDynamParams	Integer	1 -	Dimensionality of the state.
	inMeasureParams	Integer	1 -	Dimensionality of the measurement.
	inControlParams	Integer	0 -	Dimensionality of the control vector
	inReset	Bool		When true, filter is reinitialized.
	inPredict	Bool		When true, filter computes predicted state.
	inCorrect	Bool		When true, filter updates predicted state from measurement.
	inControl	Matrix		Control vector
	inMeasurement	Matrix		Value to be used for correction.
	inTransitionMatrix	Matrix
	inPreState	Matrix
	outState	Matrix		Set when inCorrect is true
	outPrediction	Matrix		Set when inPredict is true

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
DomainError	inControl must be a matrix of size 1 x inControlParams in cvKalmanFilter.
DomainError	inMeasurement must be a matrix of size 1 x inMeasureParams in cvKalmanFilter.
DomainError	inPreState must be a matrix of size 1 x inDynamParams in cvKalmanFilter.
DomainError	inTransitionMatrix must be a matrix of size inDynamParams x inDynamParams in cvKalmanFilter.

Complexity Level

This filter is available on Basic Complexity Level.