Extends the ROOT::Fit::Result class with a TNamed inheritance providing easy possibility for I/O.

Definition at line 34 of file TFitResult.h.

Public Member Functions
	TFitResult (const char name, const char title)

	TFitResult (const ROOT::Fit::FitResult &f)
	Constructor from a ROOT::Fit::FitResult copy the contained TF1 pointer function if it is.

	TFitResult (int status=0)

	~TFitResult () override

bool	Contour (unsigned int ipar, unsigned int jpar, TGraph *gr, double confLevel=0.683)
	Create a 2D contour around the minimum for the parameter ipar and jpar if a minimum does not exist or is invalid it will return false on exit a TGraph is filled with the contour points the number of contour points is determined by the size of the TGraph.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

double	Error (unsigned int i) const

TMatrixDSym	GetCorrelationMatrix () const
	Return the correlation matrix from fit.

TMatrixDSym	GetCovarianceMatrix () const
	Return the covariance matrix from fit.

TClass *	IsA () const override

void	Print (Option_t *option="") const override
	Print result of the fit, by default chi2, parameter values and errors.

bool	Scan (unsigned int ipar, TGraph *gr, double xmin=0, double xmax=0)
	Scan parameter ipar between value of xmin and xmax A graph must be given which will be on return filled with the scan resul If the graph size is zero, a default size n = 40 will be used.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from ROOT::Fit::FitResult
	FitResult ()
	Default constructor for an empty (non valid) fit result.

	FitResult (const FitConfig &fconfig)
	Constructor from a fit-config for a dummy fit (e.g.

virtual	~FitResult ()
	Destructor.

double	Chi2 () const
	Return the Chi2 value after fitting In case of unbinned fits (or not defined one, see the documentation of Fitter::FitFCN) return -1 In case of binned likelihood fits (Poisson Likelihood) return the 2 * negative log-likelihood ratio using the definition of Baker-Cousins.

bool	Contour (unsigned int ipar, unsigned int jpar, unsigned int &npoints, double pntsx, double pntsy, double confLevel=0.683)
	create contour of two parameters around the minimum pass as option confidence level: default is a value of 0.683

double	Correlation (unsigned int i, unsigned int j) const
	retrieve correlation elements

double	CovMatrix (unsigned int i, unsigned int j) const
	retrieve covariance matrix element

int	CovMatrixStatus () const
	covariance matrix status code using Minuit convention : =0 not calculated, =1 approximated, =2 made pos def , =3 accurate

double	Edm () const
	Expected distance from minimum.

double	Error (unsigned int i) const
	parameter error by index

const std::vector< double > &	Errors () const
	parameter errors (return st::vector)

void	FillResult (const std::shared_ptr< ROOT::Math::Minimizer > &min, const FitConfig &fconfig, const std::shared_ptr< IModelFunction > &f, bool isValid, unsigned int sizeOfData=0, int fitType=1, const ROOT::Math::IMultiGenFunction *chi2func=nullptr, unsigned int ncalls=0)
	Fill the fit result from a Minimizer instance after fitting Run also Minos if requested from the configuration.

const BinData *	FittedBinData () const
	return BinData used in the fit (return a nullptr in case a different fit is done or the data are not available Pointer is managed internally, it must not be deleted

const IModelFunction *	FittedFunction () const
	fitting quantities

void	GetConfidenceIntervals (const BinData &data, double *ci, double cl=0.95, bool norm=false) const
	evaluate confidence interval for the point specified in the passed data sets the confidence interval are returned in the array ci cl is the desired confidence interval value.

std::vector< double >	GetConfidenceIntervals (double cl=0.95, bool norm=false) const
	evaluate confidence interval for the data set used in the last fit the confidence interval are returned as a vector of data points

void	GetConfidenceIntervals (unsigned int n, unsigned int stride1, unsigned int stride2, const double x, double ci, double cl=0.95, bool norm=false) const
	get confidence intervals for an array of n points x.

template<class Matrix >
void	GetCorrelationMatrix (Matrix &mat) const
	fill a correlation matrix elements using a generic symmetric matrix class implementing operator(i,j) the matrix must be previously allocates with right size (npar * npar)

template<class Matrix >
void	GetCovarianceMatrix (Matrix &mat) const
	fill covariance matrix elements using a generic matrix class implementing operator(i,j) the matrix must be previously allocates with right size (npar * npar)

const double *	GetErrors () const
	parameter errors (return const pointer)

std::string	GetParameterName (unsigned int ipar) const
	get name of parameter (deprecated)

const double *	GetParams () const
	parameter values (return const pointer)

double	GlobalCC (unsigned int i) const
	parameter global correlation coefficient

bool	HasMinosError (unsigned int i) const
	query if parameter i has the Minos error

int	Index (const std::string &name) const
	get index for parameter name (return -1 if not found)

bool	IsEmpty () const
	True if a fit result does not exist (even invalid) with parameter values.

bool	IsParameterBound (unsigned int ipar) const
	query if a parameter is bound

bool	IsParameterFixed (unsigned int ipar) const
	query if a parameter is fixed

bool	IsValid () const
	True if fit successful, otherwise false.

double	LowerError (unsigned int i) const
	lower Minos error. If Minos has not run for parameter i return the parabolic error

double	MinFcnValue () const
	Return value of the objective function (chi2 or likelihood) used in the fit.

const std::string &	MinimizerType () const
	minimization quantities

unsigned int	NCalls () const
	Number of function calls to find minimum.

unsigned int	Ndf () const
	Number of degree of freedom.

unsigned int	NFreeParameters () const
	get total number of free parameters

bool	NormalizedErrors () const
	flag to check if errors are normalized

void	NormalizeErrors ()
	normalize errors using chi2/ndf for chi2 fits

unsigned int	NPar () const
	total number of parameters (abbreviation)

unsigned int	NTotalParameters () const
	get total number of parameters

double	Parameter (unsigned int i) const
	parameter value by index

bool	ParameterBounds (unsigned int ipar, double &lower, double &upper) const
	retrieve parameter bounds - return false if parameter is not bound

const std::vector< double > &	Parameters () const
	parameter values (return std::vector)

double	ParError (unsigned int i) const
	parameter error by index

std::string	ParName (unsigned int i) const
	name of the parameter

void	Print (std::ostream &os, bool covmat=false) const
	print the result and optionally covariance matrix and correlations

void	PrintCovMatrix (std::ostream &os) const
	print error matrix and correlations

double	Prob () const
	p value of the fit (chi2 probability)

bool	Scan (unsigned int ipar, unsigned int &npoints, double pntsx, double pntsy, double xmin=0, double xmax=0)
	scan likelihood value of parameter and fill the given graph.

void	SetChi2AndNdf (double chi2, unsigned int npoints)
	Set the chi2 and the ndf This function should be called when using an external FCN for fitting and one provides the chi2 and the number of fitting data points) to store and have them printed in the FitResult class.

void	SetMinosError (unsigned int i, double elow, double eup)
	set the Minos errors for parameter i (called by the Fitter class when running Minos)

int	Status () const
	minimizer status code

bool	Update (const std::shared_ptr< ROOT::Math::Minimizer > &min, const ROOT::Fit::FitConfig &fconfig, bool isValid, unsigned int ncalls=0)
	Update the fit result with a new minimization status To be run only if same fit is performed with same configuration Note that in this case MINOS is not re-run.

double	UpperError (unsigned int i) const
	upper Minos error. If Minos has not run for parameter i return the parabolic error

double	Value (unsigned int i) const
	parameter value by index

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Types inherited from ROOT::Fit::FitResult
typedef ROOT::Math::IParamMultiFunction	IModelFunction

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Member Functions inherited from ROOT::Fit::FitResult
std::shared_ptr< IModelFunction >	ModelFunction ()
	Return pointer non const pointer to model (fit) function with fitted parameter values.

void	SetModelFunction (const std::shared_ptr< IModelFunction > &func)

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from ROOT::Fit::FitResult
std::map< unsigned int, unsigned int >	fBoundParams
	list of limited parameters

double	fChi2
	fit chi2 value (different than fval in case of chi2 fits)

std::vector< double >	fCovMatrix
	covariance matrix (size is npar*(npar+1)/2) where npar is total parameters

int	fCovStatus
	covariance matrix status code

double	fEdm
	expected distance from minimum

std::vector< double >	fErrors
	errors

std::shared_ptr< FitData >	fFitData
	! data set used in the fit

std::shared_ptr< IModelFunction >	fFitFunc
	! model function resulting from the fit.

std::map< unsigned int, bool >	fFixedParams
	list of fixed parameters

std::vector< double >	fGlobalCC
	global Correlation coefficient

std::shared_ptr< ROOT::Math::Minimizer >	fMinimizer
	! minimizer object used for fitting

std::string	fMinimType
	string indicating type of minimizer

std::map< unsigned int, std::pair< double, double > >	fMinosErrors
	map contains the two Minos errors

unsigned int	fNCalls
	number of function calls

unsigned int	fNdf
	number of degree of freedom

unsigned int	fNFree
	number of fit free parameters (total parameters are in size of parameter vector)

bool	fNormalized
	flag for indicating is errors are normalized

std::shared_ptr< ROOT::Math::IMultiGenFunction >	fObjFunc
	! objective function used for fitting

std::vector< std::pair< double, double > >	fParamBounds
	parameter bounds

std::vector< double >	fParams
	parameter values. Size is total number of parameters

std::vector< std::string >	fParNames
	parameter names (only with FCN only fits, when fFitFunc=0)

int	fStatus
	minimizer status code

double	fVal
	minimum function value

bool	fValid
	flag for indicating valid fit

#include <TFitResult.h>

Inheritance diagram for TFitResult:

[legend]

Constructor & Destructor Documentation

◆ TFitResult() [1/3]

TFitResult::TFitResult ( int status = 0 )

inline

Definition at line 39 of file TFitResult.h.

◆ TFitResult() [2/3]

TFitResult::TFitResult	(	const char *	name,
		const char *	title
	)

inline

Definition at line 45 of file TFitResult.h.

◆ TFitResult() [3/3]

TFitResult::TFitResult ( const ROOT::Fit::FitResult & f )

Constructor from a ROOT::Fit::FitResult copy the contained TF1 pointer function if it is.

Definition at line 31 of file TFitResult.cxx.

◆ ~TFitResult()

TFitResult::~TFitResult ( )

inlineoverride

Definition at line 53 of file TFitResult.h.

Member Function Documentation

◆ Class()

static TClass * TFitResult::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TFitResult::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TFitResult::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 79 of file TFitResult.h.

◆ Contour()

bool TFitResult::Contour	(	unsigned int	ipar,
		unsigned int	jpar,
		TGraph *	gr,
		double	confLevel = `0.683`
	)

Create a 2D contour around the minimum for the parameter ipar and jpar if a minimum does not exist or is invalid it will return false on exit a TGraph is filled with the contour points the number of contour points is determined by the size of the TGraph.

if the size is zero a default number of points = 20 is used pass optionally the confidence level, default is 0.683 it is assumed that ErrorDef() defines the right error definition (i.e 1 sigma error for one parameter). If not the confidence level are scaled to new level

Definition at line 119 of file TFitResult.cxx.

◆ DeclFileName()

static const char * TFitResult::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 79 of file TFitResult.h.

◆ Error() [1/2]

void TObject::Error	(	const char *	location,
		const char *	fmt,
			...
	)		const

virtual

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented from TObject.

Definition at line 214 of file TObject.cxx.

◆ Error() [2/2]

double TFitResult::Error ( unsigned int i ) const

inline

Definition at line 74 of file TFitResult.h.

◆ GetCorrelationMatrix()

TMatrixDSym TFitResult::GetCorrelationMatrix ( ) const

Return the correlation matrix from fit.

The matrix is a symmetric matrix with a size N equal to the total number of parameters considered in the fit including the fixed ones The matrix row and columns corresponding to the fixed parameters will contain only zero's

Definition at line 77 of file TFitResult.cxx.

◆ GetCovarianceMatrix()

TMatrixDSym TFitResult::GetCovarianceMatrix ( ) const

Return the covariance matrix from fit.

The matrix is a symmetric matrix with a size N equal to the total number of parameters considered in the fit including the fixed ones The matrix row and columns corresponding to the fixed parameters will contain only zero's

Definition at line 59 of file TFitResult.cxx.

◆ IsA()

TClass * TFitResult::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 79 of file TFitResult.h.

◆ Print()

void TFitResult::Print ( Option_t * option = "" ) const

overridevirtual

Print result of the fit, by default chi2, parameter values and errors.

if option "V" is given print also error matrix and correlation

Reimplemented from TObject.

Definition at line 44 of file TFitResult.cxx.

◆ Scan()

bool TFitResult::Scan	(	unsigned int	ipar,
		TGraph *	gr,
		double	xmin = `0`,
		double	xmax = `0`
	)

Scan parameter ipar between value of xmin and xmax A graph must be given which will be on return filled with the scan resul If the graph size is zero, a default size n = 40 will be used.

Definition at line 93 of file TFitResult.cxx.

◆ Streamer()

void TFitResult::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TFitResult::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 79 of file TFitResult.h.

Libraries for TFitResult:

[legend]

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

hist/hist/inc/TFitResult.h
hist/hist/src/TFitResult.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TFitResult() [1/3]

◆ TFitResult() [2/3]

◆ TFitResult() [3/3]

◆ ~TFitResult()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Contour()

◆ DeclFileName()

◆ Error() [1/2]

◆ Error() [2/2]

◆ GetCorrelationMatrix()

◆ GetCovarianceMatrix()

◆ IsA()

◆ Print()

◆ Scan()

◆ Streamer()

◆ StreamerNVirtual()