Logo ROOT   6.21/01
Reference Guide
TProfile3D.h
Go to the documentation of this file.
1 // @(#)root/hist:$Id$
2 // Author: Rene Brun 17/05/2006
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_TProfile3D
13 #define ROOT_TProfile3D
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TProfile3D //
19 // //
20 // Profile3D histogram class. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
23 
24 #include "TH3.h"
25 #include "TProfile.h"
26 
27 class TProfile3D : public TH3D {
28 
29 public:
30  friend class TProfileHelper;
31 
32 protected:
33  TArrayD fBinEntries; //number of entries per bin
34  EErrorType fErrorMode; //Option to compute errors
35  Double_t fTmin; //Lower limit in T (if set)
36  Double_t fTmax; //Upper limit in T (if set)
37  Bool_t fScaling; //!True when TProfile3D::Scale is called
38  Double_t fTsumwt; //Total Sum of weight*T
39  Double_t fTsumwt2; //Total Sum of weight*T*T
40  TArrayD fBinSumw2; //Array of sum of squares of weights per bin
41  static Bool_t fgApproximate; //bin error approximation option
42 
43  virtual Int_t BufferFill(Double_t, Double_t) {return -2;} //may not use
44  virtual Int_t BufferFill(Double_t, Double_t, Double_t) {return -2;} //may not use
45  virtual Int_t BufferFill(Double_t, Double_t, Double_t, Double_t) {return -2;} //may not use
47 
48  // helper methods for the Merge unification in TProfileHelper
49  void SetBins(const Int_t* nbins,const Double_t* range) { SetBins(nbins[0], range[0], range[1],
50  nbins[1], range[2], range[3],
51  nbins[2], range[4], range[5]); };
52  Int_t Fill(const Double_t* v) { return Fill(v[0], v[1], v[2], v[3], v[4]); };
53 
54 
55  using TH3::Fill;
56  Int_t Fill(Double_t, Double_t,Double_t) {return TH3::Fill(0); } //MayNotUse
57  Int_t Fill(const char *, const char *, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
58  Int_t Fill(const char *, Double_t , const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
59  Int_t Fill(const char *, const char *, Double_t, Double_t) {return TH3::Fill(0); } //MayNotUse
60  Int_t Fill(Double_t, const char *, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
61  Int_t Fill(Double_t, const char *, Double_t, Double_t) {return TH3::Fill(0); } //MayNotUse
62  Int_t Fill(Double_t, Double_t, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
63 
64  virtual Double_t RetrieveBinContent(Int_t bin) const { return (fBinEntries.fArray[bin] > 0) ? fArray[bin]/fBinEntries.fArray[bin] : 0; }
65  //virtual void UpdateBinContent(Int_t bin, Double_t content);
66  virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const { Double_t err = GetBinError(bin); return err*err; }
67 
68  virtual TProfile2D *DoProjectProfile2D(const char* name, const char * title, const TAxis* projX, const TAxis* projY,
69  bool originalRange, bool useUF, bool useOF) const;
70 
71 private:
72  Double_t *GetB() {return &fBinEntries.fArray[0];}
73  Double_t *GetB2() {return (fBinSumw2.fN ? &fBinSumw2.fArray[0] : 0 ); }
74  Double_t *GetW() {return &fArray[0];}
75  Double_t *GetW2() {return &fSumw2.fArray[0];}
77  { MayNotUse("SetBins(Int_t, Double_t, Double_t"); }
78  void SetBins(Int_t, const Double_t*)
79  { MayNotUse("SetBins(Int_t, const Double_t*"); }
81  { MayNotUse("SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t"); }
82  void SetBins(Int_t, const Double_t*, Int_t, const Double_t*)
83  { MayNotUse("SetBins(Int_t, const Double_t*, Int_t, const Double_t*"); }
84 
85 public:
86  TProfile3D();
87  TProfile3D(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup
88  ,Int_t nbinsy,Double_t ylow,Double_t yup
89  ,Int_t nbinsz,Double_t zlow,Double_t zup, Option_t *option="");
90  TProfile3D(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins
91  ,Int_t nbinsy,const Double_t *ybins
92  ,Int_t nbinsz,const Double_t *zbins,Option_t *option="");
93  TProfile3D(const TProfile3D &profile);
94  TProfile3D &operator=(const TProfile3D &profile);
95  virtual ~TProfile3D();
96  virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="");
97  virtual Bool_t Add(const TH1 *h1, Double_t c1=1);
98  virtual Bool_t Add(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1);
99  static void Approximate(Bool_t approx=kTRUE);
100  void BuildOptions(Double_t tmin, Double_t tmax, Option_t *option);
101  virtual Int_t BufferEmpty(Int_t action=0);
102  virtual void Copy(TObject &hnew) const;
103  virtual Bool_t Divide(TF1 *h1, Double_t c1=1);
104  virtual Bool_t Divide(const TH1 *h1);
105  virtual Bool_t Divide(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="");
106  virtual void ExtendAxis(Double_t x, TAxis *axis);
107  virtual Int_t Fill(Double_t x, Double_t y, Double_t z, Double_t t);
109  virtual Double_t GetBinContent(Int_t bin) const;
111  { MayNotUse("GetBinContent(Int_t, Int_t"); return -1; }
112  virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t binz) const {return GetBinContent(GetBin(binx,biny,binz));}
113  virtual Double_t GetBinError(Int_t bin) const;
115  { MayNotUse("GetBinError(Int_t, Int_t"); return -1; }
116  virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t binz) const {return GetBinError(GetBin(binx,biny,binz));}
117  virtual Double_t GetBinEntries(Int_t bin) const;
119  virtual TArrayD *GetBinSumw2() {return &fBinSumw2;}
120  virtual const TArrayD *GetBinSumw2() const {return &fBinSumw2;}
121  Option_t *GetErrorOption() const;
122  virtual void GetStats(Double_t *stats) const;
123  virtual Double_t GetTmin() const {return fTmin;}
124  virtual Double_t GetTmax() const {return fTmax;}
125  virtual Long64_t Merge(TCollection *list);
126  virtual Bool_t Multiply(TF1 *h1, Double_t c1=1);
127  virtual Bool_t Multiply(const TH1 *h1);
128  virtual Bool_t Multiply(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="");
129  virtual TH3D *ProjectionXYZ(const char *name="_pxyz", Option_t *option="e") const;
130  virtual TProfile2D *Project3DProfile(Option_t *option="xy") const; // *MENU*
131  virtual void PutStats(Double_t *stats);
132  virtual void Reset(Option_t *option="");
133  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
134  virtual void Scale(Double_t c1=1, Option_t *option="");
135  virtual void SetBinEntries(Int_t bin, Double_t w);
136  virtual void SetBins(Int_t nbinsx, Double_t xmin, Double_t xmax,
137  Int_t nbinsy, Double_t ymin, Double_t ymax,
138  Int_t nbinsz, Double_t zmin, Double_t zmax);
139  virtual void SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t * yBins, Int_t nz,
140  const Double_t *zBins);
141  virtual void SetBinsLength(Int_t n=-1);
142  virtual void SetBuffer(Int_t buffersize, Option_t *opt="");
143  virtual void SetErrorOption(Option_t *option=""); // *MENU*
144  virtual void Sumw2(Bool_t flag = kTRUE);
145 
146  ClassDef(TProfile3D,8) //Profile3D histogram class
147 };
148 
149 #endif
Int_t Fill(const char *, const char *, const char *, Double_t)
Increment cell defined by namex,namey,namez by a weight w.
Definition: TProfile3D.h:57
Int_t Fill(const char *, Double_t, const char *, Double_t)
Increment cell defined by namex,y,namez by a weight w.
Definition: TProfile3D.h:58
Double_t fTmin
Definition: TProfile3D.h:35
float xmin
Definition: THbookFile.cxx:93
Double_t fTsumwt2
Definition: TProfile3D.h:39
virtual Double_t GetBinError(Int_t bin) const
Return bin error of a Profile3D histogram.
Definition: TProfile3D.cxx:745
virtual void SetBinEntries(Int_t bin, Double_t w)
Set the number of entries in bin.
virtual void SetBuffer(Int_t buffersize, Option_t *opt="")
Set the buffer size in units of 8 bytes (double).
long long Long64_t
Definition: RtypesCore.h:69
virtual TH3D * ProjectionXYZ(const char *name="_pxyz", Option_t *option="e") const
Project this profile3D into a 3-D histogram along X,Y,Z.
Definition: TProfile3D.cxx:920
virtual TProfile2D * DoProjectProfile2D(const char *name, const char *title, const TAxis *projX, const TAxis *projY, bool originalRange, bool useUF, bool useOF) const
Internal method to project to a 2D Profile.
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this profile2D by a constant c1.
Option_t * GetErrorOption() const
Return option to compute profile2D errors.
Definition: TProfile3D.cxx:753
const char Option_t
Definition: RtypesCore.h:62
virtual Int_t BufferFill(Double_t, Double_t, Double_t)
Definition: TProfile3D.h:44
void SetBins(Int_t, const Double_t *, Int_t, const Double_t *)
Redefine x and y axis parameters with variable bin sizes.
Definition: TProfile3D.h:82
return c1
Definition: legend1.C:41
virtual void Sumw2(Bool_t flag=kTRUE)
Create/Delete structure to store sum of squares of weights per bin This is needed to compute the corr...
void Reset()
Definition: TArrayD.h:47
float ymin
Definition: THbookFile.cxx:93
virtual ~TProfile3D()
Default destructor for Profile3D histograms.
Definition: TProfile3D.cxx:87
Double_t fTmax
Definition: TProfile3D.h:36
void SetBins(Int_t, Double_t, Double_t)
Redefine x axis parameters.
Definition: TProfile3D.h:76
virtual Double_t GetBinEntries(Int_t bin) const
Return bin entries of a Profile3D histogram.
Definition: TProfile3D.cxx:704
virtual Int_t BufferFill(Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile3D.h:43
virtual Int_t GetBin(Int_t binx, Int_t biny, Int_t binz) const
See comments in TH1::GetBin.
Definition: TH3.cxx:895
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
void BuildOptions(Double_t tmin, Double_t tmax, Option_t *option)
Set Profile3D histogram structure and options.
Definition: TProfile3D.cxx:142
Int_t Fill(Double_t, Double_t, const char *, Double_t)
Increment cell defined by x,y,namez by a weight w.
Definition: TProfile3D.h:62
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
Profile3D histograms are used to display the mean value of T and its RMS for each cell in X...
Definition: TProfile3D.h:27
TArrayD fSumw2
Array of sum of squares of weights.
Definition: TH1.h:101
Double_t * GetB()
Definition: TProfile3D.h:72
virtual TProfile2D * Project3DProfile(Option_t *option="xy") const
Project a 3-D profile into a 2D-profile histogram depending on the option parameter.
Double_t * GetW2()
Definition: TProfile3D.h:75
EErrorType
Definition: TProfile.h:28
Int_t Fill(Double_t, Double_t, Double_t)
Increment cell defined by x,y,z by 1 .
Definition: TProfile3D.h:56
virtual Bool_t Multiply(TF1 *h1, Double_t c1=1)
Performs the operation: this = this*c1*f1 .
Definition: TProfile3D.cxx:861
virtual Int_t BufferFill(Double_t, Double_t, Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile3D.h:45
Double_t x[n]
Definition: legend1.C:17
#define ClassDef(name, id)
Definition: Rtypes.h:326
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition: TProfile3D.h:66
static Bool_t fgApproximate
Definition: TProfile3D.h:41
virtual void GetStats(Double_t *stats) const
fill the array stats from the contents of this profile.
Definition: TProfile3D.cxx:785
virtual Double_t RetrieveBinContent(Int_t bin) const
Raw retrieval of bin content on internal data structure see convention for numbering bins in TH1::Get...
Definition: TProfile3D.h:64
Double_t fTsumwt
True when TProfile3D::Scale is called.
Definition: TProfile3D.h:38
Double_t * fArray
Definition: TArrayD.h:30
virtual void Copy(TObject &hnew) const
Copy a Profile3D histogram to a new profile2D histogram.
Definition: TProfile3D.cxx:350
virtual Double_t GetBinContent(Int_t bin) const
Return bin content of a Profile3D histogram.
Definition: TProfile3D.cxx:691
void MayNotUse(const char *method) const
Use this method to signal that a method (defined in a base class) may not be called in a derived clas...
Definition: TObject.cxx:933
TH1F * h1
Definition: legend1.C:5
virtual TArrayD * GetBinSumw2()
Definition: TProfile3D.h:119
void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
Redefine x and y axis parameters.
Definition: TProfile3D.h:80
Int_t fN
Definition: TArray.h:38
static void Approximate(Bool_t approx=kTRUE)
Set the fgApproximate flag.
Definition: TProfile3D.cxx:231
float ymax
Definition: THbookFile.cxx:93
Class to manage histogram axis.
Definition: TAxis.h:30
3-D histogram with a double per channel (see TH1 documentation)}
Definition: TH3.h:304
Int_t Fill(const Double_t *v)
Definition: TProfile3D.h:52
Collection abstract base class.
Definition: TCollection.h:63
virtual const TArrayD * GetBinSumw2() const
Definition: TProfile3D.h:120
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1 .
Definition: TProfile3D.cxx:172
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH3.cxx:286
float xmax
Definition: THbookFile.cxx:93
virtual Long64_t Merge(TCollection *list)
Merge all histograms in the collection in this histogram.
Definition: TProfile3D.cxx:853
virtual void SetErrorOption(Option_t *option="")
Set option to compute profile3D errors.
virtual Double_t GetBinContent(Int_t, Int_t) const
Definition: TProfile3D.h:110
Int_t Fill(Double_t, const char *, const char *, Double_t)
Increment cell defined by x,namey,namez by a weight w.
Definition: TProfile3D.h:60
Int_t Fill(Double_t, const char *, Double_t, Double_t)
Increment cell defined by x,namey,z by a weight w.
Definition: TProfile3D.h:61
virtual Double_t GetBinEffectiveEntries(Int_t bin)
Return bin effective entries for a weighted filled Profile histogram.
Definition: TProfile3D.cxx:721
TProfile3D()
Default constructor for Profile3D histograms.
Definition: TProfile3D.cxx:77
return c2
Definition: legend2.C:14
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
double Double_t
Definition: RtypesCore.h:55
virtual Double_t GetTmax() const
Definition: TProfile3D.h:124
Double_t y[n]
Definition: legend1.C:17
The TH1 histogram class.
Definition: TH1.h:56
TArrayD fBinEntries
Definition: TProfile3D.h:33
void SetBins(const Int_t *nbins, const Double_t *range)
Definition: TProfile3D.h:49
virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:112
Profile2D histograms are used to display the mean value of Z and its RMS for each cell in X...
Definition: TProfile2D.h:27
Array of doubles (64 bits per element).
Definition: TArrayD.h:27
Double_t * GetB2()
Definition: TProfile3D.h:73
Double_t * GetW()
Definition: TProfile3D.h:74
virtual void SetBinsLength(Int_t n=-1)
Set total number of bins including under/overflow.
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
Bool_t fScaling
Definition: TProfile3D.h:37
Int_t Fill(const char *, const char *, Double_t, Double_t)
Increment cell defined by namex,namey,z by a weight w.
Definition: TProfile3D.h:59
EErrorType fErrorMode
Definition: TProfile3D.h:34
1-Dim function class
Definition: TF1.h:211
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition: TProfile3D.cxx:246
virtual Double_t GetTmin() const
Definition: TProfile3D.h:123
TProfile3D & operator=(const TProfile3D &profile)
Definition: TProfile3D.cxx:163
virtual void ExtendAxis(Double_t x, TAxis *axis)
Profile histogram is resized along axis such that x is in the axis range.
void SetBins(Int_t, const Double_t *)
Redefine x axis parameters with variable bin sizes.
Definition: TProfile3D.h:78
virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:116
const Bool_t kTRUE
Definition: RtypesCore.h:87
const Int_t n
Definition: legend1.C:16
char name[80]
Definition: TGX11.cxx:109
virtual Double_t GetBinError(Int_t, Int_t) const
Definition: TProfile3D.h:114
virtual Bool_t Divide(TF1 *h1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) .
Definition: TProfile3D.cxx:379
TArrayD fBinSumw2
Definition: TProfile3D.h:40