Logo ROOT   6.08/07
Reference Guide
TProfile.h
Go to the documentation of this file.
1 // @(#)root/hist:$Id$
2 // Author: Rene Brun 29/09/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 
12 #ifndef ROOT_TProfile
13 #define ROOT_TProfile
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TProfile //
19 // //
20 // Profile histogram class. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
23 
24 #ifndef ROOT_TH1
25 #include "TH1.h"
26 #endif
27 
28 class TProfileHelper;
29 
31 
32 class TF1;
33 
34 class TProfile : public TH1D {
35 
36 public:
37  friend class TProfileHelper;
38 
39 protected:
40  TArrayD fBinEntries; //number of entries per bin
41  EErrorType fErrorMode; //Option to compute errors
42  Double_t fYmin; //Lower limit in Y (if set)
43  Double_t fYmax; //Upper limit in Y (if set)
44  Bool_t fScaling; //!True when TProfile::Scale is called
45  Double_t fTsumwy; //Total Sum of weight*Y
46  Double_t fTsumwy2; //Total Sum of weight*Y*Y
47  TArrayD fBinSumw2; //Array of sum of squares of weights per bin
48 
49 static Bool_t fgApproximate; //bin error approximation option
50 
51  virtual Int_t BufferFill(Double_t, Double_t) {return -2;} //may not use
53 
54  // helper methods for the Merge unification in TProfileHelper
55  void SetBins(const Int_t* nbins, const Double_t* range) { SetBins(nbins[0], range[0], range[1]); };
56  Int_t Fill(const Double_t* v) { return Fill(v[0], v[1], v[2]); };
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 
62 private:
63  Int_t Fill(Double_t) { MayNotUse("Fill(Double_t)"); return -1;}
64  void FillN(Int_t, const Double_t *, const Double_t *, Int_t) { MayNotUse("FillN(Int_t, Double_t*, Double_t*, Int_t)"); }
65  Double_t *GetB() {return &fBinEntries.fArray[0];}
66  Double_t *GetB2() {return (fBinSumw2.fN ? &fBinSumw2.fArray[0] : 0 ); }
67  Double_t *GetW() {return &fArray[0];}
68  Double_t *GetW2() {return &fSumw2.fArray[0];}
70  { MayNotUse("SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t"); }
71  void SetBins(Int_t, const Double_t*, Int_t, const Double_t*)
72  { MayNotUse("SetBins(Int_t, const Double_t*, Int_t, const Double_t*"); }
74  { MayNotUse("SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t, Int_t, Double_t, Double_t"); }
75  void SetBins(Int_t, const Double_t *, Int_t, const Double_t *, Int_t, const Double_t *)
76  { MayNotUse("SetBins(Int_t, const Double_t*, Int_t, const Double_t*, Int_t, const Double_t*"); }
77 
78 public:
79  TProfile();
80  TProfile(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup, Option_t *option="");
81  TProfile(const char *name,const char *title,Int_t nbinsx,Double_t xlow,Double_t xup,Double_t ylow,Double_t yup,Option_t *option="");
82  TProfile(const char *name,const char *title,Int_t nbinsx,const Float_t *xbins, Option_t *option="");
83  TProfile(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins, Option_t *option="");
84  TProfile(const char *name,const char *title,Int_t nbinsx,const Double_t *xbins, Double_t ylow,Double_t yup, Option_t *option="");
85  TProfile(const TProfile &profile);
86  virtual ~TProfile();
87  virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="");
88  virtual Bool_t Add(const TH1 *h1, Double_t c1=1);
89  virtual Bool_t Add(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1); // *MENU*
90  static void Approximate(Bool_t approx=kTRUE);
91  virtual Int_t BufferEmpty(Int_t action=0);
93  virtual void Copy(TObject &hnew) const;
94  virtual Bool_t Divide(TF1 *h1, Double_t c1=1);
95  virtual Bool_t Divide(const TH1 *h1);
96  virtual Bool_t Divide(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option=""); // *MENU*
97  virtual void ExtendAxis(Double_t x, TAxis *axis);
98  virtual Int_t Fill(Double_t x, Double_t y);
99  virtual Int_t Fill(const char *namex, Double_t y);
100  virtual Int_t Fill(Double_t x, Double_t y, Double_t w);
101  virtual Int_t Fill(const char *namex, Double_t y, Double_t w);
102  virtual void FillN(Int_t ntimes, const Double_t *x, const Double_t *y, const Double_t *w, Int_t stride=1);
103  virtual Double_t GetBinContent(Int_t bin) const;
104  virtual Double_t GetBinContent(Int_t bin, Int_t) const {return GetBinContent(bin);}
105  virtual Double_t GetBinContent(Int_t bin, Int_t, Int_t) const {return GetBinContent(bin);}
106  virtual Double_t GetBinError(Int_t bin) const;
107  virtual Double_t GetBinError(Int_t bin, Int_t) const {return GetBinError(bin);}
108  virtual Double_t GetBinError(Int_t bin, Int_t, Int_t) const {return GetBinError(bin);}
109  virtual Double_t GetBinEntries(Int_t bin) const;
110  virtual Double_t GetBinEffectiveEntries(Int_t bin) const;
111  virtual TArrayD *GetBinSumw2() {return &fBinSumw2;}
112  virtual const TArrayD *GetBinSumw2() const {return &fBinSumw2;}
113  Option_t *GetErrorOption() const;
114  virtual void GetStats(Double_t *stats) const;
115  virtual Double_t GetYmin() const {return fYmin;}
116  virtual Double_t GetYmax() const {return fYmax;}
117  virtual void LabelsDeflate(Option_t *axis="X");
118  virtual void LabelsInflate(Option_t *axis="X");
119  virtual void LabelsOption(Option_t *option="h", Option_t *axis="X");
120  virtual Long64_t Merge(TCollection *list);
121  virtual Bool_t Multiply(TF1 *h1, Double_t c1=1);
122  virtual Bool_t Multiply(const TH1 *h1);
123  virtual Bool_t Multiply(const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option=""); // *MENU*
124  TH1D *ProjectionX(const char *name="_px", Option_t *option="e") const;
125  virtual void PutStats(Double_t *stats);
126  TH1 *Rebin(Int_t ngroup=2, const char*newname="", const Double_t *xbins=0);
127  virtual void Reset(Option_t *option="");
128  virtual void SavePrimitive(std::ostream &out, Option_t *option = "");
129  virtual void Scale(Double_t c1=1, Option_t *option="");
130  virtual void SetBinEntries(Int_t bin, Double_t w);
131  virtual void SetBins(Int_t nbins, Double_t xmin, Double_t xmax);
132  virtual void SetBins(Int_t nx, const Double_t *xbins);
133  virtual void SetBinsLength(Int_t n=-1);
134  virtual void SetBuffer(Int_t buffersize, Option_t *option="");
135  virtual void SetErrorOption(Option_t *option=""); // *MENU*
136  virtual void Sumw2(Bool_t flag = kTRUE);
137 
138  ClassDef(TProfile,6) //Profile histogram class
139 };
140 
141 #endif
142 
const int nx
Definition: kalman.C:16
Double_t fYmin
Definition: TProfile.h:42
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this profile by a constant c1.
Definition: TProfile.cxx:1597
float xmin
Definition: THbookFile.cxx:93
long long Long64_t
Definition: RtypesCore.h:69
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: TProfile.h:58
TProfile()
Default constructor for Profile histograms.
Definition: TProfile.cxx:82
virtual void LabelsOption(Option_t *option="h", Option_t *axis="X")
Set option(s) to draw axis with labels option = "a" sort by alphabetic order = ">" sort by decreasing...
Definition: TProfile.cxx:965
Double_t * GetW()
Definition: TProfile.h:67
float Float_t
Definition: RtypesCore.h:53
Option_t * GetErrorOption() const
Return option to compute profile errors.
Definition: TProfile.cxx:869
const char Option_t
Definition: RtypesCore.h:62
return c1
Definition: legend1.C:41
void Reset()
Definition: TArrayD.h:49
float ymin
Definition: THbookFile.cxx:93
Double_t * GetW2()
Definition: TProfile.h:68
Double_t fYmax
Definition: TProfile.h:43
TArrayD fBinEntries
Definition: TProfile.h:40
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual Double_t GetBinError(Int_t bin, Int_t) const
Definition: TProfile.h:107
int nbins[3]
TArrayD fSumw2
Array of sum of squares of weights.
Definition: TH1.h:118
virtual const TArrayD * GetBinSumw2() const
Definition: TProfile.h:112
Profile Historam.
Definition: TProfile.h:34
EErrorType
Definition: TProfile.h:30
virtual Double_t GetBinError(Int_t bin, Int_t, Int_t) const
Definition: TProfile.h:108
static Bool_t fgApproximate
Definition: TProfile.h:49
Double_t x[n]
Definition: legend1.C:17
virtual Double_t GetBinEntries(Int_t bin) const
Return bin entries of a Profile histogram.
Definition: TProfile.cxx:809
virtual Bool_t Multiply(TF1 *h1, Double_t c1=1)
Performs the operation: this = this*c1*f1.
Definition: TProfile.cxx:1113
#define ClassDef(name, id)
Definition: Rtypes.h:254
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition: TProfile.cxx:950
virtual Long64_t Merge(TCollection *list)
Merge all histograms in the collection in this histogram.
Definition: TProfile.cxx:1102
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition: TProfile.cxx:313
virtual void GetStats(Double_t *stats) const
fill the array stats from the contents of this profile The array stats must be correctly dimensionned...
Definition: TProfile.cxx:892
virtual TArrayD * GetBinSumw2()
Definition: TProfile.h:111
virtual Int_t BufferFill(Double_t, Double_t)
accumulate arguments in buffer.
Definition: TProfile.h:51
void BuildOptions(Double_t ymin, Double_t ymax, Option_t *option)
Set Profile histogram structure and options.
Definition: TProfile.cxx:200
Double_t * fArray
Definition: TArrayD.h:32
virtual Double_t GetBinContent(Int_t bin) const
Return bin content of a Profile histogram.
Definition: TProfile.cxx:796
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:978
TArrayD fBinSumw2
Definition: TProfile.h:47
TH1F * h1
Definition: legend1.C:5
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition: TProfile.h:60
virtual Double_t GetBinError(Int_t bin) const
Return bin error of a Profile histogram.
Definition: TProfile.cxx:861
virtual Double_t GetBinContent(Int_t bin, Int_t, Int_t) const
Definition: TProfile.h:105
Int_t fN
Definition: TArray.h:40
float ymax
Definition: THbookFile.cxx:93
Class to manage histogram axis.
Definition: TAxis.h:36
Int_t Fill(Double_t)
Increment bin with abscissa X by 1.
Definition: TProfile.h:63
SVector< double, 2 > v
Definition: Dict.h:5
virtual void SetBinsLength(Int_t n=-1)
Set total number of bins including under/overflow Reallocate bin contents array.
Definition: TProfile.cxx:1634
Collection abstract base class.
Definition: TCollection.h:48
virtual void Copy(TObject &hnew) const
Copy a Profile histogram to a new profile histogram.
Definition: TProfile.cxx:397
Double_t fTsumwy2
Definition: TProfile.h:46
void SetBins(Int_t, const Double_t *, Int_t, const Double_t *)
Redefine x and y axis parameters with variable bin sizes.
Definition: TProfile.h:71
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
Definition: TProfile.cxx:1269
Int_t Fill(const Double_t *v)
Definition: TProfile.h:56
float xmax
Definition: THbookFile.cxx:93
Double_t * GetB2()
Definition: TProfile.h:66
tomato 1-D histogram with a double per channel (see TH1 documentation)}
Definition: TH1.h:618
TH1D * ProjectionX(const char *name="_px", Option_t *option="e") const
Project this profile into a 1-D histogram along X.
Definition: TProfile.cxx:1194
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: TProfile.h:73
virtual void SavePrimitive(std::ostream &out, Option_t *option="")
Save primitive as a C++ statement(s) on output stream out.
Definition: TProfile.cxx:1516
return c2
Definition: legend2.C:14
virtual Bool_t Divide(TF1 *h1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) This function is not implemented for the TProfile...
Definition: TProfile.cxx:427
double Double_t
Definition: RtypesCore.h:55
Double_t fTsumwy
True when TProfile::Scale is called.
Definition: TProfile.h:45
virtual Double_t GetYmax() const
Definition: TProfile.h:116
Double_t y[n]
Definition: legend1.C:17
The TH1 histogram class.
Definition: TH1.h:80
Array of doubles (64 bits per element).
Definition: TArrayD.h:29
void SetBins(const Int_t *nbins, const Double_t *range)
Definition: TProfile.h:55
Mother of all ROOT objects.
Definition: TObject.h:37
virtual void SetBinEntries(Int_t bin, Double_t w)
Set the number of entries in bin.
Definition: TProfile.cxx:1605
virtual Double_t GetYmin() const
Definition: TProfile.h:115
virtual void SetBuffer(Int_t buffersize, Option_t *option="")
set the buffer size in units of 8 bytes (double)
Definition: TProfile.cxx:1643
void FillN(Int_t, const Double_t *, const Double_t *, Int_t)
Fill this histogram with an array x and weights w.
Definition: TProfile.h:64
void SetBins(Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
Redefine x and y axis parameters.
Definition: TProfile.h:69
virtual ~TProfile()
Default destructor for Profile histograms.
Definition: TProfile.cxx:91
1-Dim function class
Definition: TF1.h:149
virtual void ExtendAxis(Double_t x, TAxis *axis)
Profile histogram is resized along x axis such that x is in the axis range.
Definition: TProfile.cxx:1487
static void Approximate(Bool_t approx=kTRUE)
static function set the fgApproximate flag.
Definition: TProfile.cxx:300
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1.
Definition: TProfile.cxx:241
EErrorType fErrorMode
Definition: TProfile.h:41
virtual Double_t GetBinEffectiveEntries(Int_t bin) const
Return bin effective entries for a weighted filled Profile histogram.
Definition: TProfile.cxx:827
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 c...
Definition: TProfile.cxx:1730
Double_t * GetB()
Definition: TProfile.h:65
const Bool_t kTRUE
Definition: Rtypes.h:91
const Int_t n
Definition: legend1.C:16
virtual void SetErrorOption(Option_t *option="")
Set option to compute profile errors.
Definition: TProfile.cxx:1682
char name[80]
Definition: TGX11.cxx:109
virtual void LabelsDeflate(Option_t *axis="X")
Reduce the number of bins for this axis to the number of bins having a label.
Definition: TProfile.cxx:940
Bool_t fScaling
Definition: TProfile.h:44
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: TProfile.h:75
TH1 * Rebin(Int_t ngroup=2, const char *newname="", const Double_t *xbins=0)
Rebin this profile grouping ngroup bins together case 1 xbins=0if newname is not blank a new temporar...
Definition: TProfile.cxx:1315
virtual Double_t GetBinContent(Int_t bin, Int_t) const
Definition: TProfile.h:104