Top Description Fields Constructors Methods
org.apache.commons.math3.filter

public Class DefaultMeasurementModel

extends Object
implements MeasurementModel
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.filter.MeasurementModel
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .NoDataException, .NullArgumentException, org.apache.commons.math3.linear.Array2DRowRealMatrix, .RealMatrix
Default implementation of a MeasurementModel for the use with a KalmanFilter.
Since
3.0

Field Summary

Modifier and TypeField and Description
private RealMatrix
measurementMatrix

The measurement matrix, used to associate the measurement vector to the internal state estimation vector.

private RealMatrix
measurementNoise

The measurement noise covariance matrix.

Constructor Summary

AccessConstructor and Description
public
DefaultMeasurementModel(final double[][]
the measurement matrix
measMatrix, final double[][]
the measurement noise matrix
measNoise)

Create a new MeasurementModel, taking double arrays as input parameters for the respective measurement matrix and noise.

public
DefaultMeasurementModel(final RealMatrix
the measurement matrix
measMatrix, final RealMatrix
the measurement noise matrix
measNoise)

Create a new MeasurementModel, taking RealMatrix objects as input parameters for the respective measurement matrix and noise.

Method Summary

Modifier and TypeMethod and Description
public RealMatrix
getMeasurementMatrix()

Implements org.apache.commons.math3.filter.MeasurementModel.getMeasurementMatrix.

Returns the measurement matrix.

public RealMatrix
getMeasurementNoise()

Implements org.apache.commons.math3.filter.MeasurementModel.getMeasurementNoise.

Returns the measurement noise matrix.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

measurementMatrixback to summary
private RealMatrix measurementMatrix

The measurement matrix, used to associate the measurement vector to the internal state estimation vector.

measurementNoiseback to summary
private RealMatrix measurementNoise

The measurement noise covariance matrix.

Constructor Detail

DefaultMeasurementModelback to summary
public DefaultMeasurementModel(final double[][] measMatrix, final double[][] measNoise) throws NullArgumentException, NoDataException, DimensionMismatchException

Create a new MeasurementModel, taking double arrays as input parameters for the respective measurement matrix and noise.

Parameters
measMatrix:double[][]

the measurement matrix

measNoise:double[][]

the measurement noise matrix

Exceptions
NullArgumentException:
if any of the input matrices is null
NoDataException:
if any row / column dimension of the input matrices is zero
DimensionMismatchException:
if any of the input matrices is non-rectangular
DefaultMeasurementModelback to summary
public DefaultMeasurementModel(final RealMatrix measMatrix, final RealMatrix measNoise)

Create a new MeasurementModel, taking RealMatrix objects as input parameters for the respective measurement matrix and noise.

Parameters
measMatrix:RealMatrix

the measurement matrix

measNoise:RealMatrix

the measurement noise matrix

Method Detail

getMeasurementMatrixback to summary
public RealMatrix getMeasurementMatrix()

Implements org.apache.commons.math3.filter.MeasurementModel.getMeasurementMatrix.

Doc from org.apache.commons.math3.filter.MeasurementModel.getMeasurementMatrix.

Returns the measurement matrix.

Returns:RealMatrix

the measurement matrix

getMeasurementNoiseback to summary
public RealMatrix getMeasurementNoise()

Implements org.apache.commons.math3.filter.MeasurementModel.getMeasurementNoise.

Doc from org.apache.commons.math3.filter.MeasurementModel.getMeasurementNoise.

Returns the measurement noise matrix. This method is called by the KalmanFilter every correction step, so implementations of this interface may return a modified measurement noise depending on the current iteration step.

Returns:RealMatrix

the measurement noise matrix