vec_math
Interface GradientModel

All Superinterfaces:

DataModel

All Known Implementing Classes:

AbstractGradientModel, HarmonicFit.HarmonicModel, LevenbergMarquardt.LMSineModel, LevenbergMarquardt.SinusModel, ModelDrift.PinholeDrift, ModelShift.PinholeModel, MultipleFrequencyFit.FourierComponents, OrbitModel, Overscan.WifsipOverscan

public interface GradientModel
extends DataModel

A data model, where the data model can be differentiated with respect to its model parameters. This adds a new method, #getParameterGradient.

Method Summary

Matrix

getGradientMatrix(VectorG parameters) Returns the gradient of the model for all measures.

Methods inherited from interface vec_math.DataModel

evaluateModel, getMeasureCount, getMeasurementErrors, getMeasures, getModel, getParameterCount, getResiduals, getTimes, getTotalErrors

Method Detail

getGradientMatrix

Matrix getGradientMatrix(VectorG parameters)

Returns the gradient of the model for all measures. The measure index is the row of the Matrix, the columns are the derivatives of the model with respect to the parameters. Thus, the Matrix.columns() equals DataModel.getParameterCount(), and Matrix.rows() equals DataModel.getMeasureCount().