Package org.aavso.tools.vstar.util.model

Interface IModel

All Superinterfaces:
IAlgorithm, IInteruptible
All Known Subinterfaces:
IPolynomialFitter
All Known Implementing Classes:
AbstractModel, PeriodAnalysisDerivedMultiPeriodicModel, TSPolynomialFitter, WWZMultiperiodicModel
public interface IModel extends IAlgorithm
All model classes must implement this interface, e.g. polynomial fits, Fourier coefficient based models.

  • Method Details

    • getFit

      List<ValidObservation> getFit()
      Return the fitted observations, after having executed the algorithm.
      Returns:
      A list of observations that represent the fit.

    • getResiduals

      List<ValidObservation> getResiduals()
      Return the residuals as observations, after having executed the algorithm.
      Returns:
      A list of observations that represent the residuals.

    • getParameters

      List<PeriodFitParameters> getParameters()
      Return the list of coefficients that gives rise to the model. May return null.
      Returns:
      A list of fit coefficients or null if none available.

    • hasFuncDesc

      boolean hasFuncDesc()
      Does this model have a function-based description?
      Returns:
      True or false.

    • getDescription

      String getDescription()
      Return a human-readable description of this model.
      Returns:
      The model description.

    • getKind

      String getKind()
      Return a human-readable 'kind' string (e.g. "Model", "Polynomial Fit") indicating what kind of a model this is.
      Returns:
      The 'kind' string.

    • getFunctionStrings

      Map<String,String> getFunctionStrings()
      Return a mapping from names to strings representing model functions.
      Returns:
      The model function string map.

    • getModelFunction

      ContinuousModelFunction getModelFunction()
      Returns the model function and context. This is required for creating a line plot to show the model as a continuous function. If a model creator cannot sensibly return such a function, it may return null and no such plot will be possible. It could also be useful for analysis purposes, e.g. analytic extrema finding.
      Returns:
      The function object.