hep.aida
Interface IFitFunction

public interface IFitFunction

extends IFunction

A fittable function.

Version:

$Id: IFitFunction.html,v 1.1 2002/10/08 00:51:17 tonyj Exp $

Author:

Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson, Andreas Pfeiffer, Mark Donszelmann, Guy Barrand

Source Code:

IFitFunction.java

Method Summary

double	chiSquare()
void	clearBounds(String name)
double	degreeOfFreedom()
double	error(String name)
double[]	errors()
boolean	fit(IHistogram histogram)
double[]	getGradient(double[] one, double[] orTwo) FIXME: We need a Fitter expert here!
boolean	hasGradient()
void	setBounds(String name, double lower, double upper) - NOTE you may pass Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY
void	setChiSquare(double chiSquare)
boolean	setDegreeOfFreedom(double degreeOfFreedom)
void	setErrors(double[] errors)
void	setFixed(String name, boolean state)
void	setStepSize(String name, double step)

Methods inherited from interface hep.aida.IFunction

dimension, label, parameterNames, parameterValues, setParameterValue, value

Method Detail

setFixed

public void setFixed(String name,
                     boolean state)

setBounds

public void setBounds(String name,
                      double lower,
                      double upper)

- NOTE you may pass Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY

clearBounds

public void clearBounds(String name)

setStepSize

public void setStepSize(String name,
                        double step)

error

public double error(String name)

errors

public double[] errors()

chiSquare

public double chiSquare()

degreeOfFreedom

public double degreeOfFreedom()

setErrors

public void setErrors(double[] errors)

setChiSquare

public void setChiSquare(double chiSquare)

setDegreeOfFreedom

public boolean setDegreeOfFreedom(double degreeOfFreedom)

hasGradient

public boolean hasGradient()

getGradient

public double[] getGradient(double[] one,
                            double[] orTwo)

FIXME: We need a Fitter expert here!

fit

public boolean fit(IHistogram histogram)

Parameters:

histogram - The histogram to fit to the function.

Returns:

Whether the fit converged or not.