CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

               

---

AIDA::IFitResult Class Reference

#include <IFitResult.h>

List of all members.

Public Methods
virtual	~IFitResult ()
	Destructor. More...
virtual bool	isValid ()=0
	True if fit successful, otherwise false. More...
virtual int	fitStatus ()=0
	Status of the fit. PENDING: what are the suggested values? More...
virtual IFunction*	fittedFunction ()=0
	Fitted function. The parameters hold the results of the fit. More...
virtual double	quality ()=0
	Quality of the fit. Depending on the fit method this may be the value of Chi2 or Maximu Likelihood. More...
virtual int	ndf ()=0
	Number of degrees of freedom. More...
virtual double	covMatrixElement (int i, int j)=0
	Covariance matrix. PENDING: interface for matrix to be defined. More...
virtual std::string	fitMethodName ()=0
	Fit method name as set in the fitter. More...
virtual std::string	engineName ()=0
	Engine used to do fitting. More...
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. PENDING: the contents and format of this string to be defined. PENDING: XML? stor name and path? ranges of DataPipe? More...
virtual const std::vector< std::string>&	constraints ()=0
	Vector of constraints. More...
virtual IFitParameterSettings*	fitParameterSettings (std::string name)=0
	Access to applied parameter settings. More...
virtual const std::vector< double>&	fittedParameters () const=0
virtual const std::vector< std::string>&	fittedParameterNames () const=0
virtual double	fittedParameter (std::string &name)=0
virtual const std::vector< double>&	errors () const=0
virtual const std::vector< double>&	errorsPlus () const=0
virtual const std::vector< double>&	errorsMinus () const=0

---

Detailed Description

@interface

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

Definition at line 35 of file IFitResult.h.

---

Constructor & Destructor Documentation

AIDA::IFitResult::~IFitResult ( ) [inline, virtual]

Definition at line 39 of file IFitResult.h.

---

Member Function Documentation

const std::vector< std::string > & AIDA::IFitResult::constraints ( ) [pure virtual]

double AIDA::IFitResult::covMatrixElement ( int i, int j ) [pure virtual]

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

std::string AIDA::IFitResult::engineName ( ) [pure 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.

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.

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.

std::string AIDA::IFitResult::fitMethodName ( ) [pure virtual]

IFitParameterSettings * AIDA::IFitResult::fitParameterSettings ( std::string name ) [pure virtual]

int AIDA::IFitResult::fitStatus ( ) [pure virtual]

IFunction * AIDA::IFitResult::fittedFunction ( ) [pure virtual]

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

Get the value of a fitted parameter by name. Returns: The value.

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

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.

bool AIDA::IFitResult::isValid ( ) [pure virtual]

int AIDA::IFitResult::ndf ( ) [pure virtual]

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

---

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

• IFitResult.h

---