 |
ROOT
Reference Guide |
|
| |
ROOT
Reference Guide |
|
Extends the ROOT::Fit::Result class with a TNamed inheritance providing easy possibility for I/O.
Definition at line 32 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. More... | |
| TFitResult (int status=0) | |
| virtual | ~TFitResult () |
| 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. More... | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. More... | |
| double | Error (unsigned int i) const |
| TMatrixDSym | GetCorrelationMatrix () const |
| Return the correlation matrix from fit. More... | |
| TMatrixDSym | GetCovarianceMatrix () const |
| Return the covariance matrix from fit. More... | |
| virtual void | Print (Option_t *option="") const |
| Print result of the fit, by default chi2, parameter values and errors. More... | |
| 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. More... | |
 Public Member Functions inherited from TNamed | |
| TNamed () | |
| TNamed (const char *name, const char *title) | |
| TNamed (const TNamed &named) | |
| TNamed copy ctor. More... | |
| TNamed (const TString &name, const TString &title) | |
| virtual | ~TNamed () |
| TNamed destructor. More... | |
| virtual void | Clear (Option_t *option="") |
| Set name and title to empty strings (""). More... | |
| virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility. More... | |
| virtual Int_t | Compare (const TObject *obj) const |
| Compare two TNamed objects. More... | |
| virtual void | Copy (TObject &named) const |
| Copy this to obj. More... | |
| virtual void | FillBuffer (char *&buffer) |
| Encode TNamed into output buffer. More... | |
| virtual const char * | GetName () const |
| Returns name of object. More... | |
| virtual const char * | GetTitle () const |
| Returns title of object. More... | |
| virtual ULong_t | Hash () const |
| Return hash value for this object. More... | |
| virtual Bool_t | IsSortable () const |
| virtual void | ls (Option_t *option="") const |
| List TNamed name and title. More... | |
| TNamed & | operator= (const TNamed &rhs) |
| TNamed assignment operator. More... | |
| virtual void | Print (Option_t *option="") const |
| Print TNamed name and title. More... | |
| virtual void | SetName (const char *name) |
| Set the name of the TNamed. More... | |
| virtual void | SetNameTitle (const char *name, const char *title) |
| Set all the TNamed parameters (name and title). More... | |
| virtual void | SetTitle (const char *title="") |
| Set the title of the TNamed. More... | |
| virtual Int_t | Sizeof () const |
| Return size of the TNamed part of the TObject. More... | |
| Public Member Functions inherited from TObject | |
| TObject () | |
| TObject constructor. More... | |
| TObject (const TObject &object) | |
| TObject copy ctor. More... | |
| virtual | ~TObject () |
| TObject destructor. More... | |
| void | AbstractMethod (const char *method) const |
| Use this method to implement an "abstract" method that you don't want to leave purely abstract. More... | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. More... | |
| virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action. More... | |
| 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. More... | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. More... | |
| virtual void | Clear (Option_t *="") |
| virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility. More... | |
| virtual Int_t | Compare (const TObject *obj) const |
| Compare abstract method. More... | |
| virtual void | Copy (TObject &object) const |
| Copy this to obj. More... | |
| virtual void | Delete (Option_t *option="") |
| Delete this object. More... | |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object. More... | |
| virtual void | Draw (Option_t *option="") |
| Default Draw method for all objects. More... | |
| virtual void | DrawClass () const |
| Draw class inheritance tree of the class to which this object belongs. More... | |
| virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More... | |
| virtual void | Dump () const |
| Dump contents of object on stdout. More... | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. More... | |
| virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
| Execute method on this object with the given parameter string, e.g. More... | |
| virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
| Execute method on this object with parameters stored in the TObjArray. More... | |
| virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| Execute action corresponding to an event at (px,py). More... | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. More... | |
| virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. More... | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. More... | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. More... | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. More... | |
| virtual const char * | GetName () const |
| Returns name of object. More... | |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). More... | |
| virtual Option_t * | GetOption () const |
| virtual const char * | GetTitle () const |
| Returns title of object. More... | |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. More... | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. More... | |
| virtual ULong_t | Hash () const |
| Return hash value for this object. More... | |
| 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. More... | |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. More... | |
| virtual Bool_t | InheritsFrom (const char *classname) const |
| Returns kTRUE if object inherits from class "classname". More... | |
| virtual Bool_t | InheritsFrom (const TClass *cl) const |
| Returns kTRUE if object inherits from TClass cl. More... | |
| virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas. More... | |
| void | InvertBit (UInt_t f) |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). More... | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
| R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
| virtual Bool_t | IsSortable () const |
| R__ALWAYS_INLINE Bool_t | IsZombie () const |
| virtual void | ls (Option_t *option="") const |
| The ls function lists the contents of a class on stdout. More... | |
| 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). More... | |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification. More... | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. More... | |
| void | operator delete (void *ptr) |
| Operator delete. More... | |
| void | operator delete[] (void *ptr) |
| Operator delete []. More... | |
| 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. More... | |
| virtual void | Paint (Option_t *option="") |
| This method must be overridden if a class wants to paint itself. More... | |
| virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list. More... | |
| virtual void | Print (Option_t *option="") const |
| This method must be overridden when a class wants to print itself. More... | |
| virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory. More... | |
| virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list. More... | |
| void | ResetBit (UInt_t f) |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename. More... | |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out". More... | |
| void | SetBit (UInt_t f) |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. More... | |
| virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object. More... | |
| virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id. More... | |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. More... | |
| 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. More... | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. More... | |
| virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
| Write this object to the current directory. More... | |
| virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
| Write this object to the current directory. More... | |
| Public Member Functions inherited from ROOT::Fit::FitResult | |
| FitResult () | |
| Default constructor for an empty (non valid) fit result. More... | |
| FitResult (const FitConfig &fconfig) | |
| Constructor from a fit-config for a dummy fit (e.g. More... | |
| FitResult (const FitResult &rhs) | |
| Copy constructor. More... | |
| virtual | ~FitResult () |
| Destructor. More... | |
| double | Chi2 () const |
| Chi2 fit value in case of likelihood must be computed ? More... | |
| 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 More... | |
| double | Correlation (unsigned int i, unsigned int j) const |
| retrieve correlation elements More... | |
| double | CovMatrix (unsigned int i, unsigned int j) const |
| retrieve covariance matrix element More... | |
| int | CovMatrixStatus () const |
| covariance matrix status code using Minuit convention : =0 not calculated, =1 approximated, =2 made pos def , =3 accurate More... | |
| double | Edm () const |
| Expected distance from minimum. More... | |
| double | Error (unsigned int i) const |
| parameter error by index More... | |
| const std::vector< double > & | Errors () const |
| parameter errors (return st::vector) More... | |
| 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, bool binFit=true, const ROOT::Math::IMultiGenFunction *chi2func=0, unsigned int ncalls=0) |
| Fill the fit result from a Minimizer instance after fitting Run also Minos if requested from the configuration. More... | |
| 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 More... | |
| const IModelFunction * | FittedFunction () const |
| fitting quantities More... | |
| 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. More... | |
| 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 More... | |
| 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. More... | |
| 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) More... | |
| 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) More... | |
| const double * | GetErrors () const |
| parameter errors (return const pointer) More... | |
| std::string | GetParameterName (unsigned int ipar) const |
| get name of parameter (deprecated) More... | |
| const double * | GetParams () const |
| parameter values (return const pointer) More... | |
| double | GlobalCC (unsigned int i) const |
| parameter global correlation coefficient More... | |
| bool | HasMinosError (unsigned int i) const |
| query if parameter i has the Minos error More... | |
| int | Index (const std::string &name) const |
| get index for parameter name (return -1 if not found) More... | |
| bool | IsEmpty () const |
| True if a fit result does not exist (even invalid) with parameter values. More... | |
| bool | IsParameterBound (unsigned int ipar) const |
| query if a parameter is bound More... | |
| bool | IsParameterFixed (unsigned int ipar) const |
| query if a parameter is fixed More... | |
| bool | IsValid () const |
| True if fit successful, otherwise false. More... | |
| double | LowerError (unsigned int i) const |
| lower Minos error. If Minos has not run for parameter i return the parabolic error More... | |
| double | MinFcnValue () const |
| Return value of the objective function (chi2 or likelihood) used in the fit. More... | |
| const std::string & | MinimizerType () const |
| minimization quantities More... | |
| unsigned int | NCalls () const |
| Number of function calls to find minimum. More... | |
| unsigned int | Ndf () const |
| Number of degree of freedom. More... | |
| unsigned int | NFreeParameters () const |
| get total number of free parameters More... | |
| bool | NormalizedErrors () const |
| flag to chek if errors are normalized More... | |
| void | NormalizeErrors () |
| normalize errors using chi2/ndf for chi2 fits More... | |
| unsigned int | NPar () const |
| total number of parameters (abbreviation) More... | |
| unsigned int | NTotalParameters () const |
| get total number of parameters More... | |
| FitResult & | operator= (const FitResult &rhs) |
| Assignment operator. More... | |
| double | Parameter (unsigned int i) const |
| parameter value by index More... | |
| bool | ParameterBounds (unsigned int ipar, double &lower, double &upper) const |
| retrieve parameter bounds - return false if parameter is not bound More... | |
| const std::vector< double > & | Parameters () const |
| parameter values (return std::vector) More... | |
| double | ParError (unsigned int i) const |
| parameter error by index More... | |
| std::string | ParName (unsigned int i) const |
| name of the parameter More... | |
| void | Print (std::ostream &os, bool covmat=false) const |
| print the result and optionaly covariance matrix and correlations More... | |
| void | PrintCovMatrix (std::ostream &os) const |
| print error matrix and correlations More... | |
| double | Prob () const |
| p value of the fit (chi2 probability) More... | |
| 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. More... | |
| void | SetMinosError (unsigned int i, double elow, double eup) |
| set the Minos errors for parameter i (called by the Fitter class when running Minos) More... | |
| int | Status () const |
| minimizer status code More... | |
| 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. More... | |
| double | UpperError (unsigned int i) const |
| upper Minos error. If Minos has not run for parameter i return the parabolic error More... | |
| double | Value (unsigned int i) const |
| parameter value by index More... | |
Additional Inherited Members | |
| Public Types inherited from TObject | |
| enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
| enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
| enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
| enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
| Public Types inherited from ROOT::Fit::FitResult | |
| typedef ROOT::Math::IParamMultiFunction | IModelFunction |
| Static Public Member Functions inherited from TObject | |
| static Long_t | GetDtorOnly () |
| Return destructor only flag. More... | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. More... | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. More... | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. More... | |
| 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). More... | |
| 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. More... | |
| 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 |
| double | fChi2 |
| std::vector< double > | fCovMatrix |
| int | fCovStatus |
| double | fEdm |
| std::vector< double > | fErrors |
| std::shared_ptr< FitData > | fFitData |
| model function resulting from the fit. More... | |
| std::shared_ptr< IModelFunction > | fFitFunc |
| objective function used for fitting More... | |
| std::map< unsigned int, bool > | fFixedParams |
| data set used in the fit More... | |
| std::vector< double > | fGlobalCC |
| std::shared_ptr< ROOT::Math::Minimizer > | fMinimizer |
| std::string | fMinimType |
| std::map< unsigned int, std::pair< double, double > > | fMinosErrors |
| unsigned int | fNCalls |
| unsigned int | fNdf |
| unsigned int | fNFree |
| bool | fNormalized |
| std::shared_ptr< ROOT::Math::IMultiGenFunction > | fObjFunc |
| minimizer object used for fitting More... | |
| std::vector< std::pair< double, double > > | fParamBounds |
| std::vector< double > | fParams |
| std::vector< std::string > | fParNames |
| int | fStatus |
| double | fVal |
| bool | fValid |
#include <TFitResult.h>
|
inline |
Definition at line 37 of file TFitResult.h.
|
inline |
Definition at line 43 of file TFitResult.h.
| 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.
|
inlinevirtual |
Definition at line 51 of file TFitResult.h.
| 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.
|
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 187 of file TObject.cxx.
|
inline |
Definition at line 72 of file TFitResult.h.
| 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.
| 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.
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 TNamed.
Definition at line 44 of file TFitResult.cxx.
| 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.
