Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TF2.h
Go to the documentation of this file.
1 // @(#)root/hist:$Id$
2 // Author: Rene Brun 23/08/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 // ---------------------------------- F2.h
12 
13 #ifndef ROOT_TF2
14 #define ROOT_TF2
15 
16 
17 
18 //////////////////////////////////////////////////////////////////////////
19 // //
20 // TF2 //
21 // //
22 // The Parametric 2-D function //
23 // //
24 //////////////////////////////////////////////////////////////////////////
25 
26 #include "TF1.h"
27 #include "TArrayD.h"
28 
29 class TF2 : public TF1 {
30 
31 protected:
32  Double_t fYmin; //Lower bound for the range in y
33  Double_t fYmax; //Upper bound for the range in y
34  Int_t fNpy; //Number of points along y used for the graphical representation
35  TArrayD fContour; //Array to display contour levels
36 
37 public:
38  TF2();
39  TF2(const char *name, const char *formula, Double_t xmin=0, Double_t xmax=1, Double_t ymin=0, Double_t ymax=1, Option_t * opt = nullptr);
40 #ifndef __CINT__
41  TF2(const char *name, Double_t (*fcn)(Double_t *, Double_t *), Double_t xmin=0, Double_t xmax=1, Double_t ymin=0, Double_t ymax=1, Int_t npar=0,Int_t ndim = 2);
42  TF2(const char *name, Double_t (*fcn)(const Double_t *, const Double_t *), Double_t xmin=0, Double_t xmax=1, Double_t ymin=0, Double_t ymax=1, Int_t npar=0, Int_t ndim = 2);
43 #endif
44 
45  // constructor using a functor
46 
47  TF2(const char *name, ROOT::Math::ParamFunctor f, Double_t xmin = 0, Double_t xmax = 1, Double_t ymin = 0, Double_t ymax = 1, Int_t npar = 0, Int_t ndim = 2);
48 
49 
50  // Template constructors from a pointer to any C++ class of type PtrObj with a specific member function of type
51  // MemFn.
52  template <class PtrObj, typename MemFn>
53  TF2(const char *name, const PtrObj& p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Int_t npar, Int_t ndim = 2) :
54  TF1(name,p,memFn,xmin,xmax,npar,ndim),
55  fYmin(ymin), fYmax(ymax), fNpy(30), fContour(0)
56  {
57  fNpx = 30;
58  }
59  /// backward compatible ctor
60  template <class PtrObj, typename MemFn>
61  TF2(const char *name, const PtrObj& p, MemFn memFn, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Int_t npar, const char * , const char *) :
62  TF1(name,p,memFn,xmin,xmax,npar,2),
63  fYmin(ymin), fYmax(ymax), fNpy(30), fContour(0)
64  {
65  fNpx = 30;
66  }
67 
68  // Template constructors from any C++ callable object, defining the operator() (double * , double *)
69  // and returning a double.
70  template <typename Func>
71  TF2(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Int_t npar,Int_t ndim = 2) :
72  TF1(name,f,xmin,xmax,npar,ndim),
73  fYmin(ymin), fYmax(ymax), fNpy(30), fContour(0)
74  {
75  fNpx = 30;
76  }
77  /// backward compatible ctor
78  template <typename Func>
79  TF2(const char *name, Func f, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Int_t npar,const char *) :
80  TF1(name,f,xmin,xmax,npar,2),
81  fYmin(ymin), fYmax(ymax), fNpy(30), fContour(0)
82  {
83  fNpx = 30;
84  }
85 
86 
87  TF2(const TF2 &f2);
88  TF2 &operator=(const TF2& rhs);
89  virtual ~TF2();
90  virtual void Copy(TObject &f2) const;
91  virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
92  virtual void Draw(Option_t *option="");
93  virtual TF1 *DrawCopy(Option_t *option="") const;
94  virtual TObject *DrawDerivative(Option_t * ="al") {return 0;}
95  virtual TObject *DrawIntegral(Option_t * ="al") {return 0;}
96  //virtual void DrawF2(const char *formula, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Option_t *option="");
97  virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
98  virtual Int_t GetContour(Double_t *levels=0);
99  virtual Double_t GetContourLevel(Int_t level) const;
100  Int_t GetNpy() const {return fNpy;}
101  virtual char *GetObjectInfo(Int_t px, Int_t py) const;
102  Double_t GetRandom();
103  Double_t GetRandom(Double_t xmin, Double_t xmax);
104  virtual void GetRandom2(Double_t &xrandom, Double_t &yrandom);
105  using TF1::GetRange;
106  virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &xmax, Double_t &ymax) const;
107  virtual void GetRange(Double_t &xmin, Double_t &ymin, Double_t &zmin, Double_t &xmax, Double_t &ymax, Double_t &zmax) const;
108  virtual Double_t GetSave(const Double_t *x);
109  virtual Double_t GetMinimumXY(Double_t &x, Double_t &y) const;
110  virtual Double_t GetMaximumXY(Double_t &x, Double_t &y) const;
111  using TF1::GetMinimum;
112  using TF1::GetMaximum;
113  virtual Double_t GetMinimum(Double_t *x ) const;
114  virtual Double_t GetMaximum(Double_t *x ) const;
115  virtual Double_t GetYmin() const {return fYmin;}
116  virtual Double_t GetYmax() const {return fYmax;}
117  using TF1::Integral;
118  virtual Double_t Integral(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsrel=1.e-6);
119  virtual Bool_t IsInside(const Double_t *x) const;
120  virtual TH1 *CreateHistogram();
121  virtual void Paint(Option_t *option="");
122  virtual void Save(Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax);
123  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
124  virtual void SetNpy(Int_t npy=100); // *MENU*
125  virtual void SetContour(Int_t nlevels=20, const Double_t *levels=0);
126  virtual void SetContourLevel(Int_t level, Double_t value);
127  virtual void SetRange(Double_t xmin, Double_t xmax);
128  virtual void SetRange(Double_t xmin, Double_t ymin, Double_t xmax, Double_t ymax); // *MENU*
129  virtual void SetRange(Double_t xmin, Double_t ymin, Double_t zmin, Double_t xmax, Double_t ymax, Double_t zmax);
130 
131  //Moments
132  virtual Double_t Moment2(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t epsilon=0.000001);
133  virtual Double_t CentralMoment2(Double_t nx, Double_t ax, Double_t bx, Double_t ny, Double_t ay, Double_t by, Double_t epsilon=0.000001);
134 
135  virtual Double_t Mean2X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsilon=0.000001) {return Moment2(1,ax,bx,0,ay,by,epsilon);}
136  virtual Double_t Mean2Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsilon=0.000001) {return Moment2(0,ax,bx,1,ay,by,epsilon);}
137 
138  virtual Double_t Variance2X(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsilon=0.000001) {return CentralMoment2(2,ax,bx,0,ay,by,epsilon);}
139  virtual Double_t Variance2Y(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsilon=0.000001) {return CentralMoment2(0,ax,bx,2,ay,by,epsilon);}
140 
141  virtual Double_t Covariance2XY(Double_t ax, Double_t bx, Double_t ay, Double_t by, Double_t epsilon=0.000001) {return CentralMoment2(1,ax,bx,1,ay,by,epsilon);}
142 
143 protected:
144 
145  virtual Double_t FindMinMax(Double_t* x, bool findmax) const;
146 
147  ClassDef(TF2,4) //The Parametric 2-D function
148 };
149 
150 inline void TF2::SetRange(Double_t xmin, Double_t xmax)
151  { TF1::SetRange(xmin, xmax); }
152 inline void TF2::SetRange(Double_t xmin, Double_t ymin, Double_t, Double_t xmax, Double_t ymax, Double_t)
153  { SetRange(xmin, ymin, xmax, ymax); }
154 
155 #endif