hep.aida.ext

Interface IFitMethod

All Known Implementing Classes:

AbstractFitMethod, BinnedMaximumLikelihoodFitMethod, ChiSquaredFitMethod, CleverChiSquaredFitMethod, LeastSquaresFitMethod, UnbinnedMaximumLikelihoodFitMethod

public interface IFitMethod

Field Summary

Fields

Modifier and Type	Field and Description
static int	BINNED_FIT
static int	UNBINNED_FIT

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the fitMethod.
java.lang.Object	correlationObject() Get the correlation object.
double	evaluate(IDevFitDataIterator dataIter, IFunction function) Evaluate the Objective Function for a given data iterator and a given function.
double[]	evaluateGradient(int dimension, IDevFitDataIterator dataIter, IFunction function) Evaluate the gradient of the Objective Function.
double[]	evaluateGradientSumElement(IDevFitDataIterator dataIter, IFunction function) Evaluate the the sum contribution to the Objective Function gradient.
double	evaluateSumElement(IDevFitDataIterator dataIter, IFunction function) Evaluate the the sum contribution to the Objective Function value.
java.lang.String[]	fitMethodNames() Get the names for this fit method.
int	fitType() Return the fit type: BINNED_FIT if it is a binned fit, UNBINNED_FIT if unbinned.
void	setCorrelationObject(java.lang.Object correlationObj) Set the correlation object among the data.

Field Detail

BINNED_FIT

static final int BINNED_FIT

See Also:

Constant Field Values

UNBINNED_FIT

static final int UNBINNED_FIT

See Also:

Constant Field Values

Method Detail

fitType

int fitType()

Return the fit type: BINNED_FIT if it is a binned fit, UNBINNED_FIT if unbinned.

evaluate

double evaluate(IDevFitDataIterator dataIter,
                IFunction function)

Evaluate the Objective Function for a given data iterator and a given function.

evaluateSumElement

double evaluateSumElement(IDevFitDataIterator dataIter,
                          IFunction function)

Evaluate the the sum contribution to the Objective Function value.

evaluateGradient

double[] evaluateGradient(int dimension,
                          IDevFitDataIterator dataIter,
                          IFunction function)

Evaluate the gradient of the Objective Function.

evaluateGradientSumElement

double[] evaluateGradientSumElement(IDevFitDataIterator dataIter,
                                    IFunction function)

Evaluate the the sum contribution to the Objective Function gradient.

fitMethodNames

java.lang.String[] fitMethodNames()

Get the names for this fit method. The first one in the array is the default. The array cannot be null. It must have at least one name.

clear

void clear()

Clear the fitMethod. This method is invoked before the function is evaluated.

setCorrelationObject

void setCorrelationObject(java.lang.Object correlationObj)

Set the correlation object among the data.

correlationObject

java.lang.Object correlationObject()

Get the correlation object.