hep.aida.ref.fitter

Class FitFactory

java.lang.Object

hep.aida.ref.fitter.FitFactory

All Implemented Interfaces:

IFitFactory

public class FitFactory
extends java.lang.Object
implements IFitFactory

Constructor Summary

Constructors

Constructor and Description
FitFactory()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	availableFitEngines() Get the list the fit engines provided by the used implementation (e.g.
java.lang.String[]	availableFitMethods() Get the list the fit methods provided by the used implementation (e.g.
IFitData	createFitData()
IFitter	createFitter() Create a new IFitter.
IFitter	createFitter(java.lang.String fitterType) Create a new IFitter.
IFitter	createFitter(java.lang.String fitterType, java.lang.String engineType) Create a new IFitter.
IFitter	createFitter(java.lang.String fitterType, java.lang.String engineType, java.lang.String options) Create a new IFitter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FitFactory

public FitFactory()

Method Detail

createFitData

public IFitData createFitData()

Specified by:

createFitData in interface IFitFactory

createFitter

public IFitter createFitter()
                     throws java.lang.IllegalArgumentException

Description copied from interface: IFitFactory

Create a new IFitter. - "CHI2" or "Chi2" or "ChiSquared" for chi squared fitter (this is the default), - "ML" or "MaxLikelihood" for maximum likelihood fitter, - "LS" or "LeastSquares" for Last Squares fitter. specific implementation in use. The default is "" (the implementation specific default).

Specified by:

createFitter in interface IFitFactory

Returns:

The IFitter.

Throws:

java.lang.IllegalArgumentException

createFitter

public IFitter createFitter(java.lang.String fitterType)
                     throws java.lang.IllegalArgumentException

Description copied from interface: IFitFactory

Create a new IFitter.

Specified by:

createFitter in interface IFitFactory

Parameters:

fitterType - The type of fitter. The supported types are: - "CHI2" or "Chi2" or "ChiSquared" for chi squared fitter (this is the default), - "ML" or "MaxLikelihood" for maximum likelihood fitter, - "LS" or "LeastSquares" for Last Squares fitter. specific implementation in use. The default is "" (the implementation specific default).

Returns:

The IFitter.

Throws:

java.lang.IllegalArgumentException

createFitter

public IFitter createFitter(java.lang.String fitterType,
                            java.lang.String engineType)
                     throws java.lang.IllegalArgumentException

Description copied from interface: IFitFactory

Create a new IFitter.

Specified by:

createFitter in interface IFitFactory

Parameters:

fitterType - The type of fitter. The supported types are: - "CHI2" or "Chi2" or "ChiSquared" for chi squared fitter (this is the default), - "ML" or "MaxLikelihood" for maximum likelihood fitter, - "LS" or "LeastSquares" for Last Squares fitter.

engineType - The type of optimization engine used by the fitter. The available types depend on the specific implementation in use. The default is "" (the implementation specific default).

Returns:

The IFitter.

Throws:

java.lang.IllegalArgumentException

createFitter

public IFitter createFitter(java.lang.String fitterType,
                            java.lang.String engineType,
                            java.lang.String options)
                     throws java.lang.IllegalArgumentException

Description copied from interface: IFitFactory

Create a new IFitter.

Specified by:

createFitter in interface IFitFactory

Parameters:

fitterType - The type of fitter. The supported types are: - "CHI2" or "Chi2" or "ChiSquared" for chi squared fitter (this is the default), - "ML" or "MaxLikelihood" for maximum likelihood fitter, - "LS" or "LeastSquares" for Last Squares fitter.

engineType - The type of optimization engine used by the fitter. The available types depend on the specific implementation in use. The default is "" (the implementation specific default).

options - A string of options. The default is "".

Returns:

The IFitter.

Throws:

java.lang.IllegalArgumentException

availableFitMethods

public java.lang.String[] availableFitMethods()

Get the list the fit methods provided by the used implementation (e.g. "chi2", "unbinnedMaximumLikelihood" etc).

Specified by:

availableFitMethods in interface IFitFactory

Returns:

An array containing the list of the available fit methods.

availableFitEngines

public java.lang.String[] availableFitEngines()

Get the list the fit engines provided by the used implementation (e.g. "minuit", etc).

Specified by:

availableFitEngines in interface IFitFactory

Returns:

An array containing the list of the available fit engines.