hep.aida
Interface IFitResult

public interface IFitResult

Represents the result of the fit. Holds internal copies of fit parameter settings (set in IFitter) and the fitted function (clone of original function). The value of the parameters of the fitted function are obtained from the fitting.

Author:

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

Method Summary

String[]	constraints()
double	covarianceMatrixElement(int i, int j) Covariance matrix.
double	covMatrixElement(int i, int j) Deprecated. use covarianceMatrixElement REMOVE AIDA-199
String	dataDescription()
int	degreesOfFreedom() Number of degrees of freedom.
String	engineName()
double[]	errors() Get the parabolic errors on the fitted parameters.
double[]	errorsMinus() Get the negative part of the asymmetric errors on the fitted parameters.
double[]	errorsPlus() Get the positive part of the asymmetric errors on the fitted parameters.
String	fitMethodName()
IFitParameterSettings	fitParameterSettings(String name)
int	fitStatus()
IFunction	fittedFunction()
double	fittedParameter(String name) Get the value of a fitted parameter by name.
String[]	fittedParameterNames() Get the names of the fitted parameters (including fixed and constrained ones).
double[]	fittedParameters() Get the array of the fitted parameter values (including fixed and constrained ones).
boolean	isValid()
int	ndf() Deprecated. use degreesOfFreedom() REMOVE AIDA-199
double	quality()

Method Detail

isValid

public boolean isValid()

fitStatus

public int fitStatus()

fittedFunction

public IFunction fittedFunction()

quality

public double quality()

ndf

public int ndf()

Deprecated. use degreesOfFreedom() REMOVE AIDA-199

Number of degrees of freedom.

degreesOfFreedom

public int degreesOfFreedom()

Number of degrees of freedom.

covMatrixElement

public double covMatrixElement(int i,
                               int j)

Deprecated. use covarianceMatrixElement REMOVE AIDA-199

Covariance matrix. PENDING: interface for matrix to be defined.

covarianceMatrixElement

public double covarianceMatrixElement(int i,
                                      int j)

Covariance matrix. PENDING: interface for matrix to be defined.

fitMethodName

public String fitMethodName()

engineName

public String engineName()

dataDescription

public String dataDescription()

constraints

public String[] constraints()

fitParameterSettings

public IFitParameterSettings fitParameterSettings(String name)

fittedParameters

public double[] fittedParameters()

Get the array of the fitted parameter values (including fixed and constrained ones).

Returns:

The array containing the fitted values.

fittedParameterNames

public String[] fittedParameterNames()

Get the names of the fitted parameters (including fixed and constrained ones).

Returns:

The array containing the names of the fitted parameters.

fittedParameter

public double fittedParameter(String name)

Get the value of a fitted parameter by name.

Returns:

The value.

errors

public double[] errors()

Get the parabolic errors on the fitted parameters. If a parameter was fixed or constrained the error is zero.

Returns:

The parabolic errors on the fitted parameters.

errorsPlus

public double[] errorsPlus()

Get the positive part of the asymmetric errors on the fitted parameters. If a parameter was fixed or constrained the error is zero.

Returns:

The positive part of the asymmetric errors on the fitted parameters.

errorsMinus

public double[] errorsMinus()

Get the negative part of the asymmetric errors on the fitted parameters. If a parameter was fixed or constrained the error is zero.

Returns:

The negative part of the asymmetric errors on the fitted parameters.