Logo ROOT   master
Reference Guide
TProfile Class Reference

Profile Histogram.

Profile histograms are used to display the mean value of Y and its error for each bin in X. The displayed error is by default the standard error on the mean (i.e. the standard deviation divided by the sqrt(n) ). Profile histograms are in many cases an elegant replacement of two-dimensional histograms. The inter-relation of two measured quantities X and Y can always be visualized by a two-dimensional histogram or scatter plot, but if Y is an unknown (but single-valued) approximate function of X, this function is displayed by a profile histogram with much better precision than by a scatter plot.

The following formulae show the cumulated contents (capital letters) and the values displayed by the printing or plotting routines (small letters) of the elements for bin j.

\[ \begin{align} H(j) &= \sum w \cdot Y \\ E(j) &= \sum w \cdot Y^2 \\ W(j) &= \sum w \\ h(j) &= H(j) / W(j) & &\text{mean of Y,} \\ s(j) &= \sqrt{E(j)/W(j)- h(j)^2} & &\text{standard deviation of Y} \\ e(j) &= s(j)/\sqrt{W(j)} & &\text{standard error on the mean} \\ \end{align} \]

The bin content is always the mean of the Y values, but errors change depending on options:

\[ \begin{align} \text{GetBinContent}(j) &= h(j) \\ \text{GetBinError}(j) &= \begin{cases} e(j) &\text{if option="" (default). Error of the mean of all y values.} \\ s(j) &\text{if option="s". Standard deviation of all y values.} \\ \begin{cases} e(j) &\text{if } h(j) \ne 0 \\ 1/\sqrt{12 N} &\text{if } h(j)=0 \end{cases} &\text{if option="i". This is useful for storing integers such as ADC counts.} \\ 1/\sqrt{W(j)} &\text{if option="g". Error of a weighted mean for combining measurements with variances of } w. \\ \end{cases} \end{align} \]

In the special case where s(j) is zero (eg, case of 1 entry only in one bin) the bin error e(j) is computed from the average of the s(j) for all bins if the static function TProfile::Approximate() has been called. This simple/crude approximation was suggested in order to keep the bin during a fit operation. But note that this approximation is not the default behaviour. See also TProfile::BuildOptions for more on error options.

Creating and drawing a profile histogram

{
auto c1 = new TCanvas("c1","Profile histogram example",200,10,700,500);
auto hprof = new TProfile("hprof","Profile of pz versus px",100,-4,4,0,20);
Float_t px, py, pz;
for ( Int_t i=0; i<25000; i++) {
gRandom->Rannor(px,py);
pz = px*px + py*py;
hprof->Fill(px,pz,1);
}
hprof->Draw();
}

Definition at line 32 of file TProfile.h.

Public Member Functions

 TProfile ()
 Default constructor for Profile histograms. More...
 
 TProfile (const char *name, const char *title, Int_t nbinsx, Double_t xlow, Double_t xup, Option_t *option="")
 Normal Constructor for Profile histograms. More...
 
 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="")
 Constructor for Profile histograms with range in y. More...
 
 TProfile (const char *name, const char *title, Int_t nbinsx, const Float_t *xbins, Option_t *option="")
 Constructor for Profile histograms with variable bin size. More...
 
 TProfile (const char *name, const char *title, Int_t nbinsx, const Double_t *xbins, Option_t *option="")
 Constructor for Profile histograms with variable bin size. More...
 
 TProfile (const char *name, const char *title, Int_t nbinsx, const Double_t *xbins, Double_t ylow, Double_t yup, Option_t *option="")
 Constructor for Profile histograms with variable bin size. More...
 
 TProfile (const TProfile &profile)
 Copy constructor. More...
 
virtual ~TProfile ()
 Default destructor for Profile histograms. More...
 
virtual Bool_t Add (TF1 *h1, Double_t c1=1, Option_t *option="")
 Performs the operation: this = this + c1*f1. More...
 
virtual Bool_t Add (const TH1 *h1, Double_t c1=1)
 Performs the operation: this = this + c1*h1. More...
 
virtual Bool_t Add (const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1)
 Replace contents of this profile by the addition of h1 and h2. More...
 
virtual Int_t BufferEmpty (Int_t action=0)
 Fill histogram with all entries in the buffer. More...
 
void BuildOptions (Double_t ymin, Double_t ymax, Option_t *option)
 Set Profile histogram structure and options. More...
 
virtual void Copy (TObject &hnew) const
 Copy a Profile histogram to a new profile histogram. More...
 
virtual Bool_t Divide (TF1 *h1, Double_t c1=1)
 Performs the operation: this = this/(c1*f1). More...
 
virtual Bool_t Divide (const TH1 *h1)
 Divide this profile by h1. More...
 
virtual Bool_t Divide (const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="")
 Replace contents of this profile by the division of h1 by h2. More...
 
virtual void ExtendAxis (Double_t x, TAxis *axis)
 Profile histogram is resized along x axis such that x is in the axis range. More...
 
virtual Int_t Fill (Double_t x, Double_t y)
 Fill a Profile histogram (no weights). More...
 
virtual Int_t Fill (const char *namex, Double_t y)
 Fill a Profile histogram (no weights). More...
 
virtual Int_t Fill (Double_t x, Double_t y, Double_t w)
 Fill a Profile histogram with weights. More...
 
virtual Int_t Fill (const char *namex, Double_t y, Double_t w)
 Fill a Profile histogram with weights. More...
 
virtual void FillN (Int_t ntimes, const Double_t *x, const Double_t *y, const Double_t *w, Int_t stride=1)
 Fill a Profile histogram with weights. More...
 
virtual Double_t GetBinContent (Int_t bin) const
 Return bin content of a Profile histogram. More...
 
virtual Double_t GetBinContent (Int_t bin, Int_t) const
 
virtual Double_t GetBinContent (Int_t bin, Int_t, Int_t) const
 
virtual Double_t GetBinEffectiveEntries (Int_t bin) const
 Return bin effective entries for a weighted filled Profile histogram. More...
 
virtual Double_t GetBinEntries (Int_t bin) const
 Return bin entries of a Profile histogram. More...
 
virtual Double_t GetBinError (Int_t bin) const
 Return bin error of a Profile histogram. More...
 
virtual Double_t GetBinError (Int_t bin, Int_t) const
 
virtual Double_t GetBinError (Int_t bin, Int_t, Int_t) const
 
virtual TArrayDGetBinSumw2 ()
 
virtual const TArrayDGetBinSumw2 () const
 
Option_tGetErrorOption () const
 Return option to compute profile errors. More...
 
virtual void GetStats (Double_t *stats) const
 fill the array stats from the contents of this profile. More...
 
virtual Double_t GetYmax () const
 
virtual Double_t GetYmin () const
 
virtual void LabelsDeflate (Option_t *axis="X")
 Reduce the number of bins for this axis to the number of bins having a label. More...
 
virtual void LabelsInflate (Option_t *axis="X")
 Double the number of bins for axis. More...
 
virtual void LabelsOption (Option_t *option="h", Option_t *axis="X")
 Set option(s) to draw axis with labels. More...
 
virtual Long64_t Merge (TCollection *list)
 Merge all histograms in the collection in this histogram. More...
 
virtual Bool_t Multiply (TF1 *h1, Double_t c1=1)
 Performs the operation: this = this*c1*f1. More...
 
virtual Bool_t Multiply (const TH1 *h1)
 Multiply this profile by h1. More...
 
virtual Bool_t Multiply (const TH1 *h1, const TH1 *h2, Double_t c1=1, Double_t c2=1, Option_t *option="")
 Replace contents of this profile by multiplication of h1 by h2. More...
 
TProfileoperator= (const TProfile &profile)
 
TH1DProjectionX (const char *name="_px", Option_t *option="e") const
 Project this profile into a 1-D histogram along X. More...
 
virtual void PutStats (Double_t *stats)
 Replace current statistics with the values in array stats. More...
 
TH1Rebin (Int_t ngroup=2, const char *newname="", const Double_t *xbins=0)
 Rebin this profile grouping ngroup bins together. More...
 
virtual void Reset (Option_t *option="")
 Reset contents of a Profile histogram. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
virtual void Scale (Double_t c1=1, Option_t *option="")
 Multiply this profile by a constant c1. More...
 
virtual void SetBinEntries (Int_t bin, Double_t w)
 Set the number of entries in bin. More...
 
virtual void SetBins (Int_t nbins, Double_t xmin, Double_t xmax)
 Redefine x axis parameters. More...
 
virtual void SetBins (Int_t nx, const Double_t *xbins)
 Redefine x axis parameters. More...
 
virtual void SetBinsLength (Int_t n=-1)
 Set total number of bins including under/overflow. More...
 
virtual void SetBuffer (Int_t buffersize, Option_t *option="")
 Set the buffer size in units of 8 bytes (double). More...
 
virtual void SetErrorOption (Option_t *option="")
 Set option to compute profile errors. More...
 
virtual void Sumw2 (Bool_t flag=kTRUE)
 Create/delete structure to store sum of squares of weights per bin. More...
 
- Public Member Functions inherited from TH1D
 TH1D ()
 Constructor. More...
 
 TH1D (const char *name, const char *title, Int_t nbinsx, Double_t xlow, Double_t xup)
 Create a 1-Dim histogram with fix bins of type double (see TH1::TH1 for explanation of parameters) More...
 
 TH1D (const char *name, const char *title, Int_t nbinsx, const Float_t *xbins)
 Create a 1-Dim histogram with variable bins of type double (see TH1::TH1 for explanation of parameters) More...
 
 TH1D (const char *name, const char *title, Int_t nbinsx, const Double_t *xbins)
 Create a 1-Dim histogram with variable bins of type double (see TH1::TH1 for explanation of parameters) More...
 
 TH1D (const TVectorD &v)
 Create a histogram from a TVectorD by default the histogram name is "TVectorD" and title = "". More...
 
 TH1D (const TH1D &h1d)
 Constructor. More...
 
virtual ~TH1D ()
 Destructor. More...
 
virtual void AddBinContent (Int_t bin)
 Increment bin content by 1. More...
 
virtual void AddBinContent (Int_t bin, Double_t w)
 Increment bin content by a weight w. More...
 
TH1Doperator= (const TH1D &h1)
 Operator =. More...
 
- Public Member Functions inherited from TH1
virtual ~TH1 ()
 Histogram default destructor. More...
 
virtual Double_t AndersonDarlingTest (const TH1 *h2, Option_t *option="") const
 Statistical test of compatibility in shape between this histogram and h2, using the Anderson-Darling 2 sample test. More...
 
virtual Double_t AndersonDarlingTest (const TH1 *h2, Double_t &advalue) const
 Same function as above but returning also the test statistic value. More...
 
virtual void Browse (TBrowser *b)
 Browse the Histogram object. More...
 
virtual Bool_t CanExtendAllAxes () const
 Returns true if all axes are extendable. More...
 
virtual Double_t Chi2Test (const TH1 *h2, Option_t *option="UU", Double_t *res=0) const
 \( \chi^{2} \) test for comparing weighted and unweighted histograms More...
 
virtual Double_t Chi2TestX (const TH1 *h2, Double_t &chi2, Int_t &ndf, Int_t &igood, Option_t *option="UU", Double_t *res=0) const
 The computation routine of the Chisquare test. More...
 
virtual Double_t Chisquare (TF1 *f1, Option_t *option="") const
 Compute and return the chisquare of this histogram with respect to a function The chisquare is computed by weighting each histogram point by the bin error By default the full range of the histogram is used. More...
 
virtual void ClearUnderflowAndOverflow ()
 Remove all the content from the underflow and overflow bins, without changing the number of entries After calling this method, every undeflow and overflow bins will have content 0.0 The Sumw2 is also cleared, since there is no more content in the bins. More...
 
TObjectClone (const char *newname=0) const
 Make a complete copy of the underlying object. More...
 
virtual Double_t ComputeIntegral (Bool_t onlyPositive=false)
 Compute integral (cumulative sum of bins) The result stored in fIntegral is used by the GetRandom functions. More...
 
virtual void DirectoryAutoAdd (TDirectory *)
 Perform the automatic addition of the histogram to the given directory. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a line. More...
 
virtual void Draw (Option_t *option="")
 Draw this histogram with options. More...
 
virtual TH1DrawCopy (Option_t *option="", const char *name_postfix="_copy") const
 Copy this histogram and Draw in the current pad. More...
 
virtual TH1DrawNormalized (Option_t *option="", Double_t norm=1) const
 Draw a normalized copy of this histogram. More...
 
virtual void DrawPanel ()
 Display a panel with all histogram drawing options. More...
 
virtual void Eval (TF1 *f1, Option_t *option="")
 Evaluate function f1 at the center of bins of this histogram. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual TH1FFT (TH1 *h_output, Option_t *option)
 This function allows to do discrete Fourier transforms of TH1 and TH2. More...
 
virtual void FillRandom (const char *fname, Int_t ntimes=5000)
 Fill histogram following distribution in function fname. More...
 
virtual void FillRandom (TH1 *h, Int_t ntimes=5000)
 Fill histogram following distribution in histogram h. More...
 
virtual Int_t FindBin (Double_t x, Double_t y=0, Double_t z=0)
 Return Global bin number corresponding to x,y,z. More...
 
virtual Int_t FindFirstBinAbove (Double_t threshold=0, Int_t axis=1, Int_t firstBin=1, Int_t lastBin=-1) const
 Find first bin with content > threshold for axis (1=x, 2=y, 3=z) if no bins with content > threshold is found the function returns -1. More...
 
virtual Int_t FindFixBin (Double_t x, Double_t y=0, Double_t z=0) const
 Return Global bin number corresponding to x,y,z. More...
 
virtual Int_t FindLastBinAbove (Double_t threshold=0, Int_t axis=1, Int_t firstBin=1, Int_t lastBin=-1) const
 Find last bin with content > threshold for axis (1=x, 2=y, 3=z) if no bins with content > threshold is found the function returns -1. More...
 
virtual TObjectFindObject (const char *name) const
 Search object named name in the list of functions. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Search object obj in the list of functions. More...
 
virtual TFitResultPtr Fit (const char *formula, Option_t *option="", Option_t *goption="", Double_t xmin=0, Double_t xmax=0)
 Fit histogram with function fname. More...
 
virtual TFitResultPtr Fit (TF1 *f1, Option_t *option="", Option_t *goption="", Double_t xmin=0, Double_t xmax=0)
 Fit histogram with function f1. More...
 
virtual void FitPanel ()
 Display a panel with all histogram fit options. More...
 
TH1GetAsymmetry (TH1 *h2, Double_t c2=1, Double_t dc2=0)
 Return an histogram containing the asymmetry of this histogram with h2, where the asymmetry is defined as: More...
 
virtual Color_t GetAxisColor (Option_t *axis="X") const
 Return the number of divisions for "axis". More...
 
virtual Float_t GetBarOffset () const
 
virtual Float_t GetBarWidth () const
 
virtual Int_t GetBin (Int_t binx, Int_t biny=0, Int_t binz=0) const
 Return Global bin number corresponding to binx,y,z. More...
 
virtual Double_t GetBinCenter (Int_t bin) const
 Return bin center for 1D histogram. More...
 
virtual Double_t GetBinErrorLow (Int_t bin) const
 Return lower error associated to bin number bin. More...
 
virtual EBinErrorOpt GetBinErrorOption () const
 
virtual Double_t GetBinErrorUp (Int_t bin) const
 Return upper error associated to bin number bin. More...
 
virtual Double_t GetBinLowEdge (Int_t bin) const
 Return bin lower edge for 1D histogram. More...
 
virtual Double_t GetBinWidth (Int_t bin) const
 Return bin width for 1D histogram. More...
 
virtual Double_t GetBinWithContent (Double_t c, Int_t &binx, Int_t firstx=0, Int_t lastx=0, Double_t maxdiff=0) const
 Compute first binx in the range [firstx,lastx] for which diff = abs(bin_content-c) <= maxdiff. More...
 
virtual void GetBinXYZ (Int_t binglobal, Int_t &binx, Int_t &biny, Int_t &binz) const
 Return binx, biny, binz corresponding to the global bin number globalbin see TH1::GetBin function above. More...
 
const Double_tGetBuffer () const
 
Int_t GetBufferLength () const
 
Int_t GetBufferSize () const
 
virtual Double_t GetCellContent (Int_t binx, Int_t biny) const
 
virtual Double_t GetCellError (Int_t binx, Int_t biny) const
 
virtual void GetCenter (Double_t *center) const
 Fill array with center of bins for 1D histogram Better to use h1.GetXaxis().GetCenter(center) More...
 
virtual Int_t GetContour (Double_t *levels=0)
 Return contour values into array levels if pointer levels is non zero. More...
 
virtual Double_t GetContourLevel (Int_t level) const
 Return value of contour number level. More...
 
virtual Double_t GetContourLevelPad (Int_t level) const
 Return the value of contour number "level" in Pad coordinates. More...
 
TH1GetCumulative (Bool_t forward=kTRUE, const char *suffix="_cumulative") const
 Return a pointer to an histogram containing the cumulative The cumulative can be computed both in the forward (default) or backward direction; the name of the new histogram is constructed from the name of this histogram with the suffix suffix appended. More...
 
virtual Int_t GetDimension () const
 
TDirectoryGetDirectory () const
 
virtual Double_t GetEffectiveEntries () const
 Number of effective entries of the histogram. More...
 
virtual Double_t GetEntries () const
 Return the current number of entries. More...
 
virtual TF1GetFunction (const char *name) const
 Return pointer to function with name. More...
 
virtual Double_tGetIntegral ()
 Return a pointer to the array of bins integral. More...
 
virtual Double_t GetKurtosis (Int_t axis=1) const
 
virtual Color_t GetLabelColor (Option_t *axis="X") const
 Return the "axis" label color. More...
 
virtual Style_t GetLabelFont (Option_t *axis="X") const
 Return the "axis" label font. More...
 
virtual Float_t GetLabelOffset (Option_t *axis="X") const
 Return the "axis" label offset. More...
 
virtual Float_t GetLabelSize (Option_t *axis="X") const
 Return the "axis" label size. More...
 
TListGetListOfFunctions () const
 
virtual void GetLowEdge (Double_t *edge) const
 Fill array with low edge of bins for 1D histogram Better to use h1.GetXaxis().GetLowEdge(edge) More...
 
virtual Double_t GetMaximum (Double_t maxval=FLT_MAX) const
 Return maximum value smaller than maxval of bins in the range, unless the value has been overridden by TH1::SetMaximum, in which case it returns that value. More...
 
virtual Int_t GetMaximumBin () const
 Return location of bin with maximum value in the range. More...
 
virtual Int_t GetMaximumBin (Int_t &locmax, Int_t &locmay, Int_t &locmaz) const
 Return location of bin with maximum value in the range. More...
 
virtual Double_t GetMaximumStored () const
 
virtual Double_t GetMean (Int_t axis=1) const
 For axis = 1,2 or 3 returns the mean value of the histogram along X,Y or Z axis. More...
 
virtual Double_t GetMeanError (Int_t axis=1) const
 Return standard error of mean of this histogram along the X axis. More...
 
virtual Double_t GetMinimum (Double_t minval=-FLT_MAX) const
 Return minimum value larger than minval of bins in the range, unless the value has been overridden by TH1::SetMinimum, in which case it returns that value. More...
 
virtual void GetMinimumAndMaximum (Double_t &min, Double_t &max) const
 Retrieve the minimum and maximum values in the histogram. More...
 
virtual Int_t GetMinimumBin () const
 Return location of bin with minimum value in the range. More...
 
virtual Int_t GetMinimumBin (Int_t &locmix, Int_t &locmiy, Int_t &locmiz) const
 Return location of bin with minimum value in the range. More...
 
virtual Double_t GetMinimumStored () const
 
virtual Int_t GetNbinsX () const
 
virtual Int_t GetNbinsY () const
 
virtual Int_t GetNbinsZ () const
 
virtual Int_t GetNcells () const
 
virtual Int_t GetNdivisions (Option_t *axis="X") const
 Return the number of divisions for "axis". More...
 
virtual Double_t GetNormFactor () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Redefines TObject::GetObjectInfo. More...
 
Option_tGetOption () const
 
TVirtualHistPainterGetPainter (Option_t *option="")
 Return pointer to painter. More...
 
virtual Int_t GetQuantiles (Int_t nprobSum, Double_t *q, const Double_t *probSum=0)
 Compute Quantiles for this histogram Quantile x_q of a probability distribution Function F is defined as. More...
 
virtual Double_t GetRandom () const
 Return a random number distributed according the histogram bin contents. More...
 
Double_t GetRMS (Int_t axis=1) const
 
Double_t GetRMSError (Int_t axis=1) const
 
virtual Double_t GetSkewness (Int_t axis=1) const
 
EStatOverflows GetStatOverflows () const
 
virtual Double_t GetStdDev (Int_t axis=1) const
 Returns the Standard Deviation (Sigma). More...
 
virtual Double_t GetStdDevError (Int_t axis=1) const
 Return error of standard deviation estimation for Normal distribution. More...
 
virtual Double_t GetSumOfWeights () const
 Return the sum of weights excluding under/overflows. More...
 
virtual TArrayDGetSumw2 ()
 
virtual const TArrayDGetSumw2 () const
 
virtual Int_t GetSumw2N () const
 
virtual Float_t GetTickLength (Option_t *axis="X") const
 Return the "axis" tick length. More...
 
virtual Style_t GetTitleFont (Option_t *axis="X") const
 Return the "axis" title font. More...
 
virtual Float_t GetTitleOffset (Option_t *axis="X") const
 Return the "axis" title offset. More...
 
virtual Float_t GetTitleSize (Option_t *axis="X") const
 Return the "axis" title size. More...
 
TAxisGetXaxis ()
 Get the behaviour adopted by the object about the statoverflows. See EStatOverflows for more information. More...
 
const TAxisGetXaxis () const
 
TAxisGetYaxis ()
 
const TAxisGetYaxis () const
 
TAxisGetZaxis ()
 
const TAxisGetZaxis () const
 
virtual Double_t Integral (Option_t *option="") const
 Return integral of bin contents. More...
 
virtual Double_t Integral (Int_t binx1, Int_t binx2, Option_t *option="") const
 Return integral of bin contents in range [binx1,binx2]. More...
 
virtual Double_t IntegralAndError (Int_t binx1, Int_t binx2, Double_t &err, Option_t *option="") const
 Return integral of bin contents in range [binx1,binx2] and its error. More...
 
virtual Double_t Interpolate (Double_t x) const
 Given a point x, approximates the value via linear interpolation based on the two nearest bin centers. More...
 
virtual Double_t Interpolate (Double_t x, Double_t y) const
 2d Interpolation. Not yet implemented. More...
 
virtual Double_t Interpolate (Double_t x, Double_t y, Double_t z) const
 3d Interpolation. Not yet implemented. More...
 
Bool_t IsBinOverflow (Int_t bin, Int_t axis=0) const
 Return true if the bin is overflow. More...
 
Bool_t IsBinUnderflow (Int_t bin, Int_t axis=0) const
 Return true if the bin is underflow. More...
 
virtual Bool_t IsHighlight () const
 
virtual Double_t KolmogorovTest (const TH1 *h2, Option_t *option="") const
 Statistical test of compatibility in shape between this histogram and h2, using Kolmogorov test. More...
 
Long64_t Merge (TCollection *list, Option_t *option)
 Add all histograms in the collection to this histogram. More...
 
virtual void Paint (Option_t *option="")
 Control routine to paint any kind of histograms. More...
 
virtual void Print (Option_t *option="") const
 Print some global quantities for this histogram. More...
 
virtual void RebinAxis (Double_t x, TAxis *axis)
 
virtual TH1RebinX (Int_t ngroup=2, const char *newname="")
 
virtual void Rebuild (Option_t *option="")
 Using the current bin info, recompute the arrays for contents and errors. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove object from the list of functions. More...
 
virtual void ResetStats ()
 Reset the statistics including the number of entries and replace with values calculates from bin content. More...
 
virtual void SetAxisColor (Color_t color=1, Option_t *axis="X")
 Set color to draw the axis line and tick marks. More...
 
virtual void SetAxisRange (Double_t xmin, Double_t xmax, Option_t *axis="X")
 Set the "axis" range. More...
 
virtual void SetBarOffset (Float_t offset=0.25)
 
virtual void SetBarWidth (Float_t width=0.5)
 
virtual void SetBinContent (Int_t bin, Double_t content)
 Set bin content see convention for numbering bins in TH1::GetBin In case the bin number is greater than the number of bins and the timedisplay option is set or CanExtendAllAxes(), the number of bins is automatically doubled to accommodate the new bin. More...
 
virtual void SetBinContent (Int_t bin, Int_t, Double_t content)
 
virtual void SetBinContent (Int_t bin, Int_t, Int_t, Double_t content)
 
virtual void SetBinError (Int_t bin, Double_t error)
 Set the bin Error Note that this resets the bin eror option to be of Normal Type and for the non-empty bin the bin error is set by default to the square root of their content. More...
 
virtual void SetBinError (Int_t binx, Int_t biny, Double_t error)
 See convention for numbering bins in TH1::GetBin. More...
 
virtual void SetBinError (Int_t binx, Int_t biny, Int_t binz, Double_t error)
 See convention for numbering bins in TH1::GetBin. More...
 
virtual void SetBinErrorOption (EBinErrorOpt type)
 
virtual UInt_t SetCanExtend (UInt_t extendBitMask)
 Make the histogram axes extendable / not extendable according to the bit mask returns the previous bit mask specifying which axes are extendable. More...
 
virtual void SetCellContent (Int_t binx, Int_t biny, Double_t content)
 
virtual void SetCellError (Int_t binx, Int_t biny, Double_t content)
 
virtual void SetContent (const Double_t *content)
 Replace bin contents by the contents of array content. More...
 
virtual void SetContour (Int_t nlevels, const Double_t *levels=0)
 Set the number and values of contour levels. More...
 
virtual void SetContourLevel (Int_t level, Double_t value)
 Set value for one contour level. More...
 
virtual void SetDirectory (TDirectory *dir)
 By default when an histogram is created, it is added to the list of histogram objects in the current directory in memory. More...
 
virtual void SetEntries (Double_t n)
 
virtual void SetError (const Double_t *error)
 Replace bin errors by values in array error. More...
 
virtual void SetHighlight (Bool_t set=kTRUE)
 Set highlight (enable/disable) mode for the histogram by default highlight mode is disable. More...
 
virtual void SetLabelColor (Color_t color=1, Option_t *axis="X")
 Set axis labels color. More...
 
virtual void SetLabelFont (Style_t font=62, Option_t *axis="X")
 Set font number used to draw axis labels. More...
 
virtual void SetLabelOffset (Float_t offset=0.005, Option_t *axis="X")
 Set offset between axis and axis' labels. More...
 
virtual void SetLabelSize (Float_t size=0.02, Option_t *axis="X")
 Set size of axis' labels. More...
 
virtual void SetMaximum (Double_t maximum=-1111)
 
virtual void SetMinimum (Double_t minimum=-1111)
 
virtual void SetName (const char *name)
 Change the name of this histogram. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change the name and title of this histogram. More...
 
virtual void SetNdivisions (Int_t n=510, Option_t *axis="X")
 Set the number of divisions to draw an axis. More...
 
virtual void SetNormFactor (Double_t factor=1)
 
virtual void SetOption (Option_t *option=" ")
 
void SetStatOverflows (EStatOverflows statOverflows)
 
virtual void SetStats (Bool_t stats=kTRUE)
 Set statistics option on/off. More...
 
virtual void SetTickLength (Float_t length=0.02, Option_t *axis="X")
 Set the axis' tick marks length. More...
 
virtual void SetTitle (const char *title)
 See GetStatOverflows for more information. More...
 
virtual void SetTitleFont (Style_t font=62, Option_t *axis="X")
 Set the axis' title font. More...
 
virtual void SetTitleOffset (Float_t offset=1, Option_t *axis="X")
 Specify a parameter offset to control the distance between the axis and the axis' title. More...
 
virtual void SetTitleSize (Float_t size=0.02, Option_t *axis="X")
 Set the axis' title size. More...
 
virtual void SetXTitle (const char *title)
 
virtual void SetYTitle (const char *title)
 
virtual void SetZTitle (const char *title)
 
virtual TH1ShowBackground (Int_t niter=20, Option_t *option="same")
 This function calculates the background spectrum in this histogram. More...
 
virtual Int_t ShowPeaks (Double_t sigma=2, Option_t *option="", Double_t threshold=0.05)
 Interface to TSpectrum::Search. More...
 
virtual void Smooth (Int_t ntimes=1, Option_t *option="")
 Smooth bin contents of this histogram. More...
 
void UseCurrentStyle ()
 Copy current attributes from/to current style. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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 class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line. More...
 
virtual Color_t GetLineColor () const
 Return the line color. More...
 
virtual Style_t GetLineStyle () const
 Return the line style. More...
 
virtual Width_t GetLineWidth () const
 Return the line width. More...
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 AttFill default constructor. More...
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 Return the fill area color. More...
 
virtual Style_t GetFillStyle () const
 Return the fill area style. More...
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color. More...
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style. More...
 
- Public Member Functions inherited from TAttMarker
 TAttMarker ()
 TAttMarker default constructor. More...
 
 TAttMarker (Color_t color, Style_t style, Size_t msize)
 TAttMarker normal constructor. More...
 
virtual ~TAttMarker ()
 TAttMarker destructor. More...
 
void Copy (TAttMarker &attmarker) const
 Copy this marker attributes to a new TAttMarker. More...
 
virtual Color_t GetMarkerColor () const
 Return the marker color. More...
 
virtual Size_t GetMarkerSize () const
 Return the marker size. More...
 
virtual Style_t GetMarkerStyle () const
 Return the marker style. More...
 
virtual void Modify ()
 Change current marker attributes if necessary. More...
 
virtual void ResetAttMarker (Option_t *toption="")
 Reset this marker attributes to the default values. More...
 
virtual void SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetMarkerAttributes ()
 Invoke the DialogCanvas Marker attributes. More...
 
virtual void SetMarkerColor (Color_t mcolor=1)
 Set the marker color. More...
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color. More...
 
virtual void SetMarkerSize (Size_t msize=1)
 Set the marker size. More...
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 Set the marker style. More...
 
- Public Member Functions inherited from TArrayD
 TArrayD ()
 Default TArrayD ctor. More...
 
 TArrayD (Int_t n)
 Create TArrayD object and set array size to n doubles. More...
 
 TArrayD (Int_t n, const Double_t *array)
 Create TArrayD object and initialize it with values of array. More...
 
 TArrayD (const TArrayD &array)
 Copy constructor. More...
 
virtual ~TArrayD ()
 Delete TArrayD object. More...
 
void AddAt (Double_t c, Int_t i)
 Set the double c value at position i in the array. More...
 
void Adopt (Int_t n, Double_t *array)
 Adopt array arr into TArrayD, i.e. More...
 
Double_t At (Int_t i) const
 
void Copy (TArrayD &array) const
 
const Double_tGetArray () const
 
Double_tGetArray ()
 
Double_t GetAt (Int_t i) const
 
Stat_t GetSum () const
 
TArrayDoperator= (const TArrayD &rhs)
 TArrayD assignment operator. More...
 
Double_toperator[] (Int_t i)
 
Double_t operator[] (Int_t i) const
 
void Reset ()
 
void Reset (Double_t val)
 
void Set (Int_t n)
 Set size of this array to n doubles. More...
 
void Set (Int_t n, const Double_t *array)
 Set size of this array to n doubles and set the contents This function should not be called if the array was declared via Adopt. More...
 
void SetAt (Double_t v, Int_t i)
 
- Public Member Functions inherited from TArray
 TArray ()
 
 TArray (Int_t n)
 
 TArray (const TArray &a)
 
virtual ~TArray ()
 
Int_t GetSize () const
 
TArrayoperator= (const TArray &rhs)
 

Static Public Member Functions

static void Approximate (Bool_t approx=kTRUE)
 Static function to set the fgApproximate flag. More...
 
- Static Public Member Functions inherited from TH1
static void AddDirectory (Bool_t add=kTRUE)
 Sets the flag controlling the automatic add of histograms in memory. More...
 
static Bool_t AddDirectoryStatus ()
 Static function: cannot be inlined on Windows/NT. More...
 
static Int_t FitOptionsMake (Option_t *option, Foption_t &Foption)
 Decode string choptin and fill fitOption structure. More...
 
static Int_t GetDefaultBufferSize ()
 Static function return the default buffer size for automatic histograms the parameter fgBufferSize may be changed via SetDefaultBufferSize. More...
 
static Bool_t GetDefaultSumw2 ()
 Return kTRUE if TH1::Sumw2 must be called when creating new histograms. More...
 
static void SetDefaultBufferSize (Int_t buffersize=1000)
 Static function to set the default buffer size for automatic histograms. More...
 
static void SetDefaultSumw2 (Bool_t sumw2=kTRUE)
 When this static function is called with sumw2=kTRUE, all new histograms will automatically activate the storage of the sum of squares of errors, ie TH1::Sumw2 is automatically called. More...
 
static void SmoothArray (Int_t NN, Double_t *XX, Int_t ntimes=1)
 Smooth array xx, translation of Hbook routine hsmoof.F based on algorithm 353QH twice presented by J. More...
 
static void StatOverflows (Bool_t flag=kTRUE)
 if flag=kTRUE, underflows and overflows are used by the Fill functions in the computation of statistics (mean value, StdDev). More...
 
static TH1TransformHisto (TVirtualFFT *fft, TH1 *h_output, Option_t *option)
 For a given transform (first parameter), fills the histogram (second parameter) with the transform output data, specified in the third parameter If the 2nd parameter h_output is empty, a new histogram (TH1D or TH2D) is created and the user is responsible for deleting it. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from TAttMarker
static Width_t GetMarkerLineWidth (Style_t style)
 Internal helper function that returns the line width of the given marker style (0 = filled marker) More...
 
static Style_t GetMarkerStyleBase (Style_t style)
 Internal helper function that returns the corresponding marker style with line width 1 for the given style. More...
 
- Static Public Member Functions inherited from TArray
static TArrayReadArray (TBuffer &b, const TClass *clReq)
 Read TArray object from buffer. More...
 
static void WriteArray (TBuffer &b, const TArray *a)
 Write TArray object to buffer. More...
 

Protected Member Functions

virtual Int_t BufferFill (Double_t, Double_t)
 accumulate arguments in buffer. More...
 
virtual Int_t BufferFill (Double_t x, Double_t y, Double_t w)
 accumulate arguments in buffer. More...
 
Int_t Fill (const Double_t *v)
 
virtual Double_t GetBinErrorSqUnchecked (Int_t bin) const
 
virtual Double_t RetrieveBinContent (Int_t bin) const
 Raw retrieval of bin content on internal data structure see convention for numbering bins in TH1::GetBin. More...
 
void SetBins (const Int_t *nbins, const Double_t *range)
 
- Protected Member Functions inherited from TH1D
virtual void UpdateBinContent (Int_t bin, Double_t content)
 Raw update of bin content on internal data structure see convention for numbering bins in TH1::GetBin. More...
 
- Protected Member Functions inherited from TH1
 TH1 ()
 Histogram default constructor. More...
 
 TH1 (const char *name, const char *title, Int_t nbinsx, Double_t xlow, Double_t xup)
 Normal constructor for fix bin size histograms. More...
 
 TH1 (const char *name, const char *title, Int_t nbinsx, const Float_t *xbins)
 Normal constructor for variable bin size histograms. More...
 
 TH1 (const char *name, const char *title, Int_t nbinsx, const Double_t *xbins)
 Normal constructor for variable bin size histograms. More...
 
virtual Int_t AutoP2FindLimits (Double_t min, Double_t max)
 Buffer-based estimate of the histogram range using the power of 2 algorithm. More...
 
virtual void DoFillN (Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride=1)
 Internal method to fill histogram content from a vector called directly by TH1::BufferEmpty. More...
 
virtual Double_t DoIntegral (Int_t ix1, Int_t ix2, Int_t iy1, Int_t iy2, Int_t iz1, Int_t iz2, Double_t &err, Option_t *opt, Bool_t doerr=kFALSE) const
 Internal function compute integral and optionally the error between the limits specified by the bin number values working for all histograms (1D, 2D and 3D) More...
 
virtual Bool_t FindNewAxisLimits (const TAxis *axis, const Double_t point, Double_t &newMin, Double_t &newMax)
 finds new limits for the axis so that point is within the range and the limits are compatible with the previous ones (see TH1::Merge). More...
 
Bool_t GetStatOverflowsBehaviour () const
 
Bool_t IsEmpty () const
 Check if an histogram is empty (this a protected method used mainly by TH1Merger ) More...
 
virtual void SavePrimitiveHelp (std::ostream &out, const char *hname, Option_t *option="")
 Helper function for the SavePrimitive functions from TH1 or classes derived from TH1, eg TProfile, TProfile2D. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 
- Protected Member Functions inherited from TArray
Bool_t BoundsOk (const char *where, Int_t at) const
 
Bool_t OutOfBoundsError (const char *where, Int_t i) const
 Generate an out-of-bounds error. Always returns false. More...
 

Protected Attributes

TArrayD fBinEntries
 
TArrayD fBinSumw2
 
EErrorType fErrorMode
 
Bool_t fScaling
 
Double_t fTsumwy
 True when TProfile::Scale is called. More...
 
Double_t fTsumwy2
 
Double_t fYmax
 
Double_t fYmin
 
- Protected Attributes inherited from TH1
Short_t fBarOffset
 (1000*offset) for bar charts or legos More...
 
Short_t fBarWidth
 (1000*width) for bar charts or legos More...
 
EBinErrorOpt fBinStatErrOpt
 option for bin statistical errors More...
 
Double_tfBuffer
 [fBufferSize] entry buffer More...
 
Int_t fBufferSize
 fBuffer size More...
 
TArrayD fContour
 Array to display contour levels. More...
 
Int_t fDimension
 !Histogram dimension (1, 2 or 3 dim) More...
 
TDirectoryfDirectory
 !Pointer to directory holding this histogram More...
 
Double_t fEntries
 Number of entries. More...
 
TListfFunctions
 ->Pointer to list of functions (fits and user) More...
 
Double_tfIntegral
 !Integral of bins used by GetRandom More...
 
Double_t fMaximum
 Maximum value for plotting. More...
 
Double_t fMinimum
 Minimum value for plotting. More...
 
Int_t fNcells
 number of bins(1D), cells (2D) +U/Overflows More...
 
Double_t fNormFactor
 Normalization factor. More...
 
TString fOption
 histogram options More...
 
TVirtualHistPainterfPainter
 !pointer to histogram painter More...
 
EStatOverflows fStatOverflows
 per object flag to use under/overflows in statistics More...
 
TArrayD fSumw2
 Array of sum of squares of weights. More...
 
Double_t fTsumw
 Total Sum of weights. More...
 
Double_t fTsumw2
 Total Sum of squares of weights. More...
 
Double_t fTsumwx
 Total Sum of weight*X. More...
 
Double_t fTsumwx2
 Total Sum of weight*X*X. More...
 
TAxis fXaxis
 X axis descriptor. More...
 
TAxis fYaxis
 Y axis descriptor. More...
 
TAxis fZaxis
 Z axis descriptor. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color. More...
 
Style_t fFillStyle
 Fill area style. More...
 
- Protected Attributes inherited from TAttMarker
Color_t fMarkerColor
 Marker color. More...
 
Size_t fMarkerSize
 Marker size. More...
 
Style_t fMarkerStyle
 Marker style. More...
 

Static Protected Attributes

static Bool_t fgApproximate = kFALSE
 
- Static Protected Attributes inherited from TH1
static Bool_t fgAddDirectory = kTRUE
 !flag to add histograms to the directory More...
 
static Int_t fgBufferSize = 1000
 !default buffer size for automatic histograms More...
 
static Bool_t fgDefaultSumw2 = kFALSE
 !flag to call TH1::Sumw2 automatically at histogram creation time More...
 
static Bool_t fgStatOverflows = kFALSE
 !flag to use under/overflows in statistics More...
 

Private Member Functions

Int_t Fill (Double_t)
 Increment bin with abscissa X by 1. More...
 
void FillN (Int_t, const Double_t *, const Double_t *, Int_t)
 Fill this histogram with an array x and weights w. More...
 
Double_tGetB ()
 
Double_tGetB2 ()
 
Double_tGetW ()
 
Double_tGetW2 ()
 
void SetBins (Int_t, Double_t, Double_t, Int_t, Double_t, Double_t)
 Redefine x and y axis parameters. More...
 
void SetBins (Int_t, const Double_t *, Int_t, const Double_t *)
 Redefine x and y axis parameters with variable bin sizes. More...
 
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. More...
 
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. More...
 

Friends

class TProfileHelper
 

Additional Inherited Members

- Public Types inherited from TH1
enum  {
  kNoAxis = 0, kXaxis = BIT(0), kYaxis = BIT(1), kZaxis = BIT(2),
  kAllAxes = kXaxis | kYaxis | kZaxis
}
 
enum  { kNstat = 13 }
 
enum  EBinErrorOpt { kNormal = 0, kPoisson = 1, kPoisson2 = 2 }
 
enum  EStatOverflows { kIgnore = 0, kConsider = 1, kNeutral = 2 }
 Enumeration specifying the way to treat statoverflow. More...
 
enum  EStatusBits {
  kNoStats = BIT(9), kUserContour = BIT(10), kLogX = BIT(15), kIsZoomed = BIT(16),
  kNoTitle = BIT(17), kIsAverage = BIT(18), kIsNotW = BIT(19), kAutoBinPTwo = BIT(20),
  kIsHighlight = BIT(21)
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Public Attributes inherited from TArrayD
Double_tfArray
 
- Public Attributes inherited from TArray
Int_t fN
 
- Static Protected Member Functions inherited from TH1
static Int_t AutoP2GetBins (Int_t n)
 Auxilliary function to get the next power of 2 integer value larger then n. More...
 
static Double_t AutoP2GetPower2 (Double_t x, Bool_t next=kTRUE)
 Auxilliary function to get the power of 2 next (larger) or previous (smaller) a given x. More...
 
static bool CheckAxisLimits (const TAxis *a1, const TAxis *a2)
 Check that the axis limits of the histograms are the same. More...
 
static bool CheckBinLabels (const TAxis *a1, const TAxis *a2)
 Check that axis have same labels. More...
 
static bool CheckBinLimits (const TAxis *a1, const TAxis *a2)
 Check bin limits. More...
 
static bool CheckConsistency (const TH1 *h1, const TH1 *h2)
 Check histogram compatibility. More...
 
static bool CheckConsistentSubAxes (const TAxis *a1, Int_t firstBin1, Int_t lastBin1, const TAxis *a2, Int_t firstBin2=0, Int_t lastBin2=0)
 Check that two sub axis are the same. More...
 
static bool CheckEqualAxes (const TAxis *a1, const TAxis *a2)
 Check that the axis are the same. More...
 
static Bool_t RecomputeAxisLimits (TAxis &destAxis, const TAxis &anAxis)
 Finds new limits for the axis for the Merge function. More...
 
static Bool_t SameLimitsAndNBins (const TAxis &axis1, const TAxis &axis2)
 Same limits and bins. More...
 

#include <TProfile.h>

Inheritance diagram for TProfile:
[legend]

Constructor & Destructor Documentation

◆ TProfile() [1/7]

TProfile::TProfile ( )

Default constructor for Profile histograms.

Definition at line 93 of file TProfile.cxx.

◆ TProfile() [2/7]

TProfile::TProfile ( const char *  name,
const char *  title,
Int_t  nbins,
Double_t  xlow,
Double_t  xup,
Option_t option = "" 
)

Normal Constructor for Profile histograms.

The first five parameters are similar to TH1D::TH1D. All values of y are accepted at filling time. To fill a profile histogram, one must use TProfile::Fill function.

Note that when filling the profile histogram the function Fill checks if the variable y is between fYmin and fYmax. If a minimum or maximum value is set for the Y scale before filling, then all values below ymin or above ymax will be discarded. Setting the minimum or maximum value for the Y scale before filling has the same effect as calling the special TProfile constructor below where ymin and ymax are specified.

H(j) is printed as the channel contents. The errors displayed are s(j) if option='S' (spread option), or e(j) if CHOPT='' (error on mean).

See TProfile::BuildOptions() for explanation of parameters

see also comments in the TH1 base class constructors

Definition at line 127 of file TProfile.cxx.

◆ TProfile() [3/7]

TProfile::TProfile ( const char *  name,
const char *  title,
Int_t  nbins,
Double_t  xlow,
Double_t  xup,
Double_t  ylow,
Double_t  yup,
Option_t option = "" 
)

Constructor for Profile histograms with range in y.

The first five parameters are similar to TH1D::TH1D. Only the values of Y between ylow and yup will be considered at filling time. ylow and yup will also be the maximum and minimum values on the y scale when drawing the profile.

See TProfile::BuildOptions for more explanations on errors

see also comments in the TH1 base class constructors

Definition at line 181 of file TProfile.cxx.

◆ TProfile() [4/7]

TProfile::TProfile ( const char *  name,
const char *  title,
Int_t  nbins,
const Float_t xbins,
Option_t option = "" 
)

Constructor for Profile histograms with variable bin size.

See TProfile::BuildOptions() for more explanations on errors see also comments in the TH1 base class constructors

Definition at line 139 of file TProfile.cxx.

◆ TProfile() [5/7]

TProfile::TProfile ( const char *  name,
const char *  title,
Int_t  nbins,
const Double_t xbins,
Option_t option = "" 
)

Constructor for Profile histograms with variable bin size.

See TProfile::BuildOptions for more explanations on errors see also comments in the TH1 base class constructors

Definition at line 151 of file TProfile.cxx.

◆ TProfile() [6/7]

TProfile::TProfile ( const char *  name,
const char *  title,
Int_t  nbins,
const Double_t xbins,
Double_t  ylow,
Double_t  yup,
Option_t option = "" 
)

Constructor for Profile histograms with variable bin size.

See TProfile::BuildOptions for more explanations on errors

see also comments in the TH1 base class constructors

Definition at line 163 of file TProfile.cxx.

◆ TProfile() [7/7]

TProfile::TProfile ( const TProfile profile)

Copy constructor.

Definition at line 245 of file TProfile.cxx.

◆ ~TProfile()

TProfile::~TProfile ( )
virtual

Default destructor for Profile histograms.

Definition at line 101 of file TProfile.cxx.

Member Function Documentation

◆ Add() [1/3]

Bool_t TProfile::Add ( TF1 h1,
Double_t  c1 = 1,
Option_t option = "" 
)
virtual

Performs the operation: this = this + c1*f1.

Reimplemented from TH1.

Definition at line 259 of file TProfile.cxx.

◆ Add() [2/3]

Bool_t TProfile::Add ( const TH1 h1,
Double_t  c1 = 1 
)
virtual

Performs the operation: this = this + c1*h1.

Reimplemented from TH1.

Definition at line 269 of file TProfile.cxx.

◆ Add() [3/3]

Bool_t TProfile::Add ( const TH1 h1,
const TH1 h2,
Double_t  c1 = 1,
Double_t  c2 = 1 
)
virtual

Replace contents of this profile by the addition of h1 and h2.

this = c1*h1 + c2*h2

c1 and c2 are considered as weights applied to the two summed profiles. The operation acts therefore like merging the two profiles with a weight c1 and c2

Reimplemented from TH1.

Definition at line 291 of file TProfile.cxx.

◆ Approximate()

void TProfile::Approximate ( Bool_t  approx = kTRUE)
static

Static function to set the fgApproximate flag.

When the flag is true, the function GetBinError will approximate the bin error with the average profile error on all bins in the following situation only

  • the number of bins in the profile is less than 1002
  • the bin number of entries is small ( <5)
  • the estimated bin error is extremely small compared to the bin content (see TProfile::GetBinError)

Definition at line 321 of file TProfile.cxx.

◆ BufferEmpty()

Int_t TProfile::BufferEmpty ( Int_t  action = 0)
virtual

Fill histogram with all entries in the buffer.

  • action = -1 histogram is reset and refilled from the buffer (called by THistPainter::Paint)
  • action = 0 histogram is filled from the buffer
  • action = 1 histogram is filled and buffer is deleted The buffer is automatically deleted when the number of entries in the buffer is greater than the number of entries in the histogram

Reimplemented from TH1.

Definition at line 335 of file TProfile.cxx.

◆ BufferFill() [1/2]

virtual Int_t TProfile::BufferFill ( Double_t  x,
Double_t  w 
)
inlineprotectedvirtual

accumulate arguments in buffer.

When buffer is full, empty the buffer

  • fBuffer[0] = number of entries in buffer
  • fBuffer[1] = w of first entry
  • fBuffer[2] = x of first entry

Reimplemented from TH1.

Definition at line 49 of file TProfile.h.

◆ BufferFill() [2/2]

Int_t TProfile::BufferFill ( Double_t  x,
Double_t  y,
Double_t  w 
)
protectedvirtual

accumulate arguments in buffer.

When buffer is full, empty the buffer.

  • fBuffer[0] = number of entries in buffer
  • fBuffer[1] = w of first entry
  • fBuffer[2] = x of first entry
  • fBuffer[3] = y of first entry

Definition at line 393 of file TProfile.cxx.

◆ BuildOptions()

void TProfile::BuildOptions ( Double_t  ymin,
Double_t  ymax,
Option_t option 
)

Set Profile histogram structure and options.

Parameters
[in]yminminimum value allowed for y
[in]ymaxmaximum value allowed for y if (ymin = ymax = 0) there are no limits on the allowed y values (ymin = -inf, ymax = +inf)
[in]optionthis is the option for the computation of the y error of the profile ( TProfile::GetBinError ) possible values for the options are:
  • ' ' (Default) the bin errors are the standard error on the mean of Y = S(Y)/SQRT(N) where S(Y) is the standard deviation (RMS) of the Y data in the bin and N is the number of bin entries (from TProfile::GetBinEntries(ibin) ) (i.e the errors are the standard error on the bin content of the profile)
  • 's' Errors are the standard deviation of Y, S(Y)
  • 'i' Errors are S(Y)/SQRT(N) (standard error on the mean as in the default) The only difference is only when the standard deviation in Y is zero. In this case the error a standard deviation = 1/SQRT(12) is assumed and the error is 1./SQRT(12*N). This approximation assumes that the Y values are integer (e.g. ADC counts) and have an implicit uncertainty of y +/- 0.5. With the assumption that the probability that y takes any value between y-0.5 and y+0.5 is uniform, its standard error is 1/SQRT(12)
  • 'g' Errors are 1./SQRT(W) where W is the sum of the weights for the bin j W is obtained as from TProfile::GetBinEntries(ibin) This errors corresponds to the standard deviation of weighted mean where each measurement Y is uncorrelated and has an error sigma, which is expressed in the weight used to fill the Profile: w = 1/sigma^2 The resulting error in TProfile is then 1./SQRT( Sum(1./sigma^2) )

In the case of Profile filled weights and with TProfile::Sumw2() called, STD(Y) is the standard deviation of the weighted sample Y and N is in this case the number of effective entries (TProfile::GetBinEffectiveEntries(ibin) )

If a bin has N data points all with the same value Y (especially possible when dealing with integers), the spread in Y for that bin is zero, and the uncertainty assigned is also zero, and the bin is ignored in making subsequent fits. To avoid this problem one can use an approximation for the standard deviation S(Y), by using the average of all the S(Y) of the other Profile bins. To use this approximation one must call before TProfile::Approximate This approximation applies only for the default and the 's' options

Definition at line 228 of file TProfile.cxx.

◆ Copy()

void TProfile::Copy ( TObject hnew) const
virtual

Copy a Profile histogram to a new profile histogram.

Reimplemented from TH1D.

Definition at line 420 of file TProfile.cxx.

◆ Divide() [1/3]

Bool_t TProfile::Divide ( TF1 h1,
Double_t  c1 = 1 
)
virtual

Performs the operation: this = this/(c1*f1).

This function is not implemented for the TProfile

Reimplemented from TH1.

Definition at line 450 of file TProfile.cxx.

◆ Divide() [2/3]

Bool_t TProfile::Divide ( const TH1 h1)
virtual

Divide this profile by h1.

this = this/h1

This function accepts to divide a TProfile by a histogram

The function return kFALSE if the divide operation failed

Reimplemented from TH1.

Definition at line 465 of file TProfile.cxx.

◆ Divide() [3/3]

Bool_t TProfile::Divide ( const TH1 h1,
const TH1 h2,
Double_t  c1 = 1,
Double_t  c2 = 1,
Option_t option = "" 
)
virtual

Replace contents of this profile by the division of h1 by h2.

this = c1*h1/(c2*h2)

The function return kFALSE if the divide operation failed

Reimplemented from TH1.

Definition at line 544 of file TProfile.cxx.

◆ ExtendAxis()

void TProfile::ExtendAxis ( Double_t  x,
TAxis axis 
)
virtual

Profile histogram is resized along x axis such that x is in the axis range.

The new axis limits are recomputed by doubling iteratively the current axis range until the specified value x is within the limits. The algorithm makes a copy of the histogram, then loops on all bins of the old histogram to fill the extended histogram. Takes into account errors (Sumw2) if any. The axis must be extendable before invoking this function.

Ex: h->GetXaxis()->SetCanExtend(kTRUE)

Reimplemented from TH1.

Definition at line 1520 of file TProfile.cxx.

◆ Fill() [1/6]

Int_t TProfile::Fill ( const Double_t v)
inlineprotected

Definition at line 54 of file TProfile.h.

◆ Fill() [2/6]

Int_t TProfile::Fill ( Double_t  x)
inlineprivatevirtual

Increment bin with abscissa X by 1.

if x is less than the low-edge of the first bin, the Underflow bin is incremented if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented

If the storage of the sum of squares of weights has been triggered, via the function Sumw2, then the sum of the squares of weights is incremented by 1 in the bin corresponding to x.

The function returns the corresponding bin number which has its content incremented by 1

Reimplemented from TH1.

Definition at line 61 of file TProfile.h.

◆ Fill() [3/6]

Int_t TProfile::Fill ( Double_t  x,
Double_t  y 
)
virtual

Fill a Profile histogram (no weights).

Reimplemented from TH1.

Definition at line 647 of file TProfile.cxx.

◆ Fill() [4/6]

Int_t TProfile::Fill ( const char *  namex,
Double_t  y 
)
virtual

Fill a Profile histogram (no weights).

Reimplemented from TH1.

Definition at line 677 of file TProfile.cxx.

◆ Fill() [5/6]

Int_t TProfile::Fill ( Double_t  x,
Double_t  y,
Double_t  w 
)
virtual

Fill a Profile histogram with weights.

Definition at line 706 of file TProfile.cxx.

◆ Fill() [6/6]

Int_t TProfile::Fill ( const char *  namex,
Double_t  y,
Double_t  w 
)
virtual

Fill a Profile histogram with weights.

Definition at line 738 of file TProfile.cxx.

◆ FillN() [1/2]

void TProfile::FillN ( Int_t  ntimes,
const Double_t x,
const Double_t w,
Int_t  stride 
)
inlineprivatevirtual

Fill this histogram with an array x and weights w.

Parameters
[in]ntimesnumber of entries in arrays x and w (array size must be ntimes*stride)
[in]xarray of values to be histogrammed
[in]warray of weighs
[in]stridestep size through arrays x and w

If the weight is not equal to 1, the storage of the sum of squares of weights is automatically triggered and the sum of the squares of weights is incremented by \( w^2 \) in the bin corresponding to x. if w is NULL each entry is assumed a weight=1

Reimplemented from TH1.

Definition at line 62 of file TProfile.h.

◆ FillN() [2/2]

void TProfile::FillN ( Int_t  ntimes,
const Double_t x,
const Double_t y,
const Double_t w,
Int_t  stride = 1 
)
virtual

Fill a Profile histogram with weights.

Reimplemented from TH1.

Definition at line 770 of file TProfile.cxx.

◆ GetB()

Double_t* TProfile::GetB ( )
inlineprivate

Definition at line 63 of file TProfile.h.

◆ GetB2()

Double_t* TProfile::GetB2 ( )
inlineprivate

Definition at line 64 of file TProfile.h.

◆ GetBinContent() [1/3]

Double_t TProfile::GetBinContent ( Int_t  bin) const
virtual

Return bin content of a Profile histogram.

Reimplemented from TH1.

Definition at line 818 of file TProfile.cxx.

◆ GetBinContent() [2/3]

virtual Double_t TProfile::GetBinContent ( Int_t  bin,
Int_t   
) const
inlinevirtual

Reimplemented from TH1.

Definition at line 103 of file TProfile.h.

◆ GetBinContent() [3/3]

virtual Double_t TProfile::GetBinContent ( Int_t  bin,
Int_t  ,
Int_t   
) const
inlinevirtual

Reimplemented from TH1.

Definition at line 104 of file TProfile.h.

◆ GetBinEffectiveEntries()

Double_t TProfile::GetBinEffectiveEntries ( Int_t  bin) const
virtual

Return bin effective entries for a weighted filled Profile histogram.

In case of an unweighted profile, it is equivalent to the number of entries per bin The effective entries is defined as the square of the sum of the weights divided by the sum of the weights square. TProfile::Sumw2() must be called before filling the profile with weights. Only by calling this method the sum of the square of the weights per bin is stored.

Definition at line 847 of file TProfile.cxx.

◆ GetBinEntries()

Double_t TProfile::GetBinEntries ( Int_t  bin) const
virtual

Return bin entries of a Profile histogram.

Definition at line 831 of file TProfile.cxx.

◆ GetBinError() [1/3]

Double_t TProfile::GetBinError ( Int_t  bin) const
virtual

Return bin error of a Profile histogram.

Computing errors: A moving field

The computation of errors for a TProfile has evolved with the versions of ROOT. The difficulty is in computing errors for bins with low statistics.

  • prior to version 3.00, we had no special treatment of low statistic bins. As a result, these bins had huge errors. The reason is that the expression eprim2 is very close to 0 (rounding problems) or 0.
  • in version 3.00 (18 Dec 2000), the algorithm is protected for values of eprim2 very small and the bin errors set to the average bin errors, following recommendations from a group of users.
  • in version 3.01 (19 Apr 2001), it is realized that the algorithm above should be applied only to low statistic bins.
  • in version 3.02 (26 Sep 2001), the same group of users recommend instead to take two times the average error on all bins for these low statistics bins giving a very small value for eprim2.
  • in version 3.04 (Nov 2002), the algorithm is modified/protected for the case when a TProfile is projected (ProjectionX). The previous algorithm generated a N^2 problem when projecting a TProfile with a large number of bins (eg 100000).
  • in version 3.05/06, a new static function TProfile::Approximate is introduced to enable or disable (default) the approximation.

Ideas for improvements of this algorithm are welcome. No suggestions received since our call for advice to roottalk in Jul 2002. see for instance: http://root.cern.ch/root/roottalk/roottalk02/2916.html

Reimplemented from TH1.

Definition at line 882 of file TProfile.cxx.

◆ GetBinError() [2/3]

virtual Double_t TProfile::GetBinError ( Int_t  bin,
Int_t   
) const
inlinevirtual

Reimplemented from TH1.

Definition at line 106 of file TProfile.h.

◆ GetBinError() [3/3]

virtual Double_t TProfile::GetBinError ( Int_t  bin,
Int_t  ,
Int_t   
) const
inlinevirtual

Reimplemented from TH1.

Definition at line 107 of file TProfile.h.

◆ GetBinErrorSqUnchecked()

virtual Double_t TProfile::GetBinErrorSqUnchecked ( Int_t  bin) const
inlineprotectedvirtual

Reimplemented from TH1.

Definition at line 58 of file TProfile.h.

◆ GetBinSumw2() [1/2]

virtual TArrayD* TProfile::GetBinSumw2 ( )
inlinevirtual

Definition at line 110 of file TProfile.h.

◆ GetBinSumw2() [2/2]

virtual const TArrayD* TProfile::GetBinSumw2 ( ) const
inlinevirtual

Definition at line 111 of file TProfile.h.

◆ GetErrorOption()

Option_t * TProfile::GetErrorOption ( ) const

Return option to compute profile errors.

Definition at line 890 of file TProfile.cxx.

◆ GetStats()

void TProfile::GetStats ( Double_t stats) const
virtual

fill the array stats from the contents of this profile.

The array stats must be correctly dimensioned in the calling program.

  • stats[0] = sumw
  • stats[1] = sumw2
  • stats[2] = sumwx
  • stats[3] = sumwx2
  • stats[4] = sumwy
  • stats[5] = sumwy2

If no axis-subrange is specified (via TAxis::SetRange), the array stats is simply a copy of the statistics quantities computed at filling time. If a sub-range is specified, the function recomputes these quantities from the bin contents in the current axis range.

Reimplemented from TH1.

Definition at line 915 of file TProfile.cxx.

◆ GetW()

Double_t* TProfile::GetW ( )
inlineprivate

Definition at line 65 of file TProfile.h.

◆ GetW2()

Double_t* TProfile::GetW2 ( )
inlineprivate

Definition at line 66 of file TProfile.h.

◆ GetYmax()

virtual Double_t TProfile::GetYmax ( ) const
inlinevirtual

Definition at line 115 of file TProfile.h.

◆ GetYmin()

virtual Double_t TProfile::GetYmin ( ) const
inlinevirtual

Definition at line 114 of file TProfile.h.

◆ LabelsDeflate()

void TProfile::LabelsDeflate ( Option_t axis = "X")
virtual

Reduce the number of bins for this axis to the number of bins having a label.

Reimplemented from TH1.

Definition at line 963 of file TProfile.cxx.

◆ LabelsInflate()

void TProfile::LabelsInflate ( Option_t options = "X")
virtual

Double the number of bins for axis.

Refill histogram This function is called by TAxis::FindBin(const char *label)

Reimplemented from TH1.

Definition at line 973 of file TProfile.cxx.

◆ LabelsOption()

void TProfile::LabelsOption ( Option_t option = "h",
Option_t axis = "X" 
)
virtual

Set option(s) to draw axis with labels.

option might have the following values:

  • "a" sort by alphabetic order
  • ">" sort by decreasing values
  • "<" sort by increasing values
  • "h" draw labels horizontal
  • "v" draw labels vertical
  • "u" draw labels up (end of label right adjusted)
  • "d" draw labels down (start of label left adjusted)

Reimplemented from TH1.

Definition at line 991 of file TProfile.cxx.

◆ Merge()

Long64_t TProfile::Merge ( TCollection li)
virtual

Merge all histograms in the collection in this histogram.

This function computes the min/max for the x axis, compute a new number of bins, if necessary, add bin contents, errors and statistics. If overflows are present and limits are different the function will fail. The function returns the total number of entries in the result histogram if the merge is successfull, -1 otherwise.

IMPORTANT remark. The axis x may have different number of bins and different limits, BUT the largest bin width must be a multiple of the smallest bin width and the upper limit must also be a multiple of the bin width.

Reimplemented from TH1.

Definition at line 1129 of file TProfile.cxx.

◆ Multiply() [1/3]

Bool_t TProfile::Multiply ( TF1 f1,
Double_t  c1 = 1 
)
virtual

Performs the operation: this = this*c1*f1.

The function return kFALSE if the Multiply operation failed

Reimplemented from TH1.

Definition at line 1139 of file TProfile.cxx.

◆ Multiply() [2/3]

Bool_t TProfile::Multiply ( const TH1 h1)
virtual

Multiply this profile by h1.

this = this*h1

Reimplemented from TH1.

Definition at line 1181 of file TProfile.cxx.

◆ Multiply() [3/3]

Bool_t TProfile::Multiply ( const TH1 h1,
const TH1 h2,
Double_t  c1 = 1,
Double_t  c2 = 1,
Option_t option = "" 
)
virtual

Replace contents of this profile by multiplication of h1 by h2.

this = (c1*h1)*(c2*h2)

Reimplemented from TH1.

Definition at line 1193 of file TProfile.cxx.

◆ operator=()

TProfile & TProfile::operator= ( const TProfile profile)

Definition at line 250 of file TProfile.cxx.

◆ ProjectionX()

TH1D * TProfile::ProjectionX ( const char *  name = "_px",
Option_t option = "e" 
) const

Project this profile into a 1-D histogram along X.

The projection is always of the type TH1D.

  • if option "E" is specified the errors of the projected histogram are computed and set to be equal to the errors of the profile. Option "E" is defined as the default one in the header file.
  • if option "" is specified the histogram errors are simply the sqrt of its content
  • if option "B" is specified, the content of bin of the returned histogram will be equal to the GetBinEntries(bin) of the profile, otherwise (default) it will be equal to GetBinContent(bin)
  • if option "C=E" the bin contents of the projection are set to the bin errors of the profile
  • if option "W" is specified the bin content of the projected histogram is set to the product of the bin content of the profile and the entries. With this option the returned histogram will be equivalent to the one obtained by filling directly a TH1D using the 2-nd value as a weight. This makes sense only for profile filled with weights =1. If not, the error of the projected histogram obtained with this option will not be correct.

Definition at line 1220 of file TProfile.cxx.

◆ PutStats()

void TProfile::PutStats ( Double_t stats)
virtual

Replace current statistics with the values in array stats.

Reimplemented from TH1.

Definition at line 1295 of file TProfile.cxx.

◆ Rebin()

TH1 * TProfile::Rebin ( Int_t  ngroup = 2,
const char *  newname = "",
const Double_t xbins = 0 
)
virtual

Rebin this profile grouping ngroup bins together.

case 1 xbins=0

if newname is not blank a new temporary profile hnew is created. else the current profile is modified (default) The parameter ngroup indicates how many bins of this have to me merged into one bin of hnew If the original profile has errors stored (via Sumw2), the resulting profile has new errors correctly calculated.

examples: if hp is an existing TProfile histogram with 100 bins

hp->Rebin(); //merges two bins in one in hp: previous contents of hp are lost
hp->Rebin(5); //merges five bins in one in hp
TProfile *hnew = hp->Rebin(5,"hnew"); // creates a new profile hnew
//merging 5 bins of hp in one bin

NOTE: If ngroup is not an exact divider of the number of bins, the top limit of the rebinned profile is changed to the upper edge of the bin=newbins*ngroup and the corresponding bins are added to the overflow bin. Statistics will be recomputed from the new bin contents.

case 2 xbins!=0

a new profile is created (you should specify newname). The parameter ngroup is the number of variable size bins in the created profile The array xbins must contain ngroup+1 elements that represent the low-edge of the bins. The data of the old bins are added to the new bin which contains the bin center of the old bins. It is possible that information from the old binning are attached to the under-/overflow bins of the new binning.

examples: if hp is an existing TProfile with 100 bins

Double_t xbins[25] = {...} array of low-edges (xbins[25] is the upper edge of last bin
hp->Rebin(24,"hpnew",xbins); //creates a new variable bin size profile hpnew

Reimplemented from TH1.

Definition at line 1347 of file TProfile.cxx.

◆ Reset()

void TProfile::Reset ( Option_t option = "")
virtual

Reset contents of a Profile histogram.

Reimplemented from TH1D.

Definition at line 1534 of file TProfile.cxx.

◆ RetrieveBinContent()

virtual Double_t TProfile::RetrieveBinContent ( Int_t  bin) const
inlineprotectedvirtual

Raw retrieval of bin content on internal data structure see convention for numbering bins in TH1::GetBin.

Reimplemented from TH1D.

Definition at line 56 of file TProfile.h.

◆ SavePrimitive()

void TProfile::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TH1.

Definition at line 1549 of file TProfile.cxx.

◆ Scale()

void TProfile::Scale ( Double_t  c1 = 1,
Option_t option = "" 
)
virtual

Multiply this profile by a constant c1.

this = c1*this

This function uses the services of TProfile::Add

Reimplemented from TH1.

Definition at line 1629 of file TProfile.cxx.

◆ SetBinEntries()

void TProfile::SetBinEntries ( Int_t  bin,
Double_t  w 
)
virtual

Set the number of entries in bin.

Definition at line 1637 of file TProfile.cxx.

◆ SetBins() [1/7]

void TProfile::SetBins ( const Int_t nbins,
const Double_t range 
)
inlineprotected

Definition at line 53 of file TProfile.h.

◆ SetBins() [2/7]

void TProfile::SetBins ( Int_t  nx,
Double_t  xmin,
Double_t  xmax,
Int_t  ny,
Double_t  ymin,
Double_t  ymax 
)
inlineprivatevirtual

Redefine x and y axis parameters.

The X and Y axis parameters are modified. The bins content array is resized if errors (Sumw2) the errors array is resized The previous bin contents are lost To change only the axis limits, see TAxis::SetRange

Reimplemented from TH1.

Definition at line 67 of file TProfile.h.

◆ SetBins() [3/7]

void TProfile::SetBins ( Int_t  nx,
const Double_t xBins,
Int_t  ny,
const Double_t yBins 
)
inlineprivatevirtual

Redefine x and y axis parameters with variable bin sizes.

The X and Y axis parameters are modified. The bins content array is resized if errors (Sumw2) the errors array is resized The previous bin contents are lost To change only the axis limits, see TAxis::SetRange xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1

Reimplemented from TH1.

Definition at line 69 of file TProfile.h.

◆ SetBins() [4/7]

void TProfile::SetBins ( Int_t  nx,
Double_t  xmin,
Double_t  xmax,
Int_t  ny,
Double_t  ymin,
Double_t  ymax,
Int_t  nz,
Double_t  zmin,
Double_t  zmax 
)
inlineprivatevirtual

Redefine x, y and z axis parameters.

The X, Y and Z axis parameters are modified. The bins content array is resized if errors (Sumw2) the errors array is resized The previous bin contents are lost To change only the axis limits, see TAxis::SetRange

Reimplemented from TH1.

Definition at line 71 of file TProfile.h.

◆ SetBins() [5/7]

void TProfile::SetBins ( Int_t  nx,
const Double_t xBins,
Int_t  ny,
const Double_t yBins,
Int_t  nz,
const Double_t zBins 
)
inlineprivatevirtual

Redefine x, y and z axis parameters with variable bin sizes.

The X, Y and Z axis parameters are modified. The bins content array is resized if errors (Sumw2) the errors array is resized The previous bin contents are lost To change only the axis limits, see TAxis::SetRange xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1, zBins is supposed to be of length nz+1

Reimplemented from TH1.

Definition at line 73 of file TProfile.h.

◆ SetBins() [6/7]

void TProfile::SetBins ( Int_t  nbins,
Double_t  xmin,
Double_t  xmax 
)
virtual

Redefine x axis parameters.

Reimplemented from TH1.

Definition at line 1645 of file TProfile.cxx.

◆ SetBins() [7/7]

void TProfile::SetBins ( Int_t  nx,
const Double_t xbins 
)
virtual

Redefine x axis parameters.

Reimplemented from TH1.

Definition at line 1655 of file TProfile.cxx.

◆ SetBinsLength()

void TProfile::SetBinsLength ( Int_t  n = -1)
virtual

Set total number of bins including under/overflow.

Reallocate bin contents array

Reimplemented from TH1D.

Definition at line 1666 of file TProfile.cxx.

◆ SetBuffer()

void TProfile::SetBuffer ( Int_t  buffersize,
Option_t option = "" 
)
virtual

Set the buffer size in units of 8 bytes (double).

Reimplemented from TH1.

Definition at line 1675 of file TProfile.cxx.

◆ SetErrorOption()

void TProfile::SetErrorOption ( Option_t option = "")
virtual

Set option to compute profile errors.

The computation of the bin errors is based on the parameter option:

-' ' (Default) The bin errors are the standard error on the mean of the bin profiled values (Y), i.e. the standard error of the bin contents. Note that if TProfile::Approximate() is called, an approximation is used when the spread in Y is 0 and the number of bin entries is > 0 -'s' The bin errors are the standard deviations of the Y bin values Note that if TProfile::Approximate() is called, an approximation is used when the spread in Y is 0 and the number of bin entries is > 0 -'i' Errors are as in default case (standard errors of the bin contents) The only difference is for the case when the spread in Y is zero. In this case for N > 0 the error is 1./SQRT(12.*N) -'g' Errors are 1./SQRT(W) for W not equal to 0 and 0 for W = 0. W is the sum in the bin of the weights of the profile. This option is for combining measurements y +/- dy, and the profile is filled with values y and weights w = 1/dy**2

See TProfile::BuildOptions for a detailed explanation of all options

Definition at line 1714 of file TProfile.cxx.

◆ Sumw2()

void TProfile::Sumw2 ( Bool_t  flag = kTRUE)
virtual

Create/delete structure to store sum of squares of weights per bin.

This is needed to compute the correct statistical quantities of a profile filled with weights

This function is automatically called when the histogram is created if the static function TH1::SetDefaultSumw2 has been called before. If flag is false the structure is deleted

Reimplemented from TH1.

Definition at line 1762 of file TProfile.cxx.

Friends And Related Function Documentation

◆ TProfileHelper

friend class TProfileHelper
friend

Definition at line 35 of file TProfile.h.

Member Data Documentation

◆ fBinEntries

TArrayD TProfile::fBinEntries
protected

Definition at line 38 of file TProfile.h.

◆ fBinSumw2

TArrayD TProfile::fBinSumw2
protected

Definition at line 45 of file TProfile.h.

◆ fErrorMode

EErrorType TProfile::fErrorMode
protected

Definition at line 39 of file TProfile.h.

◆ fgApproximate

Bool_t TProfile::fgApproximate = kFALSE
staticprotected

Definition at line 47 of file TProfile.h.

◆ fScaling

Bool_t TProfile::fScaling
protected

Definition at line 42 of file TProfile.h.

◆ fTsumwy

Double_t TProfile::fTsumwy
protected

True when TProfile::Scale is called.

Definition at line 43 of file TProfile.h.

◆ fTsumwy2

Double_t TProfile::fTsumwy2
protected

Definition at line 44 of file TProfile.h.

◆ fYmax

Double_t TProfile::fYmax
protected

Definition at line 41 of file TProfile.h.

◆ fYmin

Double_t TProfile::fYmin
protected

Definition at line 40 of file TProfile.h.

Libraries for TProfile:
[legend]

The documentation for this class was generated from the following files: