hep.fitting
Class Fittable1DFunction

java.lang.Object
  |
  +--java.util.Observable
        |
        +--hep.fitting.Basic1DFunction
              |
              +--hep.fitting.Fittable1DFunction

Direct Known Subclasses:

hep.fitting.function.AbstractPolynomialFunction, ExponentialFunction, FitAdapter1D, GaussianFunction, LorentzianFunction, PolinomialModel, StraightLineFunction

public abstract class Fittable1DFunction

extends Basic1DFunction

Constructor Summary

Fittable1DFunction()

Method Summary

void	clearFit()
void	clearFitParams()
double[]	getDerivatives(double x, double[] a) Calculates the partial derivative of the function with respect to each parameter at point x.
Fitter	getFit()
boolean[]	getIncludeParametersInFit()
protected void	initIncludeParametersInFit(int nParameters)
protected void	setFit(Fitter fit)
abstract void	setFit(Fitter fit, double[] param)
void	setIncludeParameterInFit(int index, boolean value)
abstract void	setParameter(int i, double d)
abstract double	valueAt(double x, double[] param)

Methods inherited from class hep.fitting.Basic1DFunction

getParameterNames, getParameterValues, getTitle, setBatch, setChanged, setChanged, valueAt

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Fittable1DFunction

public Fittable1DFunction()

Method Detail

valueAt

public abstract double valueAt(double x,
                               double[] param)
                        throws FunctionValueUndefined

FunctionValueUndefined

setFit

public abstract void setFit(Fitter fit,
                            double[] param)
                     throws InvalidFunctionParameter

InvalidFunctionParameter

setParameter

public abstract void setParameter(int i,
                                  double d)
                           throws InvalidFunctionParameter

Specified by:

setParameter in class Basic1DFunction

InvalidFunctionParameter

getIncludeParametersInFit

public boolean[] getIncludeParametersInFit()

clearFitParams

public void clearFitParams()

setIncludeParameterInFit

public void setIncludeParameterInFit(int index,
                                     boolean value)

initIncludeParametersInFit

protected void initIncludeParametersInFit(int nParameters)

getDerivatives

public double[] getDerivatives(double x,
                               double[] a)
                        throws FunctionValueUndefined

Calculates the partial derivative of the function with respect to each parameter at point x. This is a non-analytical calculation which can be overriden by subclasses which wish to provide an analytical calculation

Throws:

FunctionValueUndefined - if the function is not defined for x

getFit

public Fitter getFit()

setFit

protected void setFit(Fitter fit)

clearFit

public void clearFit()