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
35public:
36 TF3();
37 TF3(const char *name, const char *formula, Double_t xmin=0, Double_t xmax=1, Double_t ymin=0,
38 Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Option_t * opt = nullptr);
39#ifndef __CINT__
40 TF3(const char *name, Double_t (*fcn)(Double_t *, Double_t *), Double_t xmin=0, Double_t xmax=1, Double_t ymin=0,
41 Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Int_t npar=0, Int_t ndim = 3);
42 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,
43 Double_t ymax=1, Double_t zmin=0, Double_t zmax=1, Int_t npar=0, Int_t ndim = 3);
44#endif
45
46 // constructor using a functor
47
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
51 // Template constructors from a pointer to any C++ class of type PtrObj with a specific member function of type
52 // MemFn.
53 template <class PtrObj, typename MemFn>
54 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,
55 Int_t ndim = 3) :
56 TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,ndim),
57 fZmin(zmin), fZmax(zmax), fNpz(30)
58 { }
59 /// Backward compatible ctor
60 template <class PtrObj, typename MemFn>
61 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,
62 const char * , const char * ) :
63 TF2(name,p,memFn,xmin,xmax,ymin,ymax,npar,3),
64 fZmin(zmin), fZmax(zmax), fNpz(30)
65 { }
66 // Template constructors from any C++ callable object, defining the operator() (double * , double *)
67 // and returning a double.
68 template <typename Func>
69 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,
70 Int_t ndim = 3 ) :
71 TF2(name,f,xmin,xmax,ymin,ymax,npar,ndim),
72 fZmin(zmin), fZmax(zmax), fNpz(30)
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);
91 virtual Double_t GetMinimumXYZ(Double_t &x, Double_t &y, Double_t &z);
92 virtual Double_t GetMaximumXYZ(Double_t &x, Double_t &y, Double_t &z);
93 Int_t GetNpz() const {return fNpz;}
94 virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom);
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="");
107 virtual void Save(Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax);
108 virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
109 virtual void SetClippingBoxOff(); // *MENU*
110 virtual void SetClippingBoxOn(Double_t xclip=0, Double_t yclip=0, Double_t zclip=0); // *MENU*
111 virtual void SetNpz(Int_t npz=30);
112 virtual void SetRange(Double_t xmin, Double_t xmax);
113 virtual void SetRange(Double_t xmin, Double_t ymin, Double_t xmax, Double_t ymax);
114 virtual void SetRange(Double_t xmin, Double_t ymin, Double_t zmin, Double_t xmax, Double_t ymax, Double_t zmax); // *MENU*
115
116 //Moments
117 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);
118 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);
119
120 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);}
121 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);}
122 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);}
123
124 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);}
125 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);}
126 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);}
127
128 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);}
129 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);}
130 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);}
131
132protected:
133
134 virtual Double_t FindMinMax(Double_t* x, bool findmax) const;
135
136 ClassDef(TF3,3) //The Parametric 3-D function
137};
138
139inline void TF3::GetRange(Double_t &xmin, Double_t &xmax) const
140 { TF2::GetRange(xmin, xmax); }
141inline void TF3::GetRange(Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const
142 { TF2::GetRange(xmin, ymin, xmax, ymax); }
143inline void TF3::SetRange(Double_t xmin, Double_t xmax)
144 { TF2::SetRange(xmin, xmax); }
145inline void TF3::SetRange(Double_t xmin, Double_t ymin, Double_t xmax, Double_t ymax)
146 { TF2::SetRange(xmin, ymin, xmax, ymax); }
147
148#endif
f
#define f(i)
Definition: RSha256.hxx:104
Int_t
int Int_t
Definition: RtypesCore.h:41
Bool_t
bool Bool_t
Definition: RtypesCore.h:59
Double_t
double Double_t
Definition: RtypesCore.h:55
Option_t
const char Option_t
Definition: RtypesCore.h:62
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:326
name
char name[80]
Definition: TGX11.cxx:109
xmin
float xmin
Definition: THbookFile.cxx:93
ymin
float ymin
Definition: THbookFile.cxx:93
xmax
float xmax
Definition: THbookFile.cxx:93
ymax
float ymax
Definition: THbookFile.cxx:93
ROOT::Math::ParamFunctorTempl
Param Functor class for Multidimensional functions.
Definition: ParamFunctor.h:274
TF1::GetRange
virtual void GetRange(Double_t *xmin, Double_t *xmax) const
Return range of a generic N-D function.
Definition: TF1.cxx:2263
TF2
A 2-Dim function with parameters.
Definition: TF2.h:29
TF2::Integral
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
TF2::SetRange
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF2.h:150
TF2::GetRange
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
TF3
A 3-Dim function with parameters.
Definition: TF3.h:28
TF3::GetZmin
virtual Double_t GetZmin() const
Definition: TF3.h:100
TF3::Covariance3XY
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:128
TF3::TF3
TF3()
F3 default constructor.
Definition: TF3.cxx:36
TF3::GetRandom3
virtual void GetRandom3(Double_t &xrandom, Double_t &yrandom, Double_t &zrandom)
Return 3 random numbers following this function shape.
Definition: TF3.cxx:324
TF3::GetNpz
Int_t GetNpz() const
Definition: TF3.h:93
TF3::Mean3Z
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:122
TF3::SavePrimitive
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TF3.cxx:591
TF3::DrawIntegral
virtual TObject * DrawIntegral(Option_t *="al")
Draw integral of this function.
Definition: TF3.h:89
TF3::fZmin
Double_t fZmin
Definition: TF3.h:31
TF3::operator=
TF3 & operator=(const TF3 &rhs)
Operator =.
Definition: TF3.cxx:126
TF3::SetNpz
virtual void SetNpz(Int_t npz=30)
Set the number of points used to draw the function.
Definition: TF3.cxx:666
TF3::GetMaximumXYZ
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::DrawDerivative
virtual TObject * DrawDerivative(Option_t *="al")
Draw derivative of this function.
Definition: TF3.h:88
TF3::TF3
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:61
TF3::SetRange
virtual void SetRange(Double_t xmin, Double_t xmax)
Initialize the upper and lower bounds to draw the function.
Definition: TF3.h:143
TF3::CentralMoment3
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
TF3::FindMinMax
virtual Double_t FindMinMax(Double_t *x, bool findmax) const
Return minimum/maximum value of the function.
Definition: TF3.cxx:212
TF3::ExecuteEvent
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute action corresponding to one event.
Definition: TF3.cxx:191
TF3::Covariance3XZ
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:129
TF3::GetMinimumXYZ
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
TF3::Paint
virtual void Paint(Option_t *option="")
Paint this 3-D function with its current attributes.
Definition: TF3.cxx:496
TF3::Variance3Y
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:125
TF3::Save
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:536
TF3::GetSave
virtual Double_t GetSave(const Double_t *x)
Get value corresponding to X in array of fSave values.
Definition: TF3.cxx:396
TF3::Moment3
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:721
TF3::fNpz
Int_t fNpz
Definition: TF3.h:33
TF3::Covariance3YZ
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:130
TF3::TF3
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:54
TF3::SetClippingBoxOn
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:642
TF3::Copy
virtual void Copy(TObject &f3) const
Copy this F3 to a new F3.
Definition: TF3.cxx:152
TF3::TF3
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:69
TF3::SetClippingBoxOff
virtual void SetClippingBoxOff()
Set the function clipping box (for drawing) "off".
Definition: TF3.cxx:522
TF3::IsInside
virtual Bool_t IsInside(const Double_t *x) const
Return kTRUE is the point is inside the function range.
Definition: TF3.cxx:473
TF3::fZmax
Double_t fZmax
Definition: TF3.h:32
TF3::Variance3X
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:124
TF3::~TF3
virtual ~TF3()
F3 default destructor.
Definition: TF3.cxx:137
TF3::Integral
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
TF3::Mean3X
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:120
TF3::GetZmax
virtual Double_t GetZmax() const
Definition: TF3.h:101
TF3::Draw
virtual void Draw(Option_t *option="")
Draw this function with its current attributes.
Definition: TF3.cxx:176
TF3::Variance3Z
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:126
TF3::GetRange
virtual void GetRange(Double_t &xmin, Double_t &xmax) const
Return range of a 1-D function.
Definition: TF3.h:139
TF3::TF3
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
TF3::Mean3Y
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:121
TF3::DistancetoPrimitive
virtual Int_t DistancetoPrimitive(Int_t px, Int_t py)
Compute distance from point px,py to a function.
Definition: TF3.cxx:167
TF3::CreateHistogram
virtual TH1 * CreateHistogram()
Create a histogram for axis range.
Definition: TF3.cxx:484
TH1
The TH1 histogram class.
Definition: TH1.h:56
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
y
Double_t y[n]
Definition: legend1.C:17
x
Double_t x[n]
Definition: legend1.C:17
epsilon
REAL epsilon
Definition: triangle.c:617