Logo ROOT   6.21/01
Reference Guide
TF3.h
Go to the documentation of this file.
1 // @(#)root/hist:$Id$
2 // Author: Rene Brun 27/10/95
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 // ---------------------------------- F3.h
12 
13 #ifndef ROOT_TF3
14 #define ROOT_TF3
15 
16 
17 
18 //////////////////////////////////////////////////////////////////////////
19 // //
20 // TF3 //
21 // //
22 // The Parametric 3-D function //
23 // //
24 //////////////////////////////////////////////////////////////////////////
25 
26 #include "TF2.h"
27 
28 class TF3 : public TF2 {
29 
30 protected:
31  Double_t fZmin; //Lower bound for the range in z
32  Double_t fZmax; //Upper bound for the range in z
33  Int_t fNpz; //Number of points along z used for the graphical representation
34  Bool_t fClipBoxOn{kFALSE}; //! is clip box on
35  Double_t fClipBox[3]; //! coordinates of clipbox
36 public:
37  TF3();
38  TF3(const char *name, const char *formula, Double_t xmin=0, Double_t xmax=1, Double_t ymin=0,
39  Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Option_t * opt = nullptr);
40 #ifndef __CINT__
41  TF3(const char *name, Double_t (*fcn)(Double_t *, Double_t *), Double_t xmin=0, Double_t xmax=1, Double_t ymin=0,
42  Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Int_t npar=0, Int_t ndim = 3);
43  TF3(const char *name, Double_t (*fcn)(const Double_t *, const Double_t *), Double_t xmin=0, Double_t xmax=1, Double_t ymin=0,
44  Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Int_t npar=0, Int_t ndim = 3);
45 #endif
46 
47  // constructor using a functor
48 
49  TF3(const char *name, ROOT::Math::ParamFunctor f, Double_t xmin = 0, Double_t xmax = 1, Double_t ymin = 0, Double_t ymax = 1, Double_t zmin=0, Double_t zmax=1, Int_t npar = 0, Int_t ndim = 3);
50 
51 
52  // Template constructors from a pointer to any C++ class of type PtrObj with a specific member function of type
53  // MemFn.
54  template <class PtrObj, typename MemFn>
55  TF3(const char *name, const PtrObj& p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar,
56  Int_t ndim = 3) :
57  TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,ndim),
58  fZmin(zmin), fZmax(zmax), fNpz(30)
59  { }
60  /// Backward compatible ctor
61  template <class PtrObj, typename MemFn>
62  TF3(const char *name, const PtrObj& p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar,
63  const char * , const char * ) :
64  TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,3),
65  fZmin(zmin), fZmax(zmax), fNpz(30)
66  { }
67  // Template constructors from any C++ callable object, defining the operator() (double * , double *)
68  // and returning a double.
69  template <typename Func>
70  TF3(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar,
71  Int_t ndim = 3 ) :
72  TF2(name,f,xmin,xmax,ymin,ymax,npar,ndim),
73  fZmin(zmin), fZmax(zmax), fNpz(30)
74  { }
75  /// backward compatible ctor
76  template <typename Func>
77  TF3(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar,
78  const char * ) :
79  TF2(name,f,xmin,xmax,ymin,ymax,npar,3),
80  fZmin(zmin), fZmax(zmax), fNpz(30)
81  { }
82 
83  TF3(const TF3 &f3);
84  TF3& operator=(const TF3 &rhs);
85  virtual ~TF3();
86  virtual void Copy(TObject &f3) const;
87  virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
88  virtual void Draw(Option_t *option="");
89  virtual TObject *DrawDerivative(Option_t * ="al") {return 0;}
90  virtual TObject *DrawIntegral(Option_t * ="al") {return 0;}
91  virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
94  Int_t GetNpz() const {return fNpz;}
95  virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom);
96  using TF1::GetRange;
97  virtual void GetRange(Double_t &xmin, Double_t &xmax) const;
98  virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const ;
99  virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &zmin, Double_t &xmax, Double_t &ymax, Double_t &zmax) const;
100  virtual Double_t GetSave(const Double_t *x);
101  virtual Double_t GetZmin() const {return fZmin;}
102  virtual Double_t GetZmax() const {return fZmax;}
103  using TF2::Integral;
104  virtual Double_t Integral(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsrel=1.e-6);
105  virtual Bool_t IsInside(const Double_t *x) const;
106  virtual TH1 *CreateHistogram();
107  virtual void Paint(Option_t *option="");
108  virtual void Save(Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax);
109  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
110  virtual void SetClippingBoxOff(); // *MENU*
111  virtual Bool_t GetClippingBoxOn() const { return fClipBoxOn; }
112  virtual void SetClippingBoxOn(Double_t xclip=0, Double_t yclip=0, Double_t zclip=0); // *MENU*
113  virtual const Double_t *GetClippingBox() const { return fClipBoxOn ? fClipBox : nullptr; }
114  virtual void SetNpz(Int_t npz=30);
115  virtual void SetRange(Double_t xmin, Double_t xmax);
117  virtual void SetRange(Double_t xmin, Double_t ymin, Double_t zmin, Double_t xmax, Double_t ymax, Double_t zmax); // *MENU*
118 
119  //Moments
120  virtual Double_t Moment3(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t nz, Double_t az, Double_t bz, Double_t epsilon=0.000001);
121  virtual Double_t CentralMoment3(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t nz, Double_t az, Double_t bz, Double_t epsilon=0.000001);
122 
123  virtual Double_t Mean3X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return Moment3(1,ax,bx,0,ay,by,0,az,bz,epsilon);}
124  virtual Double_t Mean3Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return Moment3(0,ax,bx,1,ay,by,0,az,bz,epsilon);}
125  virtual Double_t Mean3Z(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return Moment3(0,ax,bx,0,ay,by,1,az,bz,epsilon);}
126 
127  virtual Double_t Variance3X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(2,ax,bx,0,ay,by,0,az,bz,epsilon);}
128  virtual Double_t Variance3Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(0,ax,bx,2,ay,by,0,az,bz,epsilon);}
129  virtual Double_t Variance3Z(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(0,ax,bx,0,ay,by,2,az,bz,epsilon);}
130 
131  virtual Double_t Covariance3XY(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(1,ax,bx,1,ay,by,0,az,bz,epsilon);}
132  virtual Double_t Covariance3XZ(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(1,ax,bx,0,ay,by,1,az,bz,epsilon);}
133  virtual Double_t Covariance3YZ(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001) {return CentralMoment3(0,ax,bx,1,ay,by,1,az,bz,epsilon);}
134 
135 protected:
136 
137  virtual Double_t FindMinMax(Double_t* x, bool findmax) const;
138 
139  ClassDef(TF3,3) //The Parametric 3-D function
140 };
141 
142 inline void TF3::GetRange(Double_t &xmin, Double_t &xmax) const
143  { TF2::GetRange(xmin, xmax); }
145  { TF2::GetRange(xmin, ymin, xmax, ymax); }
147  { TF2::SetRange(xmin, xmax); }
149  { TF2::SetRange(xmin, ymin, xmax, ymax); }
150 
151 #endif
virtual void Copy(TObject &f3) const
Copy this F3 to a new F3.
Definition: TF3.cxx:152
float xmin
Definition: THbookFile.cxx:93
virtual Double_t Covariance3YZ(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:133
virtual Double_t Moment3(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t nz, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Return x^nx * y^ny * z^nz moment of a 3d function in range [ax,bx],[ay,by],[az,bz].
Definition: TF3.cxx:707
Param Functor class for Multidimensional functions.
Definition: ParamFunctor.h:274
virtual Double_t Covariance3XY(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:131
virtual Double_t Mean3Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:124
virtual void Draw(Option_t *option="")
Draw this function with its current attributes.
Definition: TF3.cxx:176
Double_t fZmax
Definition: TF3.h:32
virtual void Save(Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax)
Save values of function in array fSave.
Definition: TF3.cxx:530
const char Option_t
Definition: RtypesCore.h:62
virtual Double_t GetZmax() const
Definition: TF3.h:102
float ymin
Definition: THbookFile.cxx:93
virtual TH1 * CreateHistogram()
Create a histogram for axis range.
Definition: TF3.cxx:484
virtual ~TF3()
F3 default destructor.
Definition: TF3.cxx:137
Double_t fZmin
Definition: TF3.h:31
Int_t GetNpz() const
Definition: TF3.h:94
virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const
Return range of a 2-D function.
Definition: TF2.cxx:579
#define f(i)
Definition: RSha256.hxx:104
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TF3.cxx:585
virtual Double_t Mean3X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:123
virtual Bool_t GetClippingBoxOn() const
Definition: TF3.h:111
virtual Double_t Integral(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsrel=1.e-6)
Return Integral of a 2d function in range [ax,bx],[ay,by] with desired relative accuracy (default val...
Definition: TF2.cxx:644
virtual Double_t GetMinimumXYZ(Double_t &x, Double_t &y, Double_t &z)
Compute the X, Y and Z values corresponding to the minimum value of the function on its range...
Definition: TF3.cxx:280
virtual void SetClippingBoxOn(Double_t xclip=0, Double_t yclip=0, Double_t zclip=0)
Set the function clipping box (for drawing) "on" and define the clipping box.
Definition: TF3.cxx:636
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute action corresponding to one event.
Definition: TF3.cxx:191
Double_t x[n]
Definition: legend1.C:17
#define ClassDef(name, id)
Definition: Rtypes.h:326
virtual TObject * DrawDerivative(Option_t *="al")
Draw derivative of this function.
Definition: TF3.h:89
virtual Double_t Mean3Z(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:125
virtual Double_t GetMaximumXYZ(Double_t &x, Double_t &y, Double_t &z)
Compute the X, Y and Z values corresponding to the maximum value of the function on its range...
Definition: TF3.cxx:296
TF3()
coordinates of clipbox
Definition: TF3.cxx:36
virtual void Paint(Option_t *option="")
Paint this 3-D function with its current attributes.
Definition: TF3.cxx:496
Bool_t fClipBoxOn
Definition: TF3.h:34
virtual Double_t Variance3Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:128
virtual Double_t Covariance3XZ(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:132
TF3(const char *name, const PtrObj &p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar, const char *, const char *)
Backward compatible ctor.
Definition: TF3.h:62
TF3(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar, const char *)
backward compatible ctor
Definition: TF3.h:77
Double_t fClipBox[3]
is clip box on
Definition: TF3.h:35
float ymax
Definition: THbookFile.cxx:93
virtual Double_t Integral(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsrel=1.e-6)
Return Integral of a 3d function in range [ax,bx],[ay,by],[az,bz] with a desired relative accuracy...
Definition: TF3.cxx:450
virtual Double_t CentralMoment3(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t nz, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Return x^nx * y^ny * z^nz central moment of a 3d function in range [ax,bx],[ay,by],[az,bz].
Definition: TF3.cxx:723
A 3-Dim function with parameters.
Definition: TF3.h:28
virtual void GetRange(Double_t &xmin, Double_t &xmax) const
Return range of a 1-D function.
Definition: TF3.h:142
virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom)
Return 3 random numbers following this function shape.
Definition: TF3.cxx:324
virtual TObject * DrawIntegral(Option_t *="al")
Draw integral of this function.
Definition: TF3.h:90
float xmax
Definition: THbookFile.cxx:93
A 2-Dim function with parameters.
Definition: TF2.h:29
Int_t fNpz
Definition: TF3.h:33
REAL epsilon
Definition: triangle.c:617
const Bool_t kFALSE
Definition: RtypesCore.h:88
TF3 & operator=(const TF3 &rhs)
Operator =.
Definition: TF3.cxx:126
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF2.h:150
double Double_t
Definition: RtypesCore.h:55
virtual Double_t Variance3Z(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:129
Double_t y[n]
Definition: legend1.C:17
The TH1 histogram class.
Definition: TH1.h:56
you should not use this method at all Int_t Int_t Double_t Double_t Double_t e
Definition: TRolke.cxx:630
virtual void SetClippingBoxOff()
Set the function clipping box (for drawing) "off".
Definition: TF3.cxx:521
Mother of all ROOT objects.
Definition: TObject.h:37
you should not use this method at all Int_t Int_t z
Definition: TRolke.cxx:630
virtual Double_t Variance3X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t az, Double_t bz, Double_t epsilon=0.000001)
Definition: TF3.h:127
TF3(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar, Int_t ndim=3)
Definition: TF3.h:70
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF3.h:146
virtual void GetRange(Double_t *xmin, Double_t *xmax) const
Return range of a generic N-D function.
Definition: TF1.cxx:2281
virtual Bool_t IsInside(const Double_t *x) const
Return kTRUE is the point is inside the function range.
Definition: TF3.cxx:473
virtual Double_t FindMinMax(Double_t *x, bool findmax) const
Return minimum/maximum value of the function.
Definition: TF3.cxx:212
virtual Double_t GetZmin() const
Definition: TF3.h:101
virtual Int_t DistancetoPrimitive(Int_t px, Int_t py)
Compute distance from point px,py to a function.
Definition: TF3.cxx:167
char name[80]
Definition: TGX11.cxx:109
virtual Double_t GetSave(const Double_t *x)
Get value corresponding to X in array of fSave values.
Definition: TF3.cxx:396
virtual const Double_t * GetClippingBox() const
Definition: TF3.h:113
TF3(const char *name, const PtrObj &p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax, Int_t npar, Int_t ndim=3)
Definition: TF3.h:55
virtual void SetNpz(Int_t npz=30)
Set the number of points used to draw the function.
Definition: TF3.cxx:652