Logo ROOT  

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  friend class TH1Merger;
32 
33 protected:
34  TArrayD fBinEntries; //number of entries per bin
35  EErrorType fErrorMode; //Option to compute errors
36  Double_t fTmin; //Lower limit in T (if set)
37  Double_t fTmax; //Upper limit in T (if set)
38  Bool_t fScaling; //!True when TProfile3D::Scale is called
39  Double_t fTsumwt; //Total Sum of weight*T
40  Double_t fTsumwt2; //Total Sum of weight*T*T
41  TArrayD fBinSumw2; //Array of sum of squares of weights per bin
42  static Bool_t fgApproximate; //bin error approximation option
43 
44  virtual Int_t BufferFill(Double_t, Double_t) {return -2;} //may not use
45  virtual Int_t BufferFill(Double_t, Double_t, Double_t) {return -2;} //may not use
46  virtual Int_t BufferFill(Double_t, Double_t, Double_t, Double_t) {return -2;} //may not use
47  virtual Int_t BufferFill(Double_t x, Double_t y, Double_t z, Double_t t, Double_t w);
48 
49  // helper methods for the Merge unification in TProfileHelper
50  void SetBins(const Int_t* nbins,const Double_t* range) { SetBins(nbins[0], range[0], range[1],
51  nbins[1], range[2], range[3],
52  nbins[2], range[4], range[5]); };
53  Int_t Fill(const Double_t* v) { return Fill(v[0], v[1], v[2], v[3], v[4]); };
54 
55 
56  using TH3::Fill;
57  Int_t Fill(Double_t, Double_t,Double_t) {return TH3::Fill(0); } //MayNotUse
58  Int_t Fill(const char *, const char *, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
59  Int_t Fill(const char *, Double_t , const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
60  Int_t Fill(const char *, const char *, Double_t, Double_t) {return TH3::Fill(0); } //MayNotUse
61  Int_t Fill(Double_t, const char *, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
62  Int_t Fill(Double_t, const char *, Double_t, Double_t) {return TH3::Fill(0); } //MayNotUse
63  Int_t Fill(Double_t, Double_t, const char *, Double_t) {return TH3::Fill(0); } //MayNotUse
64 
65  virtual Double_t RetrieveBinContent(Int_t bin) const { return (fBinEntries.fArray[bin] > 0) ? fArray[bin]/fBinEntries.fArray[bin] : 0; }
66  //virtual void UpdateBinContent(Int_t bin, Double_t content);
67  virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const { Double_t err = GetBinError(bin); return err*err; }
68 
69  virtual TProfile2D *DoProjectProfile2D(const char* name, const char * title, const TAxis* projX, const TAxis* projY,
70  bool originalRange, bool useUF, bool useOF) const;
71 
72 private:
73  Double_t *GetB() {return &fBinEntries.fArray[0];}
74  Double_t *GetB2() {return (fBinSumw2.fN ? &fBinSumw2.fArray[0] : 0 ); }
75  Double_t *GetW() {return &fArray[0];}
76  Double_t *GetW2() {return &fSumw2.fArray[0];}
77  void SetBins(Int_t, Double_t, Double_t)
78  { MayNotUse("SetBins(Int_t, Double_t, Double_t"); }
79  void SetBins(Int_t, const Double_t*)
80  { MayNotUse("SetBins(Int_t, const Double_t*"); }
81  void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
82  { MayNotUse("SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t"); }
83  void SetBins(Int_t, const Double_t*, Int_t, const Double_t*)
84  { MayNotUse("SetBins(Int_t, const Double_t*, Int_t, const Double_t*"); }
85 
86 public:
87  TProfile3D();
88  TProfile3D(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup
89  ,Int_t nbinsy,Double_t ylow,Double_t yup
90  ,Int_t nbinsz,Double_t zlow,Double_t zup, Option_t *option="");
91  TProfile3D(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins
92  ,Int_t nbinsy,const Double_t *ybins
93  ,Int_t nbinsz,const Double_t *zbins,Option_t *option="");
94  TProfile3D(const TProfile3D &profile);
95  TProfile3D &operator=(const TProfile3D &profile);
96  virtual ~TProfile3D();
97  virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="");
98  virtual Bool_t Add(const TH1 *h1, Double_t c1=1);
99  virtual Bool_t Add(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1);
100  static void Approximate(Bool_t approx=kTRUE);
101  void BuildOptions(Double_t tmin, Double_t tmax, Option_t *option);
102  virtual Int_t BufferEmpty(Int_t action=0);
103  virtual void Copy(TObject &hnew) const;
104  virtual Bool_t Divide(TF1 *h1, Double_t c1=1);
105  virtual Bool_t Divide(const TH1 *h1);
106  virtual Bool_t Divide(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="");
107  virtual void ExtendAxis(Double_t x, TAxis *axis);
108  virtual Int_t Fill(Double_t x, Double_t y, Double_t z, Double_t t);
109  virtual Int_t Fill(Double_t x, Double_t y, Double_t z, Double_t t, Double_t w);
110  virtual Double_t GetBinContent(Int_t bin) const;
111  virtual Double_t GetBinContent(Int_t,Int_t) const
112  { MayNotUse("GetBinContent(Int_t, Int_t"); return -1; }
113  virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t binz) const {return GetBinContent(GetBin(binx,biny,binz));}
114  virtual Double_t GetBinError(Int_t bin) const;
115  virtual Double_t GetBinError(Int_t,Int_t) const
116  { MayNotUse("GetBinError(Int_t, Int_t"); return -1; }
117  virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t binz) const {return GetBinError(GetBin(binx,biny,binz));}
118  virtual Double_t GetBinEntries(Int_t bin) const;
119  virtual Double_t GetBinEffectiveEntries(Int_t bin);
120  virtual TArrayD *GetBinSumw2() {return &fBinSumw2;}
121  virtual const TArrayD *GetBinSumw2() const {return &fBinSumw2;}
122  Option_t *GetErrorOption() const;
123  virtual void GetStats(Double_t *stats) const;
124  virtual Double_t GetTmin() const {return fTmin;}
125  virtual Double_t GetTmax() const {return fTmax;}
126  virtual void LabelsDeflate(Option_t *axis="X");
127  virtual void LabelsInflate(Option_t *axis="X");
128  virtual void LabelsOption(Option_t *option="h", Option_t *axis="X");
129  virtual Long64_t Merge(TCollection *list);
130  virtual Bool_t Multiply(TF1 *h1, Double_t c1=1);
131  virtual Bool_t Multiply(const TH1 *h1);
132  virtual Bool_t Multiply(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="");
133  virtual TH3D *ProjectionXYZ(const char *name="_pxyz", Option_t *option="e") const;
134  virtual TProfile2D *Project3DProfile(Option_t *option="xy") const; // *MENU*
135  virtual void PutStats(Double_t *stats);
136  virtual void Reset(Option_t *option="");
137  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
138  virtual void Scale(Double_t c1=1, Option_t *option="");
139  virtual void SetBinEntries(Int_t bin, Double_t w);
140  virtual void SetBins(Int_t nbinsx, Double_t xmin, Double_t xmax,
141  Int_t nbinsy, Double_t ymin, Double_t ymax,
142  Int_t nbinsz, Double_t zmin, Double_t zmax);
143  virtual void SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t * yBins, Int_t nz,
144  const Double_t *zBins);
145  virtual void SetBinsLength(Int_t n=-1);
146  virtual void SetBuffer(Int_t buffersize, Option_t *opt="");
147  virtual void SetErrorOption(Option_t *option=""); // *MENU*
148  virtual void Sumw2(Bool_t flag = kTRUE);
149 
150  ClassDef(TProfile3D,8) //Profile3D histogram class
151 };
152 
153 #endif
TProfile3D::Fill
Int_t Fill(const Double_t *v)
Definition: TProfile3D.h:53
n
const Int_t n
Definition: legend1.C:16
TAxis
Class to manage histogram axis.
Definition: TAxis.h:30
TProfile3D::BuildOptions
void BuildOptions(Double_t tmin, Double_t tmax, Option_t *option)
Set Profile3D histogram structure and options.
Definition: TProfile3D.cxx:141
TProfile3D::GetBinContent
virtual Double_t GetBinContent(Int_t bin) const
Return bin content of a Profile3D histogram.
Definition: TProfile3D.cxx:690
ymax
float ymax
Definition: THbookFile.cxx:95
kTRUE
const Bool_t kTRUE
Definition: RtypesCore.h:91
TProfile3D::Project3DProfile
virtual TProfile2D * Project3DProfile(Option_t *option="xy") const
Project a 3-D profile into a 2D-profile histogram depending on the option parameter.
Definition: TProfile3D.cxx:1053
TProfile3D::DoProjectProfile2D
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.
Definition: TProfile3D.cxx:1068
TProfile3D::SavePrimitive
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TProfile3D.cxx:1222
TProfile3D::Fill
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:58
TProfile3D::ProjectionXYZ
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:960
TProfile3D::~TProfile3D
virtual ~TProfile3D()
Default destructor for Profile3D histograms.
Definition: TProfile3D.cxx:86
TProfile3D::fBinEntries
TArrayD fBinEntries
Definition: TProfile3D.h:34
Option_t
const char Option_t
Definition: RtypesCore.h:66
TH3::GetBin
virtual Int_t GetBin(Int_t binx, Int_t biny, Int_t binz) const
See comments in TH1::GetBin.
Definition: TH3.cxx:1026
TH3D
3-D histogram with a double per channel (see TH1 documentation)}
Definition: TH3.h:305
TProfile3D::RetrieveBinContent
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:65
TProfile3D::GetBinEntries
virtual Double_t GetBinEntries(Int_t bin) const
Return bin entries of a Profile3D histogram.
Definition: TProfile3D.cxx:703
TProfile3D::ExtendAxis
virtual void ExtendAxis(Double_t x, TAxis *axis)
Profile histogram is resized along axis such that x is in the axis range.
Definition: TProfile3D.cxx:1205
TProfile3D::Fill
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:63
TProfile3D::fTmin
Double_t fTmin
Definition: TProfile3D.h:36
TProfile3D::LabelsInflate
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition: TProfile3D.cxx:856
TProfile3D::fTsumwt
Double_t fTsumwt
True when TProfile3D::Scale is called.
Definition: TProfile3D.h:39
TProfile3D::GetB
Double_t * GetB()
Definition: TProfile3D.h:73
xmax
float xmax
Definition: THbookFile.cxx:95
Long64_t
long long Long64_t
Definition: RtypesCore.h:73
TProfile3D::GetBinError
virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:117
TProfile2D
Profile2D histograms are used to display the mean value of Z and its error for each cell in X,...
Definition: TProfile2D.h:27
TProfile3D::GetBinContent
virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:113
TProfile3D::BufferFill
virtual Int_t BufferFill(Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile3D.h:44
TProfile3D::LabelsDeflate
virtual void LabelsDeflate(Option_t *axis="X")
Reduce the number of bins for this axis to the number of bins having a label.
Definition: TProfile3D.cxx:846
Int_t
int Int_t
Definition: RtypesCore.h:45
TProfile3D::Scale
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this profile2D by a constant c1.
Definition: TProfile3D.cxx:1279
TProfile3D::Merge
virtual Long64_t Merge(TCollection *list)
Merge all histograms in the collection in this histogram.
Definition: TProfile3D.cxx:893
x
Double_t x[n]
Definition: legend1.C:17
TProfile3D::SetBinEntries
virtual void SetBinEntries(Int_t bin, Double_t w)
Set the number of entries in bin.
Definition: TProfile3D.cxx:1287
TObject::MayNotUse
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:943
TProfile3D::Fill
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:62
TArray::fN
Int_t fN
Definition: TArray.h:38
TProfile.h
TProfile3D::SetBins
void SetBins(Int_t, Double_t, Double_t)
Redefine x axis parameters.
Definition: TProfile3D.h:77
TProfile3D::SetBins
void SetBins(const Int_t *nbins, const Double_t *range)
Definition: TProfile3D.h:50
TProfile3D::BufferFill
virtual Int_t BufferFill(Double_t, Double_t, Double_t)
Definition: TProfile3D.h:45
TProfile3D::GetBinSumw2
virtual const TArrayD * GetBinSumw2() const
Definition: TProfile3D.h:121
TProfile3D::GetW2
Double_t * GetW2()
Definition: TProfile3D.h:76
Bool_t
bool Bool_t
Definition: RtypesCore.h:63
TProfile3D::SetBuffer
virtual void SetBuffer(Int_t buffersize, Option_t *opt="")
Set the buffer size in units of 8 bytes (double).
Definition: TProfile3D.cxx:1326
v
@ v
Definition: rootcling_impl.cxx:3635
TProfile3D::GetBinError
virtual Double_t GetBinError(Int_t, Int_t) const
Definition: TProfile3D.h:115
TProfile3D::SetBins
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:83
h1
TH1F * h1
Definition: legend1.C:5
bool
TH1Merger
Definition: TH1Merger.h:20
TProfile3D::fTmax
Double_t fTmax
Definition: TProfile3D.h:37
TProfile3D::GetStats
virtual void GetStats(Double_t *stats) const
fill the array stats from the contents of this profile.
Definition: TProfile3D.cxx:784
TProfile3D::Divide
virtual Bool_t Divide(TF1 *h1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) .
Definition: TProfile3D.cxx:378
TProfile3D::SetBins
void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
Redefine x and y axis parameters.
Definition: TProfile3D.h:81
TProfile3D::PutStats
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
Definition: TProfile3D.cxx:1174
TProfile3D::Add
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1 .
Definition: TProfile3D.cxx:171
TH3::Fill
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH3.cxx:287
xmin
float xmin
Definition: THbookFile.cxx:95
TProfile3D::fBinSumw2
TArrayD fBinSumw2
Definition: TProfile3D.h:41
TProfile3D::BufferFill
virtual Int_t BufferFill(Double_t, Double_t, Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile3D.h:46
TProfile3D::Fill
Int_t Fill(Double_t, Double_t, Double_t)
Increment cell defined by x,y,z by 1 .
Definition: TProfile3D.h:57
TProfile3D::Fill
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:60
TProfile3D::fErrorMode
EErrorType fErrorMode
Definition: TProfile3D.h:35
TProfile3D::Fill
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:61
TProfile3D::GetBinError
virtual Double_t GetBinError(Int_t bin) const
Return bin error of a Profile3D histogram.
Definition: TProfile3D.cxx:744
y
Double_t y[n]
Definition: legend1.C:17
TProfile3D::SetErrorOption
virtual void SetErrorOption(Option_t *option="")
Set option to compute profile3D errors.
Definition: TProfile3D.cxx:1364
TProfile3D
Profile3D histograms are used to display the mean value of T and its RMS for each cell in X,...
Definition: TProfile3D.h:27
TProfile3D::Fill
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:59
TH3.h
ymin
float ymin
Definition: THbookFile.cxx:95
TArrayD::Reset
void Reset()
Definition: TArrayD.h:47
TArrayD::fArray
Double_t * fArray
Definition: TArrayD.h:30
TProfile3D::GetBinEffectiveEntries
virtual Double_t GetBinEffectiveEntries(Int_t bin)
Return bin effective entries for a weighted filled Profile histogram.
Definition: TProfile3D.cxx:720
Double_t
double Double_t
Definition: RtypesCore.h:59
TProfile3D::operator=
TProfile3D & operator=(const TProfile3D &profile)
Definition: TProfile3D.cxx:162
TProfile3D::GetB2
Double_t * GetB2()
Definition: TProfile3D.h:74
TProfile3D::SetBinsLength
virtual void SetBinsLength(Int_t n=-1)
Set total number of bins including under/overflow.
Definition: TProfile3D.cxx:1317
EErrorType
EErrorType
Definition: TProfile.h:28
TProfile3D::GetBinSumw2
virtual TArrayD * GetBinSumw2()
Definition: TProfile3D.h:120
TH1::fSumw2
TArrayD fSumw2
Array of sum of squares of weights.
Definition: TH1.h:103
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:325
TH1
TH1 is the base class of all histogramm classes in ROOT.
Definition: TH1.h:58
TProfile3D::Fill
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH3.cxx:287
name
char name[80]
Definition: TGX11.cxx:110
TProfile3D::GetBinContent
virtual Double_t GetBinContent(Int_t, Int_t) const
Definition: TProfile3D.h:111
TProfileHelper
Definition: TProfileHelper.h:30
c2
return c2
Definition: legend2.C:14
TProfile3D::TProfile3D
TProfile3D()
Default constructor for Profile3D histograms.
Definition: TProfile3D.cxx:76
TProfile3D::Copy
virtual void Copy(TObject &hnew) const
Copy a Profile3D histogram to a new profile2D histogram.
Definition: TProfile3D.cxx:349
TProfile3D::GetTmax
virtual Double_t GetTmax() const
Definition: TProfile3D.h:125
TProfile3D::BufferEmpty
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition: TProfile3D.cxx:245
TCollection
Collection abstract base class.
Definition: TCollection.h:63
TProfile3D::SetBins
void SetBins(Int_t, const Double_t *)
Redefine x axis parameters with variable bin sizes.
Definition: TProfile3D.h:79
TProfile3D::Approximate
static void Approximate(Bool_t approx=kTRUE)
Set the fgApproximate flag.
Definition: TProfile3D.cxx:230
TF1
1-Dim function class
Definition: TF1.h:213
TArrayD
Array of doubles (64 bits per element).
Definition: TArrayD.h:27
TProfile3D::fTsumwt2
Double_t fTsumwt2
Definition: TProfile3D.h:40
TProfile3D::GetBinErrorSqUnchecked
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition: TProfile3D.h:67
TProfile3D::GetTmin
virtual Double_t GetTmin() const
Definition: TProfile3D.h:124
TProfile3D::Multiply
virtual Bool_t Multiply(TF1 *h1, Double_t c1=1)
Performs the operation: this = this*c1*f1 .
Definition: TProfile3D.cxx:901
TProfile3D::Sumw2
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...
Definition: TProfile3D.cxx:1378
TProfile3D::GetErrorOption
Option_t * GetErrorOption() const
Return option to compute profile2D errors.
Definition: TProfile3D.cxx:752
TProfile3D::fScaling
Bool_t fScaling
Definition: TProfile3D.h:38
TProfile3D::LabelsOption
virtual void LabelsOption(Option_t *option="h", Option_t *axis="X")
Set option(s) to draw axis with labels.
Definition: TProfile3D.cxx:874
TProfile3D::GetW
Double_t * GetW()
Definition: TProfile3D.h:75
int
c1
return c1
Definition: legend1.C:41
TProfile3D::fgApproximate
static Bool_t fgApproximate
Definition: TProfile3D.h:42