hep.aida
Interface IFitFactory

public interface IFitFactory

Factory for fitter and fit data objects.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

String[]	availableFitEngines() Get the list the fit engines provided by the used implementation (e.g.
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(String fitterType) Create a new IFitter.
IFitter	createFitter(String fitterType, String engineType) Create a new IFitter.
IFitter	createFitter(String fitterType, String engineType, String options) Create a new IFitter.

Method Detail

createFitData

public IFitData createFitData()

createFitter

public IFitter createFitter()
                     throws IllegalArgumentException

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).

Returns:

The IFitter.

Throws:

An - IllegalArgumentException an argument is incorrect.

IllegalArgumentException

createFitter

public IFitter createFitter(String fitterType)
                     throws IllegalArgumentException

Create a new IFitter.

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:

An - IllegalArgumentException an argument is incorrect.

IllegalArgumentException

createFitter

public IFitter createFitter(String fitterType,
                            String engineType)
                     throws IllegalArgumentException

Create a new IFitter.

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:

An - IllegalArgumentException an argument is incorrect.

IllegalArgumentException

createFitter

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

Create a new IFitter.

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:

An - IllegalArgumentException an argument is incorrect.

IllegalArgumentException

availableFitMethods

public String[] availableFitMethods()

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

Returns:

An array containing the list of the available fit methods.

availableFitEngines

public String[] availableFitEngines()

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

Returns:

An array containing the list of the available fit engines.