RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::IFitResult Class Referenceabstract
Inheritance diagram for AIDA::IFitResult:
AIDA::IFitResultROOT

Public Member Functions

virtual ~IFitResult ()
 Destructor.
 
virtual bool isValid ()=0
 True if fit successful, otherwise false.
 
virtual int fitStatus ()=0
 Status of the fit. PENDING: what are the suggested values?
 
virtual IFunctionfittedFunction ()=0
 Fitted function. The parameters hold the results of the fit.
 
virtual double quality ()=0
 Quality of the fit. More...
 
virtual int ndf ()=0
 Number of degrees of freedom.
 
virtual double covMatrixElement (int i, int j)=0
 Covariance matrix. PENDING: interface for matrix to be defined.
 
virtual std::string fitMethodName ()=0
 Fit method name as set in the fitter.
 
virtual std::string engineName ()=0
 Engine used to do fitting.
 
virtual std::string dataDescription ()=0
 Textual description of data - this is a hint for the user how to find the data in the tree if he wanted to repeat the fit later and lost the pointer to his orignal data object. More...
 
virtual std::vector< std::string > constraints ()=0
 Vector of constraints.
 
virtual IFitParameterSettingsfitParameterSettings (const std::string &name)=0
 Access to applied parameter settings.
 
virtual const std::vector
< double > & 
fittedParameters () const =0
 Get the array of the fitted parameter values (including fixed and constrained ones). More...
 
virtual std::vector< std::string > fittedParameterNames () const =0
 Get the names of the fitted parameters (including fixed and constrained ones). More...
 
virtual double fittedParameter (const std::string &name)=0
 Get the value of a fitted parameter by name. More...
 
virtual const std::vector
< double > & 
errors () const =0
 Get the parabolic errors on the fitted parameters. More...
 
virtual const std::vector
< double > & 
errorsPlus () const =0
 Get the positive part of the asymmetric errors on the fitted parameters. More...
 
virtual const std::vector
< double > & 
errorsMinus () const =0
 Get the negative part of the asymmetric errors on the fitted parameters. More...
 

Member Function Documentation

virtual std::string AIDA::IFitResult::dataDescription ( )
pure virtual

Textual description of data - this is a hint for the user how to find the data in the tree if he wanted to repeat the fit later and lost the pointer to his orignal data object.

PENDING: the contents and format of this string to be defined. PENDING: XML? stor name and path? ranges of DataPipe?

Implemented in AIDA::IFitResultROOT.

virtual const std::vector<double>& AIDA::IFitResult::errors ( ) const
pure virtual

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.

Implemented in AIDA::IFitResultROOT.

virtual const std::vector<double>& AIDA::IFitResult::errorsMinus ( ) const
pure virtual

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.

Implemented in AIDA::IFitResultROOT.

virtual const std::vector<double>& AIDA::IFitResult::errorsPlus ( ) const
pure virtual

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.

Implemented in AIDA::IFitResultROOT.

virtual double AIDA::IFitResult::fittedParameter ( const std::string &  name)
pure virtual

Get the value of a fitted parameter by name.

Returns
The value.

Implemented in AIDA::IFitResultROOT.

virtual std::vector<std::string> AIDA::IFitResult::fittedParameterNames ( ) const
pure virtual

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

Returns
The array containing the names of the fitted parameters.

Implemented in AIDA::IFitResultROOT.

virtual const std::vector<double>& AIDA::IFitResult::fittedParameters ( ) const
pure virtual

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

Returns
The array containing the fitted values.

Implemented in AIDA::IFitResultROOT.

virtual double AIDA::IFitResult::quality ( )
pure virtual

Quality of the fit.

Depending on the fit method this may be the value of Chi2 or Maximu Likelihood.

Implemented in AIDA::IFitResultROOT.


The documentation for this class was generated from the following file: