Logo ROOT  
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
28class TF3 : public TF2 {
29
30protected:
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
36public:
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 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);
49
50 /// Template constructors from a pointer to any C++ class of type PtrObj with a specific member function of type MemFn.
51 template <class PtrObj, typename MemFn>
52 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,
53 Int_t ndim = 3) :
54 TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,ndim),
55 fZmin(zmin), fZmax(zmax), fNpz(30)
56 { }
57
58 /// Backward compatible ctor
59 template <class PtrObj, typename MemFn>
60 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,
61 const char * , const char * ) :
62 TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,3),
63 fZmin(zmin), fZmax(zmax), fNpz(30)
64 { }
65
66 /// Template constructors from any C++ callable object, defining the operator() (double * , double *) and returning a double.
67 template <typename Func>
68 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,
69 Int_t ndim = 3 ) :
70 TF2(name,f,xmin,xmax,ymin,ymax,npar,ndim),
71 fZmin(zmin), fZmax(zmax), fNpz(30)
72 { }
73
74 /// Backward compatible ctor
75 template <typename Func>
76 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,
77 const char * ) :
78 TF2(name,f,xmin,xmax,ymin,ymax,npar,3),
79 fZmin(zmin), fZmax(zmax), fNpz(30)
80 { }
81
82 TF3(const TF3 &f3);
83 TF3& operator=(const TF3 &rhs);
84 virtual ~TF3();
85 virtual void Copy(TObject &f3) const;
86 virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
87 virtual void Draw(Option_t *option="");
88 virtual TObject *DrawDerivative(Option_t * ="al") {return 0;}
89 virtual TObject *DrawIntegral(Option_t * ="al") {return 0;}
90 virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
93 Int_t GetNpz() const {return fNpz;}
94 virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom, TRandom * rng = nullptr);
95 using TF1::GetRange;
96 virtual void GetRange(Double_t &xmin, Double_t &xmax) const;
97 virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const ;
98 virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &zmin, Double_t &xmax, Double_t &ymax, Double_t &zmax) const;
99 virtual Double_t GetSave(const Double_t *x);
100 virtual Double_t GetZmin() const {return fZmin;}
101 virtual Double_t GetZmax() const {return fZmax;}
102 using TF2::Integral;
103 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);
104 virtual Bool_t IsInside(const Double_t *x) const;
105 virtual TH1 *CreateHistogram();
106 virtual void Paint(Option_t *option="");
108 virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
109 virtual void SetClippingBoxOff(); // *MENU*
110 virtual Bool_t GetClippingBoxOn() const { return fClipBoxOn; }
111 virtual void SetClippingBoxOn(Double_t xclip=0, Double_t yclip=0, Double_t zclip=0); // *MENU*
112 virtual const Double_t *GetClippingBox() const { return fClipBoxOn ? fClipBox : nullptr; }
113 virtual void SetNpz(Int_t npz=30);
114 virtual void SetRange(Double_t xmin, Double_t xmax);
116 virtual void SetRange(Double_t xmin, Double_t ymin, Double_t zmin, Double_t xmax, Double_t ymax, Double_t zmax); // *MENU*
117
118 //Moments
119 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
122 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);}
123 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);}
124 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);}
125
126 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);}
127 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);}
128 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);}
129
130 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);}
131 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);}
132 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);}
133
134protected:
135
136 virtual Double_t FindMinMax(Double_t* x, bool findmax) const;
137
138 ClassDef(TF3,3) //The Parametric 3-D function
139};
140
142 { TF2::GetRange(xmin, xmax); }
146 { TF2::SetRange(xmin, xmax); }
149
150#endif
#define f(i)
Definition: RSha256.hxx:104
int Int_t
Definition: RtypesCore.h:45
const Bool_t kFALSE
Definition: RtypesCore.h:101
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
float xmin
Definition: THbookFile.cxx:95
float ymin
Definition: THbookFile.cxx:95
float xmax
Definition: THbookFile.cxx:95
float ymax
Definition: THbookFile.cxx:95
Param Functor class for Multidimensional functions.
Definition: ParamFunctor.h:273
virtual void GetRange(Double_t *xmin, Double_t *xmax) const
Return range of a generic N-D function.
Definition: TF1.cxx:2275
A 2-Dim function with parameters.
Definition: TF2.h:29
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:664
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF2.h:148
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:599
A 3-Dim function with parameters.
Definition: TF3.h:28
virtual Double_t GetZmin() const
Definition: TF3.h:100
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:130
TF3()
F3 default constructor.
Definition: TF3.cxx:37
Int_t GetNpz() const
Definition: TF3.h:93
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:124
virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom, TRandom *rng=nullptr)
Return 3 random numbers following this function shape.
Definition: TF3.cxx:325
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TF3.cxx:590
virtual TObject * DrawIntegral(Option_t *="al")
Draw integral of this function.
Definition: TF3.h:89
Double_t fZmin
Lower bound for the range in z.
Definition: TF3.h:31
TF3 & operator=(const TF3 &rhs)
Operator =.
Definition: TF3.cxx:127
virtual void SetNpz(Int_t npz=30)
Set the number of points used to draw the function.
Definition: TF3.cxx:657
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:297
virtual TObject * DrawDerivative(Option_t *="al")
Draw derivative of this function.
Definition: TF3.h:88
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:60
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF3.h:145
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],...
Definition: TF3.cxx:737
virtual Double_t FindMinMax(Double_t *x, bool findmax) const
Return minimum/maximum value of the function.
Definition: TF3.cxx:213
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute action corresponding to one event.
Definition: TF3.cxx:192
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:131
Bool_t fClipBoxOn
! Is clip box on
Definition: TF3.h:34
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:281
virtual void Paint(Option_t *option="")
Paint this 3-D function with its current attributes.
Definition: TF3.cxx:501
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:127
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:535
virtual Double_t GetSave(const Double_t *x)
Get value corresponding to X in array of fSave values.
Definition: TF3.cxx:398
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:712
Int_t fNpz
Number of points along z used for the graphical representation.
Definition: TF3.h:33
virtual Bool_t GetClippingBoxOn() const
Definition: TF3.h:110
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: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, Int_t ndim=3)
Template constructors from a pointer to any C++ class of type PtrObj with a specific member function ...
Definition: TF3.h:52
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:641
virtual void Copy(TObject &f3) const
Copy this F3 to a new F3.
Definition: TF3.cxx:153
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)
Template constructors from any C++ callable object, defining the operator() (double * ,...
Definition: TF3.h:68
virtual void SetClippingBoxOff()
Set the function clipping box (for drawing) "off".
Definition: TF3.cxx:526
virtual const Double_t * GetClippingBox() const
Definition: TF3.h:112
virtual Bool_t IsInside(const Double_t *x) const
Return kTRUE is the point is inside the function range.
Definition: TF3.cxx:478
Double_t fZmax
Upper bound for the range in z.
Definition: TF3.h:32
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:126
virtual ~TF3()
F3 default destructor.
Definition: TF3.cxx:138
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:452
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:122
virtual Double_t GetZmax() const
Definition: TF3.h:101
virtual void Draw(Option_t *option="")
Draw this function with its current attributes.
Definition: TF3.cxx:177
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:128
virtual void GetRange(Double_t &xmin, Double_t &xmax) const
Return range of a 1-D function.
Definition: TF3.h:141
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:76
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:123
virtual Int_t DistancetoPrimitive(Int_t px, Int_t py)
Compute distance from point px,py to a function.
Definition: TF3.cxx:168
virtual TH1 * CreateHistogram()
Create a histogram for axis range.
Definition: TF3.cxx:489
Double_t fClipBox[3]
! Coordinates of clipbox
Definition: TF3.h:35
TH1 is the base class of all histogram classes in ROOT.
Definition: TH1.h:58
Mother of all ROOT objects.
Definition: TObject.h:37
This is the base class for the ROOT Random number generators.
Definition: TRandom.h:27
Double_t y[n]
Definition: legend1.C:17
Double_t x[n]
Definition: legend1.C:17
REAL epsilon
Definition: triangle.c:618