hep.aida.ref.fitter
Class Fitter

java.lang.Object
  |
  +--hep.aida.ref.fitter.Fitter

All Implemented Interfaces:

hep.aida.IFitter

public class Fitter

extends Object

implements hep.aida.IFitter

Author:

The AIDA team @ SLAC.

Constructor Summary

Fitter(String fitMethodType, String engineType, String options)
Create a new Fitter specifying the underlying optimizing engine.

Method Summary

String[]	constraints()
hep.aida.IDataPointSet	createContour(hep.aida.IFitData d, hep.aida.IFitResult r, String par1, String par2, int npts, double nSigmas)
hep.aida.IDataPointSet	createScan1D(hep.aida.IFitData d, hep.aida.IFunction originalFunction, String parName, int npts, double pmin, double pmax)
String	engineName()
hep.aida.IFitResult	fit(hep.aida.IBaseHistogram h, hep.aida.IFunction f)
hep.aida.IFitResult	fit(hep.aida.IBaseHistogram h, String model)
hep.aida.IFitResult	fit(hep.aida.IBaseHistogram h, String model, double[] initialParameters)
hep.aida.IFitResult	fit(hep.aida.IDataPointSet dataPointSet, hep.aida.IFunction f)
hep.aida.IFitResult	fit(hep.aida.IDataPointSet dataPointSet, String model)
hep.aida.IFitResult	fit(hep.aida.IDataPointSet dataPointSet, String model, double[] initialParameters)
hep.aida.IFitResult	fit(hep.aida.IFitData d, hep.aida.IFunction originalFunction)
hep.aida.IFitResult	fit(hep.aida.IFitData d, String model)
hep.aida.IFitResult	fit(hep.aida.IFitData d, String model, double[] initialParameters)
String	fitMethodName()
hep.aida.IFitParameterSettings	fitParameterSettings(String name)
String[]	listParameterSettings()
static void	main(String[] args)
void	resetConstraints()
void	resetParameterSettings()
void	setConstraint(String expression)
void	setEngine(String engineType)
void	setFitMethod(String fitMethodType)
void	setUseFunctionGradient(boolean useGradient)
boolean	useFunctionGradient()

Methods inherited from class java.lang.Object

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

Constructor Detail

Fitter

public Fitter(String fitMethodType,
              String engineType,
              String options)
       throws IllegalArgumentException

Create a new Fitter specifying the underlying optimizing engine.

Parameters:

fitMethodType - The type of fitter.

engineType - The type of optimizer to use.

Throws:

IllegalArgumentException - if the engineType does not exist.

Method Detail

setEngine

public void setEngine(String engineType)
               throws IllegalArgumentException

Specified by:

setEngine in interface hep.aida.IFitter

IllegalArgumentException

engineName

public String engineName()

Specified by:

engineName in interface hep.aida.IFitter

setFitMethod

public void setFitMethod(String fitMethodType)
                  throws IllegalArgumentException

Specified by:

setFitMethod in interface hep.aida.IFitter

IllegalArgumentException

fitMethodName

public String fitMethodName()

Specified by:

fitMethodName in interface hep.aida.IFitter

fitParameterSettings

public hep.aida.IFitParameterSettings fitParameterSettings(String name)

Specified by:

fitParameterSettings in interface hep.aida.IFitter

listParameterSettings

public String[] listParameterSettings()

Specified by:

listParameterSettings in interface hep.aida.IFitter

resetParameterSettings

public void resetParameterSettings()

Specified by:

resetParameterSettings in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IFitData d,
                               hep.aida.IFunction originalFunction)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IBaseHistogram h,
                               hep.aida.IFunction f)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IBaseHistogram h,
                               String model)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IBaseHistogram h,
                               String model,
                               double[] initialParameters)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IDataPointSet dataPointSet,
                               hep.aida.IFunction f)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IDataPointSet dataPointSet,
                               String model)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IDataPointSet dataPointSet,
                               String model,
                               double[] initialParameters)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IFitData d,
                               String model,
                               double[] initialParameters)

Specified by:

fit in interface hep.aida.IFitter

fit

public hep.aida.IFitResult fit(hep.aida.IFitData d,
                               String model)

Specified by:

fit in interface hep.aida.IFitter

setConstraint

public void setConstraint(String expression)
                   throws IllegalArgumentException

Specified by:

setConstraint in interface hep.aida.IFitter

IllegalArgumentException

constraints

public String[] constraints()

Specified by:

constraints in interface hep.aida.IFitter

resetConstraints

public void resetConstraints()

Specified by:

resetConstraints in interface hep.aida.IFitter

createScan1D

public hep.aida.IDataPointSet createScan1D(hep.aida.IFitData d,
                                           hep.aida.IFunction originalFunction,
                                           String parName,
                                           int npts,
                                           double pmin,
                                           double pmax)

Specified by:

createScan1D in interface hep.aida.IFitter

createContour

public hep.aida.IDataPointSet createContour(hep.aida.IFitData d,
                                            hep.aida.IFitResult r,
                                            String par1,
                                            String par2,
                                            int npts,
                                            double nSigmas)

Specified by:

createContour in interface hep.aida.IFitter

useFunctionGradient

public boolean useFunctionGradient()

Specified by:

useFunctionGradient in interface hep.aida.IFitter

setUseFunctionGradient

public void setUseFunctionGradient(boolean useGradient)

Specified by:

setUseFunctionGradient in interface hep.aida.IFitter

main

public static void main(String[] args)
                 throws IOException

IOException