Documentation API of the 'org.apache.commons.math3.filter.KalmanFilter' Java class

Class KalmanFilter

  • public class KalmanFilterextends Object
    Implementation of a Kalman filter to estimate the state xk of a discrete-time controlled process that is governed by the linear stochastic difference equation:
     xk = Axk-1 + Buk-1 + wk-1 
    with a measurement xk that is
     zk = Hxk + vk. 

    The random variables wk and vk represent the process and measurement noise and are assumed to be independent of each other and distributed with normal probability (white noise).

    The Kalman filter cycle involves the following steps:

    1. predict: project the current state estimate ahead in time
    2. correct: adjust the projected estimate by an actual measurement

    The Kalman filter is initialized with a ProcessModel and a MeasurementModel, which contain the corresponding transformation and noise covariance matrices. The parameter names used in the respective models correspond to the following names commonly used in the mathematical literature:

    • A - state transition matrix
    • B - control input matrix
    • H - measurement matrix
    • Q - process noise covariance matrix
    • R - measurement noise covariance matrix
    • P - error covariance matrix
    See Also:
    Kalman filter resources, An introduction to the Kalman filter by Greg Welch and Gary Bishop, Kalman filter example by Dan Simon, ProcessModel, MeasurementModel

Warning: You cannot see the full API documentation of this class since the access to the DatMelt documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To view the complete description of this class and its methods, please request the full DataMelt membership.

If you are already a full member, please login to the DataMelt member area before visiting this documentation.