Package com.xinapse.dynamic

Class DynamicResult

java.lang.Object
com.xinapse.dynamic.DynamicResult
Direct Known Subclasses:
AbstractDynamicContrastResult
public abstract class DynamicResult extends Object
An abstract result of a computation from a dynamic signal change.

  • Constructor Details

    • DynamicResult

      protected DynamicResult(DynamicModel model, float[] varValues, float RMSError, float[] fittedCurve)
      Used by sub-class constructors.
      Parameters:
      model - the DynamicModel used to calculate the result.
      varValues - the fitted variable values in the same order as is returned by the getVarNames() and getVarUnits() methods.
      RMSError - the root-mean-squared residuals between the model and the fit.
      fittedCurve - the values of the fitted model at the same points as the data.

  • Method Details

    • getVarNames

      public String[] getVarNames()
      Returns the fitted variable names.
      Returns:
      the fitted variable names.

    • getVarUnits

      public String[] getVarUnits()
      Returns the fitted variable units.
      Returns:
      the fitted variable units.

    • getFittedVarValues

      public float[] getFittedVarValues()
      Returns the values of the fit variables after they have been optimised in the model.
      Returns:
      the values of the fit variables at the point of best fit.

    • getFittedCurve

      public float[] getFittedCurve()
      Returns the values of the fitted model at the same points as the data.
      Returns:
      the values of the fitted model at the same points as the data, or null if the model does not fit a curve to the data.

    • getRMSError

      public float getRMSError()
      Returns the RMS difference between the fit and the data.
      Returns:
      the RMS difference between the fit and the data.

    • getResultTitle

      public abstract String getResultTitle()
      Returns a title suitable for heading up this DynamicResult.
      Returns:
      a title for this DynamicResult.