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
27class TProfile3D : public TH3D {
28
29public:
30 friend class TProfileHelper;
31 friend class TH1Merger;
32
33protected:
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
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
72private:
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];}
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*"); }
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
86public:
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);
110 virtual Double_t GetBinContent(Int_t bin) 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;
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;
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,
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
int Int_t
Definition: RtypesCore.h:45
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
long long Long64_t
Definition: RtypesCore.h:80
const Bool_t kTRUE
Definition: RtypesCore.h:100
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
EErrorType
Definition: TProfile.h:28
Array of doubles (64 bits per element).
Definition: TArrayD.h:27
Double_t * fArray
Definition: TArrayD.h:30
void Reset()
Definition: TArrayD.h:47
Int_t fN
Definition: TArray.h:38
Class to manage histogram axis.
Definition: TAxis.h:30
Collection abstract base class.
Definition: TCollection.h:65
1-Dim function class
Definition: TF1.h:213
TH1 is the base class of all histogram classes in ROOT.
Definition: TH1.h:58
TArrayD fSumw2
Array of sum of squares of weights.
Definition: TH1.h:103
3-D histogram with a double per channel (see TH1 documentation)}
Definition: TH3.h:305
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH3.cxx:337
virtual Int_t GetBin(Int_t binx, Int_t biny, Int_t binz) const
See comments in TH1::GetBin.
Definition: TH3.cxx:1075
Mother of all ROOT objects.
Definition: TObject.h:37
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:946
Profile2D histograms are used to display the mean value of Z and its error for each cell in X,...
Definition: TProfile2D.h:27
Profile3D histograms are used to display the mean value of T and its RMS for each cell in X,...
Definition: TProfile3D.h:27
TProfile3D & operator=(const TProfile3D &profile)
Definition: TProfile3D.cxx:162
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
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.
Double_t * GetW()
Definition: TProfile3D.h:75
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...
virtual void ExtendAxis(Double_t x, TAxis *axis)
Profile histogram is resized along axis such that x is in the axis range.
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
static Bool_t fgApproximate
Bin error approximation option.
Definition: TProfile3D.h:42
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
virtual void SetBuffer(Int_t buffersize, Option_t *opt="")
Set the buffer size in units of 8 bytes (double).
void SetBins(Int_t, Double_t, Double_t)
Redefine x axis parameters.
Definition: TProfile3D.h:77
virtual Double_t GetBinError(Int_t, Int_t) const
Definition: TProfile3D.h:115
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition: TProfile3D.cxx:245
virtual Long64_t Merge(TCollection *list)
Merge all histograms in the collection in this histogram.
Definition: TProfile3D.cxx:893
Option_t * GetErrorOption() const
Return option to compute profile2D errors.
Definition: TProfile3D.cxx:752
Bool_t fScaling
! True when TProfile3D::Scale is called
Definition: TProfile3D.h:38
void SetBins(const Int_t *nbins, const Double_t *range)
Definition: TProfile3D.h:50
virtual Double_t GetBinError(Int_t bin) const
Return bin error of a Profile3D histogram.
Definition: TProfile3D.cxx:744
virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:117
void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
Redefine x and y axis parameters.
Definition: TProfile3D.h:81
Double_t fTsumwt2
Total Sum of weight*T*T.
Definition: TProfile3D.h:40
virtual Double_t GetBinEffectiveEntries(Int_t bin)
Return bin effective entries for a weighted filled Profile histogram.
Definition: TProfile3D.cxx:720
virtual Double_t GetBinContent(Int_t, Int_t) const
Definition: TProfile3D.h:111
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
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1 .
Definition: TProfile3D.cxx:171
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
virtual void GetStats(Double_t *stats) const
fill the array stats from the contents of this profile.
Definition: TProfile3D.cxx:784
TProfile3D()
Default constructor for Profile3D histograms.
Definition: TProfile3D.cxx:76
virtual TArrayD * GetBinSumw2()
Definition: TProfile3D.h:120
TArrayD fBinEntries
Number of entries per bin.
Definition: TProfile3D.h:34
virtual Double_t GetBinContent(Int_t bin) const
Return bin content of a Profile3D histogram.
Definition: TProfile3D.cxx:690
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition: TProfile3D.h:67
virtual Int_t BufferFill(Double_t, Double_t, Double_t)
Definition: TProfile3D.h:45
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this profile2D by a constant c1.
virtual Bool_t Multiply(TF1 *h1, Double_t c1=1)
Performs the operation: this = this*c1*f1 .
Definition: TProfile3D.cxx:901
Double_t fTmin
Lower limit in T (if set)
Definition: TProfile3D.h:36
void SetBins(Int_t, const Double_t *)
Redefine x axis parameters with variable bin sizes.
Definition: TProfile3D.h:79
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Int_t Fill(Double_t, Double_t, Double_t)
Increment cell defined by x,y,z by 1 .
Definition: TProfile3D.h:57
virtual TProfile2D * Project3DProfile(Option_t *option="xy") const
Project a 3-D profile into a 2D-profile histogram depending on the option parameter.
virtual void SetBinEntries(Int_t bin, Double_t w)
Set the number of entries in bin.
virtual void Copy(TObject &hnew) const
Copy a Profile3D histogram to a new profile2D histogram.
Definition: TProfile3D.cxx:349
void BuildOptions(Double_t tmin, Double_t tmax, Option_t *option)
Set Profile3D histogram structure and options.
Definition: TProfile3D.cxx:141
Int_t Fill(const Double_t *v)
Definition: TProfile3D.h:53
TArrayD fBinSumw2
Array of sum of squares of weights per bin.
Definition: TProfile3D.h:41
Double_t * GetB()
Definition: TProfile3D.h:73
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
virtual Double_t GetTmax() const
Definition: TProfile3D.h:125
virtual void SetErrorOption(Option_t *option="")
Set option to compute profile3D errors.
virtual Bool_t Divide(TF1 *h1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) .
Definition: TProfile3D.cxx:378
virtual ~TProfile3D()
Default destructor for Profile3D histograms.
Definition: TProfile3D.cxx:86
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
Double_t * GetB2()
Definition: TProfile3D.h:74
virtual Int_t BufferFill(Double_t, Double_t, Double_t, Double_t)
Accumulate arguments in buffer.
Definition: TProfile3D.h:46
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition: TProfile3D.cxx:856
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
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
EErrorType fErrorMode
Option to compute errors.
Definition: TProfile3D.h:35
virtual const TArrayD * GetBinSumw2() const
Definition: TProfile3D.h:121
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
virtual Int_t BufferFill(Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile3D.h:44
virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t binz) const
Definition: TProfile3D.h:113
virtual Double_t GetBinEntries(Int_t bin) const
Return bin entries of a Profile3D histogram.
Definition: TProfile3D.cxx:703
virtual Double_t GetTmin() const
Definition: TProfile3D.h:124
Double_t * GetW2()
Definition: TProfile3D.h:76
virtual void SetBinsLength(Int_t n=-1)
Set total number of bins including under/overflow.
Double_t fTsumwt
Total Sum of weight*T.
Definition: TProfile3D.h:39
virtual void LabelsOption(Option_t *option="h", Option_t *axis="X")
Set option(s) to draw axis with labels.
Definition: TProfile3D.cxx:874
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
static void Approximate(Bool_t approx=kTRUE)
Set the fgApproximate flag.
Definition: TProfile3D.cxx:230
Double_t fTmax
Upper limit in T (if set)
Definition: TProfile3D.h:37
return c1
Definition: legend1.C:41
Double_t y[n]
Definition: legend1.C:17
Double_t x[n]
Definition: legend1.C:17
const Int_t n
Definition: legend1.C:16
TH1F * h1
Definition: legend1.C:5
return c2
Definition: legend2.C:14
const double xbins[xbins_n]