Logo ROOT  
Reference Guide
TProfile2D.h
Go to the documentation of this file.
1// @(#)root/hist:$Id$
2// Author: Rene Brun 16/04/2000
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_TProfile2D
13#define ROOT_TProfile2D
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TProfile2D //
19// //
20// Profile2D histogram class. //
21// //
22//////////////////////////////////////////////////////////////////////////
23
24#include "TH2.h"
25#include "TProfile.h"
26
27class TProfile2D : public TH2D {
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 fZmin; ///< Lower limit in Z (if set)
37 Double_t fZmax; ///< Upper limit in Z (if set)
38 Bool_t fScaling; ///<! True when TProfile2D::Scale is called
39 Double_t fTsumwz; ///< Total Sum of weight*Z
40 Double_t fTsumwz2; ///< Total Sum of weight*Z*Z
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
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 Int_t Fill(const Double_t* v) { return Fill(v[0], v[1], v[2], v[3]); };
52
53 virtual TProfile *DoProfile(bool onX, const char *name, Int_t firstbin, Int_t lastbin, Option_t *option) const;
54
55 using TH2::Fill;
56 Int_t Fill(Double_t, Double_t) {return TH2::Fill(0); } //MayNotUse
57
58 virtual Double_t RetrieveBinContent(Int_t bin) const { return (fBinEntries.fArray[bin] > 0) ? fArray[bin]/fBinEntries.fArray[bin] : 0; }
59 //virtual void UpdateBinContent(Int_t bin, Double_t content);
60 virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const { Double_t err = GetBinError(bin); return err*err; }
61
62private:
64 Double_t *GetB2() {return (fBinSumw2.fN ? &fBinSumw2.fArray[0] : 0 ); }
65 Double_t *GetW() {return &fArray[0];}
66 Double_t *GetW2() {return &fSumw2.fArray[0];}
68 { MayNotUse("SetBins(Int_t, Double_t, Double_t"); }
69 void SetBins(Int_t, const Double_t*)
70 { MayNotUse("SetBins(Int_t, const Double_t*"); }
72 { MayNotUse("SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t, Int_t, Double_t, Double_t"); }
73 void SetBins(Int_t, const Double_t *, Int_t, const Double_t *, Int_t, const Double_t *)
74 { MayNotUse("SetBins(Int_t, const Double_t*, Int_t, const Double_t*, Int_t, const Double_t*"); }
75
76public:
77 TProfile2D();
78 TProfile2D(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup
79 ,Int_t nbinsy,Double_t ylow,Double_t yup
80 ,Double_t zlow, Double_t zup,Option_t *option="");
81 TProfile2D(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup
82 ,Int_t nbinsy,Double_t ylow,Double_t yup,Option_t *option="");
83 TProfile2D(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins
84 ,Int_t nbinsy,Double_t ylow,Double_t yup,Option_t *option="");
85 TProfile2D(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup
86 ,Int_t nbinsy,const Double_t *ybins,Option_t *option="");
87 TProfile2D(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins
88 ,Int_t nbinsy,const Double_t *ybins,Option_t *option="");
89 TProfile2D(const TProfile2D &profile);
90 TProfile2D &operator=(const TProfile2D &profile);
91 virtual ~TProfile2D();
92 virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="");
93 virtual Bool_t Add(const TH1 *h1, Double_t c1=1);
94 virtual Bool_t Add(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1); // *MENU*
95 static void Approximate(Bool_t approx=kTRUE);
96 void BuildOptions(Double_t zmin, Double_t zmax, Option_t *option);
97 virtual Int_t BufferEmpty(Int_t action=0);
98 virtual void Copy(TObject &hnew) const;
99 virtual Bool_t Divide(TF1 *h1, Double_t c1=1);
100 virtual Bool_t Divide(const TH1 *h1);
101 virtual Bool_t Divide(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option=""); // *MENU*
102 virtual void ExtendAxis(Double_t x, TAxis *axis);
104 virtual Int_t Fill(Double_t x, const char *namey, Double_t z, Double_t w = 1.);
105 virtual Int_t Fill(const char *namex, Double_t y, Double_t z, Double_t w = 1.);
106 virtual Int_t Fill(const char *namex, const char *namey, Double_t z, Double_t w = 1.);
107 virtual Int_t Fill(Double_t x, Double_t y, Double_t z, Double_t w);
108 virtual Double_t GetBinContent(Int_t bin) const;
109 virtual Double_t GetBinContent(Int_t binx, Int_t biny) const {return GetBinContent(GetBin(binx,biny));}
110 virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t) const {return GetBinContent(GetBin(binx,biny));}
111 virtual Double_t GetBinError(Int_t bin) const;
112 virtual Double_t GetBinError(Int_t binx, Int_t biny) const {return GetBinError(GetBin(binx,biny));}
113 virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t) const {return GetBinError(GetBin(binx,biny));}
114 virtual Double_t GetBinEntries(Int_t bin) const;
116 virtual TArrayD *GetBinSumw2() {return &fBinSumw2;}
117 virtual const TArrayD *GetBinSumw2() const {return &fBinSumw2;}
118 Option_t *GetErrorOption() const;
119 virtual void GetStats(Double_t *stats) const;
120 virtual Double_t GetZmin() const {return fZmin;}
121 virtual Double_t GetZmax() const {return fZmax;}
122 virtual void LabelsDeflate(Option_t *axis="X");
123 virtual void LabelsInflate(Option_t *axis="X");
124 virtual void LabelsOption(Option_t *option="h", Option_t *axis="X");
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=""); // *MENU*
129 TH2D *ProjectionXY(const char *name="_pxy", Option_t *option="e") const;
130 TProfile *ProfileX(const char *name="_pfx", Int_t firstybin=0, Int_t lastybin=-1, Option_t *option="") const; // *MENU*
131 TProfile *ProfileY(const char *name="_pfy", Int_t firstxbin=0, Int_t lastxbin=-1, Option_t *option="") const; // *MENU*
132 virtual void PutStats(Double_t *stats);
133 virtual void Reset(Option_t *option="");
134 virtual TProfile2D *Rebin2D(Int_t nxgroup=2, Int_t nygroup=2, const char *newname="");
135 virtual TProfile2D *RebinX(Int_t ngroup=2, const char *newname="");
136 virtual TProfile2D *RebinY(Int_t ngroup=2, const char *newname="");
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, Int_t nbinsy, Double_t ymin, Double_t ymax);
141 virtual void SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t *yBins);
142 virtual void SetBinsLength(Int_t n=-1);
143 virtual void SetBuffer(Int_t buffersize, Option_t *option="");
144 virtual void SetErrorOption(Option_t *option=""); // *MENU*
145 virtual void Sumw2(Bool_t flag = kTRUE);
147
148 ClassDef(TProfile2D,8) //Profile2D histogram class
149};
150
151#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
Int_t GetSize() const
Definition: TArray.h:47
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
2-D histogram with a double per channel (see TH1 documentation)}
Definition: TH2.h:292
Int_t Fill(Double_t)
Invalid Fill method.
Definition: TH2.cxx:358
virtual Int_t GetBin(Int_t binx, Int_t biny, Int_t binz=0) const
Return Global bin number corresponding to binx,y,z.
Definition: TH2.cxx:1049
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
virtual Double_t GetBinError(Int_t bin) const
Return bin error of a Profile2D histogram.
Definition: TProfile2D.cxx:880
virtual TProfile2D * RebinX(Int_t ngroup=2, const char *newname="")
Rebin only the X axis.
virtual ~TProfile2D()
Default destructor for Profile2D histograms.
Definition: TProfile2D.cxx:98
Double_t fTsumwz
Total Sum of weight*Z.
Definition: TProfile2D.h:39
void SetBins(Int_t, Double_t, Double_t)
Redefine x axis parameters.
Definition: TProfile2D.h:67
virtual void GetStats(Double_t *stats) const
Fill the array stats from the contents of this profile.
Definition: TProfile2D.cxx:915
Int_t Fill(const Double_t *v)
Definition: TProfile2D.h:51
virtual Double_t GetBinContent(Int_t binx, Int_t biny) const
Definition: TProfile2D.h:109
TH2D * ProjectionXY(const char *name="_pxy", Option_t *option="e") const
Project this profile2D into a 2-D histogram along X,Y.
virtual Bool_t Divide(TF1 *h1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) .
Definition: TProfile2D.cxx:414
virtual Double_t GetBinError(Int_t binx, Int_t biny) const
Definition: TProfile2D.h:112
virtual Double_t GetBinContent(Int_t binx, Int_t biny, Int_t) const
Definition: TProfile2D.h:110
static void Approximate(Bool_t approx=kTRUE)
Static function, set the fgApproximate flag.
Definition: TProfile2D.cxx:276
virtual const TArrayD * GetBinSumw2() const
Definition: TProfile2D.h:117
EErrorType fErrorMode
Option to compute errors.
Definition: TProfile2D.h:35
Double_t fZmin
Lower limit in Z (if set)
Definition: TProfile2D.h:36
virtual Double_t GetBinError(Int_t binx, Int_t biny, Int_t) const
Definition: TProfile2D.h:113
Double_t * GetW2()
Definition: TProfile2D.h:66
virtual void SetBuffer(Int_t buffersize, Option_t *option="")
Set the buffer size in units of 8 bytes (double).
virtual void Copy(TObject &hnew) const
Copy a Profile2D histogram to a new profile2D histogram.
Definition: TProfile2D.cxx:385
Bool_t fScaling
! True when TProfile2D::Scale is called
Definition: TProfile2D.h:38
virtual Double_t GetBinEffectiveEntries(Int_t bin)
Return bin effective entries for a weighted filled Profile histogram.
Definition: TProfile2D.cxx:857
Option_t * GetErrorOption() const
Return option to compute profile2D errors.
Definition: TProfile2D.cxx:888
TArrayD fBinSumw2
Array of sum of squares of weights per bin.
Definition: TProfile2D.h:41
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this profile2D by a constant c1.
virtual TProfile * DoProfile(bool onX, const char *name, Int_t firstbin, Int_t lastbin, Option_t *option) const
Implementation of ProfileX or ProfileY for a TProfile2D.
virtual Int_t BufferFill(Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile2D.h:44
virtual void LabelsDeflate(Option_t *axis="X")
Reduce the number of bins for this axis to the number of bins having a label.
Definition: TProfile2D.cxx:979
Double_t * GetB2()
Definition: TProfile2D.h:64
TProfile * ProfileY(const char *name="_pfy", Int_t firstxbin=0, Int_t lastxbin=-1, Option_t *option="") const
Project a 2-D histogram into a profile histogram along X.
virtual Double_t GetBinContent(Int_t bin) const
Return bin content of a Profile2D histogram.
Definition: TProfile2D.cxx:828
void SetBins(Int_t, const Double_t *)
Redefine x axis parameters with variable bin sizes.
Definition: TProfile2D.h:69
Double_t * GetW()
Definition: TProfile2D.h:65
virtual void SetBinEntries(Int_t bin, Double_t w)
Set the number of entries in bin.
TProfile * ProfileX(const char *name="_pfx", Int_t firstybin=0, Int_t lastybin=-1, Option_t *option="") const
Project a 2-D histogram into a profile histogram along X.
TProfile2D()
Default constructor for Profile2D histograms.
Definition: TProfile2D.cxx:88
Int_t Fill(Double_t, Double_t)
Increment cell defined by x,y by 1.
Definition: TProfile2D.h:56
TArrayD fBinEntries
Number of entries per bin.
Definition: TProfile2D.h:34
void SetBins(const Int_t *nbins, const Double_t *range)
Definition: TProfile2D.h:49
virtual void Sumw2(Bool_t flag=kTRUE)
Create/Delete structure to store sum of squares of weights per bin.
virtual Bool_t Multiply(TF1 *h1, Double_t c1=1)
Performs the operation: this = this*c1*f1.
virtual Int_t BufferFill(Double_t, Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile2D.h:45
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition: TProfile2D.cxx:989
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
static Bool_t fgApproximate
Bin error approximation option.
Definition: TProfile2D.h:42
virtual Double_t GetBinEntries(Int_t bin) const
Return bin entries of a Profile2D histogram.
Definition: TProfile2D.cxx:841
virtual Long64_t Merge(TCollection *list)
Merge all histograms in the collection in this histogram.
virtual void ExtendAxis(Double_t x, TAxis *axis)
Profile histogram is resized along axis such that x is in the axis range.
virtual TProfile2D * Rebin2D(Int_t nxgroup=2, Int_t nygroup=2, const char *newname="")
Rebin this histogram grouping nxgroup/nygroup bins along the xaxis/yaxis together.
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition: TProfile2D.cxx:290
virtual TProfile2D * RebinY(Int_t ngroup=2, const char *newname="")
Rebin only the Y axis.
Double_t fZmax
Upper limit in Z (if set)
Definition: TProfile2D.h:37
void BuildOptions(Double_t zmin, Double_t zmax, Option_t *option)
Set Profile2D histogram structure and options.
Definition: TProfile2D.cxx:189
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1 .
Definition: TProfile2D.cxx:220
TProfile2D & operator=(const TProfile2D &profile)
Definition: TProfile2D.cxx:211
Double_t fTsumwz2
Total Sum of weight*Z*Z.
Definition: TProfile2D.h:40
void SetBins(Int_t, const Double_t *, Int_t, const Double_t *, Int_t, const Double_t *)
Redefine x, y and z axis parameters with variable bin sizes.
Definition: TProfile2D.h:73
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition: TProfile2D.h:60
virtual TArrayD * GetBinSumw2()
Definition: TProfile2D.h:116
void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
Redefine x, y and z axis parameters.
Definition: TProfile2D.h:71
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: TProfile2D.h:58
Double_t GetNumberOfBins()
Definition: TProfile2D.h:146
Double_t * GetB()
Definition: TProfile2D.h:63
virtual void SetErrorOption(Option_t *option="")
Set option to compute profile2D errors.
virtual void LabelsOption(Option_t *option="h", Option_t *axis="X")
Set option(s) to draw axis with labels.
virtual Double_t GetZmax() const
Definition: TProfile2D.h:121
virtual void SetBinsLength(Int_t n=-1)
Set total number of bins including under/overflow.
virtual Double_t GetZmin() const
Definition: TProfile2D.h:120
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Profile Histogram.
Definition: TProfile.h:32
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]