Class DefaultMeasurementModel
- java.lang.Object
-
- org.apache.commons.math4.legacy.filter.DefaultMeasurementModel
-
- All Implemented Interfaces:
MeasurementModel
public class DefaultMeasurementModel extends Object implements MeasurementModel
Default implementation of aMeasurementModelfor the use with aKalmanFilter.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description DefaultMeasurementModel(double[][] measMatrix, double[][] measNoise)Create a newMeasurementModel, taking double arrays as input parameters for the respective measurement matrix and noise.DefaultMeasurementModel(RealMatrix measMatrix, RealMatrix measNoise)Create a newMeasurementModel, takingRealMatrixobjects as input parameters for the respective measurement matrix and noise.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RealMatrixgetMeasurementMatrix()Returns the measurement matrix.RealMatrixgetMeasurementNoise()Returns the measurement noise matrix.
-
-
-
Constructor Detail
-
DefaultMeasurementModel
public DefaultMeasurementModel(double[][] measMatrix, double[][] measNoise) throws NullArgumentException, NoDataException, DimensionMismatchException
Create a newMeasurementModel, taking double arrays as input parameters for the respective measurement matrix and noise.- Parameters:
measMatrix- the measurement matrixmeasNoise- the measurement noise matrix- Throws:
NullArgumentException- if any of the input matrices isnullNoDataException- if any row / column dimension of the input matrices is zeroDimensionMismatchException- if any of the input matrices is non-rectangular
-
DefaultMeasurementModel
public DefaultMeasurementModel(RealMatrix measMatrix, RealMatrix measNoise)
Create a newMeasurementModel, takingRealMatrixobjects as input parameters for the respective measurement matrix and noise.- Parameters:
measMatrix- the measurement matrixmeasNoise- the measurement noise matrix
-
-
Method Detail
-
getMeasurementMatrix
public RealMatrix getMeasurementMatrix()
Returns the measurement matrix.- Specified by:
getMeasurementMatrixin interfaceMeasurementModel- Returns:
- the measurement matrix
-
getMeasurementNoise
public RealMatrix getMeasurementNoise()
Returns the measurement noise matrix. This method is called by theKalmanFilterevery correction step, so implementations of this interface may return a modified measurement noise depending on the current iteration step.- Specified by:
getMeasurementNoisein interfaceMeasurementModel- Returns:
- the measurement noise matrix
- See Also:
KalmanFilter.correct(double[]),KalmanFilter.correct(org.apache.commons.math4.legacy.linear.RealVector)
-
-