Logo ROOT  
Reference Guide
TVirtualFitter.h
Go to the documentation of this file.
1// @(#)root/hist:$Id$
2// Author: Rene Brun 31/08/99
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TVirtualFitter
13#define ROOT_TVirtualFitter
14
15//////////////////////////////////////////////////////////////////////////
16// //
17// TVirtualFitter //
18// //
19// Abstract base class for fitting //
20// //
21//////////////////////////////////////////////////////////////////////////
22
23
24#include "TNamed.h"
25#include "TMethodCall.h"
26#include "Foption.h"
27
28
29class TVirtualFitter : public TNamed {
30
31protected:
32 Foption_t fOption; ///< Struct with the fit options
33 Int_t fXfirst; ///< First bin on X axis
34 Int_t fXlast; ///< Last bin on X axis
35 Int_t fYfirst; ///< First bin on Y axis
36 Int_t fYlast; ///< Last bin on Y axis
37 Int_t fZfirst; ///< First bin on Z axis
38 Int_t fZlast; ///< Last bin on Z axis
39 Int_t fNpoints; ///< Number of points to fit
40 Int_t fPointSize; ///< Number of words per point in the cache
41 Int_t fCacheSize; ///< Size of the fCache array
42 Double_t *fCache; ///<[fCacheSize] Array of points data (fNpoints*fPointSize < fCacheSize words)
43 TObject *fObjectFit; ///< Pointer to object being fitted
44 TObject *fUserFunc; ///< Pointer to user theoretical function (a TF1*)
45 TMethodCall *fMethodCall; ///< Pointer to MethodCall in case of interpreted function
46 void (*fFCN)(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag);
47
48// static TVirtualFitter *fgFitter; //Current fitter (default TFitter)
49// static Int_t fgMaxpar; //Maximum number of fit parameters for current fitter
50// static Int_t fgMaxiter; //Maximum number of iterations
51// static Double_t fgErrorDef; //Error definition (default=1)
52// static Double_t fgPrecision; //maximum precision
53// static TString fgDefault; //name of the default fitter ("Minuit","Fumili",etc)
54
57
58public:
60 virtual ~TVirtualFitter();
61 virtual Double_t Chisquare(Int_t npar, Double_t *params) const = 0;
62
63 virtual void Clear(Option_t *option="") = 0;
64 virtual Int_t ExecuteCommand(const char *command, Double_t *args, Int_t nargs) = 0;
65 virtual void FixParameter(Int_t ipar) = 0;
66 virtual void GetConfidenceIntervals(Int_t n, Int_t ndim, const Double_t *x, Double_t *ci, Double_t cl=0.95);
67 virtual void GetConfidenceIntervals(TObject *obj, Double_t cl=0.95);
68 virtual Double_t *GetCovarianceMatrix() const = 0;
70 virtual Int_t GetErrors(Int_t ipar,Double_t &eplus, Double_t &eminus, Double_t &eparab, Double_t &globcc) const = 0;
71 typedef void (* FCNFunc_t )(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag);
72 virtual FCNFunc_t GetFCN() { return fFCN; }
73 virtual Foption_t GetFitOption() const {return fOption;}
75 virtual Int_t GetNumberTotalParameters() const = 0;
76 virtual Int_t GetNumberFreeParameters() const = 0;
77 virtual TObject *GetObjectFit() const {return fObjectFit;}
78 virtual Double_t GetParError(Int_t ipar) const = 0;
79 virtual Double_t GetParameter(Int_t ipar) const = 0;
80 virtual Int_t GetParameter(Int_t ipar,char *name,Double_t &value,Double_t &verr,Double_t &vlow, Double_t &vhigh) const = 0;
81 virtual const char *GetParName(Int_t ipar) const = 0;
82 virtual Int_t GetStats(Double_t &amin, Double_t &edm, Double_t &errdef, Int_t &nvpar, Int_t &nparx) const = 0;
83 virtual Double_t GetSumLog(Int_t i) = 0;
84 virtual TObject *GetUserFunc() const {return fUserFunc;}
85 virtual Int_t GetXfirst() const {return fXfirst;}
86 virtual Int_t GetXlast() const {return fXlast;}
87 virtual Int_t GetYfirst() const {return fYfirst;}
88 virtual Int_t GetYlast() const {return fYlast;}
89 virtual Int_t GetZfirst() const {return fZfirst;}
90 virtual Int_t GetZlast() const {return fZlast;}
91 virtual Bool_t IsFixed(Int_t ipar) const = 0;
92 virtual void PrintResults(Int_t level, Double_t amin) const = 0;
93 virtual void ReleaseParameter(Int_t ipar) = 0;
94 virtual Double_t *SetCache(Int_t npoints, Int_t psize);
95 virtual void SetFCN(void (*fcn)(Int_t &, Double_t *, Double_t &f, Double_t *, Int_t));
96 virtual void SetFitMethod(const char *name) = 0;
97 virtual void SetFitOption(Foption_t option) {fOption = option;}
98 virtual void SetObjectFit(TObject *obj) {fObjectFit = obj;}
99 virtual Int_t SetParameter(Int_t ipar,const char *parname,Double_t value,Double_t verr,Double_t vlow, Double_t vhigh) = 0;
100 virtual void SetUserFunc(TObject *userfunc) {fUserFunc = userfunc;}
101 virtual void SetXfirst(Int_t first) {fXfirst = first;}
102 virtual void SetXlast (Int_t last) {fXlast = last;}
103 virtual void SetYfirst(Int_t first) {fYfirst = first;}
104 virtual void SetYlast (Int_t last) {fYlast = last;}
105 virtual void SetZfirst(Int_t first) {fZfirst = first;}
106 virtual void SetZlast (Int_t last) {fZlast = last;}
107
108 static TVirtualFitter *GetFitter();
109 static TVirtualFitter *Fitter(TObject *obj, Int_t maxpar = 25);
110 static const char *GetDefaultFitter();
111 static Int_t GetMaxIterations();
112 static Double_t GetErrorDef();
113 static Double_t GetPrecision();
114 static void SetDefaultFitter(const char* name = "");
115 static void SetFitter(TVirtualFitter *fitter, Int_t maxpar = 25);
116 static void SetMaxIterations(Int_t niter=5000);
117 static void SetErrorDef(Double_t errdef=1);
118 static void SetPrecision(Double_t prec=1e-6);
119
120 ClassDef(TVirtualFitter,0) //Abstract interface for fitting
121};
122
123#endif
typedef void(GLAPIENTRYP _GLUfuncptr)(void)
#define f(i)
Definition: RSha256.hxx:104
#define e(i)
Definition: RSha256.hxx:103
int Int_t
Definition: RtypesCore.h:45
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
char name[80]
Definition: TGX11.cxx:110
Method or function calling interface.
Definition: TMethodCall.h:37
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:37
Abstract Base Class for Fitting.
Foption_t fOption
Struct with the fit options.
virtual Int_t GetXlast() const
virtual void PrintResults(Int_t level, Double_t amin) const =0
virtual void SetXfirst(Int_t first)
virtual Int_t GetYfirst() const
virtual void SetFitOption(Foption_t option)
static void SetDefaultFitter(const char *name="")
static: set name of default fitter
virtual void SetZlast(Int_t last)
virtual Int_t GetStats(Double_t &amin, Double_t &edm, Double_t &errdef, Int_t &nvpar, Int_t &nparx) const =0
static void SetPrecision(Double_t prec=1e-6)
static: Set the tolerance used in the minimization algorithm For example for MIGRAD this is tolerance...
Int_t fPointSize
Number of words per point in the cache.
virtual void SetXlast(Int_t last)
virtual void SetObjectFit(TObject *obj)
virtual void SetFitMethod(const char *name)=0
virtual void GetConfidenceIntervals(Int_t n, Int_t ndim, const Double_t *x, Double_t *ci, Double_t cl=0.95)
return confidence intervals in array x of dimension ndim implemented in TFitter and TLinearFitter
virtual TObject * GetObjectFit() const
TObject * fUserFunc
Pointer to user theoretical function (a TF1*)
virtual void ReleaseParameter(Int_t ipar)=0
virtual Double_t GetSumLog(Int_t i)=0
virtual Foption_t GetFitOption() const
TMethodCall * fMethodCall
Pointer to MethodCall in case of interpreted function.
static Int_t GetMaxIterations()
static: Return the maximum number of iterations actually max number of function calls
virtual const char * GetParName(Int_t ipar) const =0
virtual void SetZfirst(Int_t first)
static Double_t GetPrecision()
static: Return the fit relative precision
Int_t fYlast
Last bin on Y axis.
Int_t fXfirst
First bin on X axis.
Int_t fZfirst
First bin on Z axis.
virtual Double_t * GetCovarianceMatrix() const =0
virtual void SetYfirst(Int_t first)
virtual Double_t GetCovarianceMatrixElement(Int_t i, Int_t j) const =0
virtual Int_t GetParameter(Int_t ipar, char *name, Double_t &value, Double_t &verr, Double_t &vlow, Double_t &vhigh) const =0
Int_t fXlast
Last bin on X axis.
virtual FCNFunc_t GetFCN()
virtual Double_t * SetCache(Int_t npoints, Int_t psize)
Initialize the cache array npoints is the number of points to be stored (or already stored) in the ca...
virtual void SetFCN(void(*fcn)(Int_t &, Double_t *, Double_t &f, Double_t *, Int_t))
To set the address of the minimization objective function called by the native compiler (see function...
virtual Double_t GetParError(Int_t ipar) const =0
TVirtualFitter()
Default constructor.
virtual void SetYlast(Int_t last)
static const char * GetDefaultFitter()
static: return the name of the default fitter
virtual Int_t GetNumberFreeParameters() const =0
virtual ~TVirtualFitter()
Cleanup virtual fitter.
Double_t * fCache
[fCacheSize] Array of points data (fNpoints*fPointSize < fCacheSize words)
virtual Int_t GetZfirst() const
virtual Int_t SetParameter(Int_t ipar, const char *parname, Double_t value, Double_t verr, Double_t vlow, Double_t vhigh)=0
virtual void Clear(Option_t *option="")=0
Set name and title to empty strings ("").
TMethodCall * GetMethodCall() const
void(* FCNFunc_t)(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag)
virtual Int_t GetZlast() const
virtual Bool_t IsFixed(Int_t ipar) const =0
virtual Int_t GetXfirst() const
virtual Int_t ExecuteCommand(const char *command, Double_t *args, Int_t nargs)=0
static void SetMaxIterations(Int_t niter=5000)
static: Set the maximum number of function calls for the minimization algorithm For example for MIGRA...
virtual Double_t GetParameter(Int_t ipar) const =0
void(* fFCN)(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag)
virtual Int_t GetNumberTotalParameters() const =0
static Double_t GetErrorDef()
static: Return the Error Definition
TObject * fObjectFit
Pointer to object being fitted.
virtual void SetUserFunc(TObject *userfunc)
Int_t fCacheSize
Size of the fCache array.
virtual Int_t GetYlast() const
TVirtualFitter & operator=(const TVirtualFitter &tvf)
assignment operator
Int_t fYfirst
First bin on Y axis.
static void SetErrorDef(Double_t errdef=1)
static: Set the Error Definition (default=1) For Minuit this is the value passed with the "SET ERR" c...
static TVirtualFitter * GetFitter()
static: return the current Fitter
virtual void FixParameter(Int_t ipar)=0
virtual TObject * GetUserFunc() const
Int_t fZlast
Last bin on Z axis.
Int_t fNpoints
Number of points to fit.
static TVirtualFitter * Fitter(TObject *obj, Int_t maxpar=25)
Static function returning a pointer to the current fitter.
static void SetFitter(TVirtualFitter *fitter, Int_t maxpar=25)
Static function to set an alternative fitter.
virtual Double_t Chisquare(Int_t npar, Double_t *params) const =0
virtual Int_t GetErrors(Int_t ipar, Double_t &eplus, Double_t &eminus, Double_t &eparab, Double_t &globcc) const =0
Double_t x[n]
Definition: legend1.C:17
const Int_t n
Definition: legend1.C:16
static constexpr double eplus
Definition: first.py:1