hep.aida.ext
Interface IFitMethod

All Known Implementing Classes:

AbstractFitMethod

public interface IFitMethod

Author:

The AIDA team @ SLAC. Interface to be implemented by all classes providing the value of the Objective Function to be optimized in the process of fitting.

Source Code:

IFitMethod.java

Field Summary

static int	BINNED_FIT
static int	UNBINNED_FIT

Method Summary

void	clear() Clear the fitMethod.
Object	correlationObject() Get the correlation object.
double	evaluate(hep.aida.dev.IDevFitDataIterator dataIter, hep.aida.IFunction function) Evaluate the Objective Function for a given data iterator and a given function.
double[]	evaluateGradient(int dimension, hep.aida.dev.IDevFitDataIterator dataIter, hep.aida.IFunction function) Evaluate the gradient of the Objective Function.
double[]	evaluateGradientSumElement(hep.aida.dev.IDevFitDataIterator dataIter, hep.aida.IFunction function) Evaluate the the sum contribution to the Objective Function gradient.
double	evaluateSumElement(hep.aida.dev.IDevFitDataIterator dataIter, hep.aida.IFunction function) Evaluate the the sum contribution to the Objective Function value.
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(Object correlationObj) Set the correlation object among the data.

Field Detail

BINNED_FIT

public static final int BINNED_FIT

See Also:

Constant Field Values

UNBINNED_FIT

public static final int UNBINNED_FIT

See Also:

Constant Field Values

Method Detail

fitType

public int fitType()

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

evaluate

public double evaluate(hep.aida.dev.IDevFitDataIterator dataIter,
                       hep.aida.IFunction function)

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

evaluateSumElement

public double evaluateSumElement(hep.aida.dev.IDevFitDataIterator dataIter,
                                 hep.aida.IFunction function)

Evaluate the the sum contribution to the Objective Function value.

evaluateGradient

public double[] evaluateGradient(int dimension,
                                 hep.aida.dev.IDevFitDataIterator dataIter,
                                 hep.aida.IFunction function)

Evaluate the gradient of the Objective Function.

evaluateGradientSumElement

public double[] evaluateGradientSumElement(hep.aida.dev.IDevFitDataIterator dataIter,
                                           hep.aida.IFunction function)

Evaluate the the sum contribution to the Objective Function gradient.

fitMethodNames

public 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

public void clear()

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

setCorrelationObject

public void setCorrelationObject(Object correlationObj)

Set the correlation object among the data.

correlationObject

public Object correlationObject()

Get the correlation object.