Class CalibrationQuality

java.lang.Object
neqsim.process.calibration.CalibrationQuality
All Implemented Interfaces:
Serializable
public class CalibrationQuality extends Object implements Serializable
Represents calibration quality metrics for model validation.

Provides statistical measures to assess how well the calibrated model fits the measured data.

Version:
1.0
Author:
ESOL
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final double
    coverage
     
    private final double
    mae
     
    private final double
    mse
     
    private final double
    r2
     
    private final double
    rmse
     
    private final int
    sampleCount
     
    private static final long
    serialVersionUID
     
    private final Instant
    timestamp
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CalibrationQuality(Instant timestamp, double rmse, double mse, double mae, double r2, int sampleCount, double coverage)
    Constructor for CalibrationQuality.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getCoverage()
    Gets the operating range coverage percentage.
    double
    getMae()
    Gets the mean absolute error.
    double
    getMse()
    Gets the mean square error.
    double
    getOverallScore()
    Calculates an overall quality score (0-100).
    double
    getR2()
    Gets the coefficient of determination (R-squared).
    String
    getRating()
    Gets a qualitative rating of calibration quality.
    double
    getRmse()
    Gets the root mean square error.
    int
    getSampleCount()
    Gets the number of samples used in calibration.
    Instant
    getTimestamp()
    Gets the timestamp of quality assessment.
    boolean
    isAcceptable(double r2Threshold, double rmseThreshold)
    Determines if calibration quality is acceptable.
    String
    toString()
     

    Methods inherited from class Object

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

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • timestamp

      private final Instant timestamp

    • rmse

      private final double rmse

    • mse

      private final double mse

    • mae

      private final double mae

    • r2

      private final double r2

    • sampleCount

      private final int sampleCount

    • coverage

      private final double coverage

  • Constructor Details

    • CalibrationQuality

      public CalibrationQuality(Instant timestamp, double rmse, double mse, double mae, double r2, int sampleCount, double coverage)
      Constructor for CalibrationQuality.
      Parameters:
      timestamp - the time of quality assessment
      rmse - root mean square error
      mse - mean square error
      mae - mean absolute error
      r2 - coefficient of determination
      sampleCount - number of samples used
      coverage - percentage of operating range covered

  • Method Details

    • getTimestamp

      public Instant getTimestamp()
      Gets the timestamp of quality assessment.
      Returns:
      timestamp

    • getRmse

      public double getRmse()
      Gets the root mean square error.
      Returns:
      RMSE value

    • getMse

      public double getMse()
      Gets the mean square error.
      Returns:
      MSE value

    • getMae

      public double getMae()
      Gets the mean absolute error.
      Returns:
      MAE value

    • getR2

      public double getR2()
      Gets the coefficient of determination (R-squared).
      Returns:
      R2 value (0 to 1, higher is better)

    • getSampleCount

      public int getSampleCount()
      Gets the number of samples used in calibration.
      Returns:
      sample count

    • getCoverage

      public double getCoverage()
      Gets the operating range coverage percentage.
      Returns:
      coverage (0 to 100)

    • getOverallScore

      public double getOverallScore()
      Calculates an overall quality score (0-100).

      Score combines R2 (higher is better) and coverage metrics.

      Returns:
      overall score from 0 (poor) to 100 (excellent)

    • getRating

      public String getRating()
      Gets a qualitative rating of calibration quality.
      Returns:
      rating string: "Excellent", "Good", "Fair", or "Poor"

    • isAcceptable

      public boolean isAcceptable(double r2Threshold, double rmseThreshold)
      Determines if calibration quality is acceptable.
      Parameters:
      r2Threshold - minimum acceptable R2 value
      rmseThreshold - maximum acceptable RMSE
      Returns:
      true if quality meets thresholds

    • toString

      public String toString()
      Overrides:
      toString in class Object