Class EnKFParameterEstimator.EnKFResult

java.lang.Object

neqsim.process.calibration.EnKFParameterEstimator.EnKFResult

All Implemented Interfaces:

Serializable

Enclosing class:

EnKFParameterEstimator

public static class EnKFParameterEstimator.EnKFResult
extends Object
implements Serializable

Result of an EnKF update step.

Version:

1.0

Author:

NeqSim Development Team

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	anomalyDetected
private final double[]	estimates
private final double[]	measurements
private final double[]	predictions
private final double	rmse
private static final long	serialVersionUID
private final int	step
private final double[]	uncertainties

Constructor Summary

Constructors

Constructor	Description
EnKFResult(int step, double[] estimates, double[] uncertainties, double[] measurements, double[] predictions, boolean anomalyDetected)	Constructor.

Method Summary

Modifier and Type	Method	Description
double[]	getConfidenceIntervalLower()	Gets 95% confidence interval lower bounds.
double[]	getConfidenceIntervalUpper()	Gets 95% confidence interval upper bounds.
double[]	getEstimates()	Gets parameter estimates.
double[]	getMeasurements()	Gets the measurements used in this update.
double[]	getPredictions()	Gets the model predictions.
double	getRMSE()	Gets the RMSE of predictions vs measurements.
int	getStep()	Gets the update step number.
double[]	getUncertainties()	Gets parameter uncertainties (standard deviations).
boolean	isAnomalyDetected()	Returns true if anomaly was detected.
CalibrationResult	toCalibrationResult(String[] parameterNames)	Converts to a CalibrationResult for compatibility with existing API.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

step

private final int step

estimates

private final double[] estimates

uncertainties

private final double[] uncertainties

measurements

private final double[] measurements

predictions

private final double[] predictions

rmse

private final double rmse

anomalyDetected

private final boolean anomalyDetected

Constructor Details

EnKFResult

public EnKFResult(int step,
 double[] estimates,
 double[] uncertainties,
 double[] measurements,
 double[] predictions,
 boolean anomalyDetected)

Constructor.

Parameters:

step - update step number

estimates - parameter estimates

uncertainties - parameter uncertainties (std dev)

measurements - observed measurements

predictions - model predictions

anomalyDetected - whether anomaly was detected

Method Details

getStep

public int getStep()

Gets the update step number.

Returns:

the step number

getEstimates

public double[] getEstimates()

Gets parameter estimates.

Returns:

array of parameter estimates

getUncertainties

public double[] getUncertainties()

Gets parameter uncertainties (standard deviations).

Returns:

array of parameter standard deviations

getConfidenceIntervalLower

public double[] getConfidenceIntervalLower()

Gets 95% confidence interval lower bounds.

Returns:

array of lower confidence bounds

getConfidenceIntervalUpper

public double[] getConfidenceIntervalUpper()

Gets 95% confidence interval upper bounds.

Returns:

array of upper confidence bounds

getMeasurements

public double[] getMeasurements()

Gets the measurements used in this update.

Returns:

array of measurement values

getPredictions

public double[] getPredictions()

Gets the model predictions.

Returns:

array of model predictions

getRMSE

public double getRMSE()

Gets the RMSE of predictions vs measurements.

Returns:

the root mean square error

isAnomalyDetected

public boolean isAnomalyDetected()

Returns true if anomaly was detected.

Returns:

true if anomaly was detected

toCalibrationResult

public CalibrationResult toCalibrationResult(String[] parameterNames)

Converts to a CalibrationResult for compatibility with existing API.

Parameters:

parameterNames - names for the parameters

Returns:

CalibrationResult