Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TH1.cxx
Go to the documentation of this file.
1// @(#)root/hist:$Id$
2// Author: Rene Brun 26/12/94
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#include <array>
13#include <cctype>
14#include <climits>
15#include <cmath>
16#include <cstdio>
17#include <cstdlib>
18#include <cstring>
19#include <iostream>
20#include <memory>
21#include <sstream>
22#include <fstream>
23#include <limits>
24#include <iomanip>
25
26#include "TROOT.h"
27#include "TBuffer.h"
28#include "TEnv.h"
29#include "TClass.h"
30#include "TMath.h"
31#include "THashList.h"
32#include "TH1.h"
33#include "TH2.h"
34#include "TH3.h"
35#include "TF2.h"
36#include "TF3.h"
37#include "TPluginManager.h"
38#include "TVirtualPad.h"
39#include "TRandom.h"
40#include "TVirtualFitter.h"
41#include "THLimitsFinder.h"
42#include "TProfile.h"
43#include "TStyle.h"
44#include "TVectorF.h"
45#include "TVectorD.h"
46#include "TBrowser.h"
47#include "TError.h"
48#include "TVirtualHistPainter.h"
49#include "TVirtualFFT.h"
50#include "TVirtualPaveStats.h"
51
52#include "HFitInterface.h"
53#include "Fit/DataRange.h"
54#include "Fit/BinData.h"
55#include "Math/GoFTest.h"
58
59#include "TH1Merger.h"
60
61/** \addtogroup Histograms
62@{
63\class TH1C
64\brief 1-D histogram with a byte per channel (see TH1 documentation)
65\class TH1S
66\brief 1-D histogram with a short per channel (see TH1 documentation)
67\class TH1I
68\brief 1-D histogram with an int per channel (see TH1 documentation)
69\class TH1L
70\brief 1-D histogram with a long64 per channel (see TH1 documentation)
71\class TH1F
72\brief 1-D histogram with a float per channel (see TH1 documentation)
73\class TH1D
74\brief 1-D histogram with a double per channel (see TH1 documentation)
75@}
76*/
77
78/** \class TH1
79 \ingroup Histograms
80TH1 is the base class of all histogram classes in %ROOT.
81
82It provides the common interface for operations such as binning, filling, drawing, which
83will be detailed below.
84
85-# [Creating histograms](\ref creating-histograms)
86 - [Labelling axes](\ref labelling-axis)
87-# [Binning](\ref binning)
88 - [Fix or variable bin size](\ref fix-var)
89 - [Convention for numbering bins](\ref convention)
90 - [Alphanumeric Bin Labels](\ref alpha)
91 - [Histograms with automatic bins](\ref auto-bin)
92 - [Rebinning](\ref rebinning)
93-# [Filling histograms](\ref filling-histograms)
94 - [Associated errors](\ref associated-errors)
95 - [Associated functions](\ref associated-functions)
96 - [Projections of histograms](\ref prof-hist)
97 - [Random Numbers and histograms](\ref random-numbers)
98 - [Making a copy of a histogram](\ref making-a-copy)
99 - [Normalizing histograms](\ref normalizing)
100-# [Drawing histograms](\ref drawing-histograms)
101 - [Setting Drawing histogram contour levels (2-D hists only)](\ref cont-level)
102 - [Setting histogram graphics attributes](\ref graph-att)
103 - [Customising how axes are drawn](\ref axis-drawing)
104-# [Fitting histograms](\ref fitting-histograms)
105-# [Saving/reading histograms to/from a ROOT file](\ref saving-histograms)
106-# [Operations on histograms](\ref operations-on-histograms)
107-# [Miscellaneous operations](\ref misc)
108
109ROOT supports the following histogram types:
110
111 - 1-D histograms:
112 - TH1C : histograms with one byte per channel. Maximum bin content = 127
113 - TH1S : histograms with one short per channel. Maximum bin content = 32767
114 - TH1I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
115 - TH1L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
116 - TH1F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content = +/-16777216 (\ref floatmax "***")
117 - TH1D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content = +/-9007199254740992 (\ref doublemax "****")
118 - 2-D histograms:
119 - TH2C : histograms with one byte per channel. Maximum bin content = 127
120 - TH2S : histograms with one short per channel. Maximum bin content = 32767
121 - TH2I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
122 - TH2L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
123 - TH2F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content = +/-16777216 (\ref floatmax "***")
124 - TH2D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content = +/-9007199254740992 (\ref doublemax "****")
125 - 3-D histograms:
126 - TH3C : histograms with one byte per channel. Maximum bin content = 127
127 - TH3S : histograms with one short per channel. Maximum bin content = 32767
128 - TH3I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
129 - TH3L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
130 - TH3F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content = +/-16777216 (\ref floatmax "***")
131 - TH3D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content = +/-9007199254740992 (\ref doublemax "****")
132 - Profile histograms: See classes TProfile, TProfile2D and TProfile3D.
133 Profile histograms are used to display the mean value of Y and its standard deviation
134 for each bin in X. Profile histograms are in many cases an elegant
135 replacement of two-dimensional histograms : the inter-relation of two
136 measured quantities X and Y can always be visualized by a two-dimensional
137 histogram or scatter-plot; If Y is an unknown (but single-valued)
138 approximate function of X, this function is displayed by a profile
139 histogram with much better precision than by a scatter-plot.
140
141<sup>
142\anchor intmax (*) INT_MAX = 2147483647 is the [maximum value for a variable of type int.](https://docs.microsoft.com/en-us/cpp/c-language/cpp-integer-limits)<br>
143\anchor llongmax (**) LLONG_MAX = 9223372036854775807 is the [maximum value for a variable of type long64.](https://docs.microsoft.com/en-us/cpp/c-language/cpp-integer-limits)<br>
144\anchor floatmax (***) 2^24 = 16777216 is the [maximum integer that can be properly represented by a float32 with 23-bit mantissa.](https://stackoverflow.com/a/3793950/7471760)<br>
145\anchor doublemax (****) 2^53 = 9007199254740992 is the [maximum integer that can be properly represented by a double64 with 52-bit mantissa.](https://stackoverflow.com/a/3793950/7471760)
146</sup>
147
148The inheritance hierarchy looks as follows:
149
150\image html classTH1__inherit__graph_org.svg width=100%
151
152\anchor creating-histograms
153## Creating histograms
154
155Histograms are created by invoking one of the constructors, e.g.
156~~~ {.cpp}
157 TH1F *h1 = new TH1F("h1", "h1 title", 100, 0, 4.4);
158 TH2F *h2 = new TH2F("h2", "h2 title", 40, 0, 4, 30, -3, 3);
159~~~
160Histograms may also be created by:
161
162 - calling the Clone() function, see below
163 - making a projection from a 2-D or 3-D histogram, see below
164 - reading a histogram from a file
165
166 When a histogram is created, a reference to it is automatically added
167 to the list of in-memory objects for the current file or directory.
168 Then the pointer to this histogram in the current directory can be found
169 by its name, doing:
170~~~ {.cpp}
171 TH1F *h1 = (TH1F*)gDirectory->FindObject(name);
172~~~
173
174 This default behaviour can be changed by:
175~~~ {.cpp}
176 h->SetDirectory(nullptr); // for the current histogram h
177 TH1::AddDirectory(kFALSE); // sets a global switch disabling the referencing
178~~~
179 When the histogram is deleted, the reference to it is removed from
180 the list of objects in memory.
181 When a file is closed, all histograms in memory associated with this file
182 are automatically deleted.
183
184\anchor labelling-axis
185### Labelling axes
186
187 Axis titles can be specified in the title argument of the constructor.
188 They must be separated by ";":
189~~~ {.cpp}
190 TH1F* h=new TH1F("h", "Histogram title;X Axis;Y Axis", 100, 0, 1);
191~~~
192 The histogram title and the axis titles can be any TLatex string, and
193 are persisted if a histogram is written to a file.
194
195 Any title can be omitted:
196~~~ {.cpp}
197 TH1F* h=new TH1F("h", "Histogram title;;Y Axis", 100, 0, 1);
198 TH1F* h=new TH1F("h", ";;Y Axis", 100, 0, 1);
199~~~
200 The method SetTitle() has the same syntax:
201~~~ {.cpp}
202 h->SetTitle("Histogram title;Another X title Axis");
203~~~
204Alternatively, the title of each axis can be set directly:
205~~~ {.cpp}
206 h->GetXaxis()->SetTitle("X axis title");
207 h->GetYaxis()->SetTitle("Y axis title");
208~~~
209For bin labels see \ref binning.
210
211\anchor binning
212## Binning
213
214\anchor fix-var
215### Fix or variable bin size
216
217 All histogram types support either fix or variable bin sizes.
218 2-D histograms may have fix size bins along X and variable size bins
219 along Y or vice-versa. The functions to fill, manipulate, draw or access
220 histograms are identical in both cases.
221
222 Each histogram always contains 3 axis objects of type TAxis: fXaxis, fYaxis and fZaxis.
223 To access the axis parameters, use:
224~~~ {.cpp}
225 TAxis *xaxis = h->GetXaxis(); etc.
226 Double_t binCenter = xaxis->GetBinCenter(bin), etc.
227~~~
228 See class TAxis for a description of all the access functions.
229 The axis range is always stored internally in double precision.
230
231\anchor convention
232### Convention for numbering bins
233
234 For all histogram types: nbins, xlow, xup
235~~~ {.cpp}
236 bin = 0; underflow bin
237 bin = 1; first bin with low-edge xlow INCLUDED
238 bin = nbins; last bin with upper-edge xup EXCLUDED
239 bin = nbins+1; overflow bin
240~~~
241 In case of 2-D or 3-D histograms, a "global bin" number is defined.
242 For example, assuming a 3-D histogram with (binx, biny, binz), the function
243~~~ {.cpp}
244 Int_t gbin = h->GetBin(binx, biny, binz);
245~~~
246 returns a global/linearized gbin number. This global gbin is useful
247 to access the bin content/error information independently of the dimension.
248 Note that to access the information other than bin content and errors
249 one should use the TAxis object directly with e.g.:
250~~~ {.cpp}
251 Double_t xcenter = h3->GetZaxis()->GetBinCenter(27);
252~~~
253 returns the center along z of bin number 27 (not the global bin)
254 in the 3-D histogram h3.
255
256\anchor alpha
257### Alphanumeric Bin Labels
258
259 By default, a histogram axis is drawn with its numeric bin labels.
260 One can specify alphanumeric labels instead with:
261
262 - call TAxis::SetBinLabel(bin, label);
263 This can always be done before or after filling.
264 When the histogram is drawn, bin labels will be automatically drawn.
265 See examples labels1.C and labels2.C
266 - call to a Fill function with one of the arguments being a string, e.g.
267~~~ {.cpp}
268 hist1->Fill(somename, weight);
269 hist2->Fill(x, somename, weight);
270 hist2->Fill(somename, y, weight);
271 hist2->Fill(somenamex, somenamey, weight);
272~~~
273 See examples hlabels1.C and hlabels2.C
274 - via TTree::Draw. see for example cernstaff.C
275~~~ {.cpp}
276 tree.Draw("Nation::Division");
277~~~
278 where "Nation" and "Division" are two branches of a Tree.
279
280When using the options 2 or 3 above, the labels are automatically
281 added to the list (THashList) of labels for a given axis.
282 By default, an axis is drawn with the order of bins corresponding
283 to the filling sequence. It is possible to reorder the axis
284
285 - alphabetically
286 - by increasing or decreasing values
287
288 The reordering can be triggered via the TAxis context menu by selecting
289 the menu item "LabelsOption" or by calling directly
290 TH1::LabelsOption(option, axis) where
291
292 - axis may be "X", "Y" or "Z"
293 - option may be:
294 - "a" sort by alphabetic order
295 - ">" sort by decreasing values
296 - "<" sort by increasing values
297 - "h" draw labels horizontal
298 - "v" draw labels vertical
299 - "u" draw labels up (end of label right adjusted)
300 - "d" draw labels down (start of label left adjusted)
301
302 When using the option 2 above, new labels are added by doubling the current
303 number of bins in case one label does not exist yet.
304 When the Filling is terminated, it is possible to trim the number
305 of bins to match the number of active labels by calling
306~~~ {.cpp}
307 TH1::LabelsDeflate(axis) with axis = "X", "Y" or "Z"
308~~~
309 This operation is automatic when using TTree::Draw.
310 Once bin labels have been created, they become persistent if the histogram
311 is written to a file or when generating the C++ code via SavePrimitive.
312
313\anchor auto-bin
314### Histograms with automatic bins
315
316 When a histogram is created with an axis lower limit greater or equal
317 to its upper limit, the SetBuffer is automatically called with an
318 argument fBufferSize equal to fgBufferSize (default value=1000).
319 fgBufferSize may be reset via the static function TH1::SetDefaultBufferSize.
320 The axis limits will be automatically computed when the buffer will
321 be full or when the function BufferEmpty is called.
322
323\anchor rebinning
324### Rebinning
325
326 At any time, a histogram can be rebinned via TH1::Rebin. This function
327 returns a new histogram with the rebinned contents.
328 If bin errors were stored, they are recomputed during the rebinning.
329
330
331\anchor filling-histograms
332## Filling histograms
333
334 A histogram is typically filled with statements like:
335~~~ {.cpp}
336 h1->Fill(x);
337 h1->Fill(x, w); //fill with weight
338 h2->Fill(x, y)
339 h2->Fill(x, y, w)
340 h3->Fill(x, y, z)
341 h3->Fill(x, y, z, w)
342~~~
343 or via one of the Fill functions accepting names described above.
344 The Fill functions compute the bin number corresponding to the given
345 x, y or z argument and increment this bin by the given weight.
346 The Fill functions return the bin number for 1-D histograms or global
347 bin number for 2-D and 3-D histograms.
348 If TH1::Sumw2 has been called before filling, the sum of squares of
349 weights is also stored.
350 One can also increment directly a bin number via TH1::AddBinContent
351 or replace the existing content via TH1::SetBinContent. Passing an
352 out-of-range bin to TH1::AddBinContent leads to undefined behavior.
353 To access the bin content of a given bin, do:
354~~~ {.cpp}
355 Double_t binContent = h->GetBinContent(bin);
356~~~
357
358 By default, the bin number is computed using the current axis ranges.
359 If the automatic binning option has been set via
360~~~ {.cpp}
361 h->SetCanExtend(TH1::kAllAxes);
362~~~
363 then, the Fill Function will automatically extend the axis range to
364 accommodate the new value specified in the Fill argument. The method
365 used is to double the bin size until the new value fits in the range,
366 merging bins two by two. This automatic binning options is extensively
367 used by the TTree::Draw function when histogramming Tree variables
368 with an unknown range.
369 This automatic binning option is supported for 1-D, 2-D and 3-D histograms.
370
371 During filling, some statistics parameters are incremented to compute
372 the mean value and Root Mean Square with the maximum precision.
373
374 In case of histograms of type TH1C, TH1S, TH2C, TH2S, TH3C, TH3S
375 a check is made that the bin contents do not exceed the maximum positive
376 capacity (127 or 32767). Histograms of all types may have positive
377 or/and negative bin contents.
378
379\anchor associated-errors
380### Associated errors
381 By default, for each bin, the sum of weights is computed at fill time.
382 One can also call TH1::Sumw2 to force the storage and computation
383 of the sum of the square of weights per bin.
384 If Sumw2 has been called, the error per bin is computed as the
385 sqrt(sum of squares of weights), otherwise the error is set equal
386 to the sqrt(bin content).
387 To return the error for a given bin number, do:
388~~~ {.cpp}
389 Double_t error = h->GetBinError(bin);
390~~~
391
392\anchor associated-functions
393### Associated functions
394 One or more objects (typically a TF1*) can be added to the list
395 of functions (fFunctions) associated to each histogram.
396 When TH1::Fit is invoked, the fitted function is added to this list.
397 Given a histogram (or TGraph) `h`, one can retrieve an associated function
398 with:
399~~~ {.cpp}
400 TF1 *myfunc = h->GetFunction("myfunc");
401~~~
402
403
404\anchor operations-on-histograms
405## Operations on histograms
406
407 Many types of operations are supported on histograms or between histograms
408
409 - Addition of a histogram to the current histogram.
410 - Additions of two histograms with coefficients and storage into the current
411 histogram.
412 - Multiplications and Divisions are supported in the same way as additions.
413 - The Add, Divide and Multiply functions also exist to add, divide or multiply
414 a histogram by a function.
415
416 If a histogram has associated error bars (TH1::Sumw2 has been called),
417 the resulting error bars are also computed assuming independent histograms.
418 In case of divisions, Binomial errors are also supported.
419 One can mark a histogram to be an "average" histogram by setting its bit kIsAverage via
420 myhist.SetBit(TH1::kIsAverage);
421 When adding (see TH1::Add) average histograms, the histograms are averaged and not summed.
422
423
424\anchor prof-hist
425### Projections of histograms
426
427 One can:
428
429 - make a 1-D projection of a 2-D histogram or Profile
430 see functions TH2::ProjectionX,Y, TH2::ProfileX,Y, TProfile::ProjectionX
431 - make a 1-D, 2-D or profile out of a 3-D histogram
432 see functions TH3::ProjectionZ, TH3::Project3D.
433
434 One can fit these projections via:
435~~~ {.cpp}
436 TH2::FitSlicesX,Y, TH3::FitSlicesZ.
437~~~
438
439\anchor random-numbers
440### Random Numbers and histograms
441
442 TH1::FillRandom can be used to randomly fill a histogram using
443 the contents of an existing TF1 function or another
444 TH1 histogram (for all dimensions).
445 For example, the following two statements create and fill a histogram
446 10000 times with a default gaussian distribution of mean 0 and sigma 1:
447~~~ {.cpp}
448 TH1F h1("h1", "histo from a gaussian", 100, -3, 3);
449 h1.FillRandom("gaus", 10000);
450~~~
451 TH1::GetRandom can be used to return a random number distributed
452 according to the contents of a histogram.
453
454\anchor making-a-copy
455### Making a copy of a histogram
456 Like for any other ROOT object derived from TObject, one can use
457 the Clone() function. This makes an identical copy of the original
458 histogram including all associated errors and functions, e.g.:
459~~~ {.cpp}
460 TH1F *hnew = (TH1F*)h->Clone("hnew");
461~~~
462
463\anchor normalizing
464### Normalizing histograms
465
466 One can scale a histogram such that the bins integral is equal to
467 the normalization parameter via TH1::Scale(Double_t norm), where norm
468 is the desired normalization divided by the integral of the histogram.
471\anchor drawing-histograms
472## Drawing histograms
473
474 Histograms are drawn via the THistPainter class. Each histogram has
475 a pointer to its own painter (to be usable in a multithreaded program).
476 Many drawing options are supported.
477 See THistPainter::Paint() for more details.
478
479 The same histogram can be drawn with different options in different pads.
480 When a histogram drawn in a pad is deleted, the histogram is
481 automatically removed from all pads where it was drawn.
482 If a histogram is drawn in a pad, then modified, the new status
483 of the histogram will be automatically shown in the pad next time
484 the pad is updated. One does not need to redraw the histogram.
485 To draw the current version of a histogram in a pad, one can use
486~~~ {.cpp}
487 h->DrawCopy();
488~~~
489 DrawCopy() is also useful when a temporary histogram should be drawn, for
490 example in
491~~~ {.cpp}
492 void drawHisto() {
493 TH1D histo("histo", "An example histogram", 10, 0, 10);
494 // ...
495 histo.DrawCopy();
496 } // histo goes out of scope here, but the copy stays visible
497~~~
498
499 One can use TH1::SetMaximum() and TH1::SetMinimum() to force a particular
500 value for the maximum or the minimum scale on the plot. (For 1-D
501 histograms this means the y-axis, while for 2-D histograms these
502 functions affect the z-axis).
503
504 TH1::UseCurrentStyle() can be used to change all histogram graphics
505 attributes to correspond to the current selected style.
506 This function must be called for each histogram.
507 In case one reads and draws many histograms from a file, one can force
508 the histograms to inherit automatically the current graphics style
509 by calling before gROOT->ForceStyle().
510
511\anchor cont-level
512### Setting Drawing histogram contour levels (2-D hists only)
513
514 By default contours are automatically generated at equidistant
515 intervals. A default value of 20 levels is used. This can be modified
516 via TH1::SetContour() or TH1::SetContourLevel().
517 the contours level info is used by the drawing options "cont", "surf",
518 and "lego".
519
520\anchor graph-att
521### Setting histogram graphics attributes
522
523 The histogram classes inherit from the attribute classes:
524 TAttLine, TAttFill, and TAttMarker.
525 See the member functions of these classes for the list of options.
526
527\anchor axis-drawing
528### Customizing how axes are drawn
529
530 Use the functions of TAxis, such as
531~~~ {.cpp}
532 histogram.GetXaxis()->SetTicks("+");
533 histogram.GetYaxis()->SetRangeUser(1., 5.);
534~~~
535
536\anchor fitting-histograms
537## Fitting histograms
538
539 Histograms (1-D, 2-D, 3-D and Profiles) can be fitted with a user
540 specified function or a pre-defined function via TH1::Fit.
541 See TH1::Fit(TF1*, Option_t *, Option_t *, Double_t, Double_t) for the fitting documentation and the possible [fitting options](\ref HFitOpt)
542
543 The FitPanel can also be used for fitting an histogram. See the [FitPanel documentation](https://root.cern/manual/fitting/#using-the-fit-panel).
544
545\anchor saving-histograms
546## Saving/reading histograms to/from a ROOT file
547
548 The following statements create a ROOT file and store a histogram
549 on the file. Because TH1 derives from TNamed, the key identifier on
550 the file is the histogram name:
551~~~ {.cpp}
552 TFile f("histos.root", "new");
553 TH1F h1("hgaus", "histo from a gaussian", 100, -3, 3);
554 h1.FillRandom("gaus", 10000);
555 h1->Write();
556~~~
557 To read this histogram in another Root session, do:
558~~~ {.cpp}
559 TFile f("histos.root");
560 TH1F *h = (TH1F*)f.Get("hgaus");
561~~~
562 One can save all histograms in memory to the file by:
563~~~ {.cpp}
564 file->Write();
565~~~
566
567
568\anchor misc
569## Miscellaneous operations
570
571~~~ {.cpp}
572 TH1::KolmogorovTest(): statistical test of compatibility in shape
573 between two histograms
574 TH1::Smooth() smooths the bin contents of a 1-d histogram
575 TH1::Integral() returns the integral of bin contents in a given bin range
576 TH1::GetMean(int axis) returns the mean value along axis
577 TH1::GetStdDev(int axis) returns the sigma distribution along axis
578 TH1::GetEntries() returns the number of entries
579 TH1::Reset() resets the bin contents and errors of a histogram
580~~~
581 IMPORTANT NOTE: The returned values for GetMean and GetStdDev depend on how the
582 histogram statistics are calculated. By default, if no range has been set, the
583 returned values are the (unbinned) ones calculated at fill time. If a range has been
584 set, however, the values are calculated using the bins in range; THIS IS TRUE EVEN
585 IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset the range.
586 To ensure that the returned values are always those of the binned data stored in the
587 histogram, call TH1::ResetStats. See TH1::GetStats.
588*/
589
590TF1 *gF1=nullptr; //left for back compatibility (use TVirtualFitter::GetUserFunc instead)
591
596
597extern void H1InitGaus();
598extern void H1InitExpo();
599extern void H1InitPolynom();
600extern void H1LeastSquareFit(Int_t n, Int_t m, Double_t *a);
603
604
605////////////////////////////////////////////////////////////////////////////////
606/// Histogram default constructor.
607
609{
610 fDirectory = nullptr;
611 fFunctions = new TList;
612 fNcells = 0;
613 fIntegral = nullptr;
614 fPainter = nullptr;
615 fEntries = 0;
616 fNormFactor = 0;
618 fMaximum = -1111;
619 fMinimum = -1111;
620 fBufferSize = 0;
621 fBuffer = nullptr;
624 fXaxis.SetName("xaxis");
625 fYaxis.SetName("yaxis");
626 fZaxis.SetName("zaxis");
627 fXaxis.SetParent(this);
628 fYaxis.SetParent(this);
629 fZaxis.SetParent(this);
631}
632
633////////////////////////////////////////////////////////////////////////////////
634/// Histogram default destructor.
635
637{
639 return;
640 }
641 delete[] fIntegral;
642 fIntegral = nullptr;
643 delete[] fBuffer;
644 fBuffer = nullptr;
645 if (fFunctions) {
647
649 TObject* obj = nullptr;
650 //special logic to support the case where the same object is
651 //added multiple times in fFunctions.
652 //This case happens when the same object is added with different
653 //drawing modes
654 //In the loop below we must be careful with objects (eg TCutG) that may
655 // have been added to the list of functions of several histograms
656 //and may have been already deleted.
657 while ((obj = fFunctions->First())) {
658 while(fFunctions->Remove(obj)) { }
660 break;
661 }
662 delete obj;
663 obj = nullptr;
664 }
665 delete fFunctions;
666 fFunctions = nullptr;
667 }
668 if (fDirectory) {
669 fDirectory->Remove(this);
670 fDirectory = nullptr;
671 }
672 delete fPainter;
673 fPainter = nullptr;
674}
675
676////////////////////////////////////////////////////////////////////////////////
677/// Constructor for fix bin size histograms.
678/// Creates the main histogram structure.
679///
680/// \param[in] name name of histogram (avoid blanks)
681/// \param[in] title histogram title.
682/// If title is of the form `stringt;stringx;stringy;stringz`,
683/// the histogram title is set to `stringt`,
684/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
685/// \param[in] nbins number of bins
686/// \param[in] xlow low edge of first bin
687/// \param[in] xup upper edge of last bin (not included in last bin)
688
689
690TH1::TH1(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
691 :TNamed(name,title)
692{
693 Build();
694 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
695 fXaxis.Set(nbins,xlow,xup);
696 fNcells = fXaxis.GetNbins()+2;
697}
698
699////////////////////////////////////////////////////////////////////////////////
700/// Constructor for variable bin size histograms using an input array of type float.
701/// Creates the main histogram structure.
702///
703/// \param[in] name name of histogram (avoid blanks)
704/// \param[in] title histogram title.
705/// If title is of the form `stringt;stringx;stringy;stringz`
706/// the histogram title is set to `stringt`,
707/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
708/// \param[in] nbins number of bins
709/// \param[in] xbins array of low-edges for each bin.
710/// This is an array of type float and size nbins+1
711
712TH1::TH1(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
713 :TNamed(name,title)
714{
715 Build();
716 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
717 if (xbins) fXaxis.Set(nbins,xbins);
718 else fXaxis.Set(nbins,0,1);
719 fNcells = fXaxis.GetNbins()+2;
720}
721
722////////////////////////////////////////////////////////////////////////////////
723/// Constructor for variable bin size histograms using an input array of type double.
724///
725/// \param[in] name name of histogram (avoid blanks)
726/// \param[in] title histogram title.
727/// If title is of the form `stringt;stringx;stringy;stringz`
728/// the histogram title is set to `stringt`,
729/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
730/// \param[in] nbins number of bins
731/// \param[in] xbins array of low-edges for each bin.
732/// This is an array of type double and size nbins+1
733
734TH1::TH1(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
735 :TNamed(name,title)
736{
737 Build();
738 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
739 if (xbins) fXaxis.Set(nbins,xbins);
740 else fXaxis.Set(nbins,0,1);
741 fNcells = fXaxis.GetNbins()+2;
742}
743
744////////////////////////////////////////////////////////////////////////////////
745/// Static function: cannot be inlined on Windows/NT.
746
751
752////////////////////////////////////////////////////////////////////////////////
753/// Browse the Histogram object.
754
756{
757 Draw(b ? b->GetDrawOption() : "");
758 gPad->Update();
759}
760
761////////////////////////////////////////////////////////////////////////////////
762/// Creates histogram basic data structure.
763
765{
766 fDirectory = nullptr;
767 fPainter = nullptr;
768 fIntegral = nullptr;
769 fEntries = 0;
770 fNormFactor = 0;
772 fMaximum = -1111;
773 fMinimum = -1111;
774 fBufferSize = 0;
775 fBuffer = nullptr;
778 fXaxis.SetName("xaxis");
779 fYaxis.SetName("yaxis");
780 fZaxis.SetName("zaxis");
781 fYaxis.Set(1,0.,1.);
782 fZaxis.Set(1,0.,1.);
783 fXaxis.SetParent(this);
784 fYaxis.SetParent(this);
785 fZaxis.SetParent(this);
786
788
789 fFunctions = new TList;
790
792
795 if (fDirectory) {
797 fDirectory->Append(this,kTRUE);
798 }
799 }
800}
801
802////////////////////////////////////////////////////////////////////////////////
803/// Performs the operation: `this = this + c1*f1`
804/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
805///
806/// By default, the function is computed at the centre of the bin.
807/// if option "I" is specified (1-d histogram only), the integral of the
808/// function in each bin is used instead of the value of the function at
809/// the centre of the bin.
810///
811/// Only bins inside the function range are recomputed.
812///
813/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
814/// you should call Sumw2 before making this operation.
815/// This is particularly important if you fit the histogram after TH1::Add
816///
817/// The function return kFALSE if the Add operation failed
818
820{
821 if (!f1) {
822 Error("Add","Attempt to add a non-existing function");
823 return kFALSE;
824 }
825
826 TString opt = option;
827 opt.ToLower();
828 Bool_t integral = kFALSE;
829 if (opt.Contains("i") && fDimension == 1) integral = kTRUE;
830
831 Int_t ncellsx = GetNbinsX() + 2; // cells = normal bins + underflow bin + overflow bin
832 Int_t ncellsy = GetNbinsY() + 2;
833 Int_t ncellsz = GetNbinsZ() + 2;
834 if (fDimension < 2) ncellsy = 1;
835 if (fDimension < 3) ncellsz = 1;
836
837 // delete buffer if it is there since it will become invalid
838 if (fBuffer) BufferEmpty(1);
839
840 // - Add statistics
841 Double_t s1[10];
842 for (Int_t i = 0; i < 10; ++i) s1[i] = 0;
843 PutStats(s1);
844 SetMinimum();
845 SetMaximum();
846
847 // - Loop on bins (including underflows/overflows)
848 Int_t bin, binx, biny, binz;
849 Double_t cu=0;
850 Double_t xx[3];
851 Double_t *params = nullptr;
852 f1->InitArgs(xx,params);
853 for (binz = 0; binz < ncellsz; ++binz) {
855 for (biny = 0; biny < ncellsy; ++biny) {
857 for (binx = 0; binx < ncellsx; ++binx) {
859 if (!f1->IsInside(xx)) continue;
861 bin = binx + ncellsx * (biny + ncellsy * binz);
862 if (integral) {
864 } else {
865 cu = c1*f1->EvalPar(xx);
866 }
867 if (TF1::RejectedPoint()) continue;
868 AddBinContent(bin,cu);
869 }
870 }
871 }
872
873 return kTRUE;
874}
875
876int TH1::LoggedInconsistency(const char *name, const TH1 *h1, const TH1 *h2, bool useMerge) const
877{
878 const auto inconsistency = CheckConsistency(h1, h2);
879
881 if (useMerge)
882 Info(name, "Histograms have different dimensions - trying to use TH1::Merge");
883 else {
884 Error(name, "Histograms have different dimensions");
885 }
887 if (useMerge)
888 Info(name, "Histograms have different number of bins - trying to use TH1::Merge");
889 else {
890 Error(name, "Histograms have different number of bins");
891 }
892 } else if (inconsistency & kDifferentAxisLimits) {
893 if (useMerge)
894 Info(name, "Histograms have different axis limits - trying to use TH1::Merge");
895 else
896 Warning(name, "Histograms have different axis limits");
897 } else if (inconsistency & kDifferentBinLimits) {
898 if (useMerge)
899 Info(name, "Histograms have different bin limits - trying to use TH1::Merge");
900 else
901 Warning(name, "Histograms have different bin limits");
902 } else if (inconsistency & kDifferentLabels) {
903 // in case of different labels -
904 if (useMerge)
905 Info(name, "Histograms have different labels - trying to use TH1::Merge");
906 else
907 Info(name, "Histograms have different labels");
908 }
909
910 return inconsistency;
911}
912
913////////////////////////////////////////////////////////////////////////////////
914/// Performs the operation: `this = this + c1*h1`
915/// If errors are defined (see TH1::Sumw2), errors are also recalculated.
916///
917/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
918/// if not already set.
919///
920/// Note also that adding histogram with labels is not supported, histogram will be
921/// added merging them by bin number independently of the labels.
922/// For adding histogram with labels one should use TH1::Merge
923///
924/// SPECIAL CASE (Average/Efficiency histograms)
925/// For histograms representing averages or efficiencies, one should compute the average
926/// of the two histograms and not the sum. One can mark a histogram to be an average
927/// histogram by setting its bit kIsAverage with
928/// myhist.SetBit(TH1::kIsAverage);
929/// Note that the two histograms must have their kIsAverage bit set
930///
931/// IMPORTANT NOTE1: If you intend to use the errors of this histogram later
932/// you should call Sumw2 before making this operation.
933/// This is particularly important if you fit the histogram after TH1::Add
934///
935/// IMPORTANT NOTE2: if h1 has a normalisation factor, the normalisation factor
936/// is used , ie this = this + c1*factor*h1
937/// Use the other TH1::Add function if you do not want this feature
938///
939/// IMPORTANT NOTE3: You should be careful about the statistics of the
940/// returned histogram, whose statistics may be binned or unbinned,
941/// depending on whether c1 is negative, whether TAxis::kAxisRange is true,
942/// and whether TH1::ResetStats has been called on either this or h1.
943/// See TH1::GetStats.
944///
945/// The function return kFALSE if the Add operation failed
946
948{
949 if (!h1) {
950 Error("Add","Attempt to add a non-existing histogram");
951 return kFALSE;
952 }
953
954 // delete buffer if it is there since it will become invalid
955 if (fBuffer) BufferEmpty(1);
956
957 bool useMerge = false;
958 const bool considerMerge = (c1 == 1. && !this->TestBit(kIsAverage) && !h1->TestBit(kIsAverage) );
959 const auto inconsistency = LoggedInconsistency("Add", this, h1, considerMerge);
960 // If there is a bad inconsistency and we can't even consider merging, just give up
962 return false;
963 }
964 // If there is an inconsistency, we try to use merging
967 }
968
969 if (useMerge) {
970 TList l;
971 l.Add(const_cast<TH1*>(h1));
972 auto iret = Merge(&l);
973 return (iret >= 0);
974 }
975
976 // Create Sumw2 if h1 has Sumw2 set
977 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
978 // In addition, create Sumw2 if is not a simple addition, otherwise errors will not be correctly computed
979 if (fSumw2.fN == 0 && c1 != 1.0) Sumw2();
980
981 // - Add statistics (for c1=1)
982 Double_t entries = GetEntries() + h1->GetEntries();
983
984 // statistics can be preserved only in case of positive coefficients
985 // otherwise with negative c1 (histogram subtraction) one risks to get negative variances
986 Bool_t resetStats = (c1 < 0);
987 Double_t s1[kNstat] = {0};
988 Double_t s2[kNstat] = {0};
989 if (!resetStats) {
990 // need to initialize to zero s1 and s2 since
991 // GetStats fills only used elements depending on dimension and type
992 GetStats(s1);
993 h1->GetStats(s2);
994 }
995
996 SetMinimum();
997 SetMaximum();
998
999 // - Loop on bins (including underflows/overflows)
1000 Double_t factor = 1;
1001 if (h1->GetNormFactor() != 0) factor = h1->GetNormFactor()/h1->GetSumOfWeights();
1002 Double_t c1sq = c1 * c1;
1003 Double_t factsq = factor * factor;
1004
1005 for (Int_t bin = 0; bin < fNcells; ++bin) {
1006 //special case where histograms have the kIsAverage bit set
1007 if (this->TestBit(kIsAverage) && h1->TestBit(kIsAverage)) {
1009 Double_t y2 = this->RetrieveBinContent(bin);
1012 Double_t w1 = 1., w2 = 1.;
1013
1014 // consider all special cases when bin errors are zero
1015 // see http://root-forum.cern.ch/viewtopic.php?f=3&t=13299
1016 if (e1sq) w1 = 1. / e1sq;
1017 else if (h1->fSumw2.fN) {
1018 w1 = 1.E200; // use an arbitrary huge value
1019 if (y1 == 0) {
1020 // use an estimated error from the global histogram scale
1021 double sf = (s2[0] != 0) ? s2[1]/s2[0] : 1;
1022 w1 = 1./(sf*sf);
1023 }
1024 }
1025 if (e2sq) w2 = 1. / e2sq;
1026 else if (fSumw2.fN) {
1027 w2 = 1.E200; // use an arbitrary huge value
1028 if (y2 == 0) {
1029 // use an estimated error from the global histogram scale
1030 double sf = (s1[0] != 0) ? s1[1]/s1[0] : 1;
1031 w2 = 1./(sf*sf);
1032 }
1033 }
1034
1035 double y = (w1*y1 + w2*y2)/(w1 + w2);
1036 UpdateBinContent(bin, y);
1037 if (fSumw2.fN) {
1038 double err2 = 1./(w1 + w2);
1039 if (err2 < 1.E-200) err2 = 0; // to remove arbitrary value when e1=0 AND e2=0
1040 fSumw2.fArray[bin] = err2;
1041 }
1042 } else { // normal case of addition between histograms
1043 AddBinContent(bin, c1 * factor * h1->RetrieveBinContent(bin));
1044 if (fSumw2.fN) fSumw2.fArray[bin] += c1sq * factsq * h1->GetBinErrorSqUnchecked(bin);
1045 }
1046 }
1047
1048 // update statistics (do here to avoid changes by SetBinContent)
1049 if (resetStats) {
1050 // statistics need to be reset in case coefficient are negative
1051 ResetStats();
1052 }
1053 else {
1054 for (Int_t i=0;i<kNstat;i++) {
1055 if (i == 1) s1[i] += c1*c1*s2[i];
1056 else s1[i] += c1*s2[i];
1057 }
1058 PutStats(s1);
1059 if (c1 == 1.0)
1060 SetEntries(entries);
1061 else {
1062 // compute entries as effective entries in case of
1063 // weights different than 1
1064 double sumw2 = 0;
1065 double sumw = GetSumOfAllWeights(true, &sumw2);
1066 if (sumw2 > 0) SetEntries( sumw*sumw/sumw2);
1067 }
1068 }
1069 return kTRUE;
1070}
1071
1072////////////////////////////////////////////////////////////////////////////////
1073/// Replace contents of this histogram by the addition of h1 and h2.
1074///
1075/// `this = c1*h1 + c2*h2`
1076/// if errors are defined (see TH1::Sumw2), errors are also recalculated
1077///
1078/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
1079/// if not already set.
1080///
1081/// Note also that adding histogram with labels is not supported, histogram will be
1082/// added merging them by bin number independently of the labels.
1083/// For adding histogram ith labels one should use TH1::Merge
1084///
1085/// SPECIAL CASE (Average/Efficiency histograms)
1086/// For histograms representing averages or efficiencies, one should compute the average
1087/// of the two histograms and not the sum. One can mark a histogram to be an average
1088/// histogram by setting its bit kIsAverage with
1089/// myhist.SetBit(TH1::kIsAverage);
1090/// Note that the two histograms must have their kIsAverage bit set
1091///
1092/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
1093/// you should call Sumw2 before making this operation.
1094/// This is particularly important if you fit the histogram after TH1::Add
1095///
1096/// IMPORTANT NOTE2: You should be careful about the statistics of the
1097/// returned histogram, whose statistics may be binned or unbinned,
1098/// depending on whether c1 is negative, whether TAxis::kAxisRange is true,
1099/// and whether TH1::ResetStats has been called on either this or h1.
1100/// See TH1::GetStats.
1101///
1102/// ANOTHER SPECIAL CASE : h1 = h2 and c2 < 0
1103/// do a scaling this = c1 * h1 / (bin Volume)
1104///
1105/// The function returns kFALSE if the Add operation failed
1106
1108{
1109
1110 if (!h1 || !h2) {
1111 Error("Add","Attempt to add a non-existing histogram");
1112 return kFALSE;
1113 }
1114
1115 // delete buffer if it is there since it will become invalid
1116 if (fBuffer) BufferEmpty(1);
1117
1119 if (h1 == h2 && c2 < 0) {c2 = 0; normWidth = kTRUE;}
1120
1121 if (h1 != h2) {
1122 bool useMerge = false;
1123 const bool considerMerge = (c1 == 1. && c2 == 1. && !this->TestBit(kIsAverage) && !h1->TestBit(kIsAverage) );
1124
1125 // We can combine inconsistencies like this, since they are ordered and a
1126 // higher inconsistency is worse
1127 auto const inconsistency = std::max(LoggedInconsistency("Add", this, h1, considerMerge),
1128 LoggedInconsistency("Add", h1, h2, considerMerge));
1129
1130 // If there is a bad inconsistency and we can't even consider merging, just give up
1132 return false;
1133 }
1134 // If there is an inconsistency, we try to use merging
1137 }
1138
1139 if (useMerge) {
1140 TList l;
1141 // why TList takes non-const pointers ????
1142 l.Add(const_cast<TH1*>(h1));
1143 l.Add(const_cast<TH1*>(h2));
1144 Reset("ICE");
1145 auto iret = Merge(&l);
1146 return (iret >= 0);
1147 }
1148 }
1149
1150 // Create Sumw2 if h1 or h2 have Sumw2 set
1151 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0)) Sumw2();
1152 // Create also Sumw2 if not a simple addition (c1 = 1, c2 = 1)
1153 if (fSumw2.fN == 0 && (c1 != 1.0 || c2 != 1.0)) Sumw2();
1154 // - Add statistics
1155 Double_t nEntries = TMath::Abs( c1*h1->GetEntries() + c2*h2->GetEntries() );
1156
1157 // TODO remove
1158 // statistics can be preserved only in case of positive coefficients
1159 // otherwise with negative c1 (histogram subtraction) one risks to get negative variances
1160 // also in case of scaling with the width we cannot preserve the statistics
1161 Double_t s1[kNstat] = {0};
1162 Double_t s2[kNstat] = {0};
1164
1165
1166 Bool_t resetStats = (c1*c2 < 0) || normWidth;
1167 if (!resetStats) {
1168 // need to initialize to zero s1 and s2 since
1169 // GetStats fills only used elements depending on dimension and type
1170 h1->GetStats(s1);
1171 h2->GetStats(s2);
1172 for (Int_t i=0;i<kNstat;i++) {
1173 if (i == 1) s3[i] = c1*c1*s1[i] + c2*c2*s2[i];
1174 //else s3[i] = TMath::Abs(c1)*s1[i] + TMath::Abs(c2)*s2[i];
1175 else s3[i] = c1*s1[i] + c2*s2[i];
1176 }
1177 }
1178
1179 SetMinimum();
1180 SetMaximum();
1181
1182 if (normWidth) { // DEPRECATED CASE: belongs to fitting / drawing modules
1183
1184 Int_t nbinsx = GetNbinsX() + 2; // normal bins + underflow, overflow
1185 Int_t nbinsy = GetNbinsY() + 2;
1186 Int_t nbinsz = GetNbinsZ() + 2;
1187
1188 if (fDimension < 2) nbinsy = 1;
1189 if (fDimension < 3) nbinsz = 1;
1190
1191 Int_t bin, binx, biny, binz;
1192 for (binz = 0; binz < nbinsz; ++binz) {
1194 for (biny = 0; biny < nbinsy; ++biny) {
1196 for (binx = 0; binx < nbinsx; ++binx) {
1198 bin = GetBin(binx, biny, binz);
1199 Double_t w = wx*wy*wz;
1200 UpdateBinContent(bin, c1 * h1->RetrieveBinContent(bin) / w);
1201 if (fSumw2.fN) {
1202 Double_t e1 = h1->GetBinError(bin)/w;
1203 fSumw2.fArray[bin] = c1*c1*e1*e1;
1204 }
1205 }
1206 }
1207 }
1208 } else if (h1->TestBit(kIsAverage) && h2->TestBit(kIsAverage)) {
1209 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
1210 // special case where histograms have the kIsAverage bit set
1212 Double_t y2 = h2->RetrieveBinContent(i);
1214 Double_t e2sq = h2->GetBinErrorSqUnchecked(i);
1215 Double_t w1 = 1., w2 = 1.;
1216
1217 // consider all special cases when bin errors are zero
1218 // see http://root-forum.cern.ch/viewtopic.php?f=3&t=13299
1219 if (e1sq) w1 = 1./ e1sq;
1220 else if (h1->fSumw2.fN) {
1221 w1 = 1.E200; // use an arbitrary huge value
1222 if (y1 == 0 ) { // use an estimated error from the global histogram scale
1223 double sf = (s1[0] != 0) ? s1[1]/s1[0] : 1;
1224 w1 = 1./(sf*sf);
1225 }
1226 }
1227 if (e2sq) w2 = 1./ e2sq;
1228 else if (h2->fSumw2.fN) {
1229 w2 = 1.E200; // use an arbitrary huge value
1230 if (y2 == 0) { // use an estimated error from the global histogram scale
1231 double sf = (s2[0] != 0) ? s2[1]/s2[0] : 1;
1232 w2 = 1./(sf*sf);
1233 }
1234 }
1235
1236 double y = (w1*y1 + w2*y2)/(w1 + w2);
1237 UpdateBinContent(i, y);
1238 if (fSumw2.fN) {
1239 double err2 = 1./(w1 + w2);
1240 if (err2 < 1.E-200) err2 = 0; // to remove arbitrary value when e1=0 AND e2=0
1241 fSumw2.fArray[i] = err2;
1242 }
1243 }
1244 } else { // case of simple histogram addition
1245 Double_t c1sq = c1 * c1;
1246 Double_t c2sq = c2 * c2;
1247 for (Int_t i = 0; i < fNcells; ++i) { // Loop on cells (bins including underflows/overflows)
1248 UpdateBinContent(i, c1 * h1->RetrieveBinContent(i) + c2 * h2->RetrieveBinContent(i));
1249 if (fSumw2.fN) {
1250 fSumw2.fArray[i] = c1sq * h1->GetBinErrorSqUnchecked(i) + c2sq * h2->GetBinErrorSqUnchecked(i);
1251 }
1252 }
1253 }
1254
1255 if (resetStats) {
1256 // statistics need to be reset in case coefficient are negative
1257 ResetStats();
1258 }
1259 else {
1260 // update statistics
1261 PutStats(s3);
1262 // previous entries are correct only if c1=1 and c2=1
1263 if (c1 == 1.0 && c2 == 1.0)
1265 else {
1266 // compute entries as effective entries in case of
1267 // weights different than 1
1268 double sumw2 = 0;
1269 double sumw = GetSumOfAllWeights(true, &sumw2);
1270 if (sumw2 > 0) SetEntries( sumw*sumw/sumw2);
1271 }
1272 }
1273
1274 return kTRUE;
1275}
1276
1277////////////////////////////////////////////////////////////////////////////////
1278/// Sets the flag controlling the automatic add of histograms in memory
1279///
1280/// By default (fAddDirectory = kTRUE), histograms are automatically added
1281/// to the list of objects in memory.
1282/// Note that one histogram can be removed from its support directory
1283/// by calling h->SetDirectory(nullptr) or h->SetDirectory(dir) to add it
1284/// to the list of objects in the directory dir.
1285///
1286/// NOTE that this is a static function. To call it, use;
1287/// TH1::AddDirectory
1288
1290{
1291 fgAddDirectory = add;
1292}
1293
1294////////////////////////////////////////////////////////////////////////////////
1295/// Auxiliary function to get the power of 2 next (larger) or previous (smaller)
1296/// a given x
1297///
1298/// next = kTRUE : next larger
1299/// next = kFALSE : previous smaller
1300///
1301/// Used by the autobin power of 2 algorithm
1302
1304{
1305 Int_t nn;
1306 Double_t f2 = std::frexp(x, &nn);
1307 return ((next && x > 0.) || (!next && x <= 0.)) ? std::ldexp(std::copysign(1., f2), nn)
1308 : std::ldexp(std::copysign(1., f2), --nn);
1309}
1310
1311////////////////////////////////////////////////////////////////////////////////
1312/// Auxiliary function to get the next power of 2 integer value larger then n
1313///
1314/// Used by the autobin power of 2 algorithm
1315
1317{
1318 Int_t nn;
1319 Double_t f2 = std::frexp(n, &nn);
1320 if (TMath::Abs(f2 - .5) > 0.001)
1321 return (Int_t)std::ldexp(1., nn);
1322 return n;
1323}
1324
1325////////////////////////////////////////////////////////////////////////////////
1326/// Buffer-based estimate of the histogram range using the power of 2 algorithm.
1327///
1328/// Used by the autobin power of 2 algorithm.
1329///
1330/// Works on arguments (min and max from fBuffer) and internal inputs: fXmin,
1331/// fXmax, NBinsX (from fXaxis), ...
1332/// Result save internally in fXaxis.
1333///
1334/// Overloaded by TH2 and TH3.
1335///
1336/// Return -1 if internal inputs are inconsistent, 0 otherwise.
1337
1339{
1340 // We need meaningful raw limits
1341 if (xmi >= xma)
1342 return -1;
1343
1344 THLimitsFinder::GetLimitsFinder()->FindGoodLimits(this, xmi, xma);
1347
1348 // Now adjust
1349 if (TMath::Abs(xhma) > TMath::Abs(xhmi)) {
1350 // Start from the upper limit
1353 } else {
1354 // Start from the lower limit
1357 }
1358
1359 // Round the bins to the next power of 2; take into account the possible inflation
1360 // of the range
1361 Double_t rr = (xhma - xhmi) / (xma - xmi);
1363
1364 // Adjust using the same bin width and offsets
1365 Double_t bw = (xhma - xhmi) / nb;
1366 // Bins to left free on each side
1367 Double_t autoside = gEnv->GetValue("Hist.Binning.Auto.Side", 0.05);
1368 Int_t nbside = (Int_t)(nb * autoside);
1369
1370 // Side up
1371 Int_t nbup = (xhma - xma) / bw;
1372 if (nbup % 2 != 0)
1373 nbup++; // Must be even
1374 if (nbup != nbside) {
1375 // Accounts also for both case: larger or smaller
1376 xhma -= bw * (nbup - nbside);
1377 nb -= (nbup - nbside);
1378 }
1379
1380 // Side low
1381 Int_t nblw = (xmi - xhmi) / bw;
1382 if (nblw % 2 != 0)
1383 nblw++; // Must be even
1384 if (nblw != nbside) {
1385 // Accounts also for both case: larger or smaller
1386 xhmi += bw * (nblw - nbside);
1387 nb -= (nblw - nbside);
1388 }
1389
1390 // Set everything and project
1391 SetBins(nb, xhmi, xhma);
1392
1393 // Done
1394 return 0;
1395}
1396
1397/// Fill histogram with all entries in the buffer.
1398///
1399/// - action = -1 histogram is reset and refilled from the buffer (called by THistPainter::Paint)
1400/// - action = 0 histogram is reset and filled from the buffer. When the histogram is filled from the
1401/// buffer the value fBuffer[0] is set to a negative number (= - number of entries)
1402/// When calling with action == 0 the histogram is NOT refilled when fBuffer[0] is < 0
1403/// While when calling with action = -1 the histogram is reset and ALWAYS refilled independently if
1404/// the histogram was filled before. This is needed when drawing the histogram
1405/// - action = 1 histogram is filled and buffer is deleted
1406/// The buffer is automatically deleted when filling the histogram and the entries is
1407/// larger than the buffer size
1408
1410{
1411 // do we need to compute the bin size?
1412 if (!fBuffer) return 0;
1414
1415 // nbentries correspond to the number of entries of histogram
1416
1417 if (nbentries == 0) {
1418 // if action is 1 we delete the buffer
1419 // this will avoid infinite recursion
1420 if (action > 0) {
1421 delete [] fBuffer;
1422 fBuffer = nullptr;
1423 fBufferSize = 0;
1424 }
1425 return 0;
1426 }
1427 if (nbentries < 0 && action == 0) return 0; // case histogram has been already filled from the buffer
1428
1429 Double_t *buffer = fBuffer;
1430 if (nbentries < 0) {
1432 // a reset might call BufferEmpty() giving an infinite recursion
1433 // Protect it by setting fBuffer = nullptr
1434 fBuffer = nullptr;
1435 //do not reset the list of functions
1436 Reset("ICES");
1437 fBuffer = buffer;
1438 }
1439 if (CanExtendAllAxes() || (fXaxis.GetXmax() <= fXaxis.GetXmin())) {
1440 //find min, max of entries in buffer
1443 for (Int_t i=0;i<nbentries;i++) {
1444 Double_t x = fBuffer[2*i+2];
1445 // skip infinity or NaN values
1446 if (!std::isfinite(x)) continue;
1447 if (x < xmin) xmin = x;
1448 if (x > xmax) xmax = x;
1449 }
1450 if (fXaxis.GetXmax() <= fXaxis.GetXmin()) {
1451 Int_t rc = -1;
1453 if ((rc = AutoP2FindLimits(xmin, xmax)) < 0)
1454 Warning("BufferEmpty",
1455 "inconsistency found by power-of-2 autobin algorithm: fallback to standard method");
1456 }
1457 if (rc < 0)
1458 THLimitsFinder::GetLimitsFinder()->FindGoodLimits(this, xmin, xmax);
1459 } else {
1460 fBuffer = nullptr;
1463 if (xmax >= fXaxis.GetXmax()) ExtendAxis(xmax, &fXaxis);
1464 fBuffer = buffer;
1465 fBufferSize = keep;
1466 }
1467 }
1468
1469 // call DoFillN which will not put entries in the buffer as FillN does
1470 // set fBuffer to zero to avoid re-emptying the buffer from functions called
1471 // by DoFillN (e.g Sumw2)
1472 buffer = fBuffer; fBuffer = nullptr;
1473 DoFillN(nbentries,&buffer[2],&buffer[1],2);
1474 fBuffer = buffer;
1475
1476 // if action == 1 - delete the buffer
1477 if (action > 0) {
1478 delete [] fBuffer;
1479 fBuffer = nullptr;
1480 fBufferSize = 0;
1481 } else {
1482 // if number of entries is consistent with buffer - set it negative to avoid
1483 // refilling the histogram every time BufferEmpty(0) is called
1484 // In case it is not consistent, by setting fBuffer[0]=0 is like resetting the buffer
1485 // (it will not be used anymore the next time BufferEmpty is called)
1486 if (nbentries == (Int_t)fEntries)
1487 fBuffer[0] = -nbentries;
1488 else
1489 fBuffer[0] = 0;
1490 }
1491 return nbentries;
1492}
1493
1494////////////////////////////////////////////////////////////////////////////////
1495/// accumulate arguments in buffer. When buffer is full, empty the buffer
1496///
1497/// - `fBuffer[0]` = number of entries in buffer
1498/// - `fBuffer[1]` = w of first entry
1499/// - `fBuffer[2]` = x of first entry
1500
1502{
1503 if (!fBuffer) return -2;
1505
1506
1507 if (nbentries < 0) {
1508 // reset nbentries to a positive value so next time BufferEmpty() is called
1509 // the histogram will be refilled
1511 fBuffer[0] = nbentries;
1512 if (fEntries > 0) {
1513 // set fBuffer to zero to avoid calling BufferEmpty in Reset
1514 Double_t *buffer = fBuffer; fBuffer=nullptr;
1515 Reset("ICES"); // do not reset list of functions
1516 fBuffer = buffer;
1517 }
1518 }
1519 if (2*nbentries+2 >= fBufferSize) {
1520 BufferEmpty(1);
1521 if (!fBuffer)
1522 // to avoid infinite recursion Fill->BufferFill->Fill
1523 return Fill(x,w);
1524 // this cannot happen
1525 R__ASSERT(0);
1526 }
1527 fBuffer[2*nbentries+1] = w;
1528 fBuffer[2*nbentries+2] = x;
1529 fBuffer[0] += 1;
1530 return -2;
1531}
1532
1533////////////////////////////////////////////////////////////////////////////////
1534/// Check bin limits.
1535
1536bool TH1::CheckBinLimits(const TAxis* a1, const TAxis * a2)
1537{
1538 const TArrayD * h1Array = a1->GetXbins();
1539 const TArrayD * h2Array = a2->GetXbins();
1540 Int_t fN = h1Array->fN;
1541 if ( fN != 0 ) {
1542 if ( h2Array->fN != fN ) {
1543 return false;
1544 }
1545 else {
1546 for ( int i = 0; i < fN; ++i ) {
1547 // for i==fN (nbin+1) a->GetBinWidth() returns last bin width
1548 // we do not need to exclude that case
1549 double binWidth = a1->GetBinWidth(i);
1550 if ( ! TMath::AreEqualAbs( h1Array->GetAt(i), h2Array->GetAt(i), binWidth*1E-10 ) ) {
1551 return false;
1552 }
1553 }
1554 }
1555 }
1556
1557 return true;
1558}
1559
1560////////////////////////////////////////////////////////////////////////////////
1561/// Check that axis have same labels.
1562
1563bool TH1::CheckBinLabels(const TAxis* a1, const TAxis * a2)
1564{
1565 THashList *l1 = a1->GetLabels();
1566 THashList *l2 = a2->GetLabels();
1567
1568 if (!l1 && !l2 )
1569 return true;
1570 if (!l1 || !l2 ) {
1571 return false;
1572 }
1573 // check now labels sizes are the same
1574 if (l1->GetSize() != l2->GetSize() ) {
1575 return false;
1576 }
1577 for (int i = 1; i <= a1->GetNbins(); ++i) {
1578 TString label1 = a1->GetBinLabel(i);
1579 TString label2 = a2->GetBinLabel(i);
1580 if (label1 != label2) {
1581 return false;
1582 }
1583 }
1584
1585 return true;
1586}
1587
1588////////////////////////////////////////////////////////////////////////////////
1589/// Check that the axis limits of the histograms are the same.
1590/// If a first and last bin is passed the axis is compared between the given range
1591
1592bool TH1::CheckAxisLimits(const TAxis *a1, const TAxis *a2 )
1593{
1594 double firstBin = a1->GetBinWidth(1);
1595 double lastBin = a1->GetBinWidth( a1->GetNbins() );
1596 if ( ! TMath::AreEqualAbs(a1->GetXmin(), a2->GetXmin(), firstBin* 1.E-10) ||
1597 ! TMath::AreEqualAbs(a1->GetXmax(), a2->GetXmax(), lastBin*1.E-10) ) {
1598 return false;
1599 }
1600 return true;
1601}
1602
1603////////////////////////////////////////////////////////////////////////////////
1604/// Check that the axis are the same
1605
1606bool TH1::CheckEqualAxes(const TAxis *a1, const TAxis *a2 )
1607{
1608 if (a1->GetNbins() != a2->GetNbins() ) {
1609 ::Info("CheckEqualAxes","Axes have different number of bins : nbin1 = %d nbin2 = %d",a1->GetNbins(),a2->GetNbins() );
1610 return false;
1611 }
1612 if(!CheckAxisLimits(a1,a2)) {
1613 ::Info("CheckEqualAxes","Axes have different limits");
1614 return false;
1615 }
1616 if(!CheckBinLimits(a1,a2)) {
1617 ::Info("CheckEqualAxes","Axes have different bin limits");
1618 return false;
1619 }
1620
1621 // check labels
1622 if(!CheckBinLabels(a1,a2)) {
1623 ::Info("CheckEqualAxes","Axes have different labels");
1624 return false;
1625 }
1626
1627 return true;
1628}
1629
1630////////////////////////////////////////////////////////////////////////////////
1631/// Check that two sub axis are the same.
1632/// The limits are defined by first bin and last bin
1633/// N.B. no check is done in this case for variable bins
1634
1636{
1637 // By default is assumed that no bins are given for the second axis
1639 Double_t xmin1 = a1->GetBinLowEdge(firstBin1);
1640 Double_t xmax1 = a1->GetBinUpEdge(lastBin1);
1641
1642 Int_t nbins2 = a2->GetNbins();
1643 Double_t xmin2 = a2->GetXmin();
1644 Double_t xmax2 = a2->GetXmax();
1645
1646 if (firstBin2 < lastBin2) {
1647 // in this case assume no bins are given for the second axis
1649 xmin2 = a1->GetBinLowEdge(firstBin1);
1650 xmax2 = a1->GetBinUpEdge(lastBin1);
1651 }
1652
1653 if (nbins1 != nbins2 ) {
1654 ::Info("CheckConsistentSubAxes","Axes have different number of bins");
1655 return false;
1656 }
1657
1658 Double_t firstBin = a1->GetBinWidth(firstBin1);
1659 Double_t lastBin = a1->GetBinWidth(lastBin1);
1660 if ( ! TMath::AreEqualAbs(xmin1,xmin2,1.E-10 * firstBin) ||
1661 ! TMath::AreEqualAbs(xmax1,xmax2,1.E-10 * lastBin) ) {
1662 ::Info("CheckConsistentSubAxes","Axes have different limits");
1663 return false;
1664 }
1665
1666 return true;
1667}
1668
1669////////////////////////////////////////////////////////////////////////////////
1670/// Check histogram compatibility.
1671/// The returned integer is part of EInconsistencyBits
1672/// The value 0 means that the histograms are compatible
1673
1675{
1676 if (h1 == h2) return kFullyConsistent;
1677
1678 if (h1->GetDimension() != h2->GetDimension() ) {
1679 return kDifferentDimensions;
1680 }
1681 Int_t dim = h1->GetDimension();
1682
1683 // returns kTRUE if number of bins and bin limits are identical
1684 Int_t nbinsx = h1->GetNbinsX();
1685 Int_t nbinsy = h1->GetNbinsY();
1686 Int_t nbinsz = h1->GetNbinsZ();
1687
1688 // Check whether the histograms have the same number of bins.
1689 if (nbinsx != h2->GetNbinsX() ||
1690 (dim > 1 && nbinsy != h2->GetNbinsY()) ||
1691 (dim > 2 && nbinsz != h2->GetNbinsZ()) ) {
1693 }
1694
1695 bool ret = true;
1696
1697 // check axis limits
1698 ret &= CheckAxisLimits(h1->GetXaxis(), h2->GetXaxis());
1699 if (dim > 1) ret &= CheckAxisLimits(h1->GetYaxis(), h2->GetYaxis());
1700 if (dim > 2) ret &= CheckAxisLimits(h1->GetZaxis(), h2->GetZaxis());
1701 if (!ret) return kDifferentAxisLimits;
1702
1703 // check bin limits
1704 ret &= CheckBinLimits(h1->GetXaxis(), h2->GetXaxis());
1705 if (dim > 1) ret &= CheckBinLimits(h1->GetYaxis(), h2->GetYaxis());
1706 if (dim > 2) ret &= CheckBinLimits(h1->GetZaxis(), h2->GetZaxis());
1707 if (!ret) return kDifferentBinLimits;
1708
1709 // check labels if histograms are both not empty
1710 if ( !h1->IsEmpty() && !h2->IsEmpty() ) {
1711 ret &= CheckBinLabels(h1->GetXaxis(), h2->GetXaxis());
1712 if (dim > 1) ret &= CheckBinLabels(h1->GetYaxis(), h2->GetYaxis());
1713 if (dim > 2) ret &= CheckBinLabels(h1->GetZaxis(), h2->GetZaxis());
1714 if (!ret) return kDifferentLabels;
1715 }
1716
1717 return kFullyConsistent;
1718}
1719
1720////////////////////////////////////////////////////////////////////////////////
1721/// \f$ \chi^{2} \f$ test for comparing weighted and unweighted histograms.
1722///
1723/// Compares the histograms' adjusted (normalized) residuals.
1724/// Function: Returns p-value. Other return values are specified by the 3rd parameter
1725///
1726/// \param[in] h2 the second histogram
1727/// \param[in] option
1728/// - "UU" = experiment experiment comparison (unweighted-unweighted)
1729/// - "UW" = experiment MC comparison (unweighted-weighted). Note that
1730/// the first histogram should be unweighted
1731/// - "WW" = MC MC comparison (weighted-weighted)
1732/// - "NORM" = to be used when one or both of the histograms is scaled
1733/// but the histogram originally was unweighted
1734/// - by default underflows and overflows are not included:
1735/// * "OF" = overflows included
1736/// * "UF" = underflows included
1737/// - "P" = print chi2, ndf, p_value, igood
1738/// - "CHI2" = returns chi2 instead of p-value
1739/// - "CHI2/NDF" = returns \f$ \chi^{2} \f$/ndf
1740/// \param[in] res not empty - computes normalized residuals and returns them in this array
1741///
1742/// The current implementation is based on the papers \f$ \chi^{2} \f$ test for comparison
1743/// of weighted and unweighted histograms" in Proceedings of PHYSTAT05 and
1744/// "Comparison weighted and unweighted histograms", arXiv:physics/0605123
1745/// by N.Gagunashvili. This function has been implemented by Daniel Haertl in August 2006.
1746///
1747/// #### Introduction:
1748///
1749/// A frequently used technique in data analysis is the comparison of
1750/// histograms. First suggested by Pearson [1] the \f$ \chi^{2} \f$ test of
1751/// homogeneity is used widely for comparing usual (unweighted) histograms.
1752/// This paper describes the implementation modified \f$ \chi^{2} \f$ tests
1753/// for comparison of weighted and unweighted histograms and two weighted
1754/// histograms [2] as well as usual Pearson's \f$ \chi^{2} \f$ test for
1755/// comparison two usual (unweighted) histograms.
1756///
1757/// #### Overview:
1758///
1759/// Comparison of two histograms expect hypotheses that two histograms
1760/// represent identical distributions. To make a decision p-value should
1761/// be calculated. The hypotheses of identity is rejected if the p-value is
1762/// lower then some significance level. Traditionally significance levels
1763/// 0.1, 0.05 and 0.01 are used. The comparison procedure should include an
1764/// analysis of the residuals which is often helpful in identifying the
1765/// bins of histograms responsible for a significant overall \f$ \chi^{2} \f$ value.
1766/// Residuals are the difference between bin contents and expected bin
1767/// contents. Most convenient for analysis are the normalized residuals. If
1768/// hypotheses of identity are valid then normalized residuals are
1769/// approximately independent and identically distributed random variables
1770/// having N(0,1) distribution. Analysis of residuals expect test of above
1771/// mentioned properties of residuals. Notice that indirectly the analysis
1772/// of residuals increase the power of \f$ \chi^{2} \f$ test.
1773///
1774/// #### Methods of comparison:
1775///
1776/// \f$ \chi^{2} \f$ test for comparison two (unweighted) histograms:
1777/// Let us consider two histograms with the same binning and the number
1778/// of bins equal to r. Let us denote the number of events in the ith bin
1779/// in the first histogram as ni and as mi in the second one. The total
1780/// number of events in the first histogram is equal to:
1781/// \f[
1782/// N = \sum_{i=1}^{r} n_{i}
1783/// \f]
1784/// and
1785/// \f[
1786/// M = \sum_{i=1}^{r} m_{i}
1787/// \f]
1788/// in the second histogram. The hypothesis of identity (homogeneity) [3]
1789/// is that the two histograms represent random values with identical
1790/// distributions. It is equivalent that there exist r constants p1,...,pr,
1791/// such that
1792/// \f[
1793///\sum_{i=1}^{r} p_{i}=1
1794/// \f]
1795/// and the probability of belonging to the ith bin for some measured value
1796/// in both experiments is equal to pi. The number of events in the ith
1797/// bin is a random variable with a distribution approximated by a Poisson
1798/// probability distribution
1799/// \f[
1800///\frac{e^{-Np_{i}}(Np_{i})^{n_{i}}}{n_{i}!}
1801/// \f]
1802///for the first histogram and with distribution
1803/// \f[
1804///\frac{e^{-Mp_{i}}(Mp_{i})^{m_{i}}}{m_{i}!}
1805/// \f]
1806/// for the second histogram. If the hypothesis of homogeneity is valid,
1807/// then the maximum likelihood estimator of pi, i=1,...,r, is
1808/// \f[
1809///\hat{p}_{i}= \frac{n_{i}+m_{i}}{N+M}
1810/// \f]
1811/// and then
1812/// \f[
1813/// X^{2} = \sum_{i=1}^{r}\frac{(n_{i}-N\hat{p}_{i})^{2}}{N\hat{p}_{i}} + \sum_{i=1}^{r}\frac{(m_{i}-M\hat{p}_{i})^{2}}{M\hat{p}_{i}} =\frac{1}{MN} \sum_{i=1}^{r}\frac{(Mn_{i}-Nm_{i})^{2}}{n_{i}+m_{i}}
1814/// \f]
1815/// has approximately a \f$ \chi^{2}_{(r-1)} \f$ distribution [3].
1816/// The comparison procedure can include an analysis of the residuals which
1817/// is often helpful in identifying the bins of histograms responsible for
1818/// a significant overall \f$ \chi^{2} \f$ value. Most convenient for
1819/// analysis are the adjusted (normalized) residuals [4]
1820/// \f[
1821/// r_{i} = \frac{n_{i}-N\hat{p}_{i}}{\sqrt{N\hat{p}_{i}}\sqrt{(1-N/(N+M))(1-(n_{i}+m_{i})/(N+M))}}
1822/// \f]
1823/// If hypotheses of homogeneity are valid then residuals ri are
1824/// approximately independent and identically distributed random variables
1825/// having N(0,1) distribution. The application of the \f$ \chi^{2} \f$ test has
1826/// restrictions related to the value of the expected frequencies Npi,
1827/// Mpi, i=1,...,r. A conservative rule formulated in [5] is that all the
1828/// expectations must be 1 or greater for both histograms. In practical
1829/// cases when expected frequencies are not known the estimated expected
1830/// frequencies \f$ M\hat{p}_{i}, N\hat{p}_{i}, i=1,...,r \f$ can be used.
1831///
1832/// #### Unweighted and weighted histograms comparison:
1833///
1834/// A simple modification of the ideas described above can be used for the
1835/// comparison of the usual (unweighted) and weighted histograms. Let us
1836/// denote the number of events in the ith bin in the unweighted
1837/// histogram as ni and the common weight of events in the ith bin of the
1838/// weighted histogram as wi. The total number of events in the
1839/// unweighted histogram is equal to
1840///\f[
1841/// N = \sum_{i=1}^{r} n_{i}
1842///\f]
1843/// and the total weight of events in the weighted histogram is equal to
1844///\f[
1845/// W = \sum_{i=1}^{r} w_{i}
1846///\f]
1847/// Let us formulate the hypothesis of identity of an unweighted histogram
1848/// to a weighted histogram so that there exist r constants p1,...,pr, such
1849/// that
1850///\f[
1851/// \sum_{i=1}^{r} p_{i} = 1
1852///\f]
1853/// for the unweighted histogram. The weight wi is a random variable with a
1854/// distribution approximated by the normal probability distribution
1855/// \f$ N(Wp_{i},\sigma_{i}^{2}) \f$ where \f$ \sigma_{i}^{2} \f$ is the variance of the weight wi.
1856/// If we replace the variance \f$ \sigma_{i}^{2} \f$
1857/// with estimate \f$ s_{i}^{2} \f$ (sum of squares of weights of
1858/// events in the ith bin) and the hypothesis of identity is valid, then the
1859/// maximum likelihood estimator of pi,i=1,...,r, is
1860///\f[
1861/// \hat{p}_{i} = \frac{Ww_{i}-Ns_{i}^{2}+\sqrt{(Ww_{i}-Ns_{i}^{2})^{2}+4W^{2}s_{i}^{2}n_{i}}}{2W^{2}}
1862///\f]
1863/// We may then use the test statistic
1864///\f[
1865/// X^{2} = \sum_{i=1}^{r} \frac{(n_{i}-N\hat{p}_{i})^{2}}{N\hat{p}_{i}} + \sum_{i=1}^{r} \frac{(w_{i}-W\hat{p}_{i})^{2}}{s_{i}^{2}}
1866///\f]
1867/// and it has approximately a \f$ \sigma^{2}_{(r-1)} \f$ distribution [2]. This test, as well
1868/// as the original one [3], has a restriction on the expected frequencies. The
1869/// expected frequencies recommended for the weighted histogram is more than 25.
1870/// The value of the minimal expected frequency can be decreased down to 10 for
1871/// the case when the weights of the events are close to constant. In the case
1872/// of a weighted histogram if the number of events is unknown, then we can
1873/// apply this recommendation for the equivalent number of events as
1874///\f[
1875/// n_{i}^{equiv} = \frac{ w_{i}^{2} }{ s_{i}^{2} }
1876///\f]
1877/// The minimal expected frequency for an unweighted histogram must be 1. Notice
1878/// that any usual (unweighted) histogram can be considered as a weighted
1879/// histogram with events that have constant weights equal to 1.
1880/// The variance \f$ z_{i}^{2} \f$ of the difference between the weight wi
1881/// and the estimated expectation value of the weight is approximately equal to:
1882///\f[
1883/// z_{i}^{2} = Var(w_{i}-W\hat{p}_{i}) = N\hat{p}_{i}(1-N\hat{p}_{i})\left(\frac{Ws_{i}^{2}}{\sqrt{(Ns_{i}^{2}-w_{i}W)^{2}+4W^{2}s_{i}^{2}n_{i}}}\right)^{2}+\frac{s_{i}^{2}}{4}\left(1+\frac{Ns_{i}^{2}-w_{i}W}{\sqrt{(Ns_{i}^{2}-w_{i}W)^{2}+4W^{2}s_{i}^{2}n_{i}}}\right)^{2}
1884///\f]
1885/// The residuals
1886///\f[
1887/// r_{i} = \frac{w_{i}-W\hat{p}_{i}}{z_{i}}
1888///\f]
1889/// have approximately a normal distribution with mean equal to 0 and standard
1890/// deviation equal to 1.
1891///
1892/// #### Two weighted histograms comparison:
1893///
1894/// Let us denote the common weight of events of the ith bin in the first
1895/// histogram as w1i and as w2i in the second one. The total weight of events
1896/// in the first histogram is equal to
1897///\f[
1898/// W_{1} = \sum_{i=1}^{r} w_{1i}
1899///\f]
1900/// and
1901///\f[
1902/// W_{2} = \sum_{i=1}^{r} w_{2i}
1903///\f]
1904/// in the second histogram. Let us formulate the hypothesis of identity of
1905/// weighted histograms so that there exist r constants p1,...,pr, such that
1906///\f[
1907/// \sum_{i=1}^{r} p_{i} = 1
1908///\f]
1909/// and also expectation value of weight w1i equal to W1pi and expectation value
1910/// of weight w2i equal to W2pi. Weights in both the histograms are random
1911/// variables with distributions which can be approximated by a normal
1912/// probability distribution \f$ N(W_{1}p_{i},\sigma_{1i}^{2}) \f$ for the first histogram
1913/// and by a distribution \f$ N(W_{2}p_{i},\sigma_{2i}^{2}) \f$ for the second.
1914/// Here \f$ \sigma_{1i}^{2} \f$ and \f$ \sigma_{2i}^{2} \f$ are the variances
1915/// of w1i and w2i with estimators \f$ s_{1i}^{2} \f$ and \f$ s_{2i}^{2} \f$ respectively.
1916/// If the hypothesis of identity is valid, then the maximum likelihood and
1917/// Least Square Method estimator of pi,i=1,...,r, is
1918///\f[
1919/// \hat{p}_{i} = \frac{w_{1i}W_{1}/s_{1i}^{2}+w_{2i}W_{2} /s_{2i}^{2}}{W_{1}^{2}/s_{1i}^{2}+W_{2}^{2}/s_{2i}^{2}}
1920///\f]
1921/// We may then use the test statistic
1922///\f[
1923/// X^{2} = \sum_{i=1}^{r} \frac{(w_{1i}-W_{1}\hat{p}_{i})^{2}}{s_{1i}^{2}} + \sum_{i=1}^{r} \frac{(w_{2i}-W_{2}\hat{p}_{i})^{2}}{s_{2i}^{2}} = \sum_{i=1}^{r} \frac{(W_{1}w_{2i}-W_{2}w_{1i})^{2}}{W_{1}^{2}s_{2i}^{2}+W_{2}^{2}s_{1i}^{2}}
1924///\f]
1925/// and it has approximately a \f$ \chi^{2}_{(r-1)} \f$ distribution [2].
1926/// The normalized or studentised residuals [6]
1927///\f[
1928/// r_{i} = \frac{w_{1i}-W_{1}\hat{p}_{i}}{s_{1i}\sqrt{1 - \frac{1}{(1+W_{2}^{2}s_{1i}^{2}/W_{1}^{2}s_{2i}^{2})}}}
1929///\f]
1930/// have approximately a normal distribution with mean equal to 0 and standard
1931/// deviation 1. A recommended minimal expected frequency is equal to 10 for
1932/// the proposed test.
1933///
1934/// #### Numerical examples:
1935///
1936/// The method described herein is now illustrated with an example.
1937/// We take a distribution
1938///\f[
1939/// \phi(x) = \frac{2}{(x-10)^{2}+1} + \frac{1}{(x-14)^{2}+1} (1)
1940///\f]
1941/// defined on the interval [4,16]. Events distributed according to the formula
1942/// (1) are simulated to create the unweighted histogram. Uniformly distributed
1943/// events are simulated for the weighted histogram with weights calculated by
1944/// formula (1). Each histogram has the same number of bins: 20. Fig.1 shows
1945/// the result of comparison of the unweighted histogram with 200 events
1946/// (minimal expected frequency equal to one) and the weighted histogram with
1947/// 500 events (minimal expected frequency equal to 25)
1948/// Begin_Macro
1949/// ../../../tutorials/math/chi2test.C
1950/// End_Macro
1951/// Fig 1. An example of comparison of the unweighted histogram with 200 events
1952/// and the weighted histogram with 500 events:
1953/// 1. unweighted histogram;
1954/// 2. weighted histogram;
1955/// 3. normalized residuals plot;
1956/// 4. normal Q-Q plot of residuals.
1957///
1958/// The value of the test statistic \f$ \chi^{2} \f$ is equal to
1959/// 21.09 with p-value equal to 0.33, therefore the hypothesis of identity of
1960/// the two histograms can be accepted for 0.05 significant level. The behavior
1961/// of the normalized residuals plot (see Fig. 1c) and the normal Q-Q plot
1962/// (see Fig. 1d) of residuals are regular and we cannot identify the outliers
1963/// or bins with a big influence on \f$ \chi^{2} \f$.
1964///
1965/// The second example presents the same two histograms but 17 events was added
1966/// to content of bin number 15 in unweighted histogram. Fig.2 shows the result
1967/// of comparison of the unweighted histogram with 217 events (minimal expected
1968/// frequency equal to one) and the weighted histogram with 500 events (minimal
1969/// expected frequency equal to 25)
1970/// Begin_Macro
1971/// ../../../tutorials/math/chi2test.C(17)
1972/// End_Macro
1973/// Fig 2. An example of comparison of the unweighted histogram with 217 events
1974/// and the weighted histogram with 500 events:
1975/// 1. unweighted histogram;
1976/// 2. weighted histogram;
1977/// 3. normalized residuals plot;
1978/// 4. normal Q-Q plot of residuals.
1979///
1980/// The value of the test statistic \f$ \chi^{2} \f$ is equal to
1981/// 32.33 with p-value equal to 0.029, therefore the hypothesis of identity of
1982/// the two histograms is rejected for 0.05 significant level. The behavior of
1983/// the normalized residuals plot (see Fig. 2c) and the normal Q-Q plot (see
1984/// Fig. 2d) of residuals are not regular and we can identify the outlier or
1985/// bin with a big influence on \f$ \chi^{2} \f$.
1986///
1987/// #### References:
1988///
1989/// - [1] Pearson, K., 1904. On the Theory of Contingency and Its Relation to
1990/// Association and Normal Correlation. Drapers' Co. Memoirs, Biometric
1991/// Series No. 1, London.
1992/// - [2] Gagunashvili, N., 2006. \f$ \sigma^{2} \f$ test for comparison
1993/// of weighted and unweighted histograms. Statistical Problems in Particle
1994/// Physics, Astrophysics and Cosmology, Proceedings of PHYSTAT05,
1995/// Oxford, UK, 12-15 September 2005, Imperial College Press, London, 43-44.
1996/// Gagunashvili,N., Comparison of weighted and unweighted histograms,
1997/// arXiv:physics/0605123, 2006.
1998/// - [3] Cramer, H., 1946. Mathematical methods of statistics.
1999/// Princeton University Press, Princeton.
2000/// - [4] Haberman, S.J., 1973. The analysis of residuals in cross-classified tables.
2001/// Biometrics 29, 205-220.
2002/// - [5] Lewontin, R.C. and Felsenstein, J., 1965. The robustness of homogeneity
2003/// test in 2xN tables. Biometrics 21, 19-33.
2004/// - [6] Seber, G.A.F., Lee, A.J., 2003, Linear Regression Analysis.
2005/// John Wiley & Sons Inc., New York.
2006
2007Double_t TH1::Chi2Test(const TH1* h2, Option_t *option, Double_t *res) const
2008{
2009 Double_t chi2 = 0;
2010 Int_t ndf = 0, igood = 0;
2011
2012 TString opt = option;
2013 opt.ToUpper();
2014
2015 Double_t prob = Chi2TestX(h2,chi2,ndf,igood,option,res);
2016
2017 if(opt.Contains("P")) {
2018 printf("Chi2 = %f, Prob = %g, NDF = %d, igood = %d\n", chi2,prob,ndf,igood);
2019 }
2020 if(opt.Contains("CHI2/NDF")) {
2021 if (ndf == 0) return 0;
2022 return chi2/ndf;
2023 }
2024 if(opt.Contains("CHI2")) {
2025 return chi2;
2026 }
2027
2028 return prob;
2029}
2030
2031////////////////////////////////////////////////////////////////////////////////
2032/// The computation routine of the Chisquare test. For the method description,
2033/// see Chi2Test() function.
2034///
2035/// \return p-value
2036/// \param[in] h2 the second histogram
2037/// \param[in] option
2038/// - "UU" = experiment experiment comparison (unweighted-unweighted)
2039/// - "UW" = experiment MC comparison (unweighted-weighted). Note that the first
2040/// histogram should be unweighted
2041/// - "WW" = MC MC comparison (weighted-weighted)
2042/// - "NORM" = if one or both histograms is scaled
2043/// - "OF" = overflows included
2044/// - "UF" = underflows included
2045/// by default underflows and overflows are not included
2046/// \param[out] igood test output
2047/// - igood=0 - no problems
2048/// - For unweighted unweighted comparison
2049/// - igood=1'There is a bin in the 1st histogram with less than 1 event'
2050/// - igood=2'There is a bin in the 2nd histogram with less than 1 event'
2051/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2052/// - For unweighted weighted comparison
2053/// - igood=1'There is a bin in the 1st histogram with less then 1 event'
2054/// - igood=2'There is a bin in the 2nd histogram with less then 10 effective number of events'
2055/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2056/// - For weighted weighted comparison
2057/// - igood=1'There is a bin in the 1st histogram with less then 10 effective
2058/// number of events'
2059/// - igood=2'There is a bin in the 2nd histogram with less then 10 effective
2060/// number of events'
2061/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2062/// \param[out] chi2 chisquare of the test
2063/// \param[out] ndf number of degrees of freedom (important, when both histograms have the same empty bins)
2064/// \param[out] res normalized residuals for further analysis
2065
2066Double_t TH1::Chi2TestX(const TH1* h2, Double_t &chi2, Int_t &ndf, Int_t &igood, Option_t *option, Double_t *res) const
2067{
2068
2072
2073 Double_t sum1 = 0.0, sumw1 = 0.0;
2074 Double_t sum2 = 0.0, sumw2 = 0.0;
2075
2076 chi2 = 0.0;
2077 ndf = 0;
2078
2079 TString opt = option;
2080 opt.ToUpper();
2081
2082 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
2083
2084 const TAxis *xaxis1 = GetXaxis();
2085 const TAxis *xaxis2 = h2->GetXaxis();
2086 const TAxis *yaxis1 = GetYaxis();
2087 const TAxis *yaxis2 = h2->GetYaxis();
2088 const TAxis *zaxis1 = GetZaxis();
2089 const TAxis *zaxis2 = h2->GetZaxis();
2090
2091 Int_t nbinx1 = xaxis1->GetNbins();
2092 Int_t nbinx2 = xaxis2->GetNbins();
2093 Int_t nbiny1 = yaxis1->GetNbins();
2094 Int_t nbiny2 = yaxis2->GetNbins();
2095 Int_t nbinz1 = zaxis1->GetNbins();
2096 Int_t nbinz2 = zaxis2->GetNbins();
2097
2098 //check dimensions
2099 if (this->GetDimension() != h2->GetDimension() ){
2100 Error("Chi2TestX","Histograms have different dimensions.");
2101 return 0.0;
2102 }
2103
2104 //check number of channels
2105 if (nbinx1 != nbinx2) {
2106 Error("Chi2TestX","different number of x channels");
2107 }
2108 if (nbiny1 != nbiny2) {
2109 Error("Chi2TestX","different number of y channels");
2110 }
2111 if (nbinz1 != nbinz2) {
2112 Error("Chi2TestX","different number of z channels");
2113 }
2114
2115 //check for ranges
2116 i_start = j_start = k_start = 1;
2117 i_end = nbinx1;
2118 j_end = nbiny1;
2119 k_end = nbinz1;
2120
2121 if (xaxis1->TestBit(TAxis::kAxisRange)) {
2122 i_start = xaxis1->GetFirst();
2123 i_end = xaxis1->GetLast();
2124 }
2125 if (yaxis1->TestBit(TAxis::kAxisRange)) {
2126 j_start = yaxis1->GetFirst();
2127 j_end = yaxis1->GetLast();
2128 }
2129 if (zaxis1->TestBit(TAxis::kAxisRange)) {
2130 k_start = zaxis1->GetFirst();
2131 k_end = zaxis1->GetLast();
2132 }
2133
2134
2135 if (opt.Contains("OF")) {
2136 if (GetDimension() == 3) k_end = ++nbinz1;
2137 if (GetDimension() >= 2) j_end = ++nbiny1;
2138 if (GetDimension() >= 1) i_end = ++nbinx1;
2139 }
2140
2141 if (opt.Contains("UF")) {
2142 if (GetDimension() == 3) k_start = 0;
2143 if (GetDimension() >= 2) j_start = 0;
2144 if (GetDimension() >= 1) i_start = 0;
2145 }
2146
2147 ndf = (i_end - i_start + 1) * (j_end - j_start + 1) * (k_end - k_start + 1) - 1;
2148
2149 Bool_t comparisonUU = opt.Contains("UU");
2150 Bool_t comparisonUW = opt.Contains("UW");
2151 Bool_t comparisonWW = opt.Contains("WW");
2152 Bool_t scaledHistogram = opt.Contains("NORM");
2153
2154 if (scaledHistogram && !comparisonUU) {
2155 Info("Chi2TestX", "NORM option should be used together with UU option. It is ignored");
2156 }
2157
2158 // look at histo global bin content and effective entries
2159 Stat_t s[kNstat];
2160 GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
2161 Double_t sumBinContent1 = s[0];
2162 Double_t effEntries1 = (s[1] ? s[0] * s[0] / s[1] : 0.0);
2163
2164 h2->GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
2165 Double_t sumBinContent2 = s[0];
2166 Double_t effEntries2 = (s[1] ? s[0] * s[0] / s[1] : 0.0);
2167
2168 if (!comparisonUU && !comparisonUW && !comparisonWW ) {
2169 // deduce automatically from type of histogram
2172 else comparisonUW = true;
2173 }
2174 else comparisonWW = true;
2175 }
2176 // check unweighted histogram
2177 if (comparisonUW) {
2179 Warning("Chi2TestX","First histogram is not unweighted and option UW has been requested");
2180 }
2181 }
2182 if ( (!scaledHistogram && comparisonUU) ) {
2184 Warning("Chi2TestX","Both histograms are not unweighted and option UU has been requested");
2185 }
2186 }
2187
2188
2189 //get number of events in histogram
2191 for (Int_t i = i_start; i <= i_end; ++i) {
2192 for (Int_t j = j_start; j <= j_end; ++j) {
2193 for (Int_t k = k_start; k <= k_end; ++k) {
2194
2195 Int_t bin = GetBin(i, j, k);
2196
2198 Double_t cnt2 = h2->RetrieveBinContent(bin);
2200 Double_t e2sq = h2->GetBinErrorSqUnchecked(bin);
2201
2202 if (e1sq > 0.0) cnt1 = TMath::Floor(cnt1 * cnt1 / e1sq + 0.5); // avoid rounding errors
2203 else cnt1 = 0.0;
2204
2205 if (e2sq > 0.0) cnt2 = TMath::Floor(cnt2 * cnt2 / e2sq + 0.5); // avoid rounding errors
2206 else cnt2 = 0.0;
2207
2208 // sum contents
2209 sum1 += cnt1;
2210 sum2 += cnt2;
2211 sumw1 += e1sq;
2212 sumw2 += e2sq;
2213 }
2214 }
2215 }
2216 if (sumw1 <= 0.0 || sumw2 <= 0.0) {
2217 Error("Chi2TestX", "Cannot use option NORM when one histogram has all zero errors");
2218 return 0.0;
2219 }
2220
2221 } else {
2222 for (Int_t i = i_start; i <= i_end; ++i) {
2223 for (Int_t j = j_start; j <= j_end; ++j) {
2224 for (Int_t k = k_start; k <= k_end; ++k) {
2225
2226 Int_t bin = GetBin(i, j, k);
2227
2228 sum1 += RetrieveBinContent(bin);
2229 sum2 += h2->RetrieveBinContent(bin);
2230
2232 if ( comparisonUW || comparisonWW ) sumw2 += h2->GetBinErrorSqUnchecked(bin);
2233 }
2234 }
2235 }
2236 }
2237 //checks that the histograms are not empty
2238 if (sum1 == 0.0 || sum2 == 0.0) {
2239 Error("Chi2TestX","one histogram is empty");
2240 return 0.0;
2241 }
2242
2243 if ( comparisonWW && ( sumw1 <= 0.0 && sumw2 <= 0.0 ) ){
2244 Error("Chi2TestX","Hist1 and Hist2 have both all zero errors\n");
2245 return 0.0;
2246 }
2247
2248 //THE TEST
2249 Int_t m = 0, n = 0;
2250 //Experiment - experiment comparison
2251 if (comparisonUU) {
2252 Int_t resIndex = 0;
2253 Double_t sum = sum1 + sum2;
2254 for (Int_t i = i_start; i <= i_end; ++i) {
2255 for (Int_t j = j_start; j <= j_end; ++j) {
2256 for (Int_t k = k_start; k <= k_end; ++k) {
2257
2258 Int_t bin = GetBin(i, j, k);
2259
2261 Double_t cnt2 = h2->RetrieveBinContent(bin);
2262
2263 if (scaledHistogram) {
2264 // scale bin value to effective bin entries
2266 Double_t e2sq = h2->GetBinErrorSqUnchecked(bin);
2267
2268 if (e1sq > 0) cnt1 = TMath::Floor(cnt1 * cnt1 / e1sq + 0.5); // avoid rounding errors
2269 else cnt1 = 0;
2270
2271 if (e2sq > 0) cnt2 = TMath::Floor(cnt2 * cnt2 / e2sq + 0.5); // avoid rounding errors
2272 else cnt2 = 0;
2273 }
2274
2275 if (Int_t(cnt1) == 0 && Int_t(cnt2) == 0) --ndf; // no data means one degree of freedom less
2276 else {
2277
2280 //Double_t nexp2 = binsum*sum2/sum;
2281
2282 if (res) res[resIndex] = (cnt1 - nexp1) / TMath::Sqrt(nexp1);
2283
2284 if (cnt1 < 1) ++m;
2285 if (cnt2 < 1) ++n;
2286
2287 //Habermann correction for residuals
2288 Double_t correc = (1. - sum1 / sum) * (1. - cntsum / sum);
2289 if (res) res[resIndex] /= TMath::Sqrt(correc);
2290 if (res) resIndex++;
2291 Double_t delta = sum2 * cnt1 - sum1 * cnt2;
2292 chi2 += delta * delta / cntsum;
2293 }
2294 }
2295 }
2296 }
2297 chi2 /= sum1 * sum2;
2298
2299 // flag error only when of the two histogram is zero
2300 if (m) {
2301 igood += 1;
2302 Info("Chi2TestX","There is a bin in h1 with less than 1 event.\n");
2303 }
2304 if (n) {
2305 igood += 2;
2306 Info("Chi2TestX","There is a bin in h2 with less than 1 event.\n");
2307 }
2308
2310 return prob;
2311
2312 }
2313
2314 // unweighted - weighted comparison
2315 // case of error = 0 and content not zero is treated without problems by excluding second chi2 sum
2316 // and can be considered as a data-theory comparison
2317 if ( comparisonUW ) {
2318 Int_t resIndex = 0;
2319 for (Int_t i = i_start; i <= i_end; ++i) {
2320 for (Int_t j = j_start; j <= j_end; ++j) {
2321 for (Int_t k = k_start; k <= k_end; ++k) {
2322
2323 Int_t bin = GetBin(i, j, k);
2324
2326 Double_t cnt2 = h2->RetrieveBinContent(bin);
2327 Double_t e2sq = h2->GetBinErrorSqUnchecked(bin);
2328
2329 // case both histogram have zero bin contents
2330 if (cnt1 * cnt1 == 0 && cnt2 * cnt2 == 0) {
2331 --ndf; //no data means one degree of freedom less
2332 continue;
2333 }
2334
2335 // case weighted histogram has zero bin content and error
2336 if (cnt2 * cnt2 == 0 && e2sq == 0) {
2337 if (sumw2 > 0) {
2338 // use as approximated error as 1 scaled by a scaling ratio
2339 // estimated from the total sum weight and sum weight squared
2340 e2sq = sumw2 / sum2;
2341 }
2342 else {
2343 // return error because infinite discrepancy here:
2344 // bin1 != 0 and bin2 =0 in a histogram with all errors zero
2345 Error("Chi2TestX","Hist2 has in bin (%d,%d,%d) zero content and zero errors\n", i, j, k);
2346 chi2 = 0; return 0;
2347 }
2348 }
2349
2350 if (cnt1 < 1) m++;
2351 if (e2sq > 0 && cnt2 * cnt2 / e2sq < 10) n++;
2352
2353 Double_t var1 = sum2 * cnt2 - sum1 * e2sq;
2354 Double_t var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2355
2356 // if cnt1 is zero and cnt2 = 1 and sum1 = sum2 var1 = 0 && var2 == 0
2357 // approximate by incrementing cnt1
2358 // LM (this need to be fixed for numerical errors)
2359 while (var1 * var1 + cnt1 == 0 || var1 + var2 == 0) {
2360 sum1++;
2361 cnt1++;
2362 var1 = sum2 * cnt2 - sum1 * e2sq;
2363 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2364 }
2366
2367 while (var1 + var2 == 0) {
2368 sum1++;
2369 cnt1++;
2370 var1 = sum2 * cnt2 - sum1 * e2sq;
2371 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2372 while (var1 * var1 + cnt1 == 0 || var1 + var2 == 0) {
2373 sum1++;
2374 cnt1++;
2375 var1 = sum2 * cnt2 - sum1 * e2sq;
2376 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2377 }
2379 }
2380
2381 Double_t probb = (var1 + var2) / (2. * sum2 * sum2);
2382
2385
2388
2389 chi2 += delta1 * delta1 / nexp1;
2390
2391 if (e2sq > 0) {
2392 chi2 += delta2 * delta2 / e2sq;
2393 }
2394
2395 if (res) {
2396 if (e2sq > 0) {
2397 Double_t temp1 = sum2 * e2sq / var2;
2398 Double_t temp2 = 1.0 + (sum1 * e2sq - sum2 * cnt2) / var2;
2399 temp2 = temp1 * temp1 * sum1 * probb * (1.0 - probb) + temp2 * temp2 * e2sq / 4.0;
2400 // invert sign here
2401 res[resIndex] = - delta2 / TMath::Sqrt(temp2);
2402 }
2403 else
2404 res[resIndex] = delta1 / TMath::Sqrt(nexp1);
2405 resIndex++;
2406 }
2407 }
2408 }
2409 }
2410
2411 if (m) {
2412 igood += 1;
2413 Info("Chi2TestX","There is a bin in h1 with less than 1 event.\n");
2414 }
2415 if (n) {
2416 igood += 2;
2417 Info("Chi2TestX","There is a bin in h2 with less than 10 effective events.\n");
2418 }
2419
2420 Double_t prob = TMath::Prob(chi2, ndf);
2421
2422 return prob;
2423 }
2424
2425 // weighted - weighted comparison
2426 if (comparisonWW) {
2427 Int_t resIndex = 0;
2428 for (Int_t i = i_start; i <= i_end; ++i) {
2429 for (Int_t j = j_start; j <= j_end; ++j) {
2430 for (Int_t k = k_start; k <= k_end; ++k) {
2431
2432 Int_t bin = GetBin(i, j, k);
2434 Double_t cnt2 = h2->RetrieveBinContent(bin);
2436 Double_t e2sq = h2->GetBinErrorSqUnchecked(bin);
2437
2438 // case both histogram have zero bin contents
2439 // (use square of content to avoid numerical errors)
2440 if (cnt1 * cnt1 == 0 && cnt2 * cnt2 == 0) {
2441 --ndf; //no data means one degree of freedom less
2442 continue;
2443 }
2444
2445 if (e1sq == 0 && e2sq == 0) {
2446 // cannot treat case of booth histogram have zero zero errors
2447 Error("Chi2TestX","h1 and h2 both have bin %d,%d,%d with all zero errors\n", i,j,k);
2448 chi2 = 0; return 0;
2449 }
2450
2451 Double_t sigma = sum1 * sum1 * e2sq + sum2 * sum2 * e1sq;
2452 Double_t delta = sum2 * cnt1 - sum1 * cnt2;
2453 chi2 += delta * delta / sigma;
2454
2455 if (res) {
2456 Double_t temp = cnt1 * sum1 * e2sq + cnt2 * sum2 * e1sq;
2457 Double_t probb = temp / sigma;
2458 Double_t z = 0;
2459 if (e1sq > e2sq) {
2460 Double_t d1 = cnt1 - sum1 * probb;
2461 Double_t s1 = e1sq * ( 1. - e2sq * sum1 * sum1 / sigma );
2462 z = d1 / TMath::Sqrt(s1);
2463 }
2464 else {
2465 Double_t d2 = cnt2 - sum2 * probb;
2466 Double_t s2 = e2sq * ( 1. - e1sq * sum2 * sum2 / sigma );
2467 z = -d2 / TMath::Sqrt(s2);
2468 }
2469 res[resIndex] = z;
2470 resIndex++;
2471 }
2472
2473 if (e1sq > 0 && cnt1 * cnt1 / e1sq < 10) m++;
2474 if (e2sq > 0 && cnt2 * cnt2 / e2sq < 10) n++;
2475 }
2476 }
2477 }
2478 if (m) {
2479 igood += 1;
2480 Info("Chi2TestX","There is a bin in h1 with less than 10 effective events.\n");
2481 }
2482 if (n) {
2483 igood += 2;
2484 Info("Chi2TestX","There is a bin in h2 with less than 10 effective events.\n");
2485 }
2486 Double_t prob = TMath::Prob(chi2, ndf);
2487 return prob;
2488 }
2489 return 0;
2490}
2491////////////////////////////////////////////////////////////////////////////////
2492/// Compute and return the chisquare of this histogram with respect to a function
2493/// The chisquare is computed by weighting each histogram point by the bin error
2494/// By default the full range of the histogram is used, unless TAxis::SetRange or TAxis::SetRangeUser was called before.
2495/// Use option "R" for restricting the chisquare calculation to the given range of the function
2496/// Use option "L" for using the chisquare based on the poisson likelihood (Baker-Cousins Chisquare)
2497/// Use option "P" for using the Pearson chisquare based on the expected bin errors
2498
2500{
2501 if (!func) {
2502 Error("Chisquare","Function pointer is Null - return -1");
2503 return -1;
2504 }
2505
2506 TString opt(option); opt.ToUpper();
2507 bool useRange = opt.Contains("R");
2508 ROOT::Fit::EChisquareType type = ROOT::Fit::EChisquareType::kNeyman; // default chi2 with observed error
2511
2512 return ROOT::Fit::Chisquare(*this, *func, useRange, type);
2513}
2514
2515////////////////////////////////////////////////////////////////////////////////
2516/// Remove all the content from the underflow and overflow bins, without changing the number of entries
2517/// After calling this method, every undeflow and overflow bins will have content 0.0
2518/// The Sumw2 is also cleared, since there is no more content in the bins
2519
2521{
2522 for (Int_t bin = 0; bin < fNcells; ++bin)
2523 if (IsBinUnderflow(bin) || IsBinOverflow(bin)) {
2524 UpdateBinContent(bin, 0.0);
2525 if (fSumw2.fN) fSumw2.fArray[bin] = 0.0;
2526 }
2527}
2528
2529////////////////////////////////////////////////////////////////////////////////
2530/// Compute integral (normalized cumulative sum of bins) w/o under/overflows
2531/// The result is stored in fIntegral and used by the GetRandom functions.
2532/// This function is automatically called by GetRandom when the fIntegral
2533/// array does not exist or when the number of entries in the histogram
2534/// has changed since the previous call to GetRandom.
2535/// The resulting integral is normalized to 1.
2536/// If the routine is called with the onlyPositive flag set an error will
2537/// be produced in case of negative bin content and a NaN value returned
2538/// \param onlyPositive If set to true, an error will be produced and NaN will be returned
2539/// when a bin with negative number of entries is encountered.
2540/// \param option
2541/// - `""` (default) Compute the cumulative density function assuming current bin contents represent counts.
2542/// - `"width"` Computes the cumulative density function assuming current bin contents represent densities.
2543/// \return 1 if success, 0 if integral is zero, NAN if onlyPositive-test fails
2544
2546{
2547 if (fBuffer) BufferEmpty();
2549 // delete previously computed integral (if any)
2550 if (fIntegral) delete [] fIntegral;
2551
2552 // - Allocate space to store the integral and compute integral
2556 Int_t nbins = nbinsx * nbinsy * nbinsz;
2557
2558 fIntegral = new Double_t[nbins + 2];
2559 Int_t ibin = 0; fIntegral[ibin] = 0;
2560
2561 for (Int_t binz=1; binz <= nbinsz; ++binz) {
2563 for (Int_t biny=1; biny <= nbinsy; ++biny) {
2565 for (Int_t binx=1; binx <= nbinsx; ++binx) {
2567 ++ibin;
2569 if (useArea)
2570 y *= xWidth * yWidth * zWidth;
2571
2572 if (onlyPositive && y < 0) {
2573 Error("ComputeIntegral","Bin content is negative - return a NaN value");
2574 fIntegral[nbins] = TMath::QuietNaN();
2575 break;
2576 }
2577 fIntegral[ibin] = fIntegral[ibin - 1] + y;
2578 }
2579 }
2580 }
2581
2582 // - Normalize integral to 1
2583 if (fIntegral[nbins] == 0 ) {
2584 Error("ComputeIntegral", "Integral = 0, no hits in histogram bins (excluding over/underflow).");
2585 return 0;
2586 }
2587 for (Int_t bin=1; bin <= nbins; ++bin) fIntegral[bin] /= fIntegral[nbins];
2588 fIntegral[nbins+1] = fEntries;
2589 return fIntegral[nbins];
2590}
2591
2592////////////////////////////////////////////////////////////////////////////////
2593/// Return a pointer to the array of bins integral.
2594/// if the pointer fIntegral is null, TH1::ComputeIntegral is called
2595/// The array dimension is the number of bins in the histograms
2596/// including underflow and overflow (fNCells)
2597/// the last value integral[fNCells] is set to the number of entries of
2598/// the histogram
2599
2601{
2602 if (!fIntegral) ComputeIntegral();
2603 return fIntegral;
2604}
2605
2606////////////////////////////////////////////////////////////////////////////////
2607/// Return a pointer to a histogram containing the cumulative content.
2608/// The cumulative can be computed both in the forward (default) or backward
2609/// direction; the name of the new histogram is constructed from
2610/// the name of this histogram with the suffix "suffix" appended provided
2611/// by the user. If not provided a default suffix="_cumulative" is used.
2612///
2613/// The cumulative distribution is formed by filling each bin of the
2614/// resulting histogram with the sum of that bin and all previous
2615/// (forward == kTRUE) or following (forward = kFALSE) bins.
2616///
2617/// Note: while cumulative distributions make sense in one dimension, you
2618/// may not be getting what you expect in more than 1D because the concept
2619/// of a cumulative distribution is much trickier to define; make sure you
2620/// understand the order of summation before you use this method with
2621/// histograms of dimension >= 2.
2622///
2623/// Note 2: By default the cumulative is computed from bin 1 to Nbins
2624/// If an axis range is set, values between the minimum and maximum of the range
2625/// are set.
2626/// Setting an axis range can also be used for including underflow and overflow in
2627/// the cumulative (e.g. by setting h->GetXaxis()->SetRange(0, h->GetNbinsX()+1); )
2629
2630TH1 *TH1::GetCumulative(Bool_t forward, const char* suffix) const
2631{
2632 const Int_t firstX = fXaxis.GetFirst();
2633 const Int_t lastX = fXaxis.GetLast();
2634 const Int_t firstY = (fDimension > 1) ? fYaxis.GetFirst() : 1;
2635 const Int_t lastY = (fDimension > 1) ? fYaxis.GetLast() : 1;
2636 const Int_t firstZ = (fDimension > 1) ? fZaxis.GetFirst() : 1;
2637 const Int_t lastZ = (fDimension > 1) ? fZaxis.GetLast() : 1;
2638
2640 hintegrated->Reset();
2641 Double_t sum = 0.;
2642 Double_t esum = 0;
2643 if (forward) { // Forward computation
2644 for (Int_t binz = firstZ; binz <= lastZ; ++binz) {
2645 for (Int_t biny = firstY; biny <= lastY; ++biny) {
2646 for (Int_t binx = firstX; binx <= lastX; ++binx) {
2647 const Int_t bin = hintegrated->GetBin(binx, biny, binz);
2648 sum += RetrieveBinContent(bin);
2649 hintegrated->AddBinContent(bin, sum);
2650 if (fSumw2.fN) {
2652 hintegrated->fSumw2.fArray[bin] = esum;
2653 }
2654 }
2655 }
2656 }
2657 } else { // Backward computation
2658 for (Int_t binz = lastZ; binz >= firstZ; --binz) {
2659 for (Int_t biny = lastY; biny >= firstY; --biny) {
2660 for (Int_t binx = lastX; binx >= firstX; --binx) {
2661 const Int_t bin = hintegrated->GetBin(binx, biny, binz);
2662 sum += RetrieveBinContent(bin);
2663 hintegrated->AddBinContent(bin, sum);
2664 if (fSumw2.fN) {
2666 hintegrated->fSumw2.fArray[bin] = esum;
2667 }
2668 }
2669 }
2670 }
2671 }
2672 return hintegrated;
2673}
2674
2675////////////////////////////////////////////////////////////////////////////////
2676/// Copy this histogram structure to newth1.
2677///
2678/// Note that this function does not copy the list of associated functions.
2679/// Use TObject::Clone to make a full copy of a histogram.
2680///
2681/// Note also that the histogram it will be created in gDirectory (if AddDirectoryStatus()=true)
2682/// or will not be added to any directory if AddDirectoryStatus()=false
2683/// independently of the current directory stored in the original histogram
2684
2685void TH1::Copy(TObject &obj) const
2686{
2687 if (((TH1&)obj).fDirectory) {
2688 // We are likely to change the hash value of this object
2689 // with TNamed::Copy, to keep things correct, we need to
2690 // clean up its existing entries.
2691 ((TH1&)obj).fDirectory->Remove(&obj);
2692 ((TH1&)obj).fDirectory = nullptr;
2693 }
2694 TNamed::Copy(obj);
2695 ((TH1&)obj).fDimension = fDimension;
2696 ((TH1&)obj).fNormFactor= fNormFactor;
2697 ((TH1&)obj).fNcells = fNcells;
2698 ((TH1&)obj).fBarOffset = fBarOffset;
2699 ((TH1&)obj).fBarWidth = fBarWidth;
2700 ((TH1&)obj).fOption = fOption;
2701 ((TH1&)obj).fBinStatErrOpt = fBinStatErrOpt;
2702 ((TH1&)obj).fBufferSize= fBufferSize;
2703 // copy the Buffer
2704 // delete first a previously existing buffer
2705 if (((TH1&)obj).fBuffer != nullptr) {
2706 delete [] ((TH1&)obj).fBuffer;
2707 ((TH1&)obj).fBuffer = nullptr;
2708 }
2709 if (fBuffer) {
2710 Double_t *buf = new Double_t[fBufferSize];
2711 for (Int_t i=0;i<fBufferSize;i++) buf[i] = fBuffer[i];
2712 // obj.fBuffer has been deleted before
2713 ((TH1&)obj).fBuffer = buf;
2714 }
2715
2716 // copy bin contents (this should be done by the derived classes, since TH1 does not store the bin content)
2717 // Do this in case derived from TArray
2718 TArray* a = dynamic_cast<TArray*>(&obj);
2719 if (a) {
2720 a->Set(fNcells);
2721 for (Int_t i = 0; i < fNcells; i++)
2723 }
2724
2725 ((TH1&)obj).fEntries = fEntries;
2726
2727 // which will call BufferEmpty(0) and set fBuffer[0] to a Maybe one should call
2728 // assignment operator on the TArrayD
2729
2730 ((TH1&)obj).fTsumw = fTsumw;
2731 ((TH1&)obj).fTsumw2 = fTsumw2;
2732 ((TH1&)obj).fTsumwx = fTsumwx;
2733 ((TH1&)obj).fTsumwx2 = fTsumwx2;
2734 ((TH1&)obj).fMaximum = fMaximum;
2735 ((TH1&)obj).fMinimum = fMinimum;
2736
2737 TAttLine::Copy(((TH1&)obj));
2738 TAttFill::Copy(((TH1&)obj));
2739 TAttMarker::Copy(((TH1&)obj));
2740 fXaxis.Copy(((TH1&)obj).fXaxis);
2741 fYaxis.Copy(((TH1&)obj).fYaxis);
2742 fZaxis.Copy(((TH1&)obj).fZaxis);
2743 ((TH1&)obj).fXaxis.SetParent(&obj);
2744 ((TH1&)obj).fYaxis.SetParent(&obj);
2745 ((TH1&)obj).fZaxis.SetParent(&obj);
2746 fContour.Copy(((TH1&)obj).fContour);
2747 fSumw2.Copy(((TH1&)obj).fSumw2);
2748 // fFunctions->Copy(((TH1&)obj).fFunctions);
2749 // when copying an histogram if the AddDirectoryStatus() is true it
2750 // will be added to gDirectory independently of the fDirectory stored.
2751 // and if the AddDirectoryStatus() is false it will not be added to
2752 // any directory (fDirectory = nullptr)
2753 if (fgAddDirectory && gDirectory) {
2754 gDirectory->Append(&obj);
2755 ((TH1&)obj).fFunctions->UseRWLock();
2756 ((TH1&)obj).fDirectory = gDirectory;
2757 } else
2758 ((TH1&)obj).fDirectory = nullptr;
2759
2760}
2761
2762////////////////////////////////////////////////////////////////////////////////
2763/// Make a complete copy of the underlying object. If 'newname' is set,
2764/// the copy's name will be set to that name.
2765
2766TObject* TH1::Clone(const char* newname) const
2767{
2768 TH1* obj = (TH1*)IsA()->GetNew()(nullptr);
2769 Copy(*obj);
2770
2771 // Now handle the parts that Copy doesn't do
2772 if(fFunctions) {
2773 // The Copy above might have published 'obj' to the ListOfCleanups.
2774 // Clone can call RecursiveRemove, for example via TCheckHashRecursiveRemoveConsistency
2775 // when dictionary information is initialized, so we need to
2776 // keep obj->fFunction valid during its execution and
2777 // protect the update with the write lock.
2778
2779 // Reset stats parent - else cloning the stats will clone this histogram, too.
2780 auto oldstats = dynamic_cast<TVirtualPaveStats*>(fFunctions->FindObject("stats"));
2781 TObject *oldparent = nullptr;
2782 if (oldstats) {
2783 oldparent = oldstats->GetParent();
2784 oldstats->SetParent(nullptr);
2785 }
2786
2787 auto newlist = (TList*)fFunctions->Clone();
2788
2789 if (oldstats)
2790 oldstats->SetParent(oldparent);
2791 auto newstats = dynamic_cast<TVirtualPaveStats*>(obj->fFunctions->FindObject("stats"));
2792 if (newstats)
2793 newstats->SetParent(obj);
2794
2795 auto oldlist = obj->fFunctions;
2796 {
2798 obj->fFunctions = newlist;
2799 }
2800 delete oldlist;
2801 }
2802 if(newname && strlen(newname) ) {
2803 obj->SetName(newname);
2804 }
2805 return obj;
2806}
2807
2808////////////////////////////////////////////////////////////////////////////////
2809/// Perform the automatic addition of the histogram to the given directory
2810///
2811/// Note this function is called in place when the semantic requires
2812/// this object to be added to a directory (I.e. when being read from
2813/// a TKey or being Cloned)
2814
2816{
2818 if (addStatus) {
2819 SetDirectory(dir);
2820 if (dir) {
2822 }
2823 }
2824}
2825
2826////////////////////////////////////////////////////////////////////////////////
2827/// Compute distance from point px,py to a line.
2828///
2829/// Compute the closest distance of approach from point px,py to elements
2830/// of a histogram.
2831/// The distance is computed in pixels units.
2832///
2833/// #### Algorithm:
2834/// Currently, this simple model computes the distance from the mouse
2835/// to the histogram contour only.
2836
2838{
2839 if (!fPainter) return 9999;
2840 return fPainter->DistancetoPrimitive(px,py);
2841}
2842
2843////////////////////////////////////////////////////////////////////////////////
2844/// Performs the operation: `this = this/(c1*f1)`
2845/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
2846///
2847/// Only bins inside the function range are recomputed.
2848/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2849/// you should call Sumw2 before making this operation.
2850/// This is particularly important if you fit the histogram after TH1::Divide
2851///
2852/// The function return kFALSE if the divide operation failed
2853
2855{
2856 if (!f1) {
2857 Error("Divide","Attempt to divide by a non-existing function");
2858 return kFALSE;
2859 }
2860
2861 // delete buffer if it is there since it will become invalid
2862 if (fBuffer) BufferEmpty(1);
2863
2864 Int_t nx = GetNbinsX() + 2; // normal bins + uf / of
2865 Int_t ny = GetNbinsY() + 2;
2866 Int_t nz = GetNbinsZ() + 2;
2867 if (fDimension < 2) ny = 1;
2868 if (fDimension < 3) nz = 1;
2869
2870
2871 SetMinimum();
2872 SetMaximum();
2873
2874 // - Loop on bins (including underflows/overflows)
2875 Int_t bin, binx, biny, binz;
2876 Double_t cu, w;
2877 Double_t xx[3];
2878 Double_t *params = nullptr;
2879 f1->InitArgs(xx,params);
2880 for (binz = 0; binz < nz; ++binz) {
2881 xx[2] = fZaxis.GetBinCenter(binz);
2882 for (biny = 0; biny < ny; ++biny) {
2883 xx[1] = fYaxis.GetBinCenter(biny);
2884 for (binx = 0; binx < nx; ++binx) {
2885 xx[0] = fXaxis.GetBinCenter(binx);
2886 if (!f1->IsInside(xx)) continue;
2888 bin = binx + nx * (biny + ny * binz);
2889 cu = c1 * f1->EvalPar(xx);
2890 if (TF1::RejectedPoint()) continue;
2891 if (cu) w = RetrieveBinContent(bin) / cu;
2892 else w = 0;
2893 UpdateBinContent(bin, w);
2894 if (fSumw2.fN) {
2895 if (cu != 0) fSumw2.fArray[bin] = GetBinErrorSqUnchecked(bin) / (cu * cu);
2896 else fSumw2.fArray[bin] = 0;
2897 }
2898 }
2899 }
2900 }
2901 ResetStats();
2902 return kTRUE;
2903}
2904
2905////////////////////////////////////////////////////////////////////////////////
2906/// Divide this histogram by h1.
2907///
2908/// `this = this/h1`
2909/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
2910/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
2911/// if not already set.
2912/// The resulting errors are calculated assuming uncorrelated histograms.
2913/// See the other TH1::Divide that gives the possibility to optionally
2914/// compute binomial errors.
2915///
2916/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2917/// you should call Sumw2 before making this operation.
2918/// This is particularly important if you fit the histogram after TH1::Scale
2919///
2920/// The function return kFALSE if the divide operation failed
2921
2922Bool_t TH1::Divide(const TH1 *h1)
2923{
2924 if (!h1) {
2925 Error("Divide", "Input histogram passed does not exist (NULL).");
2926 return kFALSE;
2927 }
2928
2929 // delete buffer if it is there since it will become invalid
2930 if (fBuffer) BufferEmpty(1);
2931
2932 if (LoggedInconsistency("Divide", this, h1) >= kDifferentNumberOfBins) {
2933 return false;
2934 }
2935
2936 // Create Sumw2 if h1 has Sumw2 set
2937 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
2938
2939 // - Loop on bins (including underflows/overflows)
2940 for (Int_t i = 0; i < fNcells; ++i) {
2943 if (c1) UpdateBinContent(i, c0 / c1);
2944 else UpdateBinContent(i, 0);
2945
2946 if(fSumw2.fN) {
2947 if (c1 == 0) { fSumw2.fArray[i] = 0; continue; }
2948 Double_t c1sq = c1 * c1;
2949 fSumw2.fArray[i] = (GetBinErrorSqUnchecked(i) * c1sq + h1->GetBinErrorSqUnchecked(i) * c0 * c0) / (c1sq * c1sq);
2950 }
2951 }
2952 ResetStats();
2953 return kTRUE;
2954}
2955
2956////////////////////////////////////////////////////////////////////////////////
2957/// Replace contents of this histogram by the division of h1 by h2.
2958///
2959/// `this = c1*h1/(c2*h2)`
2960///
2961/// If errors are defined (see TH1::Sumw2), errors are also recalculated
2962/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
2963/// if not already set.
2964/// The resulting errors are calculated assuming uncorrelated histograms.
2965/// However, if option ="B" is specified, Binomial errors are computed.
2966/// In this case c1 and c2 do not make real sense and they are ignored.
2967///
2968/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2969/// you should call Sumw2 before making this operation.
2970/// This is particularly important if you fit the histogram after TH1::Divide
2971///
2972/// Please note also that in the binomial case errors are calculated using standard
2973/// binomial statistics, which means when b1 = b2, the error is zero.
2974/// If you prefer to have efficiency errors not going to zero when the efficiency is 1, you must
2975/// use the function TGraphAsymmErrors::BayesDivide, which will return an asymmetric and non-zero lower
2976/// error for the case b1=b2.
2977///
2978/// The function return kFALSE if the divide operation failed
2979
2981{
2982
2983 TString opt = option;
2984 opt.ToLower();
2985 Bool_t binomial = kFALSE;
2986 if (opt.Contains("b")) binomial = kTRUE;
2987 if (!h1 || !h2) {
2988 Error("Divide", "At least one of the input histograms passed does not exist (NULL).");
2989 return kFALSE;
2990 }
2991
2992 // delete buffer if it is there since it will become invalid
2993 if (fBuffer) BufferEmpty(1);
2994
2995 if (LoggedInconsistency("Divide", this, h1) >= kDifferentNumberOfBins ||
2996 LoggedInconsistency("Divide", h1, h2) >= kDifferentNumberOfBins) {
2997 return false;
2998 }
2999
3000 if (!c2) {
3001 Error("Divide","Coefficient of dividing histogram cannot be zero");
3002 return kFALSE;
3003 }
3004
3005 // Create Sumw2 if h1 or h2 have Sumw2 set, or if binomial errors are explicitly requested
3006 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0 || binomial)) Sumw2();
3007
3008 SetMinimum();
3009 SetMaximum();
3010
3011 // - Loop on bins (including underflows/overflows)
3012 for (Int_t i = 0; i < fNcells; ++i) {
3014 Double_t b2 = h2->RetrieveBinContent(i);
3015 if (b2) UpdateBinContent(i, c1 * b1 / (c2 * b2));
3016 else UpdateBinContent(i, 0);
3017
3018 if (fSumw2.fN) {
3019 if (b2 == 0) { fSumw2.fArray[i] = 0; continue; }
3020 Double_t b1sq = b1 * b1; Double_t b2sq = b2 * b2;
3021 Double_t c1sq = c1 * c1; Double_t c2sq = c2 * c2;
3023 Double_t e2sq = h2->GetBinErrorSqUnchecked(i);
3024 if (binomial) {
3025 if (b1 != b2) {
3026 // in the case of binomial statistics c1 and c2 must be 1 otherwise it does not make sense
3027 // c1 and c2 are ignored
3028 //fSumw2.fArray[bin] = TMath::Abs(w*(1-w)/(c2*b2));//this is the formula in Hbook/Hoper1
3029 //fSumw2.fArray[bin] = TMath::Abs(w*(1-w)/b2); // old formula from G. Flucke
3030 // formula which works also for weighted histogram (see http://root-forum.cern.ch/viewtopic.php?t=3753 )
3031 fSumw2.fArray[i] = TMath::Abs( ( (1. - 2.* b1 / b2) * e1sq + b1sq * e2sq / b2sq ) / b2sq );
3032 } else {
3033 //in case b1=b2 error is zero
3034 //use TGraphAsymmErrors::BayesDivide for getting the asymmetric error not equal to zero
3035 fSumw2.fArray[i] = 0;
3036 }
3037 } else {
3038 fSumw2.fArray[i] = c1sq * c2sq * (e1sq * b2sq + e2sq * b1sq) / (c2sq * c2sq * b2sq * b2sq);
3039 }
3040 }
3041 }
3042 ResetStats();
3043 if (binomial)
3044 // in case of binomial division use denominator for number of entries
3045 SetEntries ( h2->GetEntries() );
3046
3047 return kTRUE;
3048}
3049
3050////////////////////////////////////////////////////////////////////////////////
3051/// Draw this histogram with options.
3052///
3053/// Histograms are drawn via the THistPainter class. Each histogram has
3054/// a pointer to its own painter (to be usable in a multithreaded program).
3055/// The same histogram can be drawn with different options in different pads.
3056/// If a histogram is updated after it has been drawn, the updated data will
3057/// be shown the next time the pad is updated. One does not need to
3058/// redraw the histogram.
3059///
3060/// When a histogram is deleted, the histogram is **automatically removed from
3061/// all pads where it was drawn**. If a histogram should be modified or deleted
3062/// without affecting what is drawn, it should be drawn using DrawCopy().
3063///
3064/// By default, TH1::Draw clears the current pad. Passing the option "SAME", the
3065/// histogram will be drawn on top of what's in the pad.
3066/// One can use TH1::SetMaximum and TH1::SetMinimum to force a particular
3067/// value for the maximum or the minimum scale on the plot.
3068///
3069/// TH1::UseCurrentStyle can be used to change all histogram graphics
3070/// attributes to correspond to the current selected style.
3071/// This function must be called for each histogram.
3072/// In case one reads and draws many histograms from a file, one can force
3073/// the histograms to inherit automatically the current graphics style
3074/// by calling before gROOT->ForceStyle();
3075///
3076/// See the THistPainter class for a description of all the drawing options.
3077
3079{
3080 TString opt1 = option; opt1.ToLower();
3082 Int_t index = opt1.Index("same");
3083
3084 // Check if the string "same" is part of a TCutg name.
3085 if (index>=0) {
3086 Int_t indb = opt1.Index("[");
3087 if (indb>=0) {
3088 Int_t indk = opt1.Index("]");
3089 if (index>indb && index<indk) index = -1;
3090 }
3091 }
3092
3093 // If there is no pad or an empty pad the "same" option is ignored.
3094 if (gPad) {
3095 if (!gPad->IsEditable()) gROOT->MakeDefCanvas();
3096 if (index>=0) {
3097 if (gPad->GetX1() == 0 && gPad->GetX2() == 1 &&
3098 gPad->GetY1() == 0 && gPad->GetY2() == 1 &&
3099 gPad->GetListOfPrimitives()->GetSize()==0) opt2.Remove(index,4);
3100 } else {
3101 //the following statement is necessary in case one attempts to draw
3102 //a temporary histogram already in the current pad
3103 if (TestBit(kCanDelete)) gPad->Remove(this);
3104 gPad->Clear();
3105 }
3106 gPad->IncrementPaletteColor(1, opt1);
3107 } else {
3108 if (index>=0) opt2.Remove(index,4);
3109 }
3110
3111 AppendPad(opt2.Data());
3112}
3113
3114////////////////////////////////////////////////////////////////////////////////
3115/// Copy this histogram and Draw in the current pad.
3116///
3117/// Once the histogram is drawn into the pad, the original and its drawn copy can be modified or deleted without
3118/// affecting each other. The copied histogram will be owned by the pad, and is deleted when the pad is cleared.
3119///
3120/// DrawCopy() is useful if the original histogram is a temporary, e.g. from code such as
3121/// ~~~ {.cpp}
3122/// void someFunction(...) {
3123/// TH1D histogram(...);
3124/// histogram.DrawCopy();
3125///
3126/// // or equivalently
3127/// std::unique_ptr<TH1F> histogram(...);
3128/// histogram->DrawCopy();
3129/// }
3130/// ~~~
3131/// If Draw() has been used, the histograms would disappear from the canvas at the end of this function.
3132///
3133/// By default a postfix "_copy" is added to the histogram name. Pass an empty postfix in case
3134/// you want to draw a histogram with the same name.
3135///
3136/// See Draw() for the list of options.
3137///
3138/// In contrast to TObject::DrawClone(), DrawCopy
3139/// - Ignores `gROOT->SetSelectedPad()`.
3140/// - Does not register the histogram to any directory.
3141/// - And can cycle through a colour palette when multiple objects are drawn with auto colouring.
3142
3143TH1 *TH1::DrawCopy(Option_t *option, const char * name_postfix) const
3144{
3145 TString opt = option;
3146 opt.ToLower();
3147 if (gPad && !opt.Contains("same")) gPad->Clear();
3149 if (name_postfix) newName.Form("%s%s", GetName(), name_postfix);
3150 TH1 *newth1 = (TH1 *)Clone(newName.Data());
3151 newth1->SetDirectory(nullptr);
3152 newth1->SetBit(kCanDelete);
3153 if (gPad) gPad->IncrementPaletteColor(1, opt);
3154
3155 newth1->AppendPad(option);
3156 return newth1;
3157}
3158
3159////////////////////////////////////////////////////////////////////////////////
3160/// Draw a normalized copy of this histogram.
3161///
3162/// A clone of this histogram is normalized to norm and drawn with option.
3163/// A pointer to the normalized histogram is returned.
3164/// The contents of the histogram copy are scaled such that the new
3165/// sum of weights (excluding under and overflow) is equal to norm.
3166/// Note that the returned normalized histogram is not added to the list
3167/// of histograms in the current directory in memory.
3168/// It is the user's responsibility to delete this histogram.
3169/// The kCanDelete bit is set for the returned object. If a pad containing
3170/// this copy is cleared, the histogram will be automatically deleted.
3171///
3172/// See Draw for the list of options
3173
3175{
3177 if (sum == 0) {
3178 Error("DrawNormalized","Sum of weights is null. Cannot normalize histogram: %s",GetName());
3179 return nullptr;
3180 }
3183 TH1 *h = (TH1*)Clone();
3185 // in case of drawing with error options - scale correctly the error
3186 TString opt(option); opt.ToUpper();
3187 if (fSumw2.fN == 0) {
3188 h->Sumw2();
3189 // do not use in this case the "Error option " for drawing which is enabled by default since the normalized histogram has now errors
3190 if (opt.IsNull() || opt == "SAME") opt += "HIST";
3191 }
3192 h->Scale(norm/sum);
3193 if (TMath::Abs(fMaximum+1111) > 1e-3) h->SetMaximum(fMaximum*norm/sum);
3194 if (TMath::Abs(fMinimum+1111) > 1e-3) h->SetMinimum(fMinimum*norm/sum);
3195 h->Draw(opt);
3197 return h;
3198}
3199
3200////////////////////////////////////////////////////////////////////////////////
3201/// Display a panel with all histogram drawing options.
3202///
3203/// See class TDrawPanelHist for example
3204
3205void TH1::DrawPanel()
3206{
3207 if (!fPainter) {Draw(); if (gPad) gPad->Update();}
3208 if (fPainter) fPainter->DrawPanel();
3209}
3210
3211////////////////////////////////////////////////////////////////////////////////
3212/// Evaluate function f1 at the center of bins of this histogram.
3213///
3214/// - If option "R" is specified, the function is evaluated only
3215/// for the bins included in the function range.
3216/// - If option "A" is specified, the value of the function is added to the
3217/// existing bin contents
3218/// - If option "S" is specified, the value of the function is used to
3219/// generate a value, distributed according to the Poisson
3220/// distribution, with f1 as the mean.
3221
3223{
3224 Double_t x[3];
3225 Int_t range, stat, add;
3226 if (!f1) return;
3227
3228 TString opt = option;
3229 opt.ToLower();
3230 if (opt.Contains("a")) add = 1;
3231 else add = 0;
3232 if (opt.Contains("s")) stat = 1;
3233 else stat = 0;
3234 if (opt.Contains("r")) range = 1;
3235 else range = 0;
3236
3237 // delete buffer if it is there since it will become invalid
3238 if (fBuffer) BufferEmpty(1);
3239
3243 if (!add) Reset();
3244
3245 for (Int_t binz = 1; binz <= nbinsz; ++binz) {
3246 x[2] = fZaxis.GetBinCenter(binz);
3247 for (Int_t biny = 1; biny <= nbinsy; ++biny) {
3248 x[1] = fYaxis.GetBinCenter(biny);
3249 for (Int_t binx = 1; binx <= nbinsx; ++binx) {
3250 Int_t bin = GetBin(binx,biny,binz);
3251 x[0] = fXaxis.GetBinCenter(binx);
3252 if (range && !f1->IsInside(x)) continue;
3253 Double_t fu = f1->Eval(x[0], x[1], x[2]);
3254 if (stat) fu = gRandom->PoissonD(fu);
3255 AddBinContent(bin, fu);
3256 if (fSumw2.fN) fSumw2.fArray[bin] += TMath::Abs(fu);
3257 }
3258 }
3259 }
3260}
3261
3262////////////////////////////////////////////////////////////////////////////////
3263/// Execute action corresponding to one event.
3264///
3265/// This member function is called when a histogram is clicked with the locator
3266///
3267/// If Left button clicked on the bin top value, then the content of this bin
3268/// is modified according to the new position of the mouse when it is released.
3269
3270void TH1::ExecuteEvent(Int_t event, Int_t px, Int_t py)
3271{
3272 if (fPainter) fPainter->ExecuteEvent(event, px, py);
3273}
3274
3275////////////////////////////////////////////////////////////////////////////////
3276/// This function allows to do discrete Fourier transforms of TH1 and TH2.
3277/// Available transform types and flags are described below.
3278///
3279/// To extract more information about the transform, use the function
3280/// TVirtualFFT::GetCurrentTransform() to get a pointer to the current
3281/// transform object.
3282///
3283/// \param[out] h_output histogram for the output. If a null pointer is passed, a new histogram is created
3284/// and returned, otherwise, the provided histogram is used and should be big enough
3285/// \param[in] option option parameters consists of 3 parts:
3286/// - option on what to return
3287/// - "RE" - returns a histogram of the real part of the output
3288/// - "IM" - returns a histogram of the imaginary part of the output
3289/// - "MAG"- returns a histogram of the magnitude of the output
3290/// - "PH" - returns a histogram of the phase of the output
3291/// - option of transform type
3292/// - "R2C" - real to complex transforms - default
3293/// - "R2HC" - real to halfcomplex (special format of storing output data,
3294/// results the same as for R2C)
3295/// - "DHT" - discrete Hartley transform
3296/// real to real transforms (sine and cosine):
3297/// - "R2R_0", "R2R_1", "R2R_2", "R2R_3" - discrete cosine transforms of types I-IV
3298/// - "R2R_4", "R2R_5", "R2R_6", "R2R_7" - discrete sine transforms of types I-IV
3299/// To specify the type of each dimension of a 2-dimensional real to real
3300/// transform, use options of form "R2R_XX", for example, "R2R_02" for a transform,
3301/// which is of type "R2R_0" in 1st dimension and "R2R_2" in the 2nd.
3302/// - option of transform flag
3303/// - "ES" (from "estimate") - no time in preparing the transform, but probably sub-optimal
3304/// performance
3305/// - "M" (from "measure") - some time spend in finding the optimal way to do the transform
3306/// - "P" (from "patient") - more time spend in finding the optimal way to do the transform
3307/// - "EX" (from "exhaustive") - the most optimal way is found
3308/// This option should be chosen depending on how many transforms of the same size and
3309/// type are going to be done. Planning is only done once, for the first transform of this
3310/// size and type. Default is "ES".
3311///
3312/// Examples of valid options: "Mag R2C M" "Re R2R_11" "Im R2C ES" "PH R2HC EX"
3313
3315{
3316
3317 Int_t ndim[3];
3318 ndim[0] = this->GetNbinsX();
3319 ndim[1] = this->GetNbinsY();
3320 ndim[2] = this->GetNbinsZ();
3321
3323 TString opt = option;
3324 opt.ToUpper();
3325 if (!opt.Contains("2R")){
3326 if (!opt.Contains("2C") && !opt.Contains("2HC") && !opt.Contains("DHT")) {
3327 //no type specified, "R2C" by default
3328 opt.Append("R2C");
3329 }
3330 fft = TVirtualFFT::FFT(this->GetDimension(), ndim, opt.Data());
3331 }
3332 else {
3333 //find the kind of transform
3334 Int_t ind = opt.Index("R2R", 3);
3335 Int_t *kind = new Int_t[2];
3336 char t;
3337 t = opt[ind+4];
3338 kind[0] = atoi(&t);
3339 if (h_output->GetDimension()>1) {
3340 t = opt[ind+5];
3341 kind[1] = atoi(&t);
3342 }
3343 fft = TVirtualFFT::SineCosine(this->GetDimension(), ndim, kind, option);
3344 delete [] kind;
3345 }
3346
3347 if (!fft) return nullptr;
3348 Int_t in=0;
3349 for (Int_t binx = 1; binx<=ndim[0]; binx++) {
3350 for (Int_t biny=1; biny<=ndim[1]; biny++) {
3351 for (Int_t binz=1; binz<=ndim[2]; binz++) {
3352 fft->SetPoint(in, this->GetBinContent(binx, biny, binz));
3353 in++;
3354 }
3355 }
3356 }
3357 fft->Transform();
3359 return h_output;
3360}
3361
3362////////////////////////////////////////////////////////////////////////////////
3363/// Increment bin with abscissa X by 1.
3364///
3365/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3366/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3367///
3368/// If the storage of the sum of squares of weights has been triggered,
3369/// via the function Sumw2, then the sum of the squares of weights is incremented
3370/// by 1 in the bin corresponding to x.
3371///
3372/// The function returns the corresponding bin number which has its content incremented by 1
3373
3375{
3376 if (fBuffer) return BufferFill(x,1);
3377
3378 Int_t bin;
3379 fEntries++;
3380 bin =fXaxis.FindBin(x);
3381 if (bin <0) return -1;
3382 AddBinContent(bin);
3383 if (fSumw2.fN) ++fSumw2.fArray[bin];
3384 if (bin == 0 || bin > fXaxis.GetNbins()) {
3385 if (!GetStatOverflowsBehaviour()) return -1;
3386 }
3387 ++fTsumw;
3388 ++fTsumw2;
3389 fTsumwx += x;
3390 fTsumwx2 += x*x;
3391 return bin;
3392}
3393
3394////////////////////////////////////////////////////////////////////////////////
3395/// Increment bin with abscissa X with a weight w.
3396///
3397/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3398/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3399///
3400/// If the weight is not equal to 1, the storage of the sum of squares of
3401/// weights is automatically triggered and the sum of the squares of weights is incremented
3402/// by \f$ w^2 \f$ in the bin corresponding to x.
3403///
3404/// The function returns the corresponding bin number which has its content incremented by w
3405
3407{
3408
3409 if (fBuffer) return BufferFill(x,w);
3410
3411 Int_t bin;
3412 fEntries++;
3413 bin =fXaxis.FindBin(x);
3414 if (bin <0) return -1;
3415 if (!fSumw2.fN && w != 1.0 && !TestBit(TH1::kIsNotW) ) Sumw2(); // must be called before AddBinContent
3416 if (fSumw2.fN) fSumw2.fArray[bin] += w*w;
3417 AddBinContent(bin, w);
3418 if (bin == 0 || bin > fXaxis.GetNbins()) {
3419 if (!GetStatOverflowsBehaviour()) return -1;
3420 }
3421 Double_t z= w;
3422 fTsumw += z;
3423 fTsumw2 += z*z;
3424 fTsumwx += z*x;
3425 fTsumwx2 += z*x*x;
3426 return bin;
3427}
3428
3429////////////////////////////////////////////////////////////////////////////////
3430/// Increment bin with namex with a weight w
3431///
3432/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3433/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3434///
3435/// If the weight is not equal to 1, the storage of the sum of squares of
3436/// weights is automatically triggered and the sum of the squares of weights is incremented
3437/// by \f$ w^2 \f$ in the bin corresponding to x.
3438///
3439/// The function returns the corresponding bin number which has its content
3440/// incremented by w.
3441
3442Int_t TH1::Fill(const char *namex, Double_t w)
3443{
3444 Int_t bin;
3445 fEntries++;
3446 bin =fXaxis.FindBin(namex);
3447 if (bin <0) return -1;
3448 if (!fSumw2.fN && w != 1.0 && !TestBit(TH1::kIsNotW)) Sumw2();
3449 if (fSumw2.fN) fSumw2.fArray[bin] += w*w;
3450 AddBinContent(bin, w);
3451 if (bin == 0 || bin > fXaxis.GetNbins()) return -1;
3452 Double_t z= w;
3453 fTsumw += z;
3454 fTsumw2 += z*z;
3455 // this make sense if the histogram is not expanding (the x axis cannot be extended)
3456 if (!fXaxis.CanExtend() || !fXaxis.IsAlphanumeric()) {
3458 fTsumwx += z*x;
3459 fTsumwx2 += z*x*x;
3460 }
3461 return bin;
3462}
3463
3464////////////////////////////////////////////////////////////////////////////////
3465/// Fill this histogram with an array x and weights w.
3466///
3467/// \param[in] ntimes number of entries in arrays x and w (array size must be ntimes*stride)
3468/// \param[in] x array of values to be histogrammed
3469/// \param[in] w array of weighs
3470/// \param[in] stride step size through arrays x and w
3471///
3472/// If the weight is not equal to 1, the storage of the sum of squares of
3473/// weights is automatically triggered and the sum of the squares of weights is incremented
3474/// by \f$ w^2 \f$ in the bin corresponding to x.
3475/// if w is NULL each entry is assumed a weight=1
3476
3477void TH1::FillN(Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride)
3478{
3479 //If a buffer is activated, fill buffer
3480 if (fBuffer) {
3481 ntimes *= stride;
3482 Int_t i = 0;
3483 for (i=0;i<ntimes;i+=stride) {
3484 if (!fBuffer) break; // buffer can be deleted in BufferFill when is empty
3485 if (w) BufferFill(x[i],w[i]);
3486 else BufferFill(x[i], 1.);
3487 }
3488 // fill the remaining entries if the buffer has been deleted
3489 if (i < ntimes && !fBuffer) {
3490 auto weights = w ? &w[i] : nullptr;
3491 DoFillN((ntimes-i)/stride,&x[i],weights,stride);
3492 }
3493 return;
3494 }
3495 // call internal method
3496 DoFillN(ntimes, x, w, stride);
3497}
3498
3499////////////////////////////////////////////////////////////////////////////////
3500/// Internal method to fill histogram content from a vector
3501/// called directly by TH1::BufferEmpty
3502
3503void TH1::DoFillN(Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride)
3504{
3505 Int_t bin,i;
3506
3507 fEntries += ntimes;
3508 Double_t ww = 1;
3509 Int_t nbins = fXaxis.GetNbins();
3510 ntimes *= stride;
3511 for (i=0;i<ntimes;i+=stride) {
3512 bin =fXaxis.FindBin(x[i]);
3513 if (bin <0) continue;
3514 if (w) ww = w[i];
3515 if (!fSumw2.fN && ww != 1.0 && !TestBit(TH1::kIsNotW)) Sumw2();
3516 if (fSumw2.fN) fSumw2.fArray[bin] += ww*ww;
3517 AddBinContent(bin, ww);
3518 if (bin == 0 || bin > nbins) {
3519 if (!GetStatOverflowsBehaviour()) continue;
3520 }
3521 Double_t z= ww;
3522 fTsumw += z;
3523 fTsumw2 += z*z;
3524 fTsumwx += z*x[i];
3525 fTsumwx2 += z*x[i]*x[i];
3526 }
3527}
3528
3529////////////////////////////////////////////////////////////////////////////////
3530/// Fill histogram following distribution in function fname.
3531///
3532/// @param fname : Function name used for filling the histogram
3533/// @param ntimes : number of times the histogram is filled
3534/// @param rng : (optional) Random number generator used to sample
3535///
3536///
3537/// The distribution contained in the function fname (TF1) is integrated
3538/// over the channel contents for the bin range of this histogram.
3539/// It is normalized to 1.
3540///
3541/// Getting one random number implies:
3542/// - Generating a random number between 0 and 1 (say r1)
3543/// - Look in which bin in the normalized integral r1 corresponds to
3544/// - Fill histogram channel
3545/// ntimes random numbers are generated
3546///
3547/// One can also call TF1::GetRandom to get a random variate from a function.
3548
3549void TH1::FillRandom(const char *fname, Int_t ntimes, TRandom * rng)
3550{
3551 // - Search for fname in the list of ROOT defined functions
3552 TF1 *f1 = (TF1*)gROOT->GetFunction(fname);
3553 if (!f1) { Error("FillRandom", "Unknown function: %s",fname); return; }
3554
3557
3559{
3560 Int_t bin, binx, ibin, loop;
3561 Double_t r1, x;
3562
3563 // - Allocate temporary space to store the integral and compute integral
3564
3565 TAxis * xAxis = &fXaxis;
3566
3567 // in case axis of histogram is not defined use the function axis
3568 if (fXaxis.GetXmax() <= fXaxis.GetXmin()) {
3570 f1->GetRange(xmin,xmax);
3571 Info("FillRandom","Using function axis and range [%g,%g]",xmin, xmax);
3572 xAxis = f1->GetHistogram()->GetXaxis();
3573 }
3574
3575 Int_t first = xAxis->GetFirst();
3576 Int_t last = xAxis->GetLast();
3577 Int_t nbinsx = last-first+1;
3578
3579 Double_t *integral = new Double_t[nbinsx+1];
3580 integral[0] = 0;
3581 for (binx=1;binx<=nbinsx;binx++) {
3582 Double_t fint = f1->Integral(xAxis->GetBinLowEdge(binx+first-1),xAxis->GetBinUpEdge(binx+first-1), 0.);
3583 integral[binx] = integral[binx-1] + fint;
3584 }
3585
3586 // - Normalize integral to 1
3587 if (integral[nbinsx] == 0 ) {
3588 delete [] integral;
3589 Error("FillRandom", "Integral = zero"); return;
3590 }
3591 for (bin=1;bin<=nbinsx;bin++) integral[bin] /= integral[nbinsx];
3592
3593 // --------------Start main loop ntimes
3594 for (loop=0;loop<ntimes;loop++) {
3595 r1 = (rng) ? rng->Rndm() : gRandom->Rndm();
3596 ibin = TMath::BinarySearch(nbinsx,&integral[0],r1);
3597 //binx = 1 + ibin;
3598 //x = xAxis->GetBinCenter(binx); //this is not OK when SetBuffer is used
3599 x = xAxis->GetBinLowEdge(ibin+first)
3600 +xAxis->GetBinWidth(ibin+first)*(r1-integral[ibin])/(integral[ibin+1] - integral[ibin]);
3601 Fill(x);
3602 }
3603 delete [] integral;
3604}
3605
3606////////////////////////////////////////////////////////////////////////////////
3607/// Fill histogram following distribution in histogram h.
3608///
3609/// @param h : Histogram pointer used for sampling random number
3610/// @param ntimes : number of times the histogram is filled
3611/// @param rng : (optional) Random number generator used for sampling
3612///
3613/// The distribution contained in the histogram h (TH1) is integrated
3614/// over the channel contents for the bin range of this histogram.
3615/// It is normalized to 1.
3616///
3617/// Getting one random number implies:
3618/// - Generating a random number between 0 and 1 (say r1)
3619/// - Look in which bin in the normalized integral r1 corresponds to
3620/// - Fill histogram channel ntimes random numbers are generated
3621///
3622/// SPECIAL CASE when the target histogram has the same binning as the source.
3623/// in this case we simply use a poisson distribution where
3624/// the mean value per bin = bincontent/integral.
3625
3627{
3628 if (!h) { Error("FillRandom", "Null histogram"); return; }
3629 if (fDimension != h->GetDimension()) {
3630 Error("FillRandom", "Histograms with different dimensions"); return;
3631 }
3632 if (std::isnan(h->ComputeIntegral(true))) {
3633 Error("FillRandom", "Histograms contains negative bins, does not represent probabilities");
3634 return;
3635 }
3636
3637 //in case the target histogram has the same binning and ntimes much greater
3638 //than the number of bins we can use a fast method
3639 Int_t first = fXaxis.GetFirst();
3640 Int_t last = fXaxis.GetLast();
3641 Int_t nbins = last-first+1;
3642 if (ntimes > 10*nbins) {
3643 auto inconsistency = CheckConsistency(this,h);
3644 if (inconsistency != kFullyConsistent) return; // do nothing
3645 Double_t sumw = h->Integral(first,last);
3646 if (sumw == 0) return;
3647 Double_t sumgen = 0;
3648 for (Int_t bin=first;bin<=last;bin++) {
3649 Double_t mean = h->RetrieveBinContent(bin)*ntimes/sumw;
3650 Double_t cont = (rng) ? rng->Poisson(mean) : gRandom->Poisson(mean);
3651 sumgen += cont;
3652 AddBinContent(bin,cont);
3653 if (fSumw2.fN) fSumw2.fArray[bin] += cont;
3654 }
3655
3656 // fix for the fluctuations in the total number n
3657 // since we use Poisson instead of multinomial
3658 // add a correction to have ntimes as generated entries
3659 Int_t i;
3660 if (sumgen < ntimes) {
3661 // add missing entries
3662 for (i = Int_t(sumgen+0.5); i < ntimes; ++i)
3663 {
3664 Double_t x = h->GetRandom();
3665 Fill(x);
3666 }
3667 }
3668 else if (sumgen > ntimes) {
3669 // remove extra entries
3670 i = Int_t(sumgen+0.5);
3671 while( i > ntimes) {
3672 Double_t x = h->GetRandom(rng);
3675 // skip in case bin is empty
3676 if (y > 0) {
3677 SetBinContent(ibin, y-1.);
3678 i--;
3679 }
3680 }
3681 }
3682
3683 ResetStats();
3684 return;
3685 }
3686 // case of different axis and not too large ntimes
3687
3688 if (h->ComputeIntegral() ==0) return;
3689 Int_t loop;
3690 Double_t x;
3691 for (loop=0;loop<ntimes;loop++) {
3692 x = h->GetRandom();
3693 Fill(x);
3694 }
3695}
3696
3697////////////////////////////////////////////////////////////////////////////////
3698/// Return Global bin number corresponding to x,y,z
3699///
3700/// 2-D and 3-D histograms are represented with a one dimensional
3701/// structure. This has the advantage that all existing functions, such as
3702/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
3703/// This function tries to extend the axis if the given point belongs to an
3704/// under-/overflow bin AND if CanExtendAllAxes() is true.
3705///
3706/// See also TH1::GetBin, TAxis::FindBin and TAxis::FindFixBin
3707
3709{
3710 if (GetDimension() < 2) {
3711 return fXaxis.FindBin(x);
3712 }
3713 if (GetDimension() < 3) {
3714 Int_t nx = fXaxis.GetNbins()+2;
3717 return binx + nx*biny;
3718 }
3719 if (GetDimension() < 4) {
3720 Int_t nx = fXaxis.GetNbins()+2;
3721 Int_t ny = fYaxis.GetNbins()+2;
3724 Int_t binz = fZaxis.FindBin(z);
3725 return binx + nx*(biny +ny*binz);
3726 }
3727 return -1;
3728}
3729
3730////////////////////////////////////////////////////////////////////////////////
3731/// Return Global bin number corresponding to x,y,z.
3732///
3733/// 2-D and 3-D histograms are represented with a one dimensional
3734/// structure. This has the advantage that all existing functions, such as
3735/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
3736/// This function DOES NOT try to extend the axis if the given point belongs
3737/// to an under-/overflow bin.
3738///
3739/// See also TH1::GetBin, TAxis::FindBin and TAxis::FindFixBin
3740
3742{
3743 if (GetDimension() < 2) {
3744 return fXaxis.FindFixBin(x);
3745 }
3746 if (GetDimension() < 3) {
3747 Int_t nx = fXaxis.GetNbins()+2;
3750 return binx + nx*biny;
3751 }
3752 if (GetDimension() < 4) {
3753 Int_t nx = fXaxis.GetNbins()+2;
3754 Int_t ny = fYaxis.GetNbins()+2;
3758 return binx + nx*(biny +ny*binz);
3759 }
3760 return -1;
3761}
3762
3763////////////////////////////////////////////////////////////////////////////////
3764/// Find first bin with content > threshold for axis (1=x, 2=y, 3=z)
3765/// if no bins with content > threshold is found the function returns -1.
3766/// The search will occur between the specified first and last bin. Specifying
3767/// the value of the last bin to search to less than zero will search until the
3768/// last defined bin.
3769
3771{
3772 if (fBuffer) ((TH1*)this)->BufferEmpty();
3773
3774 if (axis < 1 || (axis > 1 && GetDimension() == 1 ) ||
3775 ( axis > 2 && GetDimension() == 2 ) || ( axis > 3 && GetDimension() > 3 ) ) {
3776 Warning("FindFirstBinAbove","Invalid axis number : %d, axis x assumed\n",axis);
3777 axis = 1;
3778 }
3779 if (firstBin < 1) {
3780 firstBin = 1;
3781 }
3783 Int_t nbinsy = (GetDimension() > 1 ) ? fYaxis.GetNbins() : 1;
3784 Int_t nbinsz = (GetDimension() > 2 ) ? fZaxis.GetNbins() : 1;
3785
3786 if (axis == 1) {
3789 }
3790 for (Int_t binx = firstBin; binx <= lastBin; binx++) {
3791 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3792 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3794 }
3795 }
3796 }
3797 }
3798 else if (axis == 2) {
3801 }
3802 for (Int_t biny = firstBin; biny <= lastBin; biny++) {
3803 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3804 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3806 }
3807 }
3808 }
3809 }
3810 else if (axis == 3) {
3813 }
3814 for (Int_t binz = firstBin; binz <= lastBin; binz++) {
3815 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3816 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3818 }
3819 }
3820 }
3821 }
3822
3823 return -1;
3824}
3825
3826////////////////////////////////////////////////////////////////////////////////
3827/// Find last bin with content > threshold for axis (1=x, 2=y, 3=z)
3828/// if no bins with content > threshold is found the function returns -1.
3829/// The search will occur between the specified first and last bin. Specifying
3830/// the value of the last bin to search to less than zero will search until the
3831/// last defined bin.
3832
3834{
3835 if (fBuffer) ((TH1*)this)->BufferEmpty();
3836
3837
3838 if (axis < 1 || ( axis > 1 && GetDimension() == 1 ) ||
3839 ( axis > 2 && GetDimension() == 2 ) || ( axis > 3 && GetDimension() > 3) ) {
3840 Warning("FindFirstBinAbove","Invalid axis number : %d, axis x assumed\n",axis);
3841 axis = 1;
3842 }
3843 if (firstBin < 1) {
3844 firstBin = 1;
3845 }
3847 Int_t nbinsy = (GetDimension() > 1 ) ? fYaxis.GetNbins() : 1;
3848 Int_t nbinsz = (GetDimension() > 2 ) ? fZaxis.GetNbins() : 1;
3849
3850 if (axis == 1) {
3853 }
3854 for (Int_t binx = lastBin; binx >= firstBin; binx--) {
3855 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3856 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3858 }
3859 }
3860 }
3861 }
3862 else if (axis == 2) {
3865 }
3866 for (Int_t biny = lastBin; biny >= firstBin; biny--) {
3867 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3868 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3870 }
3871 }
3872 }
3873 }
3874 else if (axis == 3) {
3877 }
3878 for (Int_t binz = lastBin; binz >= firstBin; binz--) {
3879 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3880 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3882 }
3883 }
3884 }
3885 }
3886
3887 return -1;
3888}
3889
3890////////////////////////////////////////////////////////////////////////////////
3891/// Search object named name in the list of functions.
3892
3893TObject *TH1::FindObject(const char *name) const
3894{
3895 if (fFunctions) return fFunctions->FindObject(name);
3896 return nullptr;
3897}
3898
3899////////////////////////////////////////////////////////////////////////////////
3900/// Search object obj in the list of functions.
3901
3902TObject *TH1::FindObject(const TObject *obj) const
3903{
3904 if (fFunctions) return fFunctions->FindObject(obj);
3905 return nullptr;
3906}
3907
3908////////////////////////////////////////////////////////////////////////////////
3909/// Fit histogram with function fname.
3910///
3911///
3912/// fname is the name of a function available in the global ROOT list of functions
3913/// `gROOT->GetListOfFunctions`. Note that this is not thread safe.
3914/// The list include any TF1 object created by the user plus some pre-defined functions
3915/// which are automatically created by ROOT the first time a pre-defined function is requested from `gROOT`
3916/// (i.e. when calling `gROOT->GetFunction(const char *name)`).
3917/// These pre-defined functions are:
3918/// - `gaus, gausn` where gausn is the normalized Gaussian
3919/// - `landau, landaun`
3920/// - `expo`
3921/// - `pol1,...9, chebyshev1,...9`.
3922///
3923/// For printing the list of all available functions do:
3924///
3925/// TF1::InitStandardFunctions(); // not needed if `gROOT->GetFunction` is called before
3926/// TF2::InitStandardFunctions(); TF3::InitStandardFunctions(); // For 2D or 3D
3927/// gROOT->GetListOfFunctions()->ls()
3928///
3929/// `fname` can also be a formula that is accepted by the linear fitter containing the special operator `++`,
3930/// representing linear components separated by `++` sign, for example `x++sin(x)` for fitting `[0]*x+[1]*sin(x)`
3931///
3932/// This function finds a pointer to the TF1 object with name `fname` and calls TH1::Fit(TF1 *, Option_t *, Option_t *,
3933/// Double_t, Double_t). See there for the fitting options and the details about fitting histograms
3934
3936{
3937 char *linear;
3938 linear= (char*)strstr(fname, "++");
3939 Int_t ndim=GetDimension();
3940 if (linear){
3941 if (ndim<2){
3943 return Fit(&f1,option,goption,xxmin,xxmax);
3944 }
3945 else if (ndim<3){
3946 TF2 f2(fname, fname);
3947 return Fit(&f2,option,goption,xxmin,xxmax);
3948 }
3949 else{
3950 TF3 f3(fname, fname);
3951 return Fit(&f3,option,goption,xxmin,xxmax);
3952 }
3953 }
3954 else{
3955 TF1 * f1 = (TF1*)gROOT->GetFunction(fname);
3956 if (!f1) { Printf("Unknown function: %s",fname); return -1; }
3957 return Fit(f1,option,goption,xxmin,xxmax);
3958 }
3959}
3960
3961////////////////////////////////////////////////////////////////////////////////
3962/// Fit histogram with the function pointer f1.
3963///
3964/// \param[in] f1 pointer to the function object
3965/// \param[in] option string defining the fit options (see table below).
3966/// \param[in] goption specify a list of graphics options. See TH1::Draw for a complete list of these options.
3967/// \param[in] xxmin lower fitting range
3968/// \param[in] xxmax upper fitting range
3969/// \return A smart pointer to the TFitResult class
3970///
3971/// \anchor HFitOpt
3972/// ### Histogram Fitting Options
3973///
3974/// Here is the full list of fit options that can be given in the parameter `option`.
3975/// Several options can be used together by concatanating the strings without the need of any delimiters.
3976///
3977/// option | description
3978/// -------|------------
3979/// "L" | Uses a log likelihood method (default is chi-square method). To be used when the histogram represents counts.
3980/// "WL" | Weighted log likelihood method. To be used when the histogram has been filled with weights different than 1. This is needed for getting correct parameter uncertainties for weighted fits.
3981/// "P" | Uses Pearson chi-square method. Uses expected errors instead of the observed one (default case). The expected error is instead estimated from the square-root of the bin function value.
3982/// "MULTI" | Uses Loglikelihood method based on multi-nomial distribution. In this case the function must be normalized and one fits only the function shape.
3983/// "W" | Fit using the chi-square method and ignoring the bin uncertainties and skip empty bins.
3984/// "WW" | Fit using the chi-square method and ignoring the bin uncertainties and include the empty bins.
3985/// "I" | Uses the integral of function in the bin instead of the default bin center value.
3986/// "F" | Uses the default minimizer (e.g. Minuit) when fitting a linear function (e.g. polN) instead of the linear fitter.
3987/// "U" | Uses a user specified objective function (e.g. user providedlikelihood function) defined using `TVirtualFitter::SetFCN`
3988/// "E" | Performs a better parameter errors estimation using the Minos technique for all fit parameters.
3989/// "M" | Uses the IMPROVE algorithm (available only in TMinuit). This algorithm attempts improve the found local minimum by searching for a better one.
3990/// "S" | The full result of the fit is returned in the `TFitResultPtr`. This is needed to get the covariance matrix of the fit. See `TFitResult` and the base class `ROOT::Math::FitResult`.
3991/// "Q" | Quiet mode (minimum printing)
3992/// "V" | Verbose mode (default is between Q and V)
3993/// "+" | Adds this new fitted function to the list of fitted functions. By default, the previous function is deleted and only the last one is kept.
3994/// "N" | Does not store the graphics function, does not draw the histogram with the function after fitting.
3995/// "0" | Does not draw the histogram and the fitted function after fitting, but in contrast to option "N", it stores the fitted function in the histogram list of functions.
3996/// "R" | Fit using a fitting range specified in the function range with `TF1::SetRange`.
3997/// "B" | Use this option when you want to fix or set limits on one or more parameters and the fitting function is a predefined one (e.g gaus, expo,..), otherwise in case of pre-defined functions, some default initial values and limits will be used.
3998/// "C" | In case of linear fitting, do no calculate the chisquare (saves CPU time).
3999/// "G" | Uses the gradient implemented in `TF1::GradientPar` for the minimization. This allows to use Automatic Differentiation when it is supported by the provided TF1 function.
4000/// "WIDTH" | Scales the histogran bin content by the bin width (useful for variable bins histograms)
4001/// "SERIAL" | Runs in serial mode. By default if ROOT is built with MT support and MT is enables, the fit is perfomed in multi-thread - "E" Perform better Errors estimation using Minos technique
4002/// "MULTITHREAD" | Forces usage of multi-thread execution whenever possible
4003///
4004/// The default fitting of an histogram (when no option is given) is perfomed as following:
4005/// - a chi-square fit (see below Chi-square Fits) computed using the bin histogram errors and excluding bins with zero errors (empty bins);
4006/// - the full range of the histogram is used, unless TAxis::SetRange or TAxis::SetRangeUser was called before;
4007/// - the default Minimizer with its default configuration is used (see below Minimizer Configuration) except for linear function;
4008/// - for linear functions (`polN`, `chenbyshev` or formula expressions combined using operator `++`) a linear minimization is used.
4009/// - only the status of the fit is returned;
4010/// - the fit is performed in Multithread whenever is enabled in ROOT;
4011/// - only the last fitted function is saved in the histogram;
4012/// - the histogram is drawn after fitting overalyed with the resulting fitting function
4013///
4014/// \anchor HFitMinimizer
4015/// ### Minimizer Configuration
4016///
4017/// The Fit is perfomed using the default Minimizer, defined in the `ROOT::Math::MinimizerOptions` class.
4018/// It is possible to change the default minimizer and its configuration parameters by calling these static functions before fitting (before calling `TH1::Fit`):
4019/// - `ROOT::Math::MinimizerOptions::SetDefaultMinimizer(minimizerName, minimizerAgorithm)` for changing the minmizer and/or the corresponding algorithm.
4020/// For example `ROOT::Math::MinimizerOptions::SetDefaultMinimizer("GSLMultiMin","BFGS");` will set the usage of the BFGS algorithm of the GSL multi-dimensional minimization
4021/// The current defaults are ("Minuit","Migrad").
4022/// See the documentation of the `ROOT::Math::MinimizerOptions` for the available minimizers in ROOT and their corresponding algorithms.
4023/// - `ROOT::Math::MinimizerOptions::SetDefaultTolerance` for setting a different tolerance value for the minimization.
4024/// - `ROOT::Math::MinimizerOptions::SetDefaultMaxFunctionCalls` for setting the maximum number of function calls.
4025/// - `ROOT::Math::MinimizerOptions::SetDefaultPrintLevel` for changing the minimizer print level from level=0 (minimal printing) to level=3 maximum printing
4026///
4027/// Other options are possible depending on the Minimizer used, see the corresponding documentation.
4028/// The default minimizer can be also set in the resource file in etc/system.rootrc. For example
4029///
4030/// ~~~ {.cpp}
4031/// Root.Fitter: Minuit2
4032/// ~~~
4033///
4034/// \anchor HFitChi2
4035/// ### Chi-square Fits
4036///
4037/// By default a chi-square (least-square) fit is performed on the histogram. The so-called modified least-square method
4038/// is used where the residual for each bin is computed using as error the observed value (the bin error) returned by `TH1::GetBinError`
4039///
4040/// \f[
4041/// Chi2 = \sum_{i}{ \left(\frac{y(i) - f(x(i) | p )}{e(i)} \right)^2 }
4042/// \f]
4043///
4044/// where `y(i)` is the bin content for each bin `i`, `x(i)` is the bin center and `e(i)` is the bin error (`sqrt(y(i)` for
4045/// an un-weighted histogram). Bins with zero errors are excluded from the fit. See also later the note on the treatment
4046/// of empty bins. When using option "I" the residual is computed not using the function value at the bin center, `f(x(i)|p)`,
4047/// but the integral of the function in the bin, Integral{ f(x|p)dx }, divided by the bin volume.
4048/// When using option `P` (Pearson chi2), the expected error computed as `e(i) = sqrt(f(x(i)|p))` is used.
4049/// In this case empty bins are considered in the fit.
4050/// Both chi-square methods should not be used when the bin content represent counts, especially in case of low bin statistics,
4051/// because they could return a biased result.
4052///
4053/// \anchor HFitNLL
4054/// ### Likelihood Fits
4055///
4056/// When using option "L" a likelihood fit is used instead of the default chi-square fit.
4057/// The likelihood is built assuming a Poisson probability density function for each bin.
4058/// The negative log-likelihood to be minimized is
4059///
4060/// \f[
4061/// NLL = - \sum_{i}{ \log {\mathrm P} ( y(i) | f(x(i) | p ) ) }
4062/// \f]
4063/// where `P(y|f)` is the Poisson distribution of observing a count `y(i)` in the bin when the expected count is `f(x(i)|p)`.
4064/// The exact likelihood used is the Poisson likelihood described in this paper:
4065/// S. Baker and R. D. Cousins, “Clarification of the use of chi-square and likelihood functions in fits to histograms,”
4066/// Nucl. Instrum. Meth. 221 (1984) 437.
4067///
4068/// \f[
4069/// NLL = \sum_{i}{( f(x(i) | p ) + y(i)\log(y(i)/ f(x(i) | p )) - y(i)) }
4070/// \f]
4071/// By using this formulation, `2*NLL` can be interpreted as the chi-square resulting from the fit.
4072///
4073/// This method should be always used when the bin content represents counts (i.e. errors are sqrt(N) ).
4074/// The likelihood method has the advantage of treating correctly bins with low statistics. In case of high
4075/// statistics/bin the distribution of the bin content becomes a normal distribution and the likelihood and the chi2 fit
4076/// give the same result.
4077///
4078/// The likelihood method, although a bit slower, it is therefore the recommended method,
4079/// when the histogram represent counts (Poisson statistics), where the chi-square methods may
4080/// give incorrect results, especially in case of low statistics.
4081/// In case of a weighted histogram, it is possible to perform also a likelihood fit by using the
4082/// option "WL". Note a weighted histogram is a histogram which has been filled with weights and it
4083/// has the information on the sum of the weight square for each bin ( TH1::Sumw2() has been called).
4084/// The bin error for a weighted histogram is the square root of the sum of the weight square.
4085///
4086/// \anchor HFitRes
4087/// ### Fit Result
4088///
4089/// The function returns a TFitResultPtr which can hold a pointer to a TFitResult object.
4090/// By default the TFitResultPtr contains only the status of the fit which is return by an
4091/// automatic conversion of the TFitResultPtr to an integer. One can write in this case directly:
4092///
4093/// ~~~ {.cpp}
4094/// Int_t fitStatus = h->Fit(myFunc);
4095/// ~~~
4096///
4097/// If the option "S" is instead used, TFitResultPtr behaves as a smart
4098/// pointer to the TFitResult object. This is useful for retrieving the full result information from the fit, such as the covariance matrix,
4099/// as shown in this example code:
4100///
4101/// ~~~ {.cpp}
4102/// TFitResultPtr r = h->Fit(myFunc,"S");
4103/// TMatrixDSym cov = r->GetCovarianceMatrix(); // to access the covariance matrix
4104/// Double_t chi2 = r->Chi2(); // to retrieve the fit chi2
4105/// Double_t par0 = r->Parameter(0); // retrieve the value for the parameter 0
4106/// Double_t err0 = r->ParError(0); // retrieve the error for the parameter 0
4107/// r->Print("V"); // print full information of fit including covariance matrix
4108/// r->Write(); // store the result in a file
4109/// ~~~
4110///
4111/// The fit parameters, error and chi-square (but not covariance matrix) can be retrieved also
4112/// directly from the fitted function that is passed to this call.
4113/// Given a pointer to an associated fitted function `myfunc`, one can retrieve the function/fit
4114/// parameters with calls such as:
4115///
4116/// ~~~ {.cpp}
4117/// Double_t chi2 = myfunc->GetChisquare();
4118/// Double_t par0 = myfunc->GetParameter(0); //value of 1st parameter
4119/// Double_t err0 = myfunc->GetParError(0); //error on first parameter
4120/// ~~~
4121///
4122/// ##### Associated functions
4123///
4124/// One or more objects (typically a TF1*) can be added to the list
4125/// of functions (fFunctions) associated to each histogram.
4126/// When TH1::Fit is invoked, the fitted function is added to the histogram list of functions (fFunctions).
4127/// If the histogram is made persistent, the list of associated functions is also persistent.
4128/// Given a histogram h, one can retrieve an associated function with:
4129///
4130/// ~~~ {.cpp}
4131/// TF1 *myfunc = h->GetFunction("myfunc");
4132/// ~~~
4133/// or by quering directly the list obtained by calling `TH1::GetListOfFunctions`.
4134///
4135/// \anchor HFitStatus
4136/// ### Fit status
4137///
4138/// The status of the fit is obtained converting the TFitResultPtr to an integer
4139/// independently if the fit option "S" is used or not:
4140///
4141/// ~~~ {.cpp}
4142/// TFitResultPtr r = h->Fit(myFunc,opt);
4143/// Int_t fitStatus = r;
4144/// ~~~
4145///
4146/// - `status = 0` : the fit has been performed successfully (i.e no error occurred).
4147/// - `status < 0` : there is an error not connected with the minimization procedure, for example when a wrong function is used.
4148/// - `status > 0` : return status from Minimizer, depends on used Minimizer. For example for TMinuit and Minuit2 we have:
4149/// - `status = migradStatus + 10*minosStatus + 100*hesseStatus + 1000*improveStatus`.
4150/// TMinuit returns 0 (for migrad, minos, hesse or improve) in case of success and 4 in case of error (see the documentation of TMinuit::mnexcm). For example, for an error
4151/// only in Minos but not in Migrad a fitStatus of 40 will be returned.
4152/// Minuit2 returns 0 in case of success and different values in migrad,minos or
4153/// hesse depending on the error. See in this case the documentation of
4154/// Minuit2Minimizer::Minimize for the migrad return status, Minuit2Minimizer::GetMinosError for the
4155/// minos return status and Minuit2Minimizer::Hesse for the hesse return status.
4156/// If other minimizers are used see their specific documentation for the status code returned.
4157/// For example in the case of Fumili, see TFumili::Minimize.
4158///
4159/// \anchor HFitRange
4160/// ### Fitting in a range
4161///
4162/// In order to fit in a sub-range of the histogram you have two options:
4163/// - pass to this function the lower (`xxmin`) and upper (`xxmax`) values for the fitting range;
4164/// - define a specific range in the fitted function and use the fitting option "R".
4165/// For example, if your histogram has a defined range between -4 and 4 and you want to fit a gaussian
4166/// only in the interval 1 to 3, you can do:
4167///
4168/// ~~~ {.cpp}
4169/// TF1 *f1 = new TF1("f1", "gaus", 1, 3);
4170/// histo->Fit("f1", "R");
4171/// ~~~
4172///
4173/// The fitting range is also limited by the histogram range defined using TAxis::SetRange
4174/// or TAxis::SetRangeUser. Therefore the fitting range is the smallest range between the
4175/// histogram one and the one defined by one of the two previous options described above.
4176///
4177/// \anchor HFitInitial
4178/// ### Setting initial conditions
4179///
4180/// Parameters must be initialized before invoking the Fit function.
4181/// The setting of the parameter initial values is automatic for the
4182/// predefined functions such as poln, expo, gaus, landau. One can however disable
4183/// this automatic computation by using the option "B".
4184/// Note that if a predefined function is defined with an argument,
4185/// eg, gaus(0), expo(1), you must specify the initial values for
4186/// the parameters.
4187/// You can specify boundary limits for some or all parameters via
4188///
4189/// ~~~ {.cpp}
4190/// f1->SetParLimits(p_number, parmin, parmax);
4191/// ~~~
4192///
4193/// if `parmin >= parmax`, the parameter is fixed
4194/// Note that you are not forced to fix the limits for all parameters.
4195/// For example, if you fit a function with 6 parameters, you can do:
4196///
4197/// ~~~ {.cpp}
4198/// func->SetParameters(0, 3.1, 1.e-6, -8, 0, 100);
4199/// func->SetParLimits(3, -10, -4);
4200/// func->FixParameter(4, 0);
4201/// func->SetParLimits(5, 1, 1);
4202/// ~~~
4203///
4204/// With this setup, parameters 0->2 can vary freely
4205/// Parameter 3 has boundaries [-10,-4] with initial value -8
4206/// Parameter 4 is fixed to 0
4207/// Parameter 5 is fixed to 100.
4208/// When the lower limit and upper limit are equal, the parameter is fixed.
4209/// However to fix a parameter to 0, one must call the FixParameter function.
4210///
4211/// \anchor HFitStatBox
4212/// ### Fit Statistics Box
4213///
4214/// The statistics box can display the result of the fit.
4215/// You can change the statistics box to display the fit parameters with
4216/// the TStyle::SetOptFit(mode) method. This mode has four digits.
4217/// mode = pcev (default = 0111)
4218///
4219/// v = 1; print name/values of parameters
4220/// e = 1; print errors (if e=1, v must be 1)
4221/// c = 1; print Chisquare/Number of degrees of freedom
4222/// p = 1; print Probability
4223///
4224/// For example: gStyle->SetOptFit(1011);
4225/// prints the fit probability, parameter names/values, and errors.
4226/// You can change the position of the statistics box with these lines
4227/// (where g is a pointer to the TGraph):
4228///
4229/// TPaveStats *st = (TPaveStats*)g->GetListOfFunctions()->FindObject("stats");
4230/// st->SetX1NDC(newx1); //new x start position
4231/// st->SetX2NDC(newx2); //new x end position
4232///
4233/// \anchor HFitExtra
4234/// ### Additional Notes on Fitting
4235///
4236/// #### Fitting a histogram of dimension N with a function of dimension N-1
4237///
4238/// It is possible to fit a TH2 with a TF1 or a TH3 with a TF2.
4239/// In this case the chi-square is computed from the squared error distance between the function values and the bin centers weighted by the bin content.
4240/// For correct error scaling, the obtained parameter error are corrected as in the case when the
4241/// option "W" is used.
4242///
4243/// #### User defined objective functions
4244///
4245/// By default when fitting a chi square function is used for fitting. When option "L" is used
4246/// a Poisson likelihood function is used. Using option "MULTI" a multinomial likelihood fit is used.
4247/// Thes functions are defined in the header Fit/Chi2Func.h or Fit/PoissonLikelihoodFCN and they
4248/// are implemented using the routines FitUtil::EvaluateChi2 or FitUtil::EvaluatePoissonLogL in
4249/// the file math/mathcore/src/FitUtil.cxx.
4250/// It is possible to specify a user defined fitting function, using option "U" and
4251/// calling the following functions:
4252///
4253/// ~~~ {.cpp}
4254/// TVirtualFitter::Fitter(myhist)->SetFCN(MyFittingFunction);
4255/// ~~~
4256///
4257/// where MyFittingFunction is of type:
4258///
4259/// ~~~ {.cpp}
4260/// extern void MyFittingFunction(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag);
4261/// ~~~
4262///
4263/// #### Note on treatment of empty bins
4264///
4265/// Empty bins, which have the content equal to zero AND error equal to zero,
4266/// are excluded by default from the chi-square fit, but they are considered in the likelihood fit.
4267/// since they affect the likelihood if the function value in these bins is not negligible.
4268/// Note that if the histogram is having bins with zero content and non zero-errors they are considered as
4269/// any other bins in the fit. Instead bins with zero error and non-zero content are by default excluded in the chi-squared fit.
4270/// In general, one should not fit a histogram with non-empty bins and zero errors.
4271///
4272/// If the bin errors are not known, one should use the fit option "W", which gives a weight=1 for each bin (it is an unweighted least-square
4273/// fit). When using option "WW" the empty bins will be also considered in the chi-square fit with an error of 1.
4274/// Note that in this fitting case (option "W" or "WW") the resulting fitted parameter errors
4275/// are corrected by the obtained chi2 value using this scaling expression:
4276/// `errorp *= sqrt(chisquare/(ndf-1))` as it is done when fitting a TGraph with
4277/// no point errors.
4278///
4279/// #### Excluding points
4280///
4281/// You can use TF1::RejectPoint inside your fitting function to exclude some points
4282/// within a certain range from the fit. See the tutorial `fit/fitExclude.C`.
4283///
4284///
4285/// #### Warning when using the option "0"
4286///
4287/// When selecting the option "0", the fitted function is added to
4288/// the list of functions of the histogram, but it is not drawn when the histogram is drawn.
4289/// You can undo this behaviour resetting its corresponding bit in the TF1 object as following:
4290///
4291/// ~~~ {.cpp}
4292/// h.Fit("myFunction", "0"); // fit, store function but do not draw
4293/// h.Draw(); // function is not drawn
4294/// h.GetFunction("myFunction")->ResetBit(TF1::kNotDraw);
4295/// h.Draw(); // function is visible again
4296/// ~~~
4298
4300{
4301 // implementation of Fit method is in file hist/src/HFitImpl.cxx
4304
4305 // create range and minimizer options with default values
4308
4309 // need to empty the buffer before
4310 // (t.b.d. do a ML unbinned fit with buffer data)
4311 if (fBuffer) BufferEmpty();
4312
4314}
4315
4316////////////////////////////////////////////////////////////////////////////////
4317/// Display a panel with all histogram fit options.
4318///
4319/// See class TFitPanel for example
4320
4321void TH1::FitPanel()
4322{
4323 if (!gPad)
4324 gROOT->MakeDefCanvas();
4325
4326 if (!gPad) {
4327 Error("FitPanel", "Unable to create a default canvas");
4328 return;
4329 }
4330
4331
4332 // use plugin manager to create instance of TFitEditor
4333 TPluginHandler *handler = gROOT->GetPluginManager()->FindHandler("TFitEditor");
4334 if (handler && handler->LoadPlugin() != -1) {
4335 if (handler->ExecPlugin(2, gPad, this) == 0)
4336 Error("FitPanel", "Unable to create the FitPanel");
4337 }
4338 else
4339 Error("FitPanel", "Unable to find the FitPanel plug-in");
4340}
4341
4342////////////////////////////////////////////////////////////////////////////////
4343/// Return a histogram containing the asymmetry of this histogram with h2,
4344/// where the asymmetry is defined as:
4345///
4346/// ~~~ {.cpp}
4347/// Asymmetry = (h1 - h2)/(h1 + h2) where h1 = this
4348/// ~~~
4349///
4350/// works for 1D, 2D, etc. histograms
4351/// c2 is an optional argument that gives a relative weight between the two
4352/// histograms, and dc2 is the error on this weight. This is useful, for example,
4353/// when forming an asymmetry between two histograms from 2 different data sets that
4354/// need to be normalized to each other in some way. The function calculates
4355/// the errors assuming Poisson statistics on h1 and h2 (that is, dh = sqrt(h)).
4356///
4357/// example: assuming 'h1' and 'h2' are already filled
4358///
4359/// ~~~ {.cpp}
4360/// h3 = h1->GetAsymmetry(h2)
4361/// ~~~
4362///
4363/// then 'h3' is created and filled with the asymmetry between 'h1' and 'h2';
4364/// h1 and h2 are left intact.
4365///
4366/// Note that it is the user's responsibility to manage the created histogram.
4367/// The name of the returned histogram will be `Asymmetry_nameOfh1-nameOfh2`
4368///
4369/// code proposed by Jason Seely (seely@mit.edu) and adapted by R.Brun
4370///
4371/// clone the histograms so top and bottom will have the
4372/// correct dimensions:
4373/// Sumw2 just makes sure the errors will be computed properly
4374/// when we form sums and ratios below.
4375
4377{
4378 TH1 *h1 = this;
4379 TString name = TString::Format("Asymmetry_%s-%s",h1->GetName(),h2->GetName() );
4380 TH1 *asym = (TH1*)Clone(name);
4381
4382 // set also the title
4383 TString title = TString::Format("(%s - %s)/(%s+%s)",h1->GetName(),h2->GetName(),h1->GetName(),h2->GetName() );
4384 asym->SetTitle(title);
4385
4386 asym->Sumw2();
4389 TH1 *top = (TH1*)asym->Clone();
4390 TH1 *bottom = (TH1*)asym->Clone();
4392
4393 // form the top and bottom of the asymmetry, and then divide:
4394 top->Add(h1,h2,1,-c2);
4395 bottom->Add(h1,h2,1,c2);
4396 asym->Divide(top,bottom);
4397
4398 Int_t xmax = asym->GetNbinsX();
4399 Int_t ymax = asym->GetNbinsY();
4400 Int_t zmax = asym->GetNbinsZ();
4401
4402 if (h1->fBuffer) h1->BufferEmpty(1);
4403 if (h2->fBuffer) h2->BufferEmpty(1);
4404 if (bottom->fBuffer) bottom->BufferEmpty(1);
4405
4406 // now loop over bins to calculate the correct errors
4407 // the reason this error calculation looks complex is because of c2
4408 for(Int_t i=1; i<= xmax; i++){
4409 for(Int_t j=1; j<= ymax; j++){
4410 for(Int_t k=1; k<= zmax; k++){
4411 Int_t bin = GetBin(i, j, k);
4412 // here some bin contents are written into variables to make the error
4413 // calculation a little more legible:
4415 Double_t b = h2->RetrieveBinContent(bin);
4416 Double_t bot = bottom->RetrieveBinContent(bin);
4417
4418 // make sure there are some events, if not, then the errors are set = 0
4419 // automatically.
4420 //if(bot < 1){} was changed to the next line from recommendation of Jason Seely (28 Nov 2005)
4421 if(bot < 1e-6){}
4422 else{
4423 // computation of errors by Christos Leonidopoulos
4425 Double_t dbsq = h2->GetBinErrorSqUnchecked(bin);
4426 Double_t error = 2*TMath::Sqrt(a*a*c2*c2*dbsq + c2*c2*b*b*dasq+a*a*b*b*dc2*dc2)/(bot*bot);
4427 asym->SetBinError(i,j,k,error);
4428 }
4429 }
4430 }
4431 }
4432 delete top;
4433 delete bottom;
4434
4435 return asym;
4436}
4437
4438////////////////////////////////////////////////////////////////////////////////
4439/// Static function
4440/// return the default buffer size for automatic histograms
4441/// the parameter fgBufferSize may be changed via SetDefaultBufferSize
4442
4444{
4445 return fgBufferSize;
4446}
4447
4448////////////////////////////////////////////////////////////////////////////////
4449/// Return kTRUE if TH1::Sumw2 must be called when creating new histograms.
4450/// see TH1::SetDefaultSumw2.
4451
4453{
4454 return fgDefaultSumw2;
4455}
4456
4457////////////////////////////////////////////////////////////////////////////////
4458/// Return the current number of entries.
4459
4461{
4462 if (fBuffer) {
4463 Int_t nentries = (Int_t) fBuffer[0];
4464 if (nentries > 0) return nentries;
4465 }
4466
4467 return fEntries;
4468}
4469
4470////////////////////////////////////////////////////////////////////////////////
4471/// Number of effective entries of the histogram.
4472///
4473/// \f[
4474/// neff = \frac{(\sum Weights )^2}{(\sum Weight^2 )}
4475/// \f]
4476///
4477/// In case of an unweighted histogram this number is equivalent to the
4478/// number of entries of the histogram.
4479/// For a weighted histogram, this number corresponds to the hypothetical number of unweighted entries
4480/// a histogram would need to have the same statistical power as this weighted histogram.
4481/// Note: The underflow/overflow are included if one has set the TH1::StatOverFlows flag
4482/// and if the statistics has been computed at filling time.
4483/// If a range is set in the histogram the number is computed from the given range.
4484
4486{
4487 Stat_t s[kNstat];
4488 this->GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
4489 return (s[1] ? s[0]*s[0]/s[1] : TMath::Abs(s[0]) );
4490}
4491
4492////////////////////////////////////////////////////////////////////////////////
4493/// Shortcut to set the three histogram colors with a single call.
4494///
4495/// By default: linecolor = markercolor = fillcolor = -1
4496/// If a color is < 0 this method does not change the corresponding color if positive or null it set the color.
4497///
4498/// For instance:
4499/// ~~~ {.cpp}
4500/// h->SetColors(kRed, kRed);
4501/// ~~~
4502/// will set the line color and the marker color to red.
4503
4505{
4506 if (linecolor >= 0)
4508 if (markercolor >= 0)
4510 if (fillcolor >= 0)
4512}
4513
4514
4515////////////////////////////////////////////////////////////////////////////////
4516/// Set highlight (enable/disable) mode for the histogram
4517/// by default highlight mode is disable
4518
4519void TH1::SetHighlight(Bool_t set)
4520{
4521 if (IsHighlight() == set)
4522 return;
4523 if (fDimension > 2) {
4524 Info("SetHighlight", "Supported only 1-D or 2-D histograms");
4525 return;
4526 }
4527
4528 SetBit(kIsHighlight, set);
4529
4530 if (fPainter)
4532}
4533
4534////////////////////////////////////////////////////////////////////////////////
4535/// Redefines TObject::GetObjectInfo.
4536/// Displays the histogram info (bin number, contents, integral up to bin
4537/// corresponding to cursor position px,py
4538
4539char *TH1::GetObjectInfo(Int_t px, Int_t py) const
4540{
4541 return ((TH1*)this)->GetPainter()->GetObjectInfo(px,py);
4542}
4543
4544////////////////////////////////////////////////////////////////////////////////
4545/// Return pointer to painter.
4546/// If painter does not exist, it is created
4547
4549{
4550 if (!fPainter) {
4551 TString opt = option;
4552 opt.ToLower();
4553 if (opt.Contains("gl") || gStyle->GetCanvasPreferGL()) {
4554 //try to create TGLHistPainter
4555 TPluginHandler *handler = gROOT->GetPluginManager()->FindHandler("TGLHistPainter");
4556
4557 if (handler && handler->LoadPlugin() != -1)
4558 fPainter = reinterpret_cast<TVirtualHistPainter *>(handler->ExecPlugin(1, this));
4559 }
4560 }
4561
4563
4564 return fPainter;
4565}
4566
4567////////////////////////////////////////////////////////////////////////////////
4568/// Compute Quantiles for this histogram.
4569/// A quantile x_p := Q(p) is defined as the value x_p such that the cumulative
4570/// probability distribution Function F of variable X yields:
4571///
4572/// ~~~ {.cpp}
4573/// F(x_p) = Pr(X <= x_p) = p with 0 <= p <= 1.
4574/// x_p = Q(p) = F_inv(p)
4575/// ~~~
4576///
4577/// For instance the median x_0.5 of a distribution is defined as that value
4578/// of the random variable X for which the distribution function equals 0.5:
4579///
4580/// ~~~ {.cpp}
4581/// F(x_0.5) = Probability(X < x_0.5) = 0.5
4582/// x_0.5 = Q(0.5)
4583/// ~~~
4584///
4585/// \author Eddy Offermann
4586/// code from Eddy Offermann, Renaissance
4587///
4588/// \param[in] n maximum size of the arrays xp and p (if given)
4589/// \param[out] xp array to be filled with nq quantiles evaluated at (p). Memory has to be preallocated by caller.
4590/// - If `p == nullptr`, the quantiles are computed at the (first `n`) probabilities p given by the CDF of the histogram;
4591/// `n` must thus be smaller or equal Nbins+1, otherwise the extra values of `xp` will not be filled and `nq` will be smaller than `n`.
4592/// If all bins have non-zero entries, the quantiles happen to be the bin centres.
4593/// Empty bins will, however, be skipped in the quantiles.
4594/// If the CDF is e.g. [0., 0., 0.1, ...], the quantiles would be, [3., 3., 3., ...], with the third bin starting
4595/// at 3.
4596/// \param[in] p array of cumulative probabilities where quantiles should be evaluated.
4597/// - if `p == nullptr`, the CDF of the histogram will be used to compute the quantiles, and will
4598/// have a size of n.
4599/// - Otherwise, it is assumed to contain at least n values.
4600/// \return number of quantiles computed
4601/// \note Unlike in TF1::GetQuantiles, `p` is here an optional argument
4602///
4603/// Note that the Integral of the histogram is automatically recomputed
4604/// if the number of entries is different of the number of entries when
4605/// the integral was computed last time. In case you do not use the Fill
4606/// functions to fill your histogram, but SetBinContent, you must call
4607/// TH1::ComputeIntegral before calling this function.
4608///
4609/// Getting quantiles xp from two histograms and storing results in a TGraph,
4610/// a so-called QQ-plot
4611///
4612/// ~~~ {.cpp}
4613/// TGraph *gr = new TGraph(nprob);
4614/// h1->GetQuantiles(nprob,gr->GetX());
4615/// h2->GetQuantiles(nprob,gr->GetY());
4616/// gr->Draw("alp");
4617/// ~~~
4618///
4619/// Example:
4620///
4621/// ~~~ {.cpp}
4622/// void quantiles() {
4623/// // demo for quantiles
4624/// const Int_t nq = 20;
4625/// TH1F *h = new TH1F("h","demo quantiles",100,-3,3);
4626/// h->FillRandom("gaus",5000);
4627/// h->GetXaxis()->SetTitle("x");
4628/// h->GetYaxis()->SetTitle("Counts");
4629///
4630/// Double_t p[nq]; // probabilities where to evaluate the quantiles in [0,1]
4631/// Double_t xp[nq]; // array of positions X to store the resulting quantiles
4632/// for (Int_t i=0;i<nq;i++) p[i] = Float_t(i+1)/nq;
4633/// h->GetQuantiles(nq,xp,p);
4634///
4635/// //show the original histogram in the top pad
4636/// TCanvas *c1 = new TCanvas("c1","demo quantiles",10,10,700,900);
4637/// c1->Divide(1,2);
4638/// c1->cd(1);
4639/// h->Draw();
4640///
4641/// // show the quantiles in the bottom pad
4642/// c1->cd(2);
4643/// gPad->SetGrid();
4644/// TGraph *gr = new TGraph(nq,p,xp);
4645/// gr->SetMarkerStyle(21);
4646/// gr->GetXaxis()->SetTitle("p");
4647/// gr->GetYaxis()->SetTitle("x");
4648/// gr->Draw("alp");
4649/// }
4650/// ~~~
4651
4653{
4654 if (GetDimension() > 1) {
4655 Error("GetQuantiles","Only available for 1-d histograms");
4656 return 0;
4657 }
4658
4659 const Int_t nbins = GetXaxis()->GetNbins();
4660 if (!fIntegral) ComputeIntegral();
4661 if (fIntegral[nbins+1] != fEntries) ComputeIntegral();
4662
4663 Int_t i, ibin;
4664 Int_t nq = n;
4665 std::unique_ptr<Double_t[]> localProb;
4666 if (p == nullptr) {
4667 nq = nbins+1;
4668 localProb.reset(new Double_t[nq]);
4669 localProb[0] = 0;
4670 for (i=1;i<nq;i++) {
4671 localProb[i] = fIntegral[i] / fIntegral[nbins];
4672 }
4673 }
4674 Double_t const *const prob = p ? p : localProb.get();
4675
4676 for (i = 0; i < nq; i++) {
4678 if (fIntegral[ibin] == prob[i]) {
4679 if (prob[i] == 0.) {
4680 for (; ibin+1 <= nbins && fIntegral[ibin+1] == 0.; ++ibin) {
4681
4682 }
4683 xp[i] = fXaxis.GetBinUpEdge(ibin);
4684 }
4685 else if (prob[i] == 1.) {
4686 xp[i] = fXaxis.GetBinUpEdge(ibin);
4687 }
4688 else {
4689 // Find equal integral in later bins (ie their entries are zero)
4690 Double_t width = 0;
4691 for (Int_t j = ibin+1; j <= nbins; ++j) {
4692 if (prob[i] == fIntegral[j]) {
4694 }
4695 else
4696 break;
4697 }
4699 }
4700 }
4701 else {
4702 xp[i] = GetBinLowEdge(ibin+1);
4704 if (dint > 0) xp[i] += GetBinWidth(ibin+1)*(prob[i]-fIntegral[ibin])/dint;
4705 }
4706 }
4707
4708 return nq;
4709}
4710
4711////////////////////////////////////////////////////////////////////////////////
4717 return 1;
4718}
4719
4720////////////////////////////////////////////////////////////////////////////////
4721/// Compute Initial values of parameters for a gaussian.
4722
4723void H1InitGaus()
4724{
4725 Double_t allcha, sumx, sumx2, x, val, stddev, mean;
4726 Int_t bin;
4727 const Double_t sqrtpi = 2.506628;
4728
4729 // - Compute mean value and StdDev of the histogram in the given range
4731 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4732 Int_t hxfirst = hFitter->GetXfirst();
4733 Int_t hxlast = hFitter->GetXlast();
4734 Double_t valmax = curHist->GetBinContent(hxfirst);
4735 Double_t binwidx = curHist->GetBinWidth(hxfirst);
4736 allcha = sumx = sumx2 = 0;
4737 for (bin=hxfirst;bin<=hxlast;bin++) {
4738 x = curHist->GetBinCenter(bin);
4739 val = TMath::Abs(curHist->GetBinContent(bin));
4740 if (val > valmax) valmax = val;
4741 sumx += val*x;
4742 sumx2 += val*x*x;
4743 allcha += val;
4744 }
4745 if (allcha == 0) return;
4746 mean = sumx/allcha;
4747 stddev = sumx2/allcha - mean*mean;
4748 if (stddev > 0) stddev = TMath::Sqrt(stddev);
4749 else stddev = 0;
4750 if (stddev == 0) stddev = binwidx*(hxlast-hxfirst+1)/4;
4751 //if the distribution is really gaussian, the best approximation
4752 //is binwidx*allcha/(sqrtpi*stddev)
4753 //However, in case of non-gaussian tails, this underestimates
4754 //the normalisation constant. In this case the maximum value
4755 //is a better approximation.
4756 //We take the average of both quantities
4758
4759 //In case the mean value is outside the histo limits and
4760 //the StdDev is bigger than the range, we take
4761 // mean = center of bins
4762 // stddev = half range
4763 Double_t xmin = curHist->GetXaxis()->GetXmin();
4764 Double_t xmax = curHist->GetXaxis()->GetXmax();
4765 if ((mean < xmin || mean > xmax) && stddev > (xmax-xmin)) {
4766 mean = 0.5*(xmax+xmin);
4767 stddev = 0.5*(xmax-xmin);
4768 }
4769 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4771 f1->SetParameter(1,mean);
4773 f1->SetParLimits(2,0,10*stddev);
4774}
4775
4776////////////////////////////////////////////////////////////////////////////////
4777/// Compute Initial values of parameters for an exponential.
4778
4779void H1InitExpo()
4780{
4782 Int_t ifail;
4784 Int_t hxfirst = hFitter->GetXfirst();
4785 Int_t hxlast = hFitter->GetXlast();
4786 Int_t nchanx = hxlast - hxfirst + 1;
4787
4789
4790 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4792 f1->SetParameter(1,slope);
4793
4794}
4795
4796////////////////////////////////////////////////////////////////////////////////
4797/// Compute Initial values of parameters for a polynom.
4798
4799void H1InitPolynom()
4800{
4801 Double_t fitpar[25];
4802
4804 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4805 Int_t hxfirst = hFitter->GetXfirst();
4806 Int_t hxlast = hFitter->GetXlast();
4807 Int_t nchanx = hxlast - hxfirst + 1;
4808 Int_t npar = f1->GetNpar();
4809
4810 if (nchanx <=1 || npar == 1) {
4811 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4812 fitpar[0] = curHist->GetSumOfWeights()/Double_t(nchanx);
4813 } else {
4815 }
4816 for (Int_t i=0;i<npar;i++) f1->SetParameter(i, fitpar[i]);
4817}
4818
4819////////////////////////////////////////////////////////////////////////////////
4820/// Least squares lpolynomial fitting without weights.
4821///
4822/// \param[in] n number of points to fit
4823/// \param[in] m number of parameters
4824/// \param[in] a array of parameters
4825///
4826/// based on CERNLIB routine LSQ: Translated to C++ by Rene Brun
4827/// (E.Keil. revised by B.Schorr, 23.10.1981.)
4828
4830{
4831 const Double_t zero = 0.;
4832 const Double_t one = 1.;
4833 const Int_t idim = 20;
4834
4835 Double_t b[400] /* was [20][20] */;
4836 Int_t i, k, l, ifail;
4838 Double_t da[20], xk, yk;
4839
4840 if (m <= 2) {
4841 H1LeastSquareLinearFit(n, a[0], a[1], ifail);
4842 return;
4843 }
4844 if (m > idim || m > n) return;
4845 b[0] = Double_t(n);
4846 da[0] = zero;
4847 for (l = 2; l <= m; ++l) {
4848 b[l-1] = zero;
4849 b[m + l*20 - 21] = zero;
4850 da[l-1] = zero;
4851 }
4853 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4854 Int_t hxfirst = hFitter->GetXfirst();
4855 Int_t hxlast = hFitter->GetXlast();
4856 for (k = hxfirst; k <= hxlast; ++k) {
4857 xk = curHist->GetBinCenter(k);
4858 yk = curHist->GetBinContent(k);
4859 power = one;
4860 da[0] += yk;
4861 for (l = 2; l <= m; ++l) {
4862 power *= xk;
4863 b[l-1] += power;
4864 da[l-1] += power*yk;
4865 }
4866 for (l = 2; l <= m; ++l) {
4867 power *= xk;
4868 b[m + l*20 - 21] += power;
4869 }
4870 }
4871 for (i = 3; i <= m; ++i) {
4872 for (k = i; k <= m; ++k) {
4873 b[k - 1 + (i-1)*20 - 21] = b[k + (i-2)*20 - 21];
4874 }
4875 }
4877
4878 for (i=0; i<m; ++i) a[i] = da[i];
4879
4880}
4881
4882////////////////////////////////////////////////////////////////////////////////
4883/// Least square linear fit without weights.
4884///
4885/// extracted from CERNLIB LLSQ: Translated to C++ by Rene Brun
4886/// (added to LSQ by B. Schorr, 15.02.1982.)
4887
4889{
4891 Int_t i, n;
4893 Double_t fn, xk, yk;
4894 Double_t det;
4895
4896 n = TMath::Abs(ndata);
4897 ifail = -2;
4898 xbar = ybar = x2bar = xybar = 0;
4900 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4901 Int_t hxfirst = hFitter->GetXfirst();
4902 Int_t hxlast = hFitter->GetXlast();
4903 for (i = hxfirst; i <= hxlast; ++i) {
4904 xk = curHist->GetBinCenter(i);
4905 yk = curHist->GetBinContent(i);
4906 if (ndata < 0) {
4907 if (yk <= 0) yk = 1e-9;
4908 yk = TMath::Log(yk);
4909 }
4910 xbar += xk;
4911 ybar += yk;
4912 x2bar += xk*xk;
4913 xybar += xk*yk;
4914 }
4915 fn = Double_t(n);
4916 det = fn*x2bar - xbar*xbar;
4917 ifail = -1;
4918 if (det <= 0) {
4919 a0 = ybar/fn;
4920 a1 = 0;
4921 return;
4922 }
4923 ifail = 0;
4924 a0 = (x2bar*ybar - xbar*xybar) / det;
4925 a1 = (fn*xybar - xbar*ybar) / det;
4926
4927}
4928
4929////////////////////////////////////////////////////////////////////////////////
4930/// Extracted from CERN Program library routine DSEQN.
4931///
4932/// Translated to C++ by Rene Brun
4933
4935{
4937 Int_t nmjp1, i, j, l;
4938 Int_t im1, jp1, nm1, nmi;
4939 Double_t s1, s21, s22;
4940 const Double_t one = 1.;
4941
4942 /* Parameter adjustments */
4943 b_dim1 = idim;
4944 b_offset = b_dim1 + 1;
4945 b -= b_offset;
4946 a_dim1 = idim;
4947 a_offset = a_dim1 + 1;
4948 a -= a_offset;
4949
4950 if (idim < n) return;
4951
4952 ifail = 0;
4953 for (j = 1; j <= n; ++j) {
4954 if (a[j + j*a_dim1] <= 0) { ifail = -1; return; }
4955 a[j + j*a_dim1] = one / a[j + j*a_dim1];
4956 if (j == n) continue;
4957 jp1 = j + 1;
4958 for (l = jp1; l <= n; ++l) {
4959 a[j + l*a_dim1] = a[j + j*a_dim1] * a[l + j*a_dim1];
4960 s1 = -a[l + (j+1)*a_dim1];
4961 for (i = 1; i <= j; ++i) { s1 = a[l + i*a_dim1] * a[i + (j+1)*a_dim1] + s1; }
4962 a[l + (j+1)*a_dim1] = -s1;
4963 }
4964 }
4965 if (k <= 0) return;
4966
4967 for (l = 1; l <= k; ++l) {
4968 b[l*b_dim1 + 1] = a[a_dim1 + 1]*b[l*b_dim1 + 1];
4969 }
4970 if (n == 1) return;
4971 for (l = 1; l <= k; ++l) {
4972 for (i = 2; i <= n; ++i) {
4973 im1 = i - 1;
4974 s21 = -b[i + l*b_dim1];
4975 for (j = 1; j <= im1; ++j) {
4976 s21 = a[i + j*a_dim1]*b[j + l*b_dim1] + s21;
4977 }
4978 b[i + l*b_dim1] = -a[i + i*a_dim1]*s21;
4979 }
4980 nm1 = n - 1;
4981 for (i = 1; i <= nm1; ++i) {
4982 nmi = n - i;
4983 s22 = -b[nmi + l*b_dim1];
4984 for (j = 1; j <= i; ++j) {
4985 nmjp1 = n - j + 1;
4986 s22 = a[nmi + nmjp1*a_dim1]*b[nmjp1 + l*b_dim1] + s22;
4987 }
4988 b[nmi + l*b_dim1] = -s22;
4989 }
4990 }
4991}
4992
4993////////////////////////////////////////////////////////////////////////////////
4994/// Return Global bin number corresponding to binx,y,z.
4995///
4996/// 2-D and 3-D histograms are represented with a one dimensional
4997/// structure.
4998/// This has the advantage that all existing functions, such as
4999/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
5000///
5001/// In case of a TH1x, returns binx directly.
5002/// see TH1::GetBinXYZ for the inverse transformation.
5003///
5004/// Convention for numbering bins
5005///
5006/// For all histogram types: nbins, xlow, xup
5007///
5008/// - bin = 0; underflow bin
5009/// - bin = 1; first bin with low-edge xlow INCLUDED
5010/// - bin = nbins; last bin with upper-edge xup EXCLUDED
5011/// - bin = nbins+1; overflow bin
5012///
5013/// In case of 2-D or 3-D histograms, a "global bin" number is defined.
5014/// For example, assuming a 3-D histogram with binx,biny,binz, the function
5015///
5016/// ~~~ {.cpp}
5017/// Int_t bin = h->GetBin(binx,biny,binz);
5018/// ~~~
5019///
5020/// returns a global/linearized bin number. This global bin is useful
5021/// to access the bin information independently of the dimension.
5022
5024{
5025 Int_t ofx = fXaxis.GetNbins() + 1; // overflow bin
5026 if (binx < 0) binx = 0;
5027 if (binx > ofx) binx = ofx;
5028
5029 return binx;
5030}
5031
5032////////////////////////////////////////////////////////////////////////////////
5033/// Return binx, biny, binz corresponding to the global bin number globalbin
5034/// see TH1::GetBin function above
5035
5037{
5038 Int_t nx = fXaxis.GetNbins()+2;
5039 Int_t ny = fYaxis.GetNbins()+2;
5040
5041 if (GetDimension() == 1) {
5042 binx = binglobal%nx;
5043 biny = 0;
5044 binz = 0;
5045 return;
5046 }
5047 if (GetDimension() == 2) {
5048 binx = binglobal%nx;
5049 biny = ((binglobal-binx)/nx)%ny;
5050 binz = 0;
5051 return;
5052 }
5053 if (GetDimension() == 3) {
5054 binx = binglobal%nx;
5055 biny = ((binglobal-binx)/nx)%ny;
5056 binz = ((binglobal-binx)/nx -biny)/ny;
5057 }
5058}
5059
5060////////////////////////////////////////////////////////////////////////////////
5061/// Return a random number distributed according the histogram bin contents.
5062/// This function checks if the bins integral exists. If not, the integral
5063/// is evaluated, normalized to one.
5064///
5065/// @param rng (optional) Random number generator pointer used (default is gRandom)
5066/// @param option (optional) Set it to "width" if your non-uniform bin contents represent a density rather than counts
5067///
5068/// The integral is automatically recomputed if the number of entries
5069/// is not the same then when the integral was computed.
5070/// @note Only valid for 1-d histograms. Use GetRandom2 or GetRandom3 otherwise.
5071/// If the histogram has a bin with negative content, a NaN is returned.
5072
5074{
5075 if (fDimension > 1) {
5076 Error("GetRandom","Function only valid for 1-d histograms");
5077 return 0;
5078 }
5080 Double_t integral = 0;
5081 // compute integral checking that all bins have positive content (see ROOT-5894)
5082 if (fIntegral) {
5083 if (fIntegral[nbinsx + 1] != fEntries)
5084 integral = const_cast<TH1 *>(this)->ComputeIntegral(true, option);
5085 else integral = fIntegral[nbinsx];
5086 } else {
5087 integral = const_cast<TH1 *>(this)->ComputeIntegral(true, option);
5088 }
5089 if (integral == 0) return 0;
5090 // return a NaN in case some bins have negative content
5091 if (integral == TMath::QuietNaN() ) return TMath::QuietNaN();
5092
5093 Double_t r1 = (rng) ? rng->Rndm() : gRandom->Rndm();
5096 if (r1 > fIntegral[ibin]) x +=
5098 return x;
5099}
5100
5101////////////////////////////////////////////////////////////////////////////////
5102/// Return content of bin number bin.
5103///
5104/// Implemented in TH1C,S,F,D
5105///
5106/// Convention for numbering bins
5107///
5108/// For all histogram types: nbins, xlow, xup
5109///
5110/// - bin = 0; underflow bin
5111/// - bin = 1; first bin with low-edge xlow INCLUDED
5112/// - bin = nbins; last bin with upper-edge xup EXCLUDED
5113/// - bin = nbins+1; overflow bin
5114///
5115/// In case of 2-D or 3-D histograms, a "global bin" number is defined.
5116/// For example, assuming a 3-D histogram with binx,biny,binz, the function
5117///
5118/// ~~~ {.cpp}
5119/// Int_t bin = h->GetBin(binx,biny,binz);
5120/// ~~~
5121///
5122/// returns a global/linearized bin number. This global bin is useful
5123/// to access the bin information independently of the dimension.
5124
5126{
5127 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
5128 if (bin < 0) bin = 0;
5129 if (bin >= fNcells) bin = fNcells-1;
5130
5131 return RetrieveBinContent(bin);
5132}
5133
5134////////////////////////////////////////////////////////////////////////////////
5135/// Compute first binx in the range [firstx,lastx] for which
5136/// diff = abs(bin_content-c) <= maxdiff
5137///
5138/// In case several bins in the specified range with diff=0 are found
5139/// the first bin found is returned in binx.
5140/// In case several bins in the specified range satisfy diff <=maxdiff
5141/// the bin with the smallest difference is returned in binx.
5142/// In all cases the function returns the smallest difference.
5143///
5144/// NOTE1: if firstx <= 0, firstx is set to bin 1
5145/// if (lastx < firstx then firstx is set to the number of bins
5146/// ie if firstx=0 and lastx=0 (default) the search is on all bins.
5147///
5148/// NOTE2: if maxdiff=0 (default), the first bin with content=c is returned.
5149
5151{
5152 if (fDimension > 1) {
5153 binx = 0;
5154 Error("GetBinWithContent","function is only valid for 1-D histograms");
5155 return 0;
5156 }
5157
5158 if (fBuffer) ((TH1*)this)->BufferEmpty();
5159
5160 if (firstx <= 0) firstx = 1;
5161 if (lastx < firstx) lastx = fXaxis.GetNbins();
5162 Int_t binminx = 0;
5163 Double_t diff, curmax = 1.e240;
5164 for (Int_t i=firstx;i<=lastx;i++) {
5166 if (diff <= 0) {binx = i; return diff;}
5167 if (diff < curmax && diff <= maxdiff) {curmax = diff, binminx=i;}
5168 }
5169 binx = binminx;
5170 return curmax;
5171}
5172
5173////////////////////////////////////////////////////////////////////////////////
5174/// Given a point x, approximates the value via linear interpolation
5175/// based on the two nearest bin centers
5176///
5177/// Andy Mastbaum 10/21/08
5178
5180{
5181 if (fBuffer) ((TH1*)this)->BufferEmpty();
5182
5184 Double_t x0,x1,y0,y1;
5185
5186 if(x<=GetBinCenter(1)) {
5187 return RetrieveBinContent(1);
5188 } else if(x>=GetBinCenter(GetNbinsX())) {
5189 return RetrieveBinContent(GetNbinsX());
5190 } else {
5191 if(x<=GetBinCenter(xbin)) {
5193 x0 = GetBinCenter(xbin-1);
5195 x1 = GetBinCenter(xbin);
5196 } else {
5198 x0 = GetBinCenter(xbin);
5200 x1 = GetBinCenter(xbin+1);
5201 }
5202 return y0 + (x-x0)*((y1-y0)/(x1-x0));
5203 }
5204}
5205
5206////////////////////////////////////////////////////////////////////////////////
5207/// 2d Interpolation. Not yet implemented.
5208
5210{
5211 Error("Interpolate","This function must be called with 1 argument for a TH1");
5212 return 0;
5213}
5214
5215////////////////////////////////////////////////////////////////////////////////
5216/// 3d Interpolation. Not yet implemented.
5217
5219{
5220 Error("Interpolate","This function must be called with 1 argument for a TH1");
5221 return 0;
5222}
5223
5224///////////////////////////////////////////////////////////////////////////////
5225/// Check if a histogram is empty
5226/// (this is a protected method used mainly by TH1Merger )
5227
5228Bool_t TH1::IsEmpty() const
5229{
5230 // if fTsumw or fentries are not zero histogram is not empty
5231 // need to use GetEntries() instead of fEntries in case of bugger histograms
5232 // so we will flash the buffer
5233 if (fTsumw != 0) return kFALSE;
5234 if (GetEntries() != 0) return kFALSE;
5235 // case fTSumw == 0 amd entries are also zero
5236 // this should not really happening, but if one sets content by hand
5237 // it can happen. a call to ResetStats() should be done in such cases
5238 double sumw = 0;
5239 for (int i = 0; i< GetNcells(); ++i) sumw += RetrieveBinContent(i);
5240 return (sumw != 0) ? kFALSE : kTRUE;
5241}
5242
5243////////////////////////////////////////////////////////////////////////////////
5244/// Return true if the bin is overflow.
5245
5247{
5248 Int_t binx, biny, binz;
5249 GetBinXYZ(bin, binx, biny, binz);
5250
5251 if (iaxis == 0) {
5252 if ( fDimension == 1 )
5253 return binx >= GetNbinsX() + 1;
5254 if ( fDimension == 2 )
5255 return (binx >= GetNbinsX() + 1) ||
5256 (biny >= GetNbinsY() + 1);
5257 if ( fDimension == 3 )
5258 return (binx >= GetNbinsX() + 1) ||
5259 (biny >= GetNbinsY() + 1) ||
5260 (binz >= GetNbinsZ() + 1);
5261 return kFALSE;
5262 }
5263 if (iaxis == 1)
5264 return binx >= GetNbinsX() + 1;
5265 if (iaxis == 2)
5266 return biny >= GetNbinsY() + 1;
5267 if (iaxis == 3)
5268 return binz >= GetNbinsZ() + 1;
5269
5270 Error("IsBinOverflow","Invalid axis value");
5271 return kFALSE;
5272}
5273
5274////////////////////////////////////////////////////////////////////////////////
5275/// Return true if the bin is underflow.
5276/// If iaxis = 0 make OR with all axes otherwise check only for the given axis
5277
5279{
5280 Int_t binx, biny, binz;
5281 GetBinXYZ(bin, binx, biny, binz);
5282
5283 if (iaxis == 0) {
5284 if ( fDimension == 1 )
5285 return (binx <= 0);
5286 else if ( fDimension == 2 )
5287 return (binx <= 0 || biny <= 0);
5288 else if ( fDimension == 3 )
5289 return (binx <= 0 || biny <= 0 || binz <= 0);
5290 else
5291 return kFALSE;
5292 }
5293 if (iaxis == 1)
5294 return (binx <= 0);
5295 if (iaxis == 2)
5296 return (biny <= 0);
5297 if (iaxis == 3)
5298 return (binz <= 0);
5299
5300 Error("IsBinUnderflow","Invalid axis value");
5301 return kFALSE;
5302}
5303
5304////////////////////////////////////////////////////////////////////////////////
5305/// Reduce the number of bins for the axis passed in the option to the number of bins having a label.
5306/// The method will remove only the extra bins existing after the last "labeled" bin.
5307/// Note that if there are "un-labeled" bins present between "labeled" bins they will not be removed
5308
5310{
5312 TAxis *axis = nullptr;
5313 if (iaxis == 1) axis = GetXaxis();
5314 if (iaxis == 2) axis = GetYaxis();
5315 if (iaxis == 3) axis = GetZaxis();
5316 if (!axis) {
5317 Error("LabelsDeflate","Invalid axis option %s",ax);
5318 return;
5319 }
5320 if (!axis->GetLabels()) return;
5321
5322 // find bin with last labels
5323 // bin number is object ID in list of labels
5324 // therefore max bin number is number of bins of the deflated histograms
5325 TIter next(axis->GetLabels());
5326 TObject *obj;
5327 Int_t nbins = 0;
5328 while ((obj = next())) {
5329 Int_t ibin = obj->GetUniqueID();
5330 if (ibin > nbins) nbins = ibin;
5331 }
5332 if (nbins < 1) nbins = 1;
5333
5334 // Do nothing in case it was the last bin
5335 if (nbins==axis->GetNbins()) return;
5336
5337 TH1 *hold = (TH1*)IsA()->New();
5338 R__ASSERT(hold);
5339 hold->SetDirectory(nullptr);
5340 Copy(*hold);
5341
5342 Bool_t timedisp = axis->GetTimeDisplay();
5343 Double_t xmin = axis->GetXmin();
5344 Double_t xmax = axis->GetBinUpEdge(nbins);
5345 if (xmax <= xmin) xmax = xmin +nbins;
5346 axis->SetRange(0,0);
5347 axis->Set(nbins,xmin,xmax);
5348 SetBinsLength(-1); // reset the number of cells
5350 if (errors) fSumw2.Set(fNcells);
5351 axis->SetTimeDisplay(timedisp);
5352 // reset histogram content
5353 Reset("ICE");
5354
5355 //now loop on all bins and refill
5356 // NOTE that if the bins without labels have content
5357 // it will be put in the underflow/overflow.
5358 // For this reason we use AddBinContent method
5360 Int_t bin,binx,biny,binz;
5361 for (bin=0; bin < hold->fNcells; ++bin) {
5362 hold->GetBinXYZ(bin,binx,biny,binz);
5364 Double_t cu = hold->RetrieveBinContent(bin);
5366 if (errors) {
5367 fSumw2.fArray[ibin] += hold->fSumw2.fArray[bin];
5368 }
5369 }
5371 delete hold;
5372}
5373
5374////////////////////////////////////////////////////////////////////////////////
5375/// Double the number of bins for axis.
5376/// Refill histogram.
5377/// This function is called by TAxis::FindBin(const char *label)
5378
5380{
5382 TAxis *axis = nullptr;
5383 if (iaxis == 1) axis = GetXaxis();
5384 if (iaxis == 2) axis = GetYaxis();
5385 if (iaxis == 3) axis = GetZaxis();
5386 if (!axis) return;
5387
5388 TH1 *hold = (TH1*)IsA()->New();
5389 hold->SetDirectory(nullptr);
5390 Copy(*hold);
5391 hold->ResetBit(kMustCleanup);
5392
5393 Bool_t timedisp = axis->GetTimeDisplay();
5394 Int_t nbins = axis->GetNbins();
5395 Double_t xmin = axis->GetXmin();
5396 Double_t xmax = axis->GetXmax();
5397 xmax = xmin + 2*(xmax-xmin);
5398 axis->SetRange(0,0);
5399 // double the bins and recompute ncells
5400 axis->Set(2*nbins,xmin,xmax);
5401 SetBinsLength(-1);
5403 if (errors) fSumw2.Set(fNcells);
5404 axis->SetTimeDisplay(timedisp);
5405
5406 Reset("ICE"); // reset content and error
5407
5408 //now loop on all bins and refill
5410 Int_t bin,ibin,binx,biny,binz;
5411 for (ibin =0; ibin < hold->fNcells; ibin++) {
5412 // get the binx,y,z values . The x-y-z (axis) bin values will stay the same between new-old after the expanding
5413 hold->GetBinXYZ(ibin,binx,biny,binz);
5414 bin = GetBin(binx,biny,binz);
5415
5416 // underflow and overflow will be cleaned up because their meaning has been altered
5417 if (hold->IsBinUnderflow(ibin,iaxis) || hold->IsBinOverflow(ibin,iaxis)) {
5418 continue;
5419 }
5420 else {
5421 AddBinContent(bin, hold->RetrieveBinContent(ibin));
5422 if (errors) fSumw2.fArray[bin] += hold->fSumw2.fArray[ibin];
5423 }
5424 }
5426 delete hold;
5427}
5428
5429////////////////////////////////////////////////////////////////////////////////
5430/// Sort bins with labels or set option(s) to draw axis with labels
5431/// \param[in] option
5432/// - "a" sort by alphabetic order
5433/// - ">" sort by decreasing values
5434/// - "<" sort by increasing values
5435/// - "h" draw labels horizontal
5436/// - "v" draw labels vertical
5437/// - "u" draw labels up (end of label right adjusted)
5438/// - "d" draw labels down (start of label left adjusted)
5439///
5440/// In case not all bins have labels sorting will work only in the case
5441/// the first `n` consecutive bins have all labels and sorting will be performed on
5442/// those label bins.
5443///
5444/// \param[in] ax axis
5445
5447{
5449 TAxis *axis = nullptr;
5450 if (iaxis == 1)
5451 axis = GetXaxis();
5452 if (iaxis == 2)
5453 axis = GetYaxis();
5454 if (iaxis == 3)
5455 axis = GetZaxis();
5456 if (!axis)
5457 return;
5458 THashList *labels = axis->GetLabels();
5459 if (!labels) {
5460 Warning("LabelsOption", "Axis %s has no labels!",axis->GetName());
5461 return;
5462 }
5463 TString opt = option;
5464 opt.ToLower();
5465 Int_t iopt = -1;
5466 if (opt.Contains("h")) {
5471 iopt = 0;
5472 }
5473 if (opt.Contains("v")) {
5478 iopt = 1;
5479 }
5480 if (opt.Contains("u")) {
5481 axis->SetBit(TAxis::kLabelsUp);
5485 iopt = 2;
5486 }
5487 if (opt.Contains("d")) {
5492 iopt = 3;
5493 }
5494 Int_t sort = -1;
5495 if (opt.Contains("a"))
5496 sort = 0;
5497 if (opt.Contains(">"))
5498 sort = 1;
5499 if (opt.Contains("<"))
5500 sort = 2;
5501 if (sort < 0) {
5502 if (iopt < 0)
5503 Error("LabelsOption", "%s is an invalid label placement option!",opt.Data());
5504 return;
5505 }
5506
5507 // Code works only if first n bins have labels if we uncomment following line
5508 // but we don't want to support this special case
5509 // Int_t n = TMath::Min(axis->GetNbins(), labels->GetSize());
5510
5511 // support only cases where each bin has a labels (should be when axis is alphanumeric)
5512 Int_t n = labels->GetSize();
5513 if (n != axis->GetNbins()) {
5514 // check if labels are all consecutive and starts from the first bin
5515 // in that case the current code will work fine
5516 Int_t firstLabelBin = axis->GetNbins()+1;
5517 Int_t lastLabelBin = -1;
5518 for (Int_t i = 0; i < n; ++i) {
5519 Int_t bin = labels->At(i)->GetUniqueID();
5520 if (bin < firstLabelBin) firstLabelBin = bin;
5521 if (bin > lastLabelBin) lastLabelBin = bin;
5522 }
5523 if (firstLabelBin != 1 || lastLabelBin-firstLabelBin +1 != n) {
5524 Error("LabelsOption", "%s of Histogram %s contains bins without labels. Sorting will not work correctly - return",
5525 axis->GetName(), GetName());
5526 return;
5527 }
5528 // case where label bins are consecutive starting from first bin will work
5529 // calling before a TH1::LabelsDeflate() will avoid this error message
5530 Warning("LabelsOption", "axis %s of Histogram %s has extra following bins without labels. Sorting will work only for first label bins",
5531 axis->GetName(), GetName());
5532 }
5533 std::vector<Int_t> a(n);
5534 std::vector<Int_t> b(n);
5535
5536
5537 Int_t i, j, k;
5538 std::vector<Double_t> cont;
5539 std::vector<Double_t> errors2;
5540 THashList *labold = new THashList(labels->GetSize(), 1);
5541 TIter nextold(labels);
5542 TObject *obj = nullptr;
5543 labold->AddAll(labels);
5544 labels->Clear();
5545
5546 // delete buffer if it is there since bins will be reordered.
5547 if (fBuffer)
5548 BufferEmpty(1);
5549
5550 if (sort > 0) {
5551 //---sort by values of bins
5552 if (GetDimension() == 1) {
5553 cont.resize(n);
5554 if (fSumw2.fN)
5555 errors2.resize(n);
5556 for (i = 0; i < n; i++) {
5557 cont[i] = RetrieveBinContent(i + 1);
5558 if (!errors2.empty())
5559 errors2[i] = GetBinErrorSqUnchecked(i + 1);
5560 b[i] = labold->At(i)->GetUniqueID(); // this is the bin corresponding to the label
5561 a[i] = i;
5562 }
5563 if (sort == 1)
5564 TMath::Sort(n, cont.data(), a.data(), kTRUE); // sort by decreasing values
5565 else
5566 TMath::Sort(n, cont.data(), a.data(), kFALSE); // sort by increasing values
5567 for (i = 0; i < n; i++) {
5568 // use UpdateBinCOntent to not screw up histogram entries
5569 UpdateBinContent(i + 1, cont[b[a[i]] - 1]); // b[a[i]] returns bin number. .we need to subtract 1
5570 if (gDebug)
5571 Info("LabelsOption","setting bin %d value %f from bin %d label %s at pos %d ",
5572 i+1,cont[b[a[i]] - 1],b[a[i]],labold->At(a[i])->GetName(),a[i]);
5573 if (!errors2.empty())
5574 fSumw2.fArray[i + 1] = errors2[b[a[i]] - 1];
5575 }
5576 for (i = 0; i < n; i++) {
5577 obj = labold->At(a[i]);
5578 labels->Add(obj);
5579 obj->SetUniqueID(i + 1);
5580 }
5581 } else if (GetDimension() == 2) {
5582 std::vector<Double_t> pcont(n + 2);
5583 Int_t nx = fXaxis.GetNbins() + 2;
5584 Int_t ny = fYaxis.GetNbins() + 2;
5585 cont.resize((nx + 2) * (ny + 2));
5586 if (fSumw2.fN)
5587 errors2.resize((nx + 2) * (ny + 2));
5588 for (i = 0; i < nx; i++) {
5589 for (j = 0; j < ny; j++) {
5590 Int_t bin = GetBin(i,j);
5591 cont[i + nx * j] = RetrieveBinContent(bin);
5592 if (!errors2.empty())
5593 errors2[i + nx * j] = GetBinErrorSqUnchecked(bin);
5594 if (axis == GetXaxis())
5595 k = i - 1;
5596 else
5597 k = j - 1;
5598 if (k >= 0 && k < n) { // we consider underflow/overflows in y for ordering the bins
5599 pcont[k] += cont[i + nx * j];
5600 a[k] = k;
5601 }
5602 }
5603 }
5604 if (sort == 1)
5605 TMath::Sort(n, pcont.data(), a.data(), kTRUE); // sort by decreasing values
5606 else
5607 TMath::Sort(n, pcont.data(), a.data(), kFALSE); // sort by increasing values
5608 for (i = 0; i < n; i++) {
5609 // iterate on old label list to find corresponding bin match
5610 TIter next(labold);
5611 UInt_t bin = a[i] + 1;
5612 while ((obj = next())) {
5613 if (obj->GetUniqueID() == (UInt_t)bin)
5614 break;
5615 else
5616 obj = nullptr;
5617 }
5618 if (!obj) {
5619 // this should not really happen
5620 R__ASSERT("LabelsOption - No corresponding bin found when ordering labels");
5621 return;
5622 }
5623
5624 labels->Add(obj);
5625 if (gDebug)
5626 std::cout << " set label " << obj->GetName() << " to bin " << i + 1 << " from order " << a[i] << " bin "
5627 << b[a[i]] << "content " << pcont[a[i]] << std::endl;
5628 }
5629 // need to set here new ordered labels - otherwise loop before does not work since labold and labels list
5630 // contain same objects
5631 for (i = 0; i < n; i++) {
5632 labels->At(i)->SetUniqueID(i + 1);
5633 }
5634 // set now the bin contents
5635 if (axis == GetXaxis()) {
5636 for (i = 0; i < n; i++) {
5637 Int_t ix = a[i] + 1;
5638 for (j = 0; j < ny; j++) {
5639 Int_t bin = GetBin(i + 1, j);
5640 UpdateBinContent(bin, cont[ix + nx * j]);
5641 if (!errors2.empty())
5642 fSumw2.fArray[bin] = errors2[ix + nx * j];
5643 }
5644 }
5645 } else {
5646 // using y axis
5647 for (i = 0; i < nx; i++) {
5648 for (j = 0; j < n; j++) {
5649 Int_t iy = a[j] + 1;
5650 Int_t bin = GetBin(i, j + 1);
5651 UpdateBinContent(bin, cont[i + nx * iy]);
5652 if (!errors2.empty())
5653 fSumw2.fArray[bin] = errors2[i + nx * iy];
5654 }
5655 }
5656 }
5657 } else {
5658 // sorting histograms: 3D case
5659 std::vector<Double_t> pcont(n + 2);
5660 Int_t nx = fXaxis.GetNbins() + 2;
5661 Int_t ny = fYaxis.GetNbins() + 2;
5662 Int_t nz = fZaxis.GetNbins() + 2;
5663 Int_t l = 0;
5664 cont.resize((nx + 2) * (ny + 2) * (nz + 2));
5665 if (fSumw2.fN)
5666 errors2.resize((nx + 2) * (ny + 2) * (nz + 2));
5667 for (i = 0; i < nx; i++) {
5668 for (j = 0; j < ny; j++) {
5669 for (k = 0; k < nz; k++) {
5670 Int_t bin = GetBin(i,j,k);
5672 if (axis == GetXaxis())
5673 l = i - 1;
5674 else if (axis == GetYaxis())
5675 l = j - 1;
5676 else
5677 l = k - 1;
5678 if (l >= 0 && l < n) { // we consider underflow/overflows in y for ordering the bins
5679 pcont[l] += c;
5680 a[l] = l;
5681 }
5682 cont[i + nx * (j + ny * k)] = c;
5683 if (!errors2.empty())
5684 errors2[i + nx * (j + ny * k)] = GetBinErrorSqUnchecked(bin);
5685 }
5686 }
5687 }
5688 if (sort == 1)
5689 TMath::Sort(n, pcont.data(), a.data(), kTRUE); // sort by decreasing values
5690 else
5691 TMath::Sort(n, pcont.data(), a.data(), kFALSE); // sort by increasing values
5692 for (i = 0; i < n; i++) {
5693 // iterate on the old label list to find corresponding bin match
5694 TIter next(labold);
5695 UInt_t bin = a[i] + 1;
5696 obj = nullptr;
5697 while ((obj = next())) {
5698 if (obj->GetUniqueID() == (UInt_t)bin) {
5699 break;
5700 }
5701 else
5702 obj = nullptr;
5703 }
5704 if (!obj) {
5705 R__ASSERT("LabelsOption - No corresponding bin found when ordering labels");
5706 return;
5707 }
5708 labels->Add(obj);
5709 if (gDebug)
5710 std::cout << " set label " << obj->GetName() << " to bin " << i + 1 << " from bin " << a[i] << "content "
5711 << pcont[a[i]] << std::endl;
5712 }
5713
5714 // need to set here new ordered labels - otherwise loop before does not work since labold and llabels list
5715 // contain same objects
5716 for (i = 0; i < n; i++) {
5717 labels->At(i)->SetUniqueID(i + 1);
5718 }
5719 // set now the bin contents
5720 if (axis == GetXaxis()) {
5721 for (i = 0; i < n; i++) {
5722 Int_t ix = a[i] + 1;
5723 for (j = 0; j < ny; j++) {
5724 for (k = 0; k < nz; k++) {
5725 Int_t bin = GetBin(i + 1, j, k);
5726 UpdateBinContent(bin, cont[ix + nx * (j + ny * k)]);
5727 if (!errors2.empty())
5728 fSumw2.fArray[bin] = errors2[ix + nx * (j + ny * k)];
5729 }
5730 }
5731 }
5732 } else if (axis == GetYaxis()) {
5733 // using y axis
5734 for (i = 0; i < nx; i++) {
5735 for (j = 0; j < n; j++) {
5736 Int_t iy = a[j] + 1;
5737 for (k = 0; k < nz; k++) {
5738 Int_t bin = GetBin(i, j + 1, k);
5739 UpdateBinContent(bin, cont[i + nx * (iy + ny * k)]);
5740 if (!errors2.empty())
5741 fSumw2.fArray[bin] = errors2[i + nx * (iy + ny * k)];
5742 }
5743 }
5744 }
5745 } else {
5746 // using z axis
5747 for (i = 0; i < nx; i++) {
5748 for (j = 0; j < ny; j++) {
5749 for (k = 0; k < n; k++) {
5750 Int_t iz = a[k] + 1;
5751 Int_t bin = GetBin(i, j , k +1);
5752 UpdateBinContent(bin, cont[i + nx * (j + ny * iz)]);
5753 if (!errors2.empty())
5754 fSumw2.fArray[bin] = errors2[i + nx * (j + ny * iz)];
5755 }
5756 }
5757 }
5758 }
5759 }
5760 } else {
5761 //---alphabetic sort
5762 // sort labels using vector of strings and TMath::Sort
5763 // I need to array because labels order in list is not necessary that of the bins
5764 std::vector<std::string> vecLabels(n);
5765 for (i = 0; i < n; i++) {
5766 vecLabels[i] = labold->At(i)->GetName();
5767 b[i] = labold->At(i)->GetUniqueID(); // this is the bin corresponding to the label
5768 a[i] = i;
5769 }
5770 // sort in ascending order for strings
5771 TMath::Sort(n, vecLabels.data(), a.data(), kFALSE);
5772 // set the new labels
5773 for (i = 0; i < n; i++) {
5774 TObject *labelObj = labold->At(a[i]);
5775 labels->Add(labold->At(a[i]));
5776 // set the corresponding bin. NB bin starts from 1
5777 labelObj->SetUniqueID(i + 1);
5778 if (gDebug)
5779 std::cout << "bin " << i + 1 << " setting new labels for axis " << labold->At(a[i])->GetName() << " from "
5780 << b[a[i]] << std::endl;
5781 }
5782
5783 if (GetDimension() == 1) {
5784 cont.resize(n + 2);
5785 if (fSumw2.fN)
5786 errors2.resize(n + 2);
5787 for (i = 0; i < n; i++) {
5788 cont[i] = RetrieveBinContent(b[a[i]]);
5789 if (!errors2.empty())
5791 }
5792 for (i = 0; i < n; i++) {
5793 UpdateBinContent(i + 1, cont[i]);
5794 if (!errors2.empty())
5795 fSumw2.fArray[i+1] = errors2[i];
5796 }
5797 } else if (GetDimension() == 2) {
5798 Int_t nx = fXaxis.GetNbins() + 2;
5799 Int_t ny = fYaxis.GetNbins() + 2;
5800 cont.resize(nx * ny);
5801 if (fSumw2.fN)
5802 errors2.resize(nx * ny);
5803 // copy old bin contents and then set to new ordered bins
5804 // N.B. bin in histograms starts from 1, but in y we consider under/overflows
5805 for (i = 0; i < nx; i++) {
5806 for (j = 0; j < ny; j++) { // ny is nbins+2
5807 Int_t bin = GetBin(i, j);
5808 cont[i + nx * j] = RetrieveBinContent(bin);
5809 if (!errors2.empty())
5810 errors2[i + nx * j] = GetBinErrorSqUnchecked(bin);
5811 }
5812 }
5813 if (axis == GetXaxis()) {
5814 for (i = 0; i < n; i++) {
5815 for (j = 0; j < ny; j++) {
5816 Int_t bin = GetBin(i + 1 , j);
5817 UpdateBinContent(bin, cont[b[a[i]] + nx * j]);
5818 if (!errors2.empty())
5819 fSumw2.fArray[bin] = errors2[b[a[i]] + nx * j];
5820 }
5821 }
5822 } else {
5823 for (i = 0; i < nx; i++) {
5824 for (j = 0; j < n; j++) {
5825 Int_t bin = GetBin(i, j + 1);
5826 UpdateBinContent(bin, cont[i + nx * b[a[j]]]);
5827 if (!errors2.empty())
5828 fSumw2.fArray[bin] = errors2[i + nx * b[a[j]]];
5829 }
5830 }
5831 }
5832 } else {
5833 // case of 3D (needs to be tested)
5834 Int_t nx = fXaxis.GetNbins() + 2;
5835 Int_t ny = fYaxis.GetNbins() + 2;
5836 Int_t nz = fZaxis.GetNbins() + 2;
5837 cont.resize(nx * ny * nz);
5838 if (fSumw2.fN)
5839 errors2.resize(nx * ny * nz);
5840 for (i = 0; i < nx; i++) {
5841 for (j = 0; j < ny; j++) {
5842 for (k = 0; k < nz; k++) {
5843 Int_t bin = GetBin(i, j, k);
5844 cont[i + nx * (j + ny * k)] = RetrieveBinContent(bin);
5845 if (!errors2.empty())
5846 errors2[i + nx * (j + ny * k)] = GetBinErrorSqUnchecked(bin);
5847 }
5848 }
5849 }
5850 if (axis == GetXaxis()) {
5851 // labels on x axis
5852 for (i = 0; i < n; i++) { // for x we loop only on bins with the labels
5853 for (j = 0; j < ny; j++) {
5854 for (k = 0; k < nz; k++) {
5855 Int_t bin = GetBin(i + 1, j, k);
5856 UpdateBinContent(bin, cont[b[a[i]] + nx * (j + ny * k)]);
5857 if (!errors2.empty())
5858 fSumw2.fArray[bin] = errors2[b[a[i]] + nx * (j + ny * k)];
5859 }
5860 }
5861 }
5862 } else if (axis == GetYaxis()) {
5863 // labels on y axis
5864 for (i = 0; i < nx; i++) {
5865 for (j = 0; j < n; j++) {
5866 for (k = 0; k < nz; k++) {
5867 Int_t bin = GetBin(i, j+1, k);
5868 UpdateBinContent(bin, cont[i + nx * (b[a[j]] + ny * k)]);
5869 if (!errors2.empty())
5870 fSumw2.fArray[bin] = errors2[i + nx * (b[a[j]] + ny * k)];
5871 }
5872 }
5873 }
5874 } else {
5875 // labels on z axis
5876 for (i = 0; i < nx; i++) {
5877 for (j = 0; j < ny; j++) {
5878 for (k = 0; k < n; k++) {
5879 Int_t bin = GetBin(i, j, k+1);
5880 UpdateBinContent(bin, cont[i + nx * (j + ny * b[a[k]])]);
5881 if (!errors2.empty())
5882 fSumw2.fArray[bin] = errors2[i + nx * (j + ny * b[a[k]])];
5883 }
5884 }
5885 }
5886 }
5887 }
5888 }
5889 // need to set to zero the statistics if axis has been sorted
5890 // see for example TH3::PutStats for definition of s vector
5891 bool labelsAreSorted = kFALSE;
5892 for (i = 0; i < n; ++i) {
5893 if (a[i] != i) {
5895 break;
5896 }
5897 }
5898 if (labelsAreSorted) {
5899 double s[TH1::kNstat];
5900 GetStats(s);
5901 if (iaxis == 1) {
5902 s[2] = 0; // fTsumwx
5903 s[3] = 0; // fTsumwx2
5904 s[6] = 0; // fTsumwxy
5905 s[9] = 0; // fTsumwxz
5906 } else if (iaxis == 2) {
5907 s[4] = 0; // fTsumwy
5908 s[5] = 0; // fTsumwy2
5909 s[6] = 0; // fTsumwxy
5910 s[10] = 0; // fTsumwyz
5911 } else if (iaxis == 3) {
5912 s[7] = 0; // fTsumwz
5913 s[8] = 0; // fTsumwz2
5914 s[9] = 0; // fTsumwxz
5915 s[10] = 0; // fTsumwyz
5916 }
5917 PutStats(s);
5918 }
5919 delete labold;
5920}
5921
5922////////////////////////////////////////////////////////////////////////////////
5923/// Test if two double are almost equal.
5924
5925static inline Bool_t AlmostEqual(Double_t a, Double_t b, Double_t epsilon = 0.00000001)
5926{
5927 return TMath::Abs(a - b) < epsilon;
5928}
5929
5930////////////////////////////////////////////////////////////////////////////////
5931/// Test if a double is almost an integer.
5932
5933static inline Bool_t AlmostInteger(Double_t a, Double_t epsilon = 0.00000001)
5934{
5935 return AlmostEqual(a - TMath::Floor(a), 0, epsilon) ||
5936 AlmostEqual(a - TMath::Floor(a), 1, epsilon);
5937}
5938
5939////////////////////////////////////////////////////////////////////////////////
5940/// Test if the binning is equidistant.
5941
5942static inline bool IsEquidistantBinning(const TAxis& axis)
5943{
5944 // check if axis bin are equals
5945 if (!axis.GetXbins()->fN) return true; //
5946 // not able to check if there is only one axis entry
5947 bool isEquidistant = true;
5948 const Double_t firstBinWidth = axis.GetBinWidth(1);
5949 for (int i = 1; i < axis.GetNbins(); ++i) {
5950 const Double_t binWidth = axis.GetBinWidth(i);
5951 const bool match = TMath::AreEqualRel(firstBinWidth, binWidth, 1.E-10);
5952 isEquidistant &= match;
5953 if (!match)
5954 break;
5955 }
5956 return isEquidistant;
5957}
5958
5959////////////////////////////////////////////////////////////////////////////////
5960/// Same limits and bins.
5961
5963 return axis1.GetNbins() == axis2.GetNbins() &&
5964 TMath::AreEqualAbs(axis1.GetXmin(), axis2.GetXmin(), axis1.GetBinWidth(axis1.GetNbins()) * 1.E-10) &&
5965 TMath::AreEqualAbs(axis1.GetXmax(), axis2.GetXmax(), axis1.GetBinWidth(axis1.GetNbins()) * 1.E-10);
5966}
5967
5968////////////////////////////////////////////////////////////////////////////////
5969/// Finds new limits for the axis for the Merge function.
5970/// returns false if the limits are incompatible
5971
5973{
5975 return kTRUE;
5976
5978 return kFALSE; // not equidistant user binning not supported
5979
5980 Double_t width1 = destAxis.GetBinWidth(0);
5981 Double_t width2 = anAxis.GetBinWidth(0);
5982 if (width1 == 0 || width2 == 0)
5983 return kFALSE; // no binning not supported
5984
5985 Double_t xmin = TMath::Min(destAxis.GetXmin(), anAxis.GetXmin());
5986 Double_t xmax = TMath::Max(destAxis.GetXmax(), anAxis.GetXmax());
5988
5989 // check the bin size
5991 return kFALSE;
5992
5993 // std::cout << "Find new limit using given axis " << anAxis.GetXmin() << " , " << anAxis.GetXmax() << " bin width " << width2 << std::endl;
5994 // std::cout << " and destination axis " << destAxis.GetXmin() << " , " << destAxis.GetXmax() << " bin width " << width1 << std::endl;
5995
5996
5997 // check the limits
5998 Double_t delta;
5999 delta = (destAxis.GetXmin() - xmin)/width1;
6000 if (!AlmostInteger(delta))
6001 xmin -= (TMath::Ceil(delta) - delta)*width1;
6002
6003 delta = (anAxis.GetXmin() - xmin)/width2;
6004 if (!AlmostInteger(delta))
6005 xmin -= (TMath::Ceil(delta) - delta)*width2;
6006
6007
6008 delta = (destAxis.GetXmin() - xmin)/width1;
6009 if (!AlmostInteger(delta))
6010 return kFALSE;
6011
6012
6013 delta = (xmax - destAxis.GetXmax())/width1;
6014 if (!AlmostInteger(delta))
6015 xmax += (TMath::Ceil(delta) - delta)*width1;
6016
6017
6018 delta = (xmax - anAxis.GetXmax())/width2;
6019 if (!AlmostInteger(delta))
6020 xmax += (TMath::Ceil(delta) - delta)*width2;
6021
6022
6023 delta = (xmax - destAxis.GetXmax())/width1;
6024 if (!AlmostInteger(delta))
6025 return kFALSE;
6026#ifdef DEBUG
6027 if (!AlmostInteger((xmax - xmin) / width)) { // unnecessary check
6028 printf("TH1::RecomputeAxisLimits - Impossible\n");
6029 return kFALSE;
6030 }
6031#endif
6032
6033
6035
6036 //std::cout << "New re-computed axis : [ " << xmin << " , " << xmax << " ] width = " << width << " nbins " << destAxis.GetNbins() << std::endl;
6037
6038 return kTRUE;
6039}
6040
6041////////////////////////////////////////////////////////////////////////////////
6042/// Add all histograms in the collection to this histogram.
6043/// This function computes the min/max for the x axis,
6044/// compute a new number of bins, if necessary,
6045/// add bin contents, errors and statistics.
6046/// If all histograms have bin labels, bins with identical labels
6047/// will be merged, no matter what their order is.
6048/// If overflows are present and limits are different the function will fail.
6049/// The function returns the total number of entries in the result histogram
6050/// if the merge is successful, -1 otherwise.
6051///
6052/// Possible option:
6053/// -NOL : the merger will ignore the labels and merge the histograms bin by bin using bin center values to match bins
6054/// -NOCHECK: the histogram will not perform a check for duplicate labels in case of axes with labels. The check
6055/// (enabled by default) slows down the merging
6056///
6057/// IMPORTANT remark. The axis x may have different number
6058/// of bins and different limits, BUT the largest bin width must be
6059/// a multiple of the smallest bin width and the upper limit must also
6060/// be a multiple of the bin width.
6061/// Example:
6062///
6063/// ~~~ {.cpp}
6064/// void atest() {
6065/// TH1F *h1 = new TH1F("h1","h1",110,-110,0);
6066/// TH1F *h2 = new TH1F("h2","h2",220,0,110);
6067/// TH1F *h3 = new TH1F("h3","h3",330,-55,55);
6068/// TRandom r;
6069/// for (Int_t i=0;i<10000;i++) {
6070/// h1->Fill(r.Gaus(-55,10));
6071/// h2->Fill(r.Gaus(55,10));
6072/// h3->Fill(r.Gaus(0,10));
6073/// }
6074///
6075/// TList *list = new TList;
6076/// list->Add(h1);
6077/// list->Add(h2);
6078/// list->Add(h3);
6079/// TH1F *h = (TH1F*)h1->Clone("h");
6080/// h->Reset();
6081/// h->Merge(list);
6082/// h->Draw();
6083/// }
6084/// ~~~
6085
6087{
6088 if (!li) return 0;
6089 if (li->IsEmpty()) return (Long64_t) GetEntries();
6090
6091 // use TH1Merger class
6092 TH1Merger merger(*this,*li,opt);
6093 Bool_t ret = merger();
6094
6095 return (ret) ? GetEntries() : -1;
6096}
6097
6098
6099////////////////////////////////////////////////////////////////////////////////
6100/// Performs the operation:
6101///
6102/// `this = this*c1*f1`
6103///
6104/// If errors are defined (see TH1::Sumw2), errors are also recalculated.
6105///
6106/// Only bins inside the function range are recomputed.
6107/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6108/// you should call Sumw2 before making this operation.
6109/// This is particularly important if you fit the histogram after TH1::Multiply
6110///
6111/// The function return kFALSE if the Multiply operation failed
6112
6114{
6115 if (!f1) {
6116 Error("Multiply","Attempt to multiply by a non-existing function");
6117 return kFALSE;
6118 }
6119
6120 // delete buffer if it is there since it will become invalid
6121 if (fBuffer) BufferEmpty(1);
6122
6123 Int_t nx = GetNbinsX() + 2; // normal bins + uf / of (cells)
6124 Int_t ny = GetNbinsY() + 2;
6125 Int_t nz = GetNbinsZ() + 2;
6126 if (fDimension < 2) ny = 1;
6127 if (fDimension < 3) nz = 1;
6128
6129 // reset min-maximum
6130 SetMinimum();
6131 SetMaximum();
6132
6133 // - Loop on bins (including underflows/overflows)
6134 Double_t xx[3];
6135 Double_t *params = nullptr;
6136 f1->InitArgs(xx,params);
6137
6138 for (Int_t binz = 0; binz < nz; ++binz) {
6139 xx[2] = fZaxis.GetBinCenter(binz);
6140 for (Int_t biny = 0; biny < ny; ++biny) {
6141 xx[1] = fYaxis.GetBinCenter(biny);
6142 for (Int_t binx = 0; binx < nx; ++binx) {
6143 xx[0] = fXaxis.GetBinCenter(binx);
6144 if (!f1->IsInside(xx)) continue;
6146 Int_t bin = binx + nx * (biny + ny *binz);
6147 Double_t cu = c1*f1->EvalPar(xx);
6148 if (TF1::RejectedPoint()) continue;
6150 if (fSumw2.fN) {
6151 fSumw2.fArray[bin] = cu * cu * GetBinErrorSqUnchecked(bin);
6152 }
6153 }
6154 }
6155 }
6156 ResetStats();
6157 return kTRUE;
6158}
6159
6160////////////////////////////////////////////////////////////////////////////////
6161/// Multiply this histogram by h1.
6162///
6163/// `this = this*h1`
6164///
6165/// If errors of this are available (TH1::Sumw2), errors are recalculated.
6166/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
6167/// if not already set.
6168///
6169/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6170/// you should call Sumw2 before making this operation.
6171/// This is particularly important if you fit the histogram after TH1::Multiply
6172///
6173/// The function return kFALSE if the Multiply operation failed
6174
6175Bool_t TH1::Multiply(const TH1 *h1)
6176{
6177 if (!h1) {
6178 Error("Multiply","Attempt to multiply by a non-existing histogram");
6179 return kFALSE;
6180 }
6181
6182 // delete buffer if it is there since it will become invalid
6183 if (fBuffer) BufferEmpty(1);
6184
6185 if (LoggedInconsistency("Multiply", this, h1) >= kDifferentNumberOfBins) {
6186 return false;
6187 }
6188
6189 // Create Sumw2 if h1 has Sumw2 set
6190 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
6191
6192 // - Reset min- maximum
6193 SetMinimum();
6194 SetMaximum();
6195
6196 // - Loop on bins (including underflows/overflows)
6197 for (Int_t i = 0; i < fNcells; ++i) {
6200 UpdateBinContent(i, c0 * c1);
6201 if (fSumw2.fN) {
6203 }
6204 }
6205 ResetStats();
6206 return kTRUE;
6207}
6208
6209////////////////////////////////////////////////////////////////////////////////
6210/// Replace contents of this histogram by multiplication of h1 by h2.
6211///
6212/// `this = (c1*h1)*(c2*h2)`
6213///
6214/// If errors of this are available (TH1::Sumw2), errors are recalculated.
6215/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
6216/// if not already set.
6217///
6218/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6219/// you should call Sumw2 before making this operation.
6220/// This is particularly important if you fit the histogram after TH1::Multiply
6221///
6222/// The function return kFALSE if the Multiply operation failed
6223
6225{
6226 TString opt = option;
6227 opt.ToLower();
6228 // Bool_t binomial = kFALSE;
6229 // if (opt.Contains("b")) binomial = kTRUE;
6230 if (!h1 || !h2) {
6231 Error("Multiply","Attempt to multiply by a non-existing histogram");
6232 return kFALSE;
6233 }
6234
6235 // delete buffer if it is there since it will become invalid
6236 if (fBuffer) BufferEmpty(1);
6237
6238 if (LoggedInconsistency("Multiply", this, h1) >= kDifferentNumberOfBins ||
6239 LoggedInconsistency("Multiply", h1, h2) >= kDifferentNumberOfBins) {
6240 return false;
6241 }
6242
6243 // Create Sumw2 if h1 or h2 have Sumw2 set
6244 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0)) Sumw2();
6245
6246 // - Reset min - maximum
6247 SetMinimum();
6248 SetMaximum();
6249
6250 // - Loop on bins (including underflows/overflows)
6251 Double_t c1sq = c1 * c1; Double_t c2sq = c2 * c2;
6252 for (Int_t i = 0; i < fNcells; ++i) {
6254 Double_t b2 = h2->RetrieveBinContent(i);
6255 UpdateBinContent(i, c1 * b1 * c2 * b2);
6256 if (fSumw2.fN) {
6257 fSumw2.fArray[i] = c1sq * c2sq * (h1->GetBinErrorSqUnchecked(i) * b2 * b2 + h2->GetBinErrorSqUnchecked(i) * b1 * b1);
6258 }
6259 }
6260 ResetStats();
6261 return kTRUE;
6262}
6263
6264////////////////////////////////////////////////////////////////////////////////
6265/// @brief Normalize a histogram to its integral or to its maximum.
6266/// @note Works for TH1, TH2, TH3, ...
6267/// @param option: normalization strategy ("", "max" or "sum")
6268/// - "": Scale to `1/(sum*bin_width)`.
6269/// - max: Scale to `1/GetMaximum()`
6270/// - sum: Scale to `1/sum`.
6271///
6272/// In case the norm is zero, it raises an error.
6273/// @sa https://root-forum.cern.ch/t/different-ways-of-normalizing-histograms/15582/
6274
6276{
6277 TString opt = option;
6278 opt.ToLower();
6279 if (!opt.IsNull() && (opt != "max") && (opt != "sum")) {
6280 Error("Normalize", "Unrecognized option %s", option);
6281 return;
6282 }
6283
6284 const Double_t norm = (opt == "max") ? GetMaximum() : Integral(opt.IsNull() ? "width" : "");
6285
6286 if (norm == 0) {
6287 Error("Normalize", "Attempt to normalize histogram with zero integral");
6288 } else {
6289 Scale(1.0 / norm, "");
6290 // An alternative could have been to call Integral("") and Scale(1/norm, "width"), but this
6291 // will lead to a different value of GetEntries.
6292 // Instead, doing simultaneously Integral("width") and Scale(1/norm, "width") leads to an error since you are
6293 // dividing twice by bin width.
6294 }
6295}
6296
6297////////////////////////////////////////////////////////////////////////////////
6298/// Control routine to paint any kind of histograms.
6299///
6300/// This function is automatically called by TCanvas::Update.
6301/// (see TH1::Draw for the list of options)
6302
6304{
6306
6307 if (fPainter) {
6308 if (option && strlen(option) > 0)
6310 else
6312 }
6313}
6314
6315////////////////////////////////////////////////////////////////////////////////
6316/// Rebin this histogram
6317///
6318/// #### case 1 xbins=0
6319///
6320/// If newname is blank (default), the current histogram is modified and
6321/// a pointer to it is returned.
6322///
6323/// If newname is not blank, the current histogram is not modified, and a
6324/// new histogram is returned which is a Clone of the current histogram
6325/// with its name set to newname.
6326///
6327/// The parameter ngroup indicates how many bins of this have to be merged
6328/// into one bin of the result.
6329///
6330/// If the original histogram has errors stored (via Sumw2), the resulting
6331/// histograms has new errors correctly calculated.
6332///
6333/// examples: if h1 is an existing TH1F histogram with 100 bins
6334///
6335/// ~~~ {.cpp}
6336/// h1->Rebin(); //merges two bins in one in h1: previous contents of h1 are lost
6337/// h1->Rebin(5); //merges five bins in one in h1
6338/// TH1F *hnew = dynamic_cast<TH1F*>(h1->Rebin(5,"hnew")); // creates a new histogram hnew
6339/// // merging 5 bins of h1 in one bin
6340/// ~~~
6341///
6342/// NOTE: If ngroup is not an exact divider of the number of bins,
6343/// the top limit of the rebinned histogram is reduced
6344/// to the upper edge of the last bin that can make a complete
6345/// group. The remaining bins are added to the overflow bin.
6346/// Statistics will be recomputed from the new bin contents.
6347///
6348/// #### case 2 xbins!=0
6349///
6350/// A new histogram is created (you should specify newname).
6351/// The parameter ngroup is the number of variable size bins in the created histogram.
6352/// The array xbins must contain ngroup+1 elements that represent the low-edges
6353/// of the bins.
6354/// If the original histogram has errors stored (via Sumw2), the resulting
6355/// histograms has new errors correctly calculated.
6356///
6357/// NOTE: The bin edges specified in xbins should correspond to bin edges
6358/// in the original histogram. If a bin edge in the new histogram is
6359/// in the middle of a bin in the original histogram, all entries in
6360/// the split bin in the original histogram will be transferred to the
6361/// lower of the two possible bins in the new histogram. This is
6362/// probably not what you want. A warning message is emitted in this
6363/// case
6364///
6365/// examples: if h1 is an existing TH1F histogram with 100 bins
6366///
6367/// ~~~ {.cpp}
6368/// Double_t xbins[25] = {...} array of low-edges (xbins[25] is the upper edge of last bin
6369/// h1->Rebin(24,"hnew",xbins); //creates a new variable bin size histogram hnew
6370/// ~~~
6371
6372TH1 *TH1::Rebin(Int_t ngroup, const char*newname, const Double_t *xbins)
6373{
6374 Int_t nbins = fXaxis.GetNbins();
6377 if ((ngroup <= 0) || (ngroup > nbins)) {
6378 Error("Rebin", "Illegal value of ngroup=%d",ngroup);
6379 return nullptr;
6380 }
6381
6382 if (fDimension > 1 || InheritsFrom(TProfile::Class())) {
6383 Error("Rebin", "Operation valid on 1-D histograms only");
6384 return nullptr;
6385 }
6386 if (!newname && xbins) {
6387 Error("Rebin","if xbins is specified, newname must be given");
6388 return nullptr;
6389 }
6390
6391 Int_t newbins = nbins/ngroup;
6392 if (!xbins) {
6393 Int_t nbg = nbins/ngroup;
6394 if (nbg*ngroup != nbins) {
6395 Warning("Rebin", "ngroup=%d is not an exact divider of nbins=%d.",ngroup,nbins);
6396 }
6397 }
6398 else {
6399 // in the case that xbins is given (rebinning in variable bins), ngroup is
6400 // the new number of bins and number of grouped bins is not constant.
6401 // when looping for setting the contents for the new histogram we
6402 // need to loop on all bins of original histogram. Then set ngroup=nbins
6403 newbins = ngroup;
6404 ngroup = nbins;
6405 }
6406
6407 // Save old bin contents into a new array
6408 Double_t entries = fEntries;
6409 Double_t *oldBins = new Double_t[nbins+2];
6410 Int_t bin, i;
6411 for (bin=0;bin<nbins+2;bin++) oldBins[bin] = RetrieveBinContent(bin);
6412 Double_t *oldErrors = nullptr;
6413 if (fSumw2.fN != 0) {
6414 oldErrors = new Double_t[nbins+2];
6415 for (bin=0;bin<nbins+2;bin++) oldErrors[bin] = GetBinError(bin);
6416 }
6417 // rebin will not include underflow/overflow if new axis range is larger than old axis range
6418 if (xbins) {
6419 if (xbins[0] < fXaxis.GetXmin() && oldBins[0] != 0 )
6420 Warning("Rebin","underflow entries will not be used when rebinning");
6421 if (xbins[newbins] > fXaxis.GetXmax() && oldBins[nbins+1] != 0 )
6422 Warning("Rebin","overflow entries will not be used when rebinning");
6423 }
6424
6425
6426 // create a clone of the old histogram if newname is specified
6427 TH1 *hnew = this;
6428 if ((newname && strlen(newname) > 0) || xbins) {
6429 hnew = (TH1*)Clone(newname);
6430 }
6431
6432 //reset can extend bit to avoid an axis extension in SetBinContent
6433 UInt_t oldExtendBitMask = hnew->SetCanExtend(kNoAxis);
6434
6435 // save original statistics
6436 Double_t stat[kNstat];
6437 GetStats(stat);
6438 bool resetStat = false;
6439 // change axis specs and rebuild bin contents array::RebinAx
6440 if(!xbins && (newbins*ngroup != nbins)) {
6442 resetStat = true; //stats must be reset because top bins will be moved to overflow bin
6443 }
6444 // save the TAttAxis members (reset by SetBins)
6456
6457 if(!xbins && (fXaxis.GetXbins()->GetSize() > 0)){ // variable bin sizes
6458 Double_t *bins = new Double_t[newbins+1];
6459 for(i = 0; i <= newbins; ++i) bins[i] = fXaxis.GetBinLowEdge(1+i*ngroup);
6460 hnew->SetBins(newbins,bins); //this also changes errors array (if any)
6461 delete [] bins;
6462 } else if (xbins) {
6463 hnew->SetBins(newbins,xbins);
6464 } else {
6465 hnew->SetBins(newbins,xmin,xmax);
6466 }
6467
6468 // Restore axis attributes
6480
6481 // copy merged bin contents (ignore under/overflows)
6482 // Start merging only once the new lowest edge is reached
6483 Int_t startbin = 1;
6484 const Double_t newxmin = hnew->GetXaxis()->GetBinLowEdge(1);
6485 while( fXaxis.GetBinCenter(startbin) < newxmin && startbin <= nbins ) {
6486 startbin++;
6487 }
6490 for (bin = 1;bin<=newbins;bin++) {
6491 binContent = 0;
6492 binError = 0;
6493 Int_t imax = ngroup;
6494 Double_t xbinmax = hnew->GetXaxis()->GetBinUpEdge(bin);
6495 // check bin edges for the cases when we provide an array of bins
6496 // be careful in case bins can have zero width
6498 hnew->GetXaxis()->GetBinLowEdge(bin),
6499 TMath::Max(1.E-8 * fXaxis.GetBinWidth(oldbin), 1.E-16 )) )
6500 {
6501 Warning("Rebin","Bin edge %d of rebinned histogram does not match any bin edges of the old histogram. Result can be inconsistent",bin);
6502 }
6503 for (i=0;i<ngroup;i++) {
6504 if( (oldbin+i > nbins) ||
6505 ( hnew != this && (fXaxis.GetBinCenter(oldbin+i) > xbinmax)) ) {
6506 imax = i;
6507 break;
6508 }
6511 }
6512 hnew->SetBinContent(bin,binContent);
6513 if (oldErrors) hnew->SetBinError(bin,TMath::Sqrt(binError));
6514 oldbin += imax;
6515 }
6516
6517 // sum underflow and overflow contents until startbin
6518 binContent = 0;
6519 binError = 0;
6520 for (i = 0; i < startbin; ++i) {
6521 binContent += oldBins[i];
6522 if (oldErrors) binError += oldErrors[i]*oldErrors[i];
6523 }
6524 hnew->SetBinContent(0,binContent);
6525 if (oldErrors) hnew->SetBinError(0,TMath::Sqrt(binError));
6526 // sum overflow
6527 binContent = 0;
6528 binError = 0;
6529 for (i = oldbin; i <= nbins+1; ++i) {
6530 binContent += oldBins[i];
6531 if (oldErrors) binError += oldErrors[i]*oldErrors[i];
6532 }
6533 hnew->SetBinContent(newbins+1,binContent);
6534 if (oldErrors) hnew->SetBinError(newbins+1,TMath::Sqrt(binError));
6535
6536 hnew->SetCanExtend(oldExtendBitMask); // restore previous state
6537
6538 // restore statistics and entries modified by SetBinContent
6539 hnew->SetEntries(entries);
6540 if (!resetStat) hnew->PutStats(stat);
6541 delete [] oldBins;
6542 if (oldErrors) delete [] oldErrors;
6543 return hnew;
6544}
6545
6546////////////////////////////////////////////////////////////////////////////////
6547/// finds new limits for the axis so that *point* is within the range and
6548/// the limits are compatible with the previous ones (see TH1::Merge).
6549/// new limits are put into *newMin* and *newMax* variables.
6550/// axis - axis whose limits are to be recomputed
6551/// point - point that should fit within the new axis limits
6552/// newMin - new minimum will be stored here
6553/// newMax - new maximum will be stored here.
6554/// false if failed (e.g. if the initial axis limits are wrong
6555/// or the new range is more than \f$ 2^{64} \f$ times the old one).
6556
6558{
6559 Double_t xmin = axis->GetXmin();
6560 Double_t xmax = axis->GetXmax();
6561 if (xmin >= xmax) return kFALSE;
6563
6564 //recompute new axis limits by doubling the current range
6565 Int_t ntimes = 0;
6566 while (point < xmin) {
6567 if (ntimes++ > 64)
6568 return kFALSE;
6569 xmin = xmin - range;
6570 range *= 2;
6571 }
6572 while (point >= xmax) {
6573 if (ntimes++ > 64)
6574 return kFALSE;
6575 xmax = xmax + range;
6576 range *= 2;
6577 }
6578 newMin = xmin;
6579 newMax = xmax;
6580 // Info("FindNewAxisLimits", "OldAxis: (%lf, %lf), new: (%lf, %lf), point: %lf",
6581 // axis->GetXmin(), axis->GetXmax(), xmin, xmax, point);
6582
6583 return kTRUE;
6584}
6585
6586////////////////////////////////////////////////////////////////////////////////
6587/// Histogram is resized along axis such that x is in the axis range.
6588/// The new axis limits are recomputed by doubling iteratively
6589/// the current axis range until the specified value x is within the limits.
6590/// The algorithm makes a copy of the histogram, then loops on all bins
6591/// of the old histogram to fill the extended histogram.
6592/// Takes into account errors (Sumw2) if any.
6593/// The algorithm works for 1-d, 2-D and 3-D histograms.
6594/// The axis must be extendable before invoking this function.
6595/// Ex:
6596///
6597/// ~~~ {.cpp}
6598/// h->GetXaxis()->SetCanExtend(kTRUE);
6599/// ~~~
6600
6601void TH1::ExtendAxis(Double_t x, TAxis *axis)
6602{
6603 if (!axis->CanExtend()) return;
6604 if (TMath::IsNaN(x)) { // x may be a NaN
6606 return;
6607 }
6608
6609 if (axis->GetXmin() >= axis->GetXmax()) return;
6610 if (axis->GetNbins() <= 0) return;
6611
6613 if (!FindNewAxisLimits(axis, x, xmin, xmax))
6614 return;
6615
6616 //save a copy of this histogram
6617 TH1 *hold = (TH1*)IsA()->New();
6618 hold->SetDirectory(nullptr);
6619 Copy(*hold);
6620 //set new axis limits
6621 axis->SetLimits(xmin,xmax);
6622
6623
6624 //now loop on all bins and refill
6626
6627 Reset("ICE"); //reset only Integral, contents and Errors
6628
6629 int iaxis = 0;
6630 if (axis == &fXaxis) iaxis = 1;
6631 if (axis == &fYaxis) iaxis = 2;
6632 if (axis == &fZaxis) iaxis = 3;
6633 bool firstw = kTRUE;
6634 Int_t binx,biny, binz = 0;
6635 Int_t ix = 0,iy = 0,iz = 0;
6636 Double_t bx,by,bz;
6637 Int_t ncells = hold->GetNcells();
6638 for (Int_t bin = 0; bin < ncells; ++bin) {
6639 hold->GetBinXYZ(bin,binx,biny,binz);
6640 bx = hold->GetXaxis()->GetBinCenter(binx);
6641 ix = fXaxis.FindFixBin(bx);
6642 if (fDimension > 1) {
6643 by = hold->GetYaxis()->GetBinCenter(biny);
6644 iy = fYaxis.FindFixBin(by);
6645 if (fDimension > 2) {
6646 bz = hold->GetZaxis()->GetBinCenter(binz);
6647 iz = fZaxis.FindFixBin(bz);
6648 }
6649 }
6650 // exclude underflow/overflow
6651 double content = hold->RetrieveBinContent(bin);
6652 if (content == 0) continue;
6653 if (IsBinUnderflow(bin,iaxis) || IsBinOverflow(bin,iaxis) ) {
6654 if (firstw) {
6655 Warning("ExtendAxis","Histogram %s has underflow or overflow in the axis that is extendable"
6656 " their content will be lost",GetName() );
6657 firstw= kFALSE;
6658 }
6659 continue;
6660 }
6661 Int_t ibin= GetBin(ix,iy,iz);
6663 if (errors) {
6664 fSumw2.fArray[ibin] += hold->GetBinErrorSqUnchecked(bin);
6665 }
6666 }
6667 delete hold;
6668}
6669
6670////////////////////////////////////////////////////////////////////////////////
6671/// Recursively remove object from the list of functions
6672
6674{
6675 // Rely on TROOT::RecursiveRemove to take the readlock.
6676
6677 if (fFunctions) {
6679 }
6680}
6681
6682////////////////////////////////////////////////////////////////////////////////
6683/// Multiply this histogram by a constant c1.
6684///
6685/// `this = c1*this`
6686///
6687/// Note that both contents and errors (if any) are scaled.
6688/// This function uses the services of TH1::Add
6689///
6690/// IMPORTANT NOTE: Sumw2() is called automatically when scaling.
6691/// If you are not interested in the histogram statistics you can call
6692/// Sumw2(kFALSE) or use the option "nosw2"
6693///
6694/// One can scale a histogram such that the bins integral is equal to
6695/// the normalization parameter via TH1::Scale(Double_t norm), where norm
6696/// is the desired normalization divided by the integral of the histogram.
6697///
6698/// If option contains "width" the bin contents and errors are divided
6699/// by the bin width.
6700
6702{
6703
6704 TString opt = option; opt.ToLower();
6705 // store bin errors when scaling since cannot anymore be computed as sqrt(N)
6706 if (!opt.Contains("nosw2") && GetSumw2N() == 0) Sumw2();
6707 if (opt.Contains("width")) Add(this, this, c1, -1);
6708 else {
6709 if (fBuffer) BufferEmpty(1);
6710 for(Int_t i = 0; i < fNcells; ++i) UpdateBinContent(i, c1 * RetrieveBinContent(i));
6711 if (fSumw2.fN) for(Int_t i = 0; i < fNcells; ++i) fSumw2.fArray[i] *= (c1 * c1); // update errors
6712 // update global histograms statistics
6713 Double_t s[kNstat] = {0};
6714 GetStats(s);
6715 for (Int_t i=0 ; i < kNstat; i++) {
6716 if (i == 1) s[i] = c1*c1*s[i];
6717 else s[i] = c1*s[i];
6718 }
6719 PutStats(s);
6720 SetMinimum(); SetMaximum(); // minimum and maximum value will be recalculated the next time
6721 }
6722
6723 // if contours set, must also scale contours
6725 if (ncontours == 0) return;
6727 for (Int_t i = 0; i < ncontours; ++i) levels[i] *= c1;
6728}
6729
6730////////////////////////////////////////////////////////////////////////////////
6731/// Returns true if all axes are extendable.
6732
6734{
6736 if (GetDimension() > 1) canExtend &= fYaxis.CanExtend();
6737 if (GetDimension() > 2) canExtend &= fZaxis.CanExtend();
6738
6739 return canExtend;
6740}
6741
6742////////////////////////////////////////////////////////////////////////////////
6743/// Make the histogram axes extendable / not extendable according to the bit mask
6744/// returns the previous bit mask specifying which axes are extendable
6745
6747{
6749
6753
6754 if (GetDimension() > 1) {
6758 }
6759
6760 if (GetDimension() > 2) {
6764 }
6765
6766 return oldExtendBitMask;
6767}
6768
6769///////////////////////////////////////////////////////////////////////////////
6770/// Internal function used in TH1::Fill to see which axis is full alphanumeric,
6771/// i.e. can be extended and is alphanumeric
6773{
6777 bitMask |= kYaxis;
6779 bitMask |= kZaxis;
6780
6781 return bitMask;
6782}
6783
6784////////////////////////////////////////////////////////////////////////////////
6785/// Static function to set the default buffer size for automatic histograms.
6786/// When a histogram is created with one of its axis lower limit greater
6787/// or equal to its upper limit, the function SetBuffer is automatically
6788/// called with the default buffer size.
6789
6791{
6792 fgBufferSize = bufsize > 0 ? bufsize : 0;
6793}
6794
6795////////////////////////////////////////////////////////////////////////////////
6796/// When this static function is called with `sumw2=kTRUE`, all new
6797/// histograms will automatically activate the storage
6798/// of the sum of squares of errors, ie TH1::Sumw2 is automatically called.
6799
6801{
6803}
6804
6805////////////////////////////////////////////////////////////////////////////////
6806/// Change/set the title.
6807///
6808/// If title is in the form `stringt;stringx;stringy;stringz;stringc`
6809/// the histogram title is set to `stringt`, the x axis title to `stringx`,
6810/// the y axis title to `stringy`, the z axis title to `stringz`, and the c
6811/// axis title for the palette is ignored at this stage.
6812/// Note that you can use e.g. `stringt;stringx` if you only want to specify
6813/// title and x axis title.
6814///
6815/// To insert the character `;` in one of the titles, one should use `#;`
6816/// or `#semicolon`.
6817
6818void TH1::SetTitle(const char *title)
6819{
6820 fTitle = title;
6821 fTitle.ReplaceAll("#;",2,"#semicolon",10);
6822
6823 // Decode fTitle. It may contain X, Y and Z titles
6825 Int_t isc = str1.Index(";");
6826 Int_t lns = str1.Length();
6827
6828 if (isc >=0 ) {
6829 fTitle = str1(0,isc);
6830 str1 = str1(isc+1, lns);
6831 isc = str1.Index(";");
6832 if (isc >=0 ) {
6833 str2 = str1(0,isc);
6834 str2.ReplaceAll("#semicolon",10,";",1);
6835 fXaxis.SetTitle(str2.Data());
6836 lns = str1.Length();
6837 str1 = str1(isc+1, lns);
6838 isc = str1.Index(";");
6839 if (isc >=0 ) {
6840 str2 = str1(0,isc);
6841 str2.ReplaceAll("#semicolon",10,";",1);
6842 fYaxis.SetTitle(str2.Data());
6843 lns = str1.Length();
6844 str1 = str1(isc+1, lns);
6845 isc = str1.Index(";");
6846 if (isc >=0 ) {
6847 str2 = str1(0,isc);
6848 str2.ReplaceAll("#semicolon",10,";",1);
6849 fZaxis.SetTitle(str2.Data());
6850 } else {
6851 str1.ReplaceAll("#semicolon",10,";",1);
6852 fZaxis.SetTitle(str1.Data());
6853 }
6854 } else {
6855 str1.ReplaceAll("#semicolon",10,";",1);
6856 fYaxis.SetTitle(str1.Data());
6857 }
6858 } else {
6859 str1.ReplaceAll("#semicolon",10,";",1);
6860 fXaxis.SetTitle(str1.Data());
6861 }
6862 }
6863
6864 fTitle.ReplaceAll("#semicolon",10,";",1);
6865
6866 if (gPad && TestBit(kMustCleanup)) gPad->Modified();
6867}
6868
6869////////////////////////////////////////////////////////////////////////////////
6870/// Smooth array xx, translation of Hbook routine `hsmoof.F`.
6871/// Based on algorithm 353QH twice presented by J. Friedman
6872/// in [Proc. of the 1974 CERN School of Computing, Norway, 11-24 August, 1974](https://cds.cern.ch/record/186223).
6873/// See also Section 4.2 in [J. Friedman, Data Analysis Techniques for High Energy Physics](https://www.slac.stanford.edu/pubs/slacreports/reports16/slac-r-176.pdf).
6874
6876{
6877 if (nn < 3 ) {
6878 ::Error("SmoothArray","Need at least 3 points for smoothing: n = %d",nn);
6879 return;
6880 }
6881
6882 Int_t ii;
6883 std::array<double, 3> hh{};
6884
6885 std::vector<double> yy(nn);
6886 std::vector<double> zz(nn);
6887 std::vector<double> rr(nn);
6888
6889 for (Int_t pass=0;pass<ntimes;pass++) {
6890 // first copy original data into temp array
6891 std::copy(xx, xx+nn, zz.begin() );
6892
6893 for (int noent = 0; noent < 2; ++noent) { // run algorithm two times
6894
6895 // do 353 i.e. running median 3, 5, and 3 in a single loop
6896 for (int kk = 0; kk < 3; kk++) {
6897 std::copy(zz.begin(), zz.end(), yy.begin());
6898 int medianType = (kk != 1) ? 3 : 5;
6899 int ifirst = (kk != 1 ) ? 1 : 2;
6900 int ilast = (kk != 1 ) ? nn-1 : nn -2;
6901 //nn2 = nn - ik - 1;
6902 // do all elements beside the first and last point for median 3
6903 // and first two and last 2 for median 5
6904 for ( ii = ifirst; ii < ilast; ii++) {
6905 zz[ii] = TMath::Median(medianType, yy.data() + ii - ifirst);
6906 }
6907
6908 if (kk == 0) { // first median 3
6909 // first point
6910 hh[0] = zz[1];
6911 hh[1] = zz[0];
6912 hh[2] = 3*zz[1] - 2*zz[2];
6913 zz[0] = TMath::Median(3, hh.data());
6914 // last point
6915 hh[0] = zz[nn - 2];
6916 hh[1] = zz[nn - 1];
6917 hh[2] = 3*zz[nn - 2] - 2*zz[nn - 3];
6918 zz[nn - 1] = TMath::Median(3, hh.data());
6919 }
6920
6921 if (kk == 1) { // median 5
6922 // second point with window length 3
6923 zz[1] = TMath::Median(3, yy.data());
6924 // second-to-last point with window length 3
6925 zz[nn - 2] = TMath::Median(3, yy.data() + nn - 3);
6926 }
6927
6928 // In the third iteration (kk == 2), the first and last point stay
6929 // the same (see paper linked in the documentation).
6930 }
6931
6932 std::copy ( zz.begin(), zz.end(), yy.begin() );
6933
6934 // quadratic interpolation for flat segments
6935 for (ii = 2; ii < (nn - 2); ii++) {
6936 if (zz[ii - 1] != zz[ii]) continue;
6937 if (zz[ii] != zz[ii + 1]) continue;
6938 const double tmp0 = zz[ii - 2] - zz[ii];
6939 const double tmp1 = zz[ii + 2] - zz[ii];
6940 if (tmp0 * tmp1 <= 0) continue;
6941 int jk = 1;
6942 if ( std::abs(tmp1) > std::abs(tmp0) ) jk = -1;
6943 yy[ii] = -0.5*zz[ii - 2*jk] + zz[ii]/0.75 + zz[ii + 2*jk] /6.;
6944 yy[ii + jk] = 0.5*(zz[ii + 2*jk] - zz[ii - 2*jk]) + zz[ii];
6945 }
6946
6947 // running means
6948 //std::copy(zz.begin(), zz.end(), yy.begin());
6949 for (ii = 1; ii < nn - 1; ii++) {
6950 zz[ii] = 0.25*yy[ii - 1] + 0.5*yy[ii] + 0.25*yy[ii + 1];
6951 }
6952 zz[0] = yy[0];
6953 zz[nn - 1] = yy[nn - 1];
6954
6955 if (noent == 0) {
6956
6957 // save computed values
6958 std::copy(zz.begin(), zz.end(), rr.begin());
6959
6960 // COMPUTE residuals
6961 for (ii = 0; ii < nn; ii++) {
6962 zz[ii] = xx[ii] - zz[ii];
6963 }
6964 }
6965
6966 } // end loop on noent
6967
6968
6969 double xmin = TMath::MinElement(nn,xx);
6970 for (ii = 0; ii < nn; ii++) {
6971 if (xmin < 0) xx[ii] = rr[ii] + zz[ii];
6972 // make smoothing defined positive - not better using 0 ?
6973 else xx[ii] = std::max((rr[ii] + zz[ii]),0.0 );
6974 }
6975 }
6976}
6977
6978////////////////////////////////////////////////////////////////////////////////
6979/// Smooth bin contents of this histogram.
6980/// if option contains "R" smoothing is applied only to the bins
6981/// defined in the X axis range (default is to smooth all bins)
6982/// Bin contents are replaced by their smooth values.
6983/// Errors (if any) are not modified.
6984/// the smoothing procedure is repeated ntimes (default=1)
6985
6987{
6988 if (fDimension != 1) {
6989 Error("Smooth","Smooth only supported for 1-d histograms");
6990 return;
6991 }
6992 Int_t nbins = fXaxis.GetNbins();
6993 if (nbins < 3) {
6994 Error("Smooth","Smooth only supported for histograms with >= 3 bins. Nbins = %d",nbins);
6995 return;
6996 }
6997
6998 // delete buffer if it is there since it will become invalid
6999 if (fBuffer) BufferEmpty(1);
7000
7001 Int_t firstbin = 1, lastbin = nbins;
7002 TString opt = option;
7003 opt.ToLower();
7004 if (opt.Contains("r")) {
7007 }
7008 nbins = lastbin - firstbin + 1;
7009 Double_t *xx = new Double_t[nbins];
7011 Int_t i;
7012 for (i=0;i<nbins;i++) {
7014 }
7015
7016 TH1::SmoothArray(nbins,xx,ntimes);
7017
7018 for (i=0;i<nbins;i++) {
7020 }
7021 fEntries = nent;
7022 delete [] xx;
7023
7024 if (gPad) gPad->Modified();
7025}
7026
7027////////////////////////////////////////////////////////////////////////////////
7028/// if flag=kTRUE, underflows and overflows are used by the Fill functions
7029/// in the computation of statistics (mean value, StdDev).
7030/// By default, underflows or overflows are not used.
7031
7033{
7035}
7036
7037////////////////////////////////////////////////////////////////////////////////
7038/// Stream a class object.
7039
7040void TH1::Streamer(TBuffer &b)
7041{
7042 if (b.IsReading()) {
7043 UInt_t R__s, R__c;
7044 Version_t R__v = b.ReadVersion(&R__s, &R__c);
7045 if (fDirectory) fDirectory->Remove(this);
7046 fDirectory = nullptr;
7047 if (R__v > 2) {
7048 b.ReadClassBuffer(TH1::Class(), this, R__v, R__s, R__c);
7049
7051 fXaxis.SetParent(this);
7052 fYaxis.SetParent(this);
7053 fZaxis.SetParent(this);
7054 TIter next(fFunctions);
7055 TObject *obj;
7056 while ((obj=next())) {
7057 if (obj->InheritsFrom(TF1::Class())) ((TF1*)obj)->SetParent(this);
7058 }
7059 return;
7060 }
7061 //process old versions before automatic schema evolution
7066 b >> fNcells;
7067 fXaxis.Streamer(b);
7068 fYaxis.Streamer(b);
7069 fZaxis.Streamer(b);
7070 fXaxis.SetParent(this);
7071 fYaxis.SetParent(this);
7072 fZaxis.SetParent(this);
7073 b >> fBarOffset;
7074 b >> fBarWidth;
7075 b >> fEntries;
7076 b >> fTsumw;
7077 b >> fTsumw2;
7078 b >> fTsumwx;
7079 b >> fTsumwx2;
7080 if (R__v < 2) {
7082 Float_t *contour=nullptr;
7083 b >> maximum; fMaximum = maximum;
7084 b >> minimum; fMinimum = minimum;
7085 b >> norm; fNormFactor = norm;
7086 Int_t n = b.ReadArray(contour);
7087 fContour.Set(n);
7088 for (Int_t i=0;i<n;i++) fContour.fArray[i] = contour[i];
7089 delete [] contour;
7090 } else {
7091 b >> fMaximum;
7092 b >> fMinimum;
7093 b >> fNormFactor;
7095 }
7096 fSumw2.Streamer(b);
7098 fFunctions->Delete();
7100 b.CheckByteCount(R__s, R__c, TH1::IsA());
7101
7102 } else {
7103 b.WriteClassBuffer(TH1::Class(),this);
7104 }
7105}
7106
7107////////////////////////////////////////////////////////////////////////////////
7108/// Print some global quantities for this histogram.
7109/// \param[in] option
7110/// - "base" is given, number of bins and ranges are also printed
7111/// - "range" is given, bin contents and errors are also printed
7112/// for all bins in the current range (default 1-->nbins)
7113/// - "all" is given, bin contents and errors are also printed
7114/// for all bins including under and overflows.
7115
7116void TH1::Print(Option_t *option) const
7117{
7118 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
7119 printf( "TH1.Print Name = %s, Entries= %d, Total sum= %g\n",GetName(),Int_t(fEntries),GetSumOfWeights());
7120 TString opt = option;
7121 opt.ToLower();
7122 Int_t all;
7123 if (opt.Contains("all")) all = 0;
7124 else if (opt.Contains("range")) all = 1;
7125 else if (opt.Contains("base")) all = 2;
7126 else return;
7127
7128 Int_t bin, binx, biny, binz;
7130 if (all == 0) {
7131 lastx = fXaxis.GetNbins()+1;
7132 if (fDimension > 1) lasty = fYaxis.GetNbins()+1;
7133 if (fDimension > 2) lastz = fZaxis.GetNbins()+1;
7134 } else {
7136 if (fDimension > 1) {firsty = fYaxis.GetFirst(); lasty = fYaxis.GetLast();}
7137 if (fDimension > 2) {firstz = fZaxis.GetFirst(); lastz = fZaxis.GetLast();}
7138 }
7139
7140 if (all== 2) {
7141 printf(" Title = %s\n", GetTitle());
7142 printf(" NbinsX= %d, xmin= %g, xmax=%g", fXaxis.GetNbins(), fXaxis.GetXmin(), fXaxis.GetXmax());
7143 if( fDimension > 1) printf(", NbinsY= %d, ymin= %g, ymax=%g", fYaxis.GetNbins(), fYaxis.GetXmin(), fYaxis.GetXmax());
7144 if( fDimension > 2) printf(", NbinsZ= %d, zmin= %g, zmax=%g", fZaxis.GetNbins(), fZaxis.GetXmin(), fZaxis.GetXmax());
7145 printf("\n");
7146 return;
7147 }
7148
7149 Double_t w,e;
7150 Double_t x,y,z;
7151 if (fDimension == 1) {
7152 for (binx=firstx;binx<=lastx;binx++) {
7155 e = GetBinError(binx);
7156 if(fSumw2.fN) printf(" fSumw[%d]=%g, x=%g, error=%g\n",binx,w,x,e);
7157 else printf(" fSumw[%d]=%g, x=%g\n",binx,w,x);
7158 }
7159 }
7160 if (fDimension == 2) {
7161 for (biny=firsty;biny<=lasty;biny++) {
7163 for (binx=firstx;binx<=lastx;binx++) {
7164 bin = GetBin(binx,biny);
7166 w = RetrieveBinContent(bin);
7167 e = GetBinError(bin);
7168 if(fSumw2.fN) printf(" fSumw[%d][%d]=%g, x=%g, y=%g, error=%g\n",binx,biny,w,x,y,e);
7169 else printf(" fSumw[%d][%d]=%g, x=%g, y=%g\n",binx,biny,w,x,y);
7170 }
7171 }
7172 }
7173 if (fDimension == 3) {
7174 for (binz=firstz;binz<=lastz;binz++) {
7176 for (biny=firsty;biny<=lasty;biny++) {
7178 for (binx=firstx;binx<=lastx;binx++) {
7179 bin = GetBin(binx,biny,binz);
7181 w = RetrieveBinContent(bin);
7182 e = GetBinError(bin);
7183 if(fSumw2.fN) printf(" fSumw[%d][%d][%d]=%g, x=%g, y=%g, z=%g, error=%g\n",binx,biny,binz,w,x,y,z,e);
7184 else printf(" fSumw[%d][%d][%d]=%g, x=%g, y=%g, z=%g\n",binx,biny,binz,w,x,y,z);
7185 }
7186 }
7187 }
7188 }
7189}
7190
7191////////////////////////////////////////////////////////////////////////////////
7192/// Using the current bin info, recompute the arrays for contents and errors
7193
7194void TH1::Rebuild(Option_t *)
7195{
7196 SetBinsLength();
7197 if (fSumw2.fN) {
7199 }
7200}
7201
7202////////////////////////////////////////////////////////////////////////////////
7203/// Reset this histogram: contents, errors, etc.
7204/// \param[in] option
7205/// - if "ICE" is specified, resets only Integral, Contents and Errors.
7206/// - if "ICES" is specified, resets only Integral, Contents, Errors and Statistics
7207/// This option is used
7208/// - if "M" is specified, resets also Minimum and Maximum
7209
7211{
7212 // The option "ICE" is used when extending the histogram (in ExtendAxis, LabelInflate, etc..)
7213 // The option "ICES is used in combination with the buffer (see BufferEmpty and BufferFill)
7214
7215 TString opt = option;
7216 opt.ToUpper();
7217 fSumw2.Reset();
7218 if (fIntegral) {
7219 delete [] fIntegral;
7220 fIntegral = nullptr;
7221 }
7222
7223 if (opt.Contains("M")) {
7224 SetMinimum();
7225 SetMaximum();
7226 }
7227
7228 if (opt.Contains("ICE") && !opt.Contains("S")) return;
7229
7230 // Setting fBuffer[0] = 0 is like resetting the buffer but not deleting it
7231 // But what is the sense of calling BufferEmpty() ? For making the axes ?
7232 // BufferEmpty will update contents that later will be
7233 // reset in calling TH1D::Reset. For this we need to reset the stats afterwards
7234 // It may be needed for computing the axis limits....
7235 if (fBuffer) {BufferEmpty(); fBuffer[0] = 0;}
7236
7237 // need to reset also the statistics
7238 // (needs to be done after calling BufferEmpty() )
7239 fTsumw = 0;
7240 fTsumw2 = 0;
7241 fTsumwx = 0;
7242 fTsumwx2 = 0;
7243 fEntries = 0;
7244
7245 if (opt == "ICES") return;
7246
7247
7248 TObject *stats = fFunctions->FindObject("stats");
7249 fFunctions->Remove(stats);
7250 //special logic to support the case where the same object is
7251 //added multiple times in fFunctions.
7252 //This case happens when the same object is added with different
7253 //drawing modes
7254 TObject *obj;
7255 while ((obj = fFunctions->First())) {
7256 while(fFunctions->Remove(obj)) { }
7257 delete obj;
7258 }
7259 if(stats) fFunctions->Add(stats);
7260 fContour.Set(0);
7261}
7262
7263////////////////////////////////////////////////////////////////////////////////
7264/// Save the histogram as .csv, .tsv or .txt. In case of any other extension, fall
7265/// back to TObject::SaveAs, which saves as a .C macro (but with the file name
7266/// extension specified by the user)
7267///
7268/// The Under/Overflow bins are also exported (as first and last lines)
7269/// The fist 2 columns are the lower and upper edges of the bins
7270/// Column 3 contains the bin contents
7271/// The last column contains the error in y. If errors are not present, the column
7272/// is left empty
7273///
7274/// The result can be immediately imported into Excel, gnuplot, Python or whatever,
7275/// without the needing to install pyroot, etc.
7276///
7277/// \param filename the name of the file where to store the histogram
7278/// \param option some tuning options
7279///
7280/// The file extension defines the delimiter used:
7281/// - `.csv` : comma
7282/// - `.tsv` : tab
7283/// - `.txt` : space
7284///
7285/// If option = "title" a title line is generated. If the y-axis has a title,
7286/// this title is displayed as column 3 name, otherwise, it shows "BinContent"
7287
7288void TH1::SaveAs(const char *filename, Option_t *option) const
7289{
7290 char del = '\0';
7291 TString ext = "";
7293 TString opt = option;
7294
7295 if (filename) {
7296 if (fname.EndsWith(".csv")) {
7297 del = ',';
7298 ext = "csv";
7299 } else if (fname.EndsWith(".tsv")) {
7300 del = '\t';
7301 ext = "tsv";
7302 } else if (fname.EndsWith(".txt")) {
7303 del = ' ';
7304 ext = "txt";
7305 }
7306 }
7307 if (!del) {
7309 return;
7310 }
7311 std::ofstream out;
7312 out.open(filename, std::ios::out);
7313 if (!out.good()) {
7314 Error("SaveAs", "cannot open file: %s", filename);
7315 return;
7316 }
7317 if (opt.Contains("title")) {
7318 if (std::strcmp(GetYaxis()->GetTitle(), "") == 0) {
7319 out << "# " << "BinLowEdge" << del << "BinUpEdge" << del
7320 << "BinContent"
7321 << del << "ey" << std::endl;
7322 } else {
7323 out << "# " << "BinLowEdge" << del << "BinUpEdge" << del << GetYaxis()->GetTitle() << del << "ey" << std::endl;
7324 }
7325 }
7326 if (fSumw2.fN) {
7327 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
7328 out << GetXaxis()->GetBinLowEdge(i) << del << GetXaxis()->GetBinUpEdge(i) << del << GetBinContent(i) << del
7329 << GetBinError(i) << std::endl;
7330 }
7331 } else {
7332 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
7333 out << GetXaxis()->GetBinLowEdge(i) << del << GetXaxis()->GetBinUpEdge(i) << del << GetBinContent(i) << del
7334 << std::endl;
7335 }
7336 }
7337 out.close();
7338 Info("SaveAs", "%s file: %s has been generated", ext.Data(), filename);
7339}
7340
7341////////////////////////////////////////////////////////////////////////////////
7342/// Provide variable name for histogram for saving as primitive
7343/// Histogram pointer has by default the histogram name with an incremental suffix.
7344/// If the histogram belongs to a graph or a stack the suffix is not added because
7345/// the graph and stack objects are not aware of this new name. Same thing if
7346/// the histogram is drawn with the option COLZ because the TPaletteAxis drawn
7347/// when this option is selected, does not know this new name either.
7348
7350{
7351 thread_local Int_t storeNumber = 0;
7352
7353 TString opt = option;
7354 opt.ToLower();
7355 TString histName = GetName();
7356 // for TProfile and TH2Poly also fDirectory should be tested
7357 if (!histName.Contains("Graph") && !histName.Contains("_stack_") && !opt.Contains("colz") &&
7358 (!testfdir || !fDirectory)) {
7359 storeNumber++;
7360 histName += "__";
7361 histName += storeNumber;
7362 }
7363 if (histName.IsNull())
7364 histName = "unnamed";
7365 return gInterpreter->MapCppName(histName);
7366}
7367
7368////////////////////////////////////////////////////////////////////////////////
7369/// Save primitive as a C++ statement(s) on output stream out
7370
7371void TH1::SavePrimitive(std::ostream &out, Option_t *option /*= ""*/)
7372{
7373 // empty the buffer before if it exists
7374 if (fBuffer)
7375 BufferEmpty();
7376
7378
7381 SetName(hname);
7382
7383 out <<" \n";
7384
7385 // Check if the histogram has equidistant X bins or not. If not, we
7386 // create an array holding the bins.
7387 if (GetXaxis()->GetXbins()->fN && GetXaxis()->GetXbins()->fArray)
7388 sxaxis = SavePrimitiveVector(out, hname + "_x", GetXaxis()->GetXbins()->fN, GetXaxis()->GetXbins()->fArray);
7389 // If the histogram is 2 or 3 dimensional, check if the histogram
7390 // has equidistant Y bins or not. If not, we create an array
7391 // holding the bins.
7392 if (fDimension > 1 && GetYaxis()->GetXbins()->fN && GetYaxis()->GetXbins()->fArray)
7393 syaxis = SavePrimitiveVector(out, hname + "_y", GetYaxis()->GetXbins()->fN, GetYaxis()->GetXbins()->fArray);
7394 // IF the histogram is 3 dimensional, check if the histogram
7395 // has equidistant Z bins or not. If not, we create an array
7396 // holding the bins.
7397 if (fDimension > 2 && GetZaxis()->GetXbins()->fN && GetZaxis()->GetXbins()->fArray)
7398 szaxis = SavePrimitiveVector(out, hname + "_z", GetZaxis()->GetXbins()->fN, GetZaxis()->GetXbins()->fArray);
7399
7400 const auto old_precision{out.precision()};
7401 constexpr auto max_precision{std::numeric_limits<double>::digits10 + 1};
7402 out << std::setprecision(max_precision);
7403
7404 out << " " << ClassName() << " *" << hname << " = new " << ClassName() << "(\"" << TString(savedName).ReplaceSpecialCppChars() << "\", \""
7405 << TString(GetTitle()).ReplaceSpecialCppChars() << "\", " << GetXaxis()->GetNbins();
7406 if (!sxaxis.IsNull())
7407 out << ", " << sxaxis << ".data()";
7408 else
7409 out << ", " << GetXaxis()->GetXmin() << ", " << GetXaxis()->GetXmax();
7410 if (fDimension > 1) {
7411 out << ", " << GetYaxis()->GetNbins();
7412 if (!syaxis.IsNull())
7413 out << ", " << syaxis << ".data()";
7414 else
7415 out << ", " << GetYaxis()->GetXmin() << ", " << GetYaxis()->GetXmax();
7416 }
7417 if (fDimension > 2) {
7418 out << ", " << GetZaxis()->GetNbins();
7419 if (!szaxis.IsNull())
7420 out << ", " << szaxis << ".data()";
7421 else
7422 out << ", " << GetZaxis()->GetXmin() << ", " << GetZaxis()->GetXmax();
7423 }
7424 out << ");\n";
7425
7427 Int_t numbins = 0, numerrors = 0;
7428
7429 std::vector<Double_t> content(fNcells), errors(save_errors ? fNcells : 0);
7430 for (Int_t bin = 0; bin < fNcells; bin++) {
7431 content[bin] = RetrieveBinContent(bin);
7432 if (content[bin])
7433 numbins++;
7434 if (save_errors) {
7435 errors[bin] = GetBinError(bin);
7436 if (errors[bin])
7437 numerrors++;
7438 }
7439 }
7440
7441 if ((numbins < 100) && (numerrors < 100)) {
7442 // in case of few non-empty bins store them as before
7443 for (Int_t bin = 0; bin < fNcells; bin++) {
7444 if (content[bin])
7445 out << " " << hname << "->SetBinContent(" << bin << "," << content[bin] << ");\n";
7446 }
7447 if (save_errors)
7448 for (Int_t bin = 0; bin < fNcells; bin++) {
7449 if (errors[bin])
7450 out << " " << hname << "->SetBinError(" << bin << "," << errors[bin] << ");\n";
7451 }
7452 } else {
7453 if (numbins > 0) {
7455 out << " for (Int_t bin = 0; bin < " << fNcells << "; bin++)\n";
7456 out << " if (" << vectname << "[bin])\n";
7457 out << " " << hname << "->SetBinContent(bin, " << vectname << "[bin]);\n";
7458 }
7459 if (numerrors > 0) {
7461 out << " for (Int_t bin = 0; bin < " << fNcells << "; bin++)\n";
7462 out << " if (" << vectname << "[bin])\n";
7463 out << " " << hname << "->SetBinError(bin, " << vectname << "[bin]);\n";
7464 }
7465 }
7466
7468 out << std::setprecision(old_precision);
7469 SetName(savedName.Data());
7470}
7471
7472////////////////////////////////////////////////////////////////////////////////
7473/// Helper function for the SavePrimitive functions from TH1
7474/// or classes derived from TH1, eg TProfile, TProfile2D.
7475
7476void TH1::SavePrimitiveHelp(std::ostream &out, const char *hname, Option_t *option /*= ""*/)
7477{
7478 if (TMath::Abs(GetBarOffset()) > 1e-5)
7479 out << " " << hname << "->SetBarOffset(" << GetBarOffset() << ");\n";
7480 if (TMath::Abs(GetBarWidth() - 1) > 1e-5)
7481 out << " " << hname << "->SetBarWidth(" << GetBarWidth() << ");\n";
7482 if (fMinimum != -1111)
7483 out << " " << hname << "->SetMinimum(" << fMinimum << ");\n";
7484 if (fMaximum != -1111)
7485 out << " " << hname << "->SetMaximum(" << fMaximum << ");\n";
7486 if (fNormFactor != 0)
7487 out << " " << hname << "->SetNormFactor(" << fNormFactor << ");\n";
7488 if (fEntries != 0)
7489 out << " " << hname << "->SetEntries(" << fEntries << ");\n";
7490 if (!fDirectory)
7491 out << " " << hname << "->SetDirectory(nullptr);\n";
7492 if (TestBit(kNoStats))
7493 out << " " << hname << "->SetStats(0);\n";
7494 if (fOption.Length() != 0)
7495 out << " " << hname << "->SetOption(\n" << TString(fOption).ReplaceSpecialCppChars() << "\");\n";
7496
7497 // save contour levels
7499 if (ncontours > 0) {
7501 if (TestBit(kUserContour)) {
7502 std::vector<Double_t> levels(ncontours);
7503 for (Int_t bin = 0; bin < ncontours; bin++)
7504 levels[bin] = GetContourLevel(bin);
7506 }
7507 out << " " << hname << "->SetContour(" << ncontours;
7508 if (!vectname.IsNull())
7509 out << ", " << vectname << ".data()";
7510 out << ");\n";
7511 }
7512
7514
7515 // save attributes
7516 SaveFillAttributes(out, hname, -1, -1);
7517 SaveLineAttributes(out, hname, 1, 1, 1);
7518 SaveMarkerAttributes(out, hname, 1, 1, 1);
7519 fXaxis.SaveAttributes(out, hname, "->GetXaxis()");
7520 fYaxis.SaveAttributes(out, hname, "->GetYaxis()");
7521 fZaxis.SaveAttributes(out, hname, "->GetZaxis()");
7522
7524}
7525
7526////////////////////////////////////////////////////////////////////////////////
7527/// Save list of functions
7528/// Also can be used by TGraph classes
7529
7530void TH1::SavePrimitiveFunctions(std::ostream &out, const char *varname, TList *lst)
7531{
7532 thread_local Int_t funcNumber = 0;
7533
7534 TObjLink *lnk = lst ? lst->FirstLink() : nullptr;
7535 while (lnk) {
7536 auto obj = lnk->GetObject();
7537 obj->SavePrimitive(out, TString::Format("nodraw #%d\n", ++funcNumber).Data());
7538 TString objvarname = obj->GetName();
7540 if (obj->InheritsFrom(TF1::Class())) {
7542 objvarname = gInterpreter->MapCppName(objvarname);
7543 out << " " << objvarname << "->SetParent(" << varname << ");\n";
7544 } else if (obj->InheritsFrom("TPaveStats")) {
7545 objvarname = "ptstats";
7546 withopt = kFALSE; // pave stats preserve own draw options
7547 out << " " << objvarname << "->SetParent(" << varname << ");\n";
7548 } else if (obj->InheritsFrom("TPolyMarker")) {
7549 objvarname = "pmarker";
7550 }
7551
7552 out << " " << varname << "->GetListOfFunctions()->Add(" << objvarname;
7553 if (withopt)
7554 out << ",\"" << TString(lnk->GetOption()).ReplaceSpecialCppChars() << "\"";
7555 out << ");\n";
7556
7557 lnk = lnk->Next();
7558 }
7559}
7560
7561////////////////////////////////////////////////////////////////////////////////
7602 }
7603}
7604
7605////////////////////////////////////////////////////////////////////////////////
7606/// For axis = 1,2 or 3 returns the mean value of the histogram along
7607/// X,Y or Z axis.
7608///
7609/// For axis = 11, 12, 13 returns the standard error of the mean value
7610/// of the histogram along X, Y or Z axis
7611///
7612/// Note that the mean value/StdDev is computed using the bins in the currently
7613/// defined range (see TAxis::SetRange). By default the range includes
7614/// all bins from 1 to nbins included, excluding underflows and overflows.
7615/// To force the underflows and overflows in the computation, one must
7616/// call the static function TH1::StatOverflows(kTRUE) before filling
7617/// the histogram.
7618///
7619/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7620/// are calculated. By default, if no range has been set, the returned mean is
7621/// the (unbinned) one calculated at fill time. If a range has been set, however,
7622/// the mean is calculated using the bins in range, as described above; THIS
7623/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7624/// the range. To ensure that the returned mean (and all other statistics) is
7625/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7626/// See TH1::GetStats.
7627///
7628/// Return mean value of this histogram along the X axis.
7629
7630Double_t TH1::GetMean(Int_t axis) const
7631{
7632 if (axis<1 || (axis>3 && axis<11) || axis>13) return 0;
7633 Double_t stats[kNstat];
7634 for (Int_t i=4;i<kNstat;i++) stats[i] = 0;
7635 GetStats(stats);
7636 if (stats[0] == 0) return 0;
7637 if (axis<4){
7638 Int_t ax[3] = {2,4,7};
7639 return stats[ax[axis-1]]/stats[0];
7640 } else {
7641 // mean error = StdDev / sqrt( Neff )
7642 Double_t stddev = GetStdDev(axis-10);
7644 return ( neff > 0 ? stddev/TMath::Sqrt(neff) : 0. );
7645 }
7646}
7647
7648////////////////////////////////////////////////////////////////////////////////
7649/// Return standard error of mean of this histogram along the X axis.
7650///
7651/// Note that the mean value/StdDev is computed using the bins in the currently
7652/// defined range (see TAxis::SetRange). By default the range includes
7653/// all bins from 1 to nbins included, excluding underflows and overflows.
7654/// To force the underflows and overflows in the computation, one must
7655/// call the static function TH1::StatOverflows(kTRUE) before filling
7656/// the histogram.
7657///
7658/// Also note, that although the definition of standard error doesn't include the
7659/// assumption of normality, many uses of this feature implicitly assume it.
7660///
7661/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7662/// are calculated. By default, if no range has been set, the returned value is
7663/// the (unbinned) one calculated at fill time. If a range has been set, however,
7664/// the value is calculated using the bins in range, as described above; THIS
7665/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7666/// the range. To ensure that the returned value (and all other statistics) is
7667/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7668/// See TH1::GetStats.
7669
7671{
7672 return GetMean(axis+10);
7673}
7674
7675////////////////////////////////////////////////////////////////////////////////
7676/// Returns the Standard Deviation (Sigma).
7677/// The Sigma estimate is computed as
7678/// \f[
7679/// \sqrt{\frac{1}{N}(\sum(x_i-x_{mean})^2)}
7680/// \f]
7681/// For axis = 1,2 or 3 returns the Sigma value of the histogram along
7682/// X, Y or Z axis
7683/// For axis = 11, 12 or 13 returns the error of StdDev estimation along
7684/// X, Y or Z axis for Normal distribution
7685///
7686/// Note that the mean value/sigma is computed using the bins in the currently
7687/// defined range (see TAxis::SetRange). By default the range includes
7688/// all bins from 1 to nbins included, excluding underflows and overflows.
7689/// To force the underflows and overflows in the computation, one must
7690/// call the static function TH1::StatOverflows(kTRUE) before filling
7691/// the histogram.
7692///
7693/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7694/// are calculated. By default, if no range has been set, the returned standard
7695/// deviation is the (unbinned) one calculated at fill time. If a range has been
7696/// set, however, the standard deviation is calculated using the bins in range,
7697/// as described above; THIS IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use
7698/// TAxis::SetRange(0, 0) to unset the range. To ensure that the returned standard
7699/// deviation (and all other statistics) is always that of the binned data stored
7700/// in the histogram, call TH1::ResetStats. See TH1::GetStats.
7701
7702Double_t TH1::GetStdDev(Int_t axis) const
7703{
7704 if (axis<1 || (axis>3 && axis<11) || axis>13) return 0;
7705
7706 Double_t x, stddev2, stats[kNstat];
7707 for (Int_t i=4;i<kNstat;i++) stats[i] = 0;
7708 GetStats(stats);
7709 if (stats[0] == 0) return 0;
7710 Int_t ax[3] = {2,4,7};
7711 Int_t axm = ax[axis%10 - 1];
7712 x = stats[axm]/stats[0];
7713 // for negative stddev (e.g. when having negative weights) - return stdev=0
7714 stddev2 = TMath::Max( stats[axm+1]/stats[0] -x*x, 0.0 );
7715 if (axis<10)
7716 return TMath::Sqrt(stddev2);
7717 else {
7718 // The right formula for StdDev error depends on 4th momentum (see Kendall-Stuart Vol 1 pag 243)
7719 // formula valid for only gaussian distribution ( 4-th momentum = 3 * sigma^4 )
7721 return ( neff > 0 ? TMath::Sqrt(stddev2/(2*neff) ) : 0. );
7722 }
7723}
7724
7725////////////////////////////////////////////////////////////////////////////////
7726/// Return error of standard deviation estimation for Normal distribution
7727///
7728/// Note that the mean value/StdDev is computed using the bins in the currently
7729/// defined range (see TAxis::SetRange). By default the range includes
7730/// all bins from 1 to nbins included, excluding underflows and overflows.
7731/// To force the underflows and overflows in the computation, one must
7732/// call the static function TH1::StatOverflows(kTRUE) before filling
7733/// the histogram.
7734///
7735/// Value returned is standard deviation of sample standard deviation.
7736/// Note that it is an approximated value which is valid only in the case that the
7737/// original data distribution is Normal. The correct one would require
7738/// the 4-th momentum value, which cannot be accurately estimated from a histogram since
7739/// the x-information for all entries is not kept.
7740///
7741/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7742/// are calculated. By default, if no range has been set, the returned value is
7743/// the (unbinned) one calculated at fill time. If a range has been set, however,
7744/// the value is calculated using the bins in range, as described above; THIS
7745/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7746/// the range. To ensure that the returned value (and all other statistics) is
7747/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7748/// See TH1::GetStats.
7749
7751{
7752 return GetStdDev(axis+10);
7753}
7754
7755////////////////////////////////////////////////////////////////////////////////
7756/// - For axis = 1, 2 or 3 returns skewness of the histogram along x, y or z axis.
7757/// - For axis = 11, 12 or 13 returns the approximate standard error of skewness
7758/// of the histogram along x, y or z axis
7759///
7760///Note, that since third and fourth moment are not calculated
7761///at the fill time, skewness and its standard error are computed bin by bin
7762///
7763/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7764/// are calculated. See TH1::GetMean and TH1::GetStdDev.
7765
7767{
7768
7769 if (axis > 0 && axis <= 3){
7770
7771 Double_t mean = GetMean(axis);
7772 Double_t stddev = GetStdDev(axis);
7774
7781 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7784 if (firstBinX == 1) firstBinX = 0;
7785 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7786 }
7788 if (firstBinY == 1) firstBinY = 0;
7789 if (lastBinY == fYaxis.GetNbins() ) lastBinY += 1;
7790 }
7792 if (firstBinZ == 1) firstBinZ = 0;
7793 if (lastBinZ == fZaxis.GetNbins() ) lastBinZ += 1;
7794 }
7795 }
7796
7797 Double_t x = 0;
7798 Double_t sum=0;
7799 Double_t np=0;
7800 for (Int_t binx = firstBinX; binx <= lastBinX; binx++) {
7801 for (Int_t biny = firstBinY; biny <= lastBinY; biny++) {
7802 for (Int_t binz = firstBinZ; binz <= lastBinZ; binz++) {
7803 if (axis==1 ) x = fXaxis.GetBinCenter(binx);
7804 else if (axis==2 ) x = fYaxis.GetBinCenter(biny);
7805 else if (axis==3 ) x = fZaxis.GetBinCenter(binz);
7807 np+=w;
7808 sum+=w*(x-mean)*(x-mean)*(x-mean);
7809 }
7810 }
7811 }
7812 sum/=np*stddev3;
7813 return sum;
7814 }
7815 else if (axis > 10 && axis <= 13) {
7816 //compute standard error of skewness
7817 // assume parent normal distribution use formula from Kendall-Stuart, Vol 1 pag 243, second edition
7819 return ( neff > 0 ? TMath::Sqrt(6./neff ) : 0. );
7820 }
7821 else {
7822 Error("GetSkewness", "illegal value of parameter");
7823 return 0;
7824 }
7825}
7826
7827////////////////////////////////////////////////////////////////////////////////
7828/// - For axis =1, 2 or 3 returns kurtosis of the histogram along x, y or z axis.
7829/// Kurtosis(gaussian(0, 1)) = 0.
7830/// - For axis =11, 12 or 13 returns the approximate standard error of kurtosis
7831/// of the histogram along x, y or z axis
7832////
7833/// Note, that since third and fourth moment are not calculated
7834/// at the fill time, kurtosis and its standard error are computed bin by bin
7835///
7836/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7837/// are calculated. See TH1::GetMean and TH1::GetStdDev.
7838
7840{
7841 if (axis > 0 && axis <= 3){
7842
7843 Double_t mean = GetMean(axis);
7844 Double_t stddev = GetStdDev(axis);
7846
7853 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7856 if (firstBinX == 1) firstBinX = 0;
7857 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7858 }
7860 if (firstBinY == 1) firstBinY = 0;
7861 if (lastBinY == fYaxis.GetNbins() ) lastBinY += 1;
7862 }
7864 if (firstBinZ == 1) firstBinZ = 0;
7865 if (lastBinZ == fZaxis.GetNbins() ) lastBinZ += 1;
7866 }
7867 }
7868
7869 Double_t x = 0;
7870 Double_t sum=0;
7871 Double_t np=0;
7872 for (Int_t binx = firstBinX; binx <= lastBinX; binx++) {
7873 for (Int_t biny = firstBinY; biny <= lastBinY; biny++) {
7874 for (Int_t binz = firstBinZ; binz <= lastBinZ; binz++) {
7875 if (axis==1 ) x = fXaxis.GetBinCenter(binx);
7876 else if (axis==2 ) x = fYaxis.GetBinCenter(biny);
7877 else if (axis==3 ) x = fZaxis.GetBinCenter(binz);
7879 np+=w;
7880 sum+=w*(x-mean)*(x-mean)*(x-mean)*(x-mean);
7881 }
7882 }
7883 }
7884 sum/=(np*stddev4);
7885 return sum-3;
7886
7887 } else if (axis > 10 && axis <= 13) {
7888 //compute standard error of skewness
7889 // assume parent normal distribution use formula from Kendall-Stuart, Vol 1 pag 243, second edition
7891 return ( neff > 0 ? TMath::Sqrt(24./neff ) : 0. );
7892 }
7893 else {
7894 Error("GetKurtosis", "illegal value of parameter");
7895 return 0;
7896 }
7897}
7898
7899////////////////////////////////////////////////////////////////////////////////
7900/// fill the array stats from the contents of this histogram
7901/// The array stats must be correctly dimensioned in the calling program.
7902///
7903/// ~~~ {.cpp}
7904/// stats[0] = sumw
7905/// stats[1] = sumw2
7906/// stats[2] = sumwx
7907/// stats[3] = sumwx2
7908/// ~~~
7909///
7910/// If no axis-subrange is specified (via TAxis::SetRange), the array stats
7911/// is simply a copy of the statistics quantities computed at filling time.
7912/// If a sub-range is specified, the function recomputes these quantities
7913/// from the bin contents in the current axis range.
7914///
7915/// IMPORTANT NOTE: This means that the returned statistics are context-dependent.
7916/// If TAxis::kAxisRange, the returned statistics are dependent on the binning;
7917/// otherwise, they are a copy of the histogram statistics computed at fill time,
7918/// which are unbinned by default (calling TH1::ResetStats forces them to use
7919/// binned statistics). You can reset TAxis::kAxisRange using TAxis::SetRange(0, 0).
7920///
7921/// Note that the mean value/StdDev is computed using the bins in the currently
7922/// defined range (see TAxis::SetRange). By default the range includes
7923/// all bins from 1 to nbins included, excluding underflows and overflows.
7924/// To force the underflows and overflows in the computation, one must
7925/// call the static function TH1::StatOverflows(kTRUE) before filling
7926/// the histogram.
7927
7928void TH1::GetStats(Double_t *stats) const
7929{
7930 if (fBuffer) ((TH1*)this)->BufferEmpty();
7931
7932 // Loop on bins (possibly including underflows/overflows)
7933 Int_t bin, binx;
7934 Double_t w,err;
7935 Double_t x;
7936 // identify the case of labels with extension of axis range
7937 // in this case the statistics in x does not make any sense
7938 Bool_t labelHist = ((const_cast<TAxis&>(fXaxis)).GetLabels() && fXaxis.CanExtend() );
7939 // fTsumw == 0 && fEntries > 0 is a special case when uses SetBinContent or calls ResetStats before
7940 if ( (fTsumw == 0 && fEntries > 0) || fXaxis.TestBit(TAxis::kAxisRange) ) {
7941 for (bin=0;bin<4;bin++) stats[bin] = 0;
7942
7945 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7947 if (firstBinX == 1) firstBinX = 0;
7948 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7949 }
7950 for (binx = firstBinX; binx <= lastBinX; binx++) {
7952 //w = TMath::Abs(RetrieveBinContent(binx));
7953 // not sure what to do here if w < 0
7955 err = TMath::Abs(GetBinError(binx));
7956 stats[0] += w;
7957 stats[1] += err*err;
7958 // statistics in x makes sense only for not labels histograms
7959 if (!labelHist) {
7960 stats[2] += w*x;
7961 stats[3] += w*x*x;
7962 }
7963 }
7964 // if (stats[0] < 0) {
7965 // // in case total is negative do something ??
7966 // stats[0] = 0;
7967 // }
7968 } else {
7969 stats[0] = fTsumw;
7970 stats[1] = fTsumw2;
7971 stats[2] = fTsumwx;
7972 stats[3] = fTsumwx2;
7973 }
7974}
7975
7976////////////////////////////////////////////////////////////////////////////////
7977/// Replace current statistics with the values in array stats
7978
7979void TH1::PutStats(Double_t *stats)
7980{
7981 fTsumw = stats[0];
7982 fTsumw2 = stats[1];
7983 fTsumwx = stats[2];
7984 fTsumwx2 = stats[3];
7985}
7986
7987////////////////////////////////////////////////////////////////////////////////
7988/// Reset the statistics including the number of entries
7989/// and replace with values calculated from bin content
7990///
7991/// The number of entries is set to the total bin content or (in case of weighted histogram)
7992/// to number of effective entries
7993///
7994/// \note By default, before calling this function, statistics are those
7995/// computed at fill time, which are unbinned. See TH1::GetStats.
7996
7997void TH1::ResetStats()
7998{
7999 Double_t stats[kNstat] = {0};
8000 fTsumw = 0;
8001 fEntries = 1; // to force re-calculation of the statistics in TH1::GetStats
8002 GetStats(stats);
8003 PutStats(stats);
8004 // histogram entries should include always underflows and overflows
8007 else {
8008 Double_t sumw2 = 0;
8009 Double_t * p_sumw2 = (fSumw2.fN > 0) ? &sumw2 : nullptr;
8011 // use effective entries for weighted histograms: (sum_w) ^2 / sum_w2
8013 }
8014}
8015
8016////////////////////////////////////////////////////////////////////////////////
8017/// Return the sum of all weights and optionally also the sum of weight squares
8018/// \param includeOverflow true to include under/overflows bins, false to exclude those.
8019/// \note Different from TH1::GetSumOfWeights, that always excludes those
8020
8022{
8023 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
8024
8025 const Int_t start = (includeOverflow ? 0 : 1);
8026 const Int_t lastX = fXaxis.GetNbins() + (includeOverflow ? 1 : 0);
8027 const Int_t lastY = (fDimension > 1) ? (fYaxis.GetNbins() + (includeOverflow ? 1 : 0)) : start;
8028 const Int_t lastZ = (fDimension > 2) ? (fZaxis.GetNbins() + (includeOverflow ? 1 : 0)) : start;
8029 Double_t sum =0;
8030 Double_t sum2 = 0;
8031 for(auto binz = start; binz <= lastZ; binz++) {
8032 for(auto biny = start; biny <= lastY; biny++) {
8033 for(auto binx = start; binx <= lastX; binx++) {
8034 const auto bin = GetBin(binx, biny, binz);
8035 sum += RetrieveBinContent(bin);
8037 }
8038 }
8039 }
8040 if (sumWeightSquare) {
8041 if (fSumw2.fN > 0)
8043 else
8045 }
8046 return sum;
8047}
8048
8049////////////////////////////////////////////////////////////////////////////////
8050///Return integral of bin contents. Only bins in the bins range are considered.
8051///
8052/// By default the integral is computed as the sum of bin contents in the range.
8053/// if option "width" is specified, the integral is the sum of
8054/// the bin contents multiplied by the bin width in x.
8055
8057{
8059}
8060
8061////////////////////////////////////////////////////////////////////////////////
8062/// Return integral of bin contents in range [binx1,binx2].
8063///
8064/// By default the integral is computed as the sum of bin contents in the range.
8065/// if option "width" is specified, the integral is the sum of
8066/// the bin contents multiplied by the bin width in x.
8067
8069{
8070 double err = 0;
8071 return DoIntegral(binx1,binx2,0,-1,0,-1,err,option);
8072}
8073
8074////////////////////////////////////////////////////////////////////////////////
8075/// Return integral of bin contents in range [binx1,binx2] and its error.
8076///
8077/// By default the integral is computed as the sum of bin contents in the range.
8078/// if option "width" is specified, the integral is the sum of
8079/// the bin contents multiplied by the bin width in x.
8080/// the error is computed using error propagation from the bin errors assuming that
8081/// all the bins are uncorrelated
8082
8084{
8085 return DoIntegral(binx1,binx2,0,-1,0,-1,error,option,kTRUE);
8086}
8087
8088////////////////////////////////////////////////////////////////////////////////
8089/// Internal function compute integral and optionally the error between the limits
8090/// specified by the bin number values working for all histograms (1D, 2D and 3D)
8091
8093 Option_t *option, Bool_t doError) const
8094{
8095 if (fBuffer) ((TH1*)this)->BufferEmpty();
8096
8097 Int_t nx = GetNbinsX() + 2;
8098 if (binx1 < 0) binx1 = 0;
8099 if (binx2 >= nx || binx2 < binx1) binx2 = nx - 1;
8100
8101 if (GetDimension() > 1) {
8102 Int_t ny = GetNbinsY() + 2;
8103 if (biny1 < 0) biny1 = 0;
8104 if (biny2 >= ny || biny2 < biny1) biny2 = ny - 1;
8105 } else {
8106 biny1 = 0; biny2 = 0;
8107 }
8108
8109 if (GetDimension() > 2) {
8110 Int_t nz = GetNbinsZ() + 2;
8111 if (binz1 < 0) binz1 = 0;
8112 if (binz2 >= nz || binz2 < binz1) binz2 = nz - 1;
8113 } else {
8114 binz1 = 0; binz2 = 0;
8115 }
8116
8117 // - Loop on bins in specified range
8118 TString opt = option;
8119 opt.ToLower();
8121 if (opt.Contains("width")) width = kTRUE;
8122
8123
8124 Double_t dx = 1., dy = .1, dz =.1;
8125 Double_t integral = 0;
8126 Double_t igerr2 = 0;
8127 for (Int_t binx = binx1; binx <= binx2; ++binx) {
8128 if (width) dx = fXaxis.GetBinWidth(binx);
8129 for (Int_t biny = biny1; biny <= biny2; ++biny) {
8130 if (width) dy = fYaxis.GetBinWidth(biny);
8131 for (Int_t binz = binz1; binz <= binz2; ++binz) {
8132 Int_t bin = GetBin(binx, biny, binz);
8133 Double_t dv = 0.0;
8134 if (width) {
8136 dv = dx * dy * dz;
8137 integral += RetrieveBinContent(bin) * dv;
8138 } else {
8139 integral += RetrieveBinContent(bin);
8140 }
8141 if (doError) {
8142 if (width) igerr2 += GetBinErrorSqUnchecked(bin) * dv * dv;
8143 else igerr2 += GetBinErrorSqUnchecked(bin);
8144 }
8145 }
8146 }
8147 }
8148
8149 if (doError) error = TMath::Sqrt(igerr2);
8150 return integral;
8151}
8152
8153////////////////////////////////////////////////////////////////////////////////
8154/// Statistical test of compatibility in shape between
8155/// this histogram and h2, using the Anderson-Darling 2 sample test.
8156///
8157/// The AD 2 sample test formula are derived from the paper
8158/// F.W Scholz, M.A. Stephens "k-Sample Anderson-Darling Test".
8159///
8160/// The test is implemented in root in the ROOT::Math::GoFTest class
8161/// It is the same formula ( (6) in the paper), and also shown in
8162/// [this preprint](http://arxiv.org/pdf/0804.0380v1.pdf)
8163///
8164/// Binned data are considered as un-binned data
8165/// with identical observation happening in the bin center.
8166///
8167/// \param[in] h2 Pointer to 1D histogram
8168/// \param[in] option is a character string to specify options
8169/// - "D" Put out a line of "Debug" printout
8170/// - "T" Return the normalized A-D test statistic
8171///
8172/// - Note1: Underflow and overflow are not considered in the test
8173/// - Note2: The test works only for un-weighted histogram (i.e. representing counts)
8174/// - Note3: The histograms are not required to have the same X axis
8175/// - Note4: The test works only for 1-dimensional histograms
8176
8178{
8179 Double_t advalue = 0;
8181
8182 TString opt = option;
8183 opt.ToUpper();
8184 if (opt.Contains("D") ) {
8185 printf(" AndersonDarlingTest Prob = %g, AD TestStatistic = %g\n",pvalue,advalue);
8186 }
8187 if (opt.Contains("T") ) return advalue;
8188
8189 return pvalue;
8190}
8191
8192////////////////////////////////////////////////////////////////////////////////
8193/// Same function as above but returning also the test statistic value
8194
8196{
8197 if (GetDimension() != 1 || h2->GetDimension() != 1) {
8198 Error("AndersonDarlingTest","Histograms must be 1-D");
8199 return -1;
8200 }
8201
8202 // empty the buffer. Probably we could add as an unbinned test
8203 if (fBuffer) ((TH1*)this)->BufferEmpty();
8204
8205 // use the BinData class
8208
8209 ROOT::Fit::FillData(data1, this, nullptr);
8210 ROOT::Fit::FillData(data2, h2, nullptr);
8211
8212 double pvalue;
8214
8215 return pvalue;
8216}
8217
8218////////////////////////////////////////////////////////////////////////////////
8219/// Statistical test of compatibility in shape between
8220/// this histogram and h2, using Kolmogorov test.
8221/// Note that the KolmogorovTest (KS) test should in theory be used only for unbinned data
8222/// and not for binned data as in the case of the histogram (see NOTE 3 below).
8223/// So, before using this method blindly, read the NOTE 3.
8224///
8225/// Default: Ignore under- and overflow bins in comparison
8226///
8227/// \param[in] h2 histogram
8228/// \param[in] option is a character string to specify options
8229/// - "U" include Underflows in test (also for 2-dim)
8230/// - "O" include Overflows (also valid for 2-dim)
8231/// - "N" include comparison of normalizations
8232/// - "D" Put out a line of "Debug" printout
8233/// - "M" Return the Maximum Kolmogorov distance instead of prob
8234/// - "X" Run the pseudo experiments post-processor with the following procedure:
8235/// make pseudoexperiments based on random values from the parent distribution,
8236/// compare the KS distance of the pseudoexperiment to the parent
8237/// distribution, and count all the KS values above the value
8238/// obtained from the original data to Monte Carlo distribution.
8239/// The number of pseudo-experiments nEXPT is by default 1000, and
8240/// it can be changed by specifying the option as "X=number",
8241/// for example "X=10000" for 10000 toys.
8242/// The function returns the probability.
8243/// (thanks to Ben Kilminster to submit this procedure). Note that
8244/// this option "X" is much slower.
8245///
8246/// The returned function value is the probability of test
8247/// (much less than one means NOT compatible)
8248///
8249/// Code adapted by Rene Brun from original HBOOK routine HDIFF
8250///
8251/// NOTE1
8252/// A good description of the Kolmogorov test can be seen at:
8253/// http://www.itl.nist.gov/div898/handbook/eda/section3/eda35g.htm
8254///
8255/// NOTE2
8256/// see also alternative function TH1::Chi2Test
8257/// The Kolmogorov test is assumed to give better results than Chi2Test
8258/// in case of histograms with low statistics.
8259///
8260/// NOTE3 (Jan Conrad, Fred James)
8261/// "The returned value PROB is calculated such that it will be
8262/// uniformly distributed between zero and one for compatible histograms,
8263/// provided the data are not binned (or the number of bins is very large
8264/// compared with the number of events). Users who have access to unbinned
8265/// data and wish exact confidence levels should therefore not put their data
8266/// into histograms, but should call directly TMath::KolmogorovTest. On
8267/// the other hand, since TH1 is a convenient way of collecting data and
8268/// saving space, this function has been provided. However, the values of
8269/// PROB for binned data will be shifted slightly higher than expected,
8270/// depending on the effects of the binning. For example, when comparing two
8271/// uniform distributions of 500 events in 100 bins, the values of PROB,
8272/// instead of being exactly uniformly distributed between zero and one, have
8273/// a mean value of about 0.56. We can apply a useful
8274/// rule: As long as the bin width is small compared with any significant
8275/// physical effect (for example the experimental resolution) then the binning
8276/// cannot have an important effect. Therefore, we believe that for all
8277/// practical purposes, the probability value PROB is calculated correctly
8278/// provided the user is aware that:
8279///
8280/// 1. The value of PROB should not be expected to have exactly the correct
8281/// distribution for binned data.
8282/// 2. The user is responsible for seeing to it that the bin widths are
8283/// small compared with any physical phenomena of interest.
8284/// 3. The effect of binning (if any) is always to make the value of PROB
8285/// slightly too big. That is, setting an acceptance criterion of (PROB>0.05
8286/// will assure that at most 5% of truly compatible histograms are rejected,
8287/// and usually somewhat less."
8288///
8289/// Note also that for GoF test of unbinned data ROOT provides also the class
8290/// ROOT::Math::GoFTest. The class has also method for doing one sample tests
8291/// (i.e. comparing the data with a given distribution).
8292
8294{
8295 TString opt = option;
8296 opt.ToUpper();
8297
8298 Double_t prob = 0;
8299 TH1 *h1 = (TH1*)this;
8300 if (h2 == nullptr) return 0;
8301 const TAxis *axis1 = h1->GetXaxis();
8302 const TAxis *axis2 = h2->GetXaxis();
8303 Int_t ncx1 = axis1->GetNbins();
8304 Int_t ncx2 = axis2->GetNbins();
8305
8306 // Check consistency of dimensions
8307 if (h1->GetDimension() != 1 || h2->GetDimension() != 1) {
8308 Error("KolmogorovTest","Histograms must be 1-D\n");
8309 return 0;
8310 }
8311
8312 // Check consistency in number of channels
8313 if (ncx1 != ncx2) {
8314 Error("KolmogorovTest","Histograms have different number of bins, %d and %d\n",ncx1,ncx2);
8315 return 0;
8316 }
8317
8318 // empty the buffer. Probably we could add as an unbinned test
8319 if (fBuffer) ((TH1*)this)->BufferEmpty();
8320
8321 // Check consistency in bin edges
8322 for(Int_t i = 1; i <= axis1->GetNbins() + 1; ++i) {
8323 if(!TMath::AreEqualRel(axis1->GetBinLowEdge(i), axis2->GetBinLowEdge(i), 1.E-15)) {
8324 Error("KolmogorovTest","Histograms are not consistent: they have different bin edges");
8325 return 0;
8326 }
8327 }
8328
8331 Double_t sum1 = 0, sum2 = 0;
8332 Double_t ew1, ew2, w1 = 0, w2 = 0;
8333 Int_t bin;
8334 Int_t ifirst = 1;
8335 Int_t ilast = ncx1;
8336 // integral of all bins (use underflow/overflow if option)
8337 if (opt.Contains("U")) ifirst = 0;
8338 if (opt.Contains("O")) ilast = ncx1 +1;
8339 for (bin = ifirst; bin <= ilast; bin++) {
8340 sum1 += h1->RetrieveBinContent(bin);
8341 sum2 += h2->RetrieveBinContent(bin);
8342 ew1 = h1->GetBinError(bin);
8343 ew2 = h2->GetBinError(bin);
8344 w1 += ew1*ew1;
8345 w2 += ew2*ew2;
8346 }
8347 if (sum1 == 0) {
8348 Error("KolmogorovTest","Histogram1 %s integral is zero\n",h1->GetName());
8349 return 0;
8350 }
8351 if (sum2 == 0) {
8352 Error("KolmogorovTest","Histogram2 %s integral is zero\n",h2->GetName());
8353 return 0;
8354 }
8355
8356 // calculate the effective entries.
8357 // the case when errors are zero (w1 == 0 or w2 ==0) are equivalent to
8358 // compare to a function. In that case the rescaling is done only on sqrt(esum2) or sqrt(esum1)
8359 Double_t esum1 = 0, esum2 = 0;
8360 if (w1 > 0)
8361 esum1 = sum1 * sum1 / w1;
8362 else
8363 afunc1 = kTRUE; // use later for calculating z
8364
8365 if (w2 > 0)
8366 esum2 = sum2 * sum2 / w2;
8367 else
8368 afunc2 = kTRUE; // use later for calculating z
8369
8370 if (afunc2 && afunc1) {
8371 Error("KolmogorovTest","Errors are zero for both histograms\n");
8372 return 0;
8373 }
8374
8375
8376 Double_t s1 = 1/sum1;
8377 Double_t s2 = 1/sum2;
8378
8379 // Find largest difference for Kolmogorov Test
8380 Double_t dfmax =0, rsum1 = 0, rsum2 = 0;
8381
8382 for (bin=ifirst;bin<=ilast;bin++) {
8383 rsum1 += s1*h1->RetrieveBinContent(bin);
8384 rsum2 += s2*h2->RetrieveBinContent(bin);
8386 }
8387
8388 // Get Kolmogorov probability
8389 Double_t z, prb1=0, prb2=0, prb3=0;
8390
8391 // case h1 is exact (has zero errors)
8392 if (afunc1)
8393 z = dfmax*TMath::Sqrt(esum2);
8394 // case h2 has zero errors
8395 else if (afunc2)
8396 z = dfmax*TMath::Sqrt(esum1);
8397 else
8398 // for comparison between two data sets
8400
8402
8403 // option N to combine normalization makes sense if both afunc1 and afunc2 are false
8404 if (opt.Contains("N") && !(afunc1 || afunc2 ) ) {
8405 // Combine probabilities for shape and normalization,
8406 prb1 = prob;
8409 prb2 = TMath::Prob(chi2,1);
8410 // see Eadie et al., section 11.6.2
8411 if (prob > 0 && prb2 > 0) prob *= prb2*(1-TMath::Log(prob*prb2));
8412 else prob = 0;
8413 }
8414 // X option. Run Pseudo-experiments to determine NULL distribution of the
8415 // KS distance. We can find the probability from the number of pseudo-experiment that have a
8416 // KS distance larger than the one opbserved in the data.
8417 // We use the histogram with the largest statistics as a parent distribution for the NULL.
8418 // Note if one histogram has zero errors is considered as a function. In that case we use it
8419 // as parent distribution for the toys.
8420 //
8421 Int_t nEXPT = 1000;
8422 if (opt.Contains("X")) {
8423 // get number of pseudo-experiment of specified
8424 if (opt.Contains("X=")) {
8425 int numpos = opt.Index("X=") + 2; // 2 is length of X=
8426 int numlen = 0;
8427 int len = opt.Length();
8428 while( (numpos+numlen<len) && isdigit(opt[numpos+numlen]) )
8429 numlen++;
8430 TString snum = opt(numpos,numlen);
8431 int num = atoi(snum.Data());
8432 if (num <= 0)
8433 Warning("KolmogorovTest","invalid number of toys given: %d - use 1000",num);
8434 else
8435 nEXPT = num;
8436 }
8437
8439 TH1D hparent;
8440 // we cannot have afunc1 and func2 both True
8441 if (afunc1 || esum1 > esum2 ) h1->Copy(hparent);
8442 else h2->Copy(hparent);
8443
8444 // copy h1Expt from h1 and h2. It is just needed to get the correct binning
8445
8446
8447 if (hparent.GetMinimum() < 0.0) {
8448 // we need to create a new histogram
8449 // With negative bins we can't draw random samples in a meaningful way.
8450 Warning("KolmogorovTest", "Detected bins with negative weights, these have been ignored and output might be "
8451 "skewed. Reduce number of bins for histogram?");
8452 while (hparent.GetMinimum() < 0.0) {
8453 Int_t idx = hparent.GetMinimumBin();
8454 hparent.SetBinContent(idx, 0.0);
8455 }
8456 }
8457
8458 // make nEXPT experiments (this should be a parameter)
8459 prb3 = 0;
8460 TH1D h1Expt;
8461 h1->Copy(h1Expt);
8462 TH1D h2Expt;
8463 h1->Copy(h2Expt);
8464 // loop on pseudoexperients and generate the two histograms h1Expt and h2Expt according to the
8465 // parent distribution. In case the parent distribution is not an histogram but a function randomize only one
8466 // histogram
8467 for (Int_t i=0; i < nEXPT; i++) {
8468 if (!afunc1) {
8469 h1Expt.Reset();
8470 h1Expt.FillRandom(&hparent, (Int_t)esum1);
8471 }
8472 if (!afunc2) {
8473 h2Expt.Reset();
8474 h2Expt.FillRandom(&hparent, (Int_t)esum2);
8475 }
8476 // note we cannot have both afunc1 and afunc2 to be true
8477 if (afunc1)
8478 dSEXPT = hparent.KolmogorovTest(&h2Expt,"M");
8479 else if (afunc2)
8480 dSEXPT = hparent.KolmogorovTest(&h1Expt,"M");
8481 else
8482 dSEXPT = h1Expt.KolmogorovTest(&h2Expt,"M");
8483 // count number of cases toy KS distance (TS) is larger than oberved one
8484 if (dSEXPT>dfmax) prb3 += 1.0;
8485 }
8486 // compute p-value
8487 prb3 /= (Double_t)nEXPT;
8488 }
8489
8490
8491 // debug printout
8492 if (opt.Contains("D")) {
8493 printf(" Kolmo Prob h1 = %s, sum bin content =%g effective entries =%g\n",h1->GetName(),sum1,esum1);
8494 printf(" Kolmo Prob h2 = %s, sum bin content =%g effective entries =%g\n",h2->GetName(),sum2,esum2);
8495 printf(" Kolmo Prob = %g, Max Dist = %g\n",prob,dfmax);
8496 if (opt.Contains("N"))
8497 printf(" Kolmo Prob = %f for shape alone, =%f for normalisation alone\n",prb1,prb2);
8498 if (opt.Contains("X"))
8499 printf(" Kolmo Prob = %f with %d pseudo-experiments\n",prb3,nEXPT);
8500 }
8501 // This numerical error condition should never occur:
8502 if (TMath::Abs(rsum1-1) > 0.002) Warning("KolmogorovTest","Numerical problems with h1=%s\n",h1->GetName());
8503 if (TMath::Abs(rsum2-1) > 0.002) Warning("KolmogorovTest","Numerical problems with h2=%s\n",h2->GetName());
8504
8505 if(opt.Contains("M")) return dfmax;
8506 else if(opt.Contains("X")) return prb3;
8507 else return prob;
8508}
8509
8510////////////////////////////////////////////////////////////////////////////////
8511/// Replace bin contents by the contents of array content
8512
8513void TH1::SetContent(const Double_t *content)
8514{
8515 fEntries = fNcells;
8516 fTsumw = 0;
8517 for (Int_t i = 0; i < fNcells; ++i) UpdateBinContent(i, content[i]);
8518}
8519
8520////////////////////////////////////////////////////////////////////////////////
8521/// Return contour values into array levels if pointer levels is non zero.
8522///
8523/// The function returns the number of contour levels.
8524/// see GetContourLevel to return one contour only
8525
8527{
8529 if (levels) {
8530 if (nlevels == 0) {
8531 nlevels = 20;
8533 } else {
8535 }
8536 for (Int_t level=0; level<nlevels; level++) levels[level] = fContour.fArray[level];
8537 }
8538 return nlevels;
8539}
8540
8541////////////////////////////////////////////////////////////////////////////////
8542/// Return value of contour number level.
8543/// Use GetContour to return the array of all contour levels
8544
8546{
8547 return (level >= 0 && level < fContour.fN) ? fContour.fArray[level] : 0.0;
8548}
8549
8550////////////////////////////////////////////////////////////////////////////////
8551/// Return the value of contour number "level" in Pad coordinates.
8552/// ie: if the Pad is in log scale along Z it returns le log of the contour level
8553/// value. See GetContour to return the array of all contour levels
8554
8556{
8557 if (level <0 || level >= fContour.fN) return 0;
8558 Double_t zlevel = fContour.fArray[level];
8559
8560 // In case of user defined contours and Pad in log scale along Z,
8561 // fContour.fArray doesn't contain the log of the contour whereas it does
8562 // in case of equidistant contours.
8563 if (gPad && gPad->GetLogz() && TestBit(kUserContour)) {
8564 if (zlevel <= 0) return 0;
8566 }
8567 return zlevel;
8568}
8569
8570////////////////////////////////////////////////////////////////////////////////
8571/// Set the maximum number of entries to be kept in the buffer.
8572
8573void TH1::SetBuffer(Int_t bufsize, Option_t * /*option*/)
8574{
8575 if (fBuffer) {
8576 BufferEmpty();
8577 delete [] fBuffer;
8578 fBuffer = nullptr;
8579 }
8580 if (bufsize <= 0) {
8581 fBufferSize = 0;
8582 return;
8583 }
8584 if (bufsize < 100) bufsize = 100;
8585 fBufferSize = 1 + bufsize*(fDimension+1);
8587 memset(fBuffer, 0, sizeof(Double_t)*fBufferSize);
8588}
8589
8590////////////////////////////////////////////////////////////////////////////////
8591/// Set the number and values of contour levels.
8592///
8593/// By default the number of contour levels is set to 20. The contours values
8594/// in the array "levels" should be specified in increasing order.
8595///
8596/// if argument levels = 0 or missing, `nlevels` equidistant contours are computed
8597/// between `zmin` and `zmax - dz`, both included, with step
8598/// `dz = (zmax - zmin)/nlevels`. Note that contour lines are not centered, but
8599/// contour surfaces (when drawing with `COLZ`) will be, since contour color `i` covers
8600/// the region of values between contour line `i` and `i+1`.
8601
8603{
8604 Int_t level;
8606 if (nlevels <=0 ) {
8607 fContour.Set(0);
8608 return;
8609 }
8611
8612 // - Contour levels are specified
8613 if (levels) {
8615 for (level=0; level<nlevels; level++) fContour.fArray[level] = levels[level];
8616 } else {
8617 // - contour levels are computed automatically as equidistant contours
8618 Double_t zmin = GetMinimum();
8619 Double_t zmax = GetMaximum();
8620 if ((zmin == zmax) && (zmin != 0)) {
8621 zmax += 0.01*TMath::Abs(zmax);
8622 zmin -= 0.01*TMath::Abs(zmin);
8623 }
8624 Double_t dz = (zmax-zmin)/Double_t(nlevels);
8625 if (gPad && gPad->GetLogz()) {
8626 if (zmax <= 0) return;
8627 if (zmin <= 0) zmin = 0.001*zmax;
8628 zmin = TMath::Log10(zmin);
8629 zmax = TMath::Log10(zmax);
8630 dz = (zmax-zmin)/Double_t(nlevels);
8631 }
8632 for (level=0; level<nlevels; level++) {
8633 fContour.fArray[level] = zmin + dz*Double_t(level);
8634 }
8635 }
8636}
8637
8638////////////////////////////////////////////////////////////////////////////////
8639/// Set value for one contour level.
8640
8642{
8643 if (level < 0 || level >= fContour.fN) return;
8645 fContour.fArray[level] = value;
8646}
8647
8648////////////////////////////////////////////////////////////////////////////////
8649/// Return maximum value smaller than maxval of bins in the range,
8650/// unless the value has been overridden by TH1::SetMaximum,
8651/// in which case it returns that value. This happens, for example,
8652/// when the histogram is drawn and the y or z axis limits are changed
8653///
8654/// To get the maximum value of bins in the histogram regardless of
8655/// whether the value has been overridden (using TH1::SetMaximum), use
8656///
8657/// ~~~ {.cpp}
8658/// h->GetBinContent(h->GetMaximumBin())
8659/// ~~~
8660///
8661/// TH1::GetMaximumBin can be used to get the location of the maximum
8662/// value.
8663
8665{
8666 if (fMaximum != -1111) return fMaximum;
8667
8668 // empty the buffer
8669 if (fBuffer) ((TH1*)this)->BufferEmpty();
8670
8671 Int_t bin, binx, biny, binz;
8672 Int_t xfirst = fXaxis.GetFirst();
8673 Int_t xlast = fXaxis.GetLast();
8674 Int_t yfirst = fYaxis.GetFirst();
8675 Int_t ylast = fYaxis.GetLast();
8676 Int_t zfirst = fZaxis.GetFirst();
8677 Int_t zlast = fZaxis.GetLast();
8679 for (binz=zfirst;binz<=zlast;binz++) {
8680 for (biny=yfirst;biny<=ylast;biny++) {
8681 for (binx=xfirst;binx<=xlast;binx++) {
8682 bin = GetBin(binx,biny,binz);
8684 if (value > maximum && value < maxval) maximum = value;
8685 }
8686 }
8687 }
8688 return maximum;
8689}
8690
8691////////////////////////////////////////////////////////////////////////////////
8692/// Return location of bin with maximum value in the range.
8693///
8694/// TH1::GetMaximum can be used to get the maximum value.
8695
8697{
8700}
8701
8702////////////////////////////////////////////////////////////////////////////////
8703/// Return location of bin with maximum value in the range.
8704
8706{
8707 // empty the buffer
8708 if (fBuffer) ((TH1*)this)->BufferEmpty();
8709
8710 Int_t bin, binx, biny, binz;
8711 Int_t locm;
8712 Int_t xfirst = fXaxis.GetFirst();
8713 Int_t xlast = fXaxis.GetLast();
8714 Int_t yfirst = fYaxis.GetFirst();
8715 Int_t ylast = fYaxis.GetLast();
8716 Int_t zfirst = fZaxis.GetFirst();
8717 Int_t zlast = fZaxis.GetLast();
8719 locm = locmax = locmay = locmaz = 0;
8720 for (binz=zfirst;binz<=zlast;binz++) {
8721 for (biny=yfirst;biny<=ylast;biny++) {
8722 for (binx=xfirst;binx<=xlast;binx++) {
8723 bin = GetBin(binx,biny,binz);
8725 if (value > maximum) {
8726 maximum = value;
8727 locm = bin;
8728 locmax = binx;
8729 locmay = biny;
8730 locmaz = binz;
8731 }
8732 }
8733 }
8734 }
8735 return locm;
8736}
8737
8738////////////////////////////////////////////////////////////////////////////////
8739/// Return minimum value larger than minval of bins in the range,
8740/// unless the value has been overridden by TH1::SetMinimum,
8741/// in which case it returns that value. This happens, for example,
8742/// when the histogram is drawn and the y or z axis limits are changed
8743///
8744/// To get the minimum value of bins in the histogram regardless of
8745/// whether the value has been overridden (using TH1::SetMinimum), use
8746///
8747/// ~~~ {.cpp}
8748/// h->GetBinContent(h->GetMinimumBin())
8749/// ~~~
8750///
8751/// TH1::GetMinimumBin can be used to get the location of the
8752/// minimum value.
8753
8755{
8756 if (fMinimum != -1111) return fMinimum;
8757
8758 // empty the buffer
8759 if (fBuffer) ((TH1*)this)->BufferEmpty();
8760
8761 Int_t bin, binx, biny, binz;
8762 Int_t xfirst = fXaxis.GetFirst();
8763 Int_t xlast = fXaxis.GetLast();
8764 Int_t yfirst = fYaxis.GetFirst();
8765 Int_t ylast = fYaxis.GetLast();
8766 Int_t zfirst = fZaxis.GetFirst();
8767 Int_t zlast = fZaxis.GetLast();
8769 for (binz=zfirst;binz<=zlast;binz++) {
8770 for (biny=yfirst;biny<=ylast;biny++) {
8771 for (binx=xfirst;binx<=xlast;binx++) {
8772 bin = GetBin(binx,biny,binz);
8775 }
8776 }
8777 }
8778 return minimum;
8779}
8780
8781////////////////////////////////////////////////////////////////////////////////
8782/// Return location of bin with minimum value in the range.
8783
8785{
8788}
8789
8790////////////////////////////////////////////////////////////////////////////////
8791/// Return location of bin with minimum value in the range.
8792
8794{
8795 // empty the buffer
8796 if (fBuffer) ((TH1*)this)->BufferEmpty();
8797
8798 Int_t bin, binx, biny, binz;
8799 Int_t locm;
8800 Int_t xfirst = fXaxis.GetFirst();
8801 Int_t xlast = fXaxis.GetLast();
8802 Int_t yfirst = fYaxis.GetFirst();
8803 Int_t ylast = fYaxis.GetLast();
8804 Int_t zfirst = fZaxis.GetFirst();
8805 Int_t zlast = fZaxis.GetLast();
8807 locm = locmix = locmiy = locmiz = 0;
8808 for (binz=zfirst;binz<=zlast;binz++) {
8809 for (biny=yfirst;biny<=ylast;biny++) {
8810 for (binx=xfirst;binx<=xlast;binx++) {
8811 bin = GetBin(binx,biny,binz);
8813 if (value < minimum) {
8814 minimum = value;
8815 locm = bin;
8816 locmix = binx;
8817 locmiy = biny;
8818 locmiz = binz;
8819 }
8820 }
8821 }
8822 }
8823 return locm;
8824}
8825
8826///////////////////////////////////////////////////////////////////////////////
8827/// Retrieve the minimum and maximum values in the histogram
8828///
8829/// This will not return a cached value and will always search the
8830/// histogram for the min and max values. The user can condition whether
8831/// or not to call this with the GetMinimumStored() and GetMaximumStored()
8832/// methods. If the cache is empty, then the value will be -1111. Users
8833/// can then use the SetMinimum() or SetMaximum() methods to cache the results.
8834/// For example, the following recipe will make efficient use of this method
8835/// and the cached minimum and maximum values.
8836//
8837/// \code{.cpp}
8838/// Double_t currentMin = pHist->GetMinimumStored();
8839/// Double_t currentMax = pHist->GetMaximumStored();
8840/// if ((currentMin == -1111) || (currentMax == -1111)) {
8841/// pHist->GetMinimumAndMaximum(currentMin, currentMax);
8842/// pHist->SetMinimum(currentMin);
8843/// pHist->SetMaximum(currentMax);
8844/// }
8845/// \endcode
8846///
8847/// \param min reference to variable that will hold found minimum value
8848/// \param max reference to variable that will hold found maximum value
8849
8850void TH1::GetMinimumAndMaximum(Double_t& min, Double_t& max) const
8851{
8852 // empty the buffer
8853 if (fBuffer) ((TH1*)this)->BufferEmpty();
8854
8855 Int_t bin, binx, biny, binz;
8856 Int_t xfirst = fXaxis.GetFirst();
8857 Int_t xlast = fXaxis.GetLast();
8858 Int_t yfirst = fYaxis.GetFirst();
8859 Int_t ylast = fYaxis.GetLast();
8860 Int_t zfirst = fZaxis.GetFirst();
8861 Int_t zlast = fZaxis.GetLast();
8862 min=TMath::Infinity();
8863 max=-TMath::Infinity();
8865 for (binz=zfirst;binz<=zlast;binz++) {
8866 for (biny=yfirst;biny<=ylast;biny++) {
8867 for (binx=xfirst;binx<=xlast;binx++) {
8868 bin = GetBin(binx,biny,binz);
8870 if (value < min) min = value;
8871 if (value > max) max = value;
8872 }
8873 }
8874 }
8875}
8876
8877////////////////////////////////////////////////////////////////////////////////
8878/// Redefine x axis parameters.
8879///
8880/// The X axis parameters are modified.
8881/// The bins content array is resized
8882/// if errors (Sumw2) the errors array is resized
8883/// The previous bin contents are lost
8884/// To change only the axis limits, see TAxis::SetRange
8885
8887{
8888 if (GetDimension() != 1) {
8889 Error("SetBins","Operation only valid for 1-d histograms");
8890 return;
8891 }
8892 fXaxis.SetRange(0,0);
8894 fYaxis.Set(1,0,1);
8895 fZaxis.Set(1,0,1);
8896 fNcells = nx+2;
8898 if (fSumw2.fN) {
8900 }
8901}
8902
8903////////////////////////////////////////////////////////////////////////////////
8904/// Redefine x axis parameters with variable bin sizes.
8905///
8906/// The X axis parameters are modified.
8907/// The bins content array is resized
8908/// if errors (Sumw2) the errors array is resized
8909/// The previous bin contents are lost
8910/// To change only the axis limits, see TAxis::SetRange
8911/// xBins is supposed to be of length nx+1
8912
8913void TH1::SetBins(Int_t nx, const Double_t *xBins)
8914{
8915 if (GetDimension() != 1) {
8916 Error("SetBins","Operation only valid for 1-d histograms");
8917 return;
8918 }
8919 fXaxis.SetRange(0,0);
8920 fXaxis.Set(nx,xBins);
8921 fYaxis.Set(1,0,1);
8922 fZaxis.Set(1,0,1);
8923 fNcells = nx+2;
8925 if (fSumw2.fN) {
8927 }
8928}
8929
8930////////////////////////////////////////////////////////////////////////////////
8931/// Redefine x and y axis parameters.
8932///
8933/// The X and Y axis parameters are modified.
8934/// The bins content array is resized
8935/// if errors (Sumw2) the errors array is resized
8936/// The previous bin contents are lost
8937/// To change only the axis limits, see TAxis::SetRange
8938
8940{
8941 if (GetDimension() != 2) {
8942 Error("SetBins","Operation only valid for 2-D histograms");
8943 return;
8944 }
8945 fXaxis.SetRange(0,0);
8946 fYaxis.SetRange(0,0);
8949 fZaxis.Set(1,0,1);
8950 fNcells = (nx+2)*(ny+2);
8952 if (fSumw2.fN) {
8954 }
8955}
8956
8957////////////////////////////////////////////////////////////////////////////////
8958/// Redefine x and y axis parameters with variable bin sizes.
8959///
8960/// The X and Y axis parameters are modified.
8961/// The bins content array is resized
8962/// if errors (Sumw2) the errors array is resized
8963/// The previous bin contents are lost
8964/// To change only the axis limits, see TAxis::SetRange
8965/// xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1
8966
8967void TH1::SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t *yBins)
8968{
8969 if (GetDimension() != 2) {
8970 Error("SetBins","Operation only valid for 2-D histograms");
8971 return;
8972 }
8973 fXaxis.SetRange(0,0);
8974 fYaxis.SetRange(0,0);
8975 fXaxis.Set(nx,xBins);
8976 fYaxis.Set(ny,yBins);
8977 fZaxis.Set(1,0,1);
8978 fNcells = (nx+2)*(ny+2);
8980 if (fSumw2.fN) {
8982 }
8983}
8984
8985////////////////////////////////////////////////////////////////////////////////
8986/// Redefine x, y and z axis parameters.
8987///
8988/// The X, Y and Z axis parameters are modified.
8989/// The bins content array is resized
8990/// if errors (Sumw2) the errors array is resized
8991/// The previous bin contents are lost
8992/// To change only the axis limits, see TAxis::SetRange
8993
8995{
8996 if (GetDimension() != 3) {
8997 Error("SetBins","Operation only valid for 3-D histograms");
8998 return;
8999 }
9000 fXaxis.SetRange(0,0);
9001 fYaxis.SetRange(0,0);
9002 fZaxis.SetRange(0,0);
9005 fZaxis.Set(nz,zmin,zmax);
9006 fNcells = (nx+2)*(ny+2)*(nz+2);
9008 if (fSumw2.fN) {
9010 }
9011}
9012
9013////////////////////////////////////////////////////////////////////////////////
9014/// Redefine x, y and z axis parameters with variable bin sizes.
9015///
9016/// The X, Y and Z axis parameters are modified.
9017/// The bins content array is resized
9018/// if errors (Sumw2) the errors array is resized
9019/// The previous bin contents are lost
9020/// To change only the axis limits, see TAxis::SetRange
9021/// xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1,
9022/// zBins is supposed to be of length nz+1
9023
9024void TH1::SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t *yBins, Int_t nz, const Double_t *zBins)
9025{
9026 if (GetDimension() != 3) {
9027 Error("SetBins","Operation only valid for 3-D histograms");
9028 return;
9029 }
9030 fXaxis.SetRange(0,0);
9031 fYaxis.SetRange(0,0);
9032 fZaxis.SetRange(0,0);
9033 fXaxis.Set(nx,xBins);
9034 fYaxis.Set(ny,yBins);
9035 fZaxis.Set(nz,zBins);
9036 fNcells = (nx+2)*(ny+2)*(nz+2);
9038 if (fSumw2.fN) {
9040 }
9041}
9042
9043////////////////////////////////////////////////////////////////////////////////
9044/// By default, when a histogram is created, it is added to the list
9045/// of histogram objects in the current directory in memory.
9046/// Remove reference to this histogram from current directory and add
9047/// reference to new directory dir. dir can be 0 in which case the
9048/// histogram does not belong to any directory.
9049///
9050/// Note that the directory is not a real property of the histogram and
9051/// it will not be copied when the histogram is copied or cloned.
9052/// If the user wants to have the copied (cloned) histogram in the same
9053/// directory, he needs to set again the directory using SetDirectory to the
9054/// copied histograms
9055
9057{
9058 if (fDirectory == dir) return;
9059 if (fDirectory) fDirectory->Remove(this);
9060 fDirectory = dir;
9061 if (fDirectory) {
9063 fDirectory->Append(this);
9064 }
9065}
9066
9067////////////////////////////////////////////////////////////////////////////////
9068/// Replace bin errors by values in array error.
9069
9070void TH1::SetError(const Double_t *error)
9071{
9072 for (Int_t i = 0; i < fNcells; ++i) SetBinError(i, error[i]);
9073}
9074
9075////////////////////////////////////////////////////////////////////////////////
9076/// Change the name of this histogram
9078
9079void TH1::SetName(const char *name)
9080{
9081 // Histograms are named objects in a THashList.
9082 // We must update the hashlist if we change the name
9083 // We protect this operation
9085 if (fDirectory) fDirectory->Remove(this);
9086 fName = name;
9087 if (fDirectory) fDirectory->Append(this);
9088}
9089
9090////////////////////////////////////////////////////////////////////////////////
9091/// Change the name and title of this histogram
9092
9093void TH1::SetNameTitle(const char *name, const char *title)
9094{
9095 // Histograms are named objects in a THashList.
9096 // We must update the hashlist if we change the name
9097 SetName(name);
9098 SetTitle(title);
9099}
9100
9101////////////////////////////////////////////////////////////////////////////////
9102/// Set statistics option on/off.
9103///
9104/// By default, the statistics box is drawn.
9105/// The paint options can be selected via gStyle->SetOptStat.
9106/// This function sets/resets the kNoStats bit in the histogram object.
9107/// It has priority over the Style option.
9108
9109void TH1::SetStats(Bool_t stats)
9110{
9112 if (!stats) {
9114 //remove the "stats" object from the list of functions
9115 if (fFunctions) {
9116 TObject *obj = fFunctions->FindObject("stats");
9117 if (obj) {
9118 fFunctions->Remove(obj);
9119 delete obj;
9120 }
9121 }
9122 }
9123}
9124
9125////////////////////////////////////////////////////////////////////////////////
9126/// Create structure to store sum of squares of weights.
9127///
9128/// if histogram is already filled, the sum of squares of weights
9129/// is filled with the existing bin contents
9130///
9131/// The error per bin will be computed as sqrt(sum of squares of weight)
9132/// for each bin.
9133///
9134/// This function is automatically called when the histogram is created
9135/// if the static function TH1::SetDefaultSumw2 has been called before.
9136/// If flag = false the structure containing the sum of the square of weights
9137/// is rest and it will be empty, but it is not deleted (i.e. GetSumw2()->fN = 0)
9138
9140{
9141 if (!flag) {
9142 // clear the array if existing - do nothing otherwise
9143 if (fSumw2.fN > 0 ) fSumw2.Set(0);
9144 return;
9145 }
9146
9147 if (fSumw2.fN == fNcells) {
9148 if (!fgDefaultSumw2 )
9149 Warning("Sumw2","Sum of squares of weights structure already created");
9150 return;
9151 }
9152
9154
9155 if (fEntries > 0)
9156 for (Int_t i = 0; i < fNcells; ++i)
9158}
9159
9160////////////////////////////////////////////////////////////////////////////////
9161/// Return pointer to function with name.
9162///
9163///
9164/// Functions such as TH1::Fit store the fitted function in the list of
9165/// functions of this histogram.
9166
9167TF1 *TH1::GetFunction(const char *name) const
9168{
9169 return (TF1*)fFunctions->FindObject(name);
9170}
9171
9172////////////////////////////////////////////////////////////////////////////////
9173/// Return value of error associated to bin number bin.
9174///
9175/// if the sum of squares of weights has been defined (via Sumw2),
9176/// this function returns the sqrt(sum of w2).
9177/// otherwise it returns the sqrt(contents) for this bin.
9178
9180{
9181 if (bin < 0) bin = 0;
9182 if (bin >= fNcells) bin = fNcells-1;
9183 if (fBuffer) ((TH1*)this)->BufferEmpty();
9184 if (fSumw2.fN) return TMath::Sqrt(fSumw2.fArray[bin]);
9185
9187}
9188
9189////////////////////////////////////////////////////////////////////////////////
9190/// Return lower error associated to bin number bin.
9191///
9192/// The error will depend on the statistic option used will return
9193/// the binContent - lower interval value
9194
9196{
9197 if (fBinStatErrOpt == kNormal) return GetBinError(bin);
9198 // in case of weighted histogram check if it is really weighted
9199 if (fSumw2.fN && fTsumw != fTsumw2) return GetBinError(bin);
9200
9201 if (bin < 0) bin = 0;
9202 if (bin >= fNcells) bin = fNcells-1;
9203 if (fBuffer) ((TH1*)this)->BufferEmpty();
9204
9205 Double_t alpha = 1.- 0.682689492;
9206 if (fBinStatErrOpt == kPoisson2) alpha = 0.05;
9207
9209 Int_t n = int(c);
9210 if (n < 0) {
9211 Warning("GetBinErrorLow","Histogram has negative bin content-force usage to normal errors");
9212 ((TH1*)this)->fBinStatErrOpt = kNormal;
9213 return GetBinError(bin);
9214 }
9215
9216 if (n == 0) return 0;
9217 return c - ROOT::Math::gamma_quantile( alpha/2, n, 1.);
9218}
9219
9220////////////////////////////////////////////////////////////////////////////////
9221/// Return upper error associated to bin number bin.
9222///
9223/// The error will depend on the statistic option used will return
9224/// the binContent - upper interval value
9225
9227{
9228 if (fBinStatErrOpt == kNormal) return GetBinError(bin);
9229 // in case of weighted histogram check if it is really weighted
9230 if (fSumw2.fN && fTsumw != fTsumw2) return GetBinError(bin);
9231 if (bin < 0) bin = 0;
9232 if (bin >= fNcells) bin = fNcells-1;
9233 if (fBuffer) ((TH1*)this)->BufferEmpty();
9234
9235 Double_t alpha = 1.- 0.682689492;
9236 if (fBinStatErrOpt == kPoisson2) alpha = 0.05;
9237
9239 Int_t n = int(c);
9240 if (n < 0) {
9241 Warning("GetBinErrorUp","Histogram has negative bin content-force usage to normal errors");
9242 ((TH1*)this)->fBinStatErrOpt = kNormal;
9243 return GetBinError(bin);
9244 }
9245
9246 // for N==0 return an upper limit at 0.68 or (1-alpha)/2 ?
9247 // decide to return always (1-alpha)/2 upper interval
9248 //if (n == 0) return ROOT::Math::gamma_quantile_c(alpha,n+1,1);
9249 return ROOT::Math::gamma_quantile_c( alpha/2, n+1, 1) - c;
9250}
9251
9252//L.M. These following getters are useless and should be probably deprecated
9253////////////////////////////////////////////////////////////////////////////////
9254/// Return bin center for 1D histogram.
9255/// Better to use h1.GetXaxis()->GetBinCenter(bin)
9256
9258{
9259 if (fDimension == 1) return fXaxis.GetBinCenter(bin);
9260 Error("GetBinCenter","Invalid method for a %d-d histogram - return a NaN",fDimension);
9261 return TMath::QuietNaN();
9262}
9263
9264////////////////////////////////////////////////////////////////////////////////
9265/// Return bin lower edge for 1D histogram.
9266/// Better to use h1.GetXaxis()->GetBinLowEdge(bin)
9267
9269{
9270 if (fDimension == 1) return fXaxis.GetBinLowEdge(bin);
9271 Error("GetBinLowEdge","Invalid method for a %d-d histogram - return a NaN",fDimension);
9272 return TMath::QuietNaN();
9273}
9274
9275////////////////////////////////////////////////////////////////////////////////
9276/// Return bin width for 1D histogram.
9277/// Better to use h1.GetXaxis()->GetBinWidth(bin)
9278
9280{
9281 if (fDimension == 1) return fXaxis.GetBinWidth(bin);
9282 Error("GetBinWidth","Invalid method for a %d-d histogram - return a NaN",fDimension);
9283 return TMath::QuietNaN();
9284}
9285
9286////////////////////////////////////////////////////////////////////////////////
9287/// Fill array with center of bins for 1D histogram
9288/// Better to use h1.GetXaxis()->GetCenter(center)
9289
9290void TH1::GetCenter(Double_t *center) const
9291{
9292 if (fDimension == 1) {
9293 fXaxis.GetCenter(center);
9294 return;
9295 }
9296 Error("GetCenter","Invalid method for a %d-d histogram ",fDimension);
9297}
9298
9299////////////////////////////////////////////////////////////////////////////////
9300/// Fill array with low edge of bins for 1D histogram
9301/// Better to use h1.GetXaxis()->GetLowEdge(edge)
9302
9303void TH1::GetLowEdge(Double_t *edge) const
9304{
9305 if (fDimension == 1) {
9307 return;
9308 }
9309 Error("GetLowEdge","Invalid method for a %d-d histogram ",fDimension);
9310}
9311
9312////////////////////////////////////////////////////////////////////////////////
9313/// Set the bin Error
9314/// Note that this resets the bin eror option to be of Normal Type and for the
9315/// non-empty bin the bin error is set by default to the square root of their content.
9316/// Note that in case the user sets after calling SetBinError explicitly a new bin content (e.g. using SetBinContent)
9317/// he needs then to provide also the corresponding bin error (using SetBinError) since the bin error
9318/// will not be recalculated after setting the content and a default error = 0 will be used for those bins.
9319///
9320/// See convention for numbering bins in TH1::GetBin
9321
9322void TH1::SetBinError(Int_t bin, Double_t error)
9323{
9324 if (bin < 0 || bin>= fNcells) return;
9325 if (!fSumw2.fN) Sumw2();
9326 fSumw2.fArray[bin] = error * error;
9327 // reset the bin error option
9329}
9330
9331////////////////////////////////////////////////////////////////////////////////
9332/// Set bin content
9333/// see convention for numbering bins in TH1::GetBin
9334/// In case the bin number is greater than the number of bins and
9335/// the timedisplay option is set or CanExtendAllAxes(),
9336/// the number of bins is automatically doubled to accommodate the new bin
9337
9339{
9340 fEntries++;
9341 fTsumw = 0;
9342 if (bin < 0) return;
9343 if (bin >= fNcells-1) {
9345 while (bin >= fNcells-1) LabelsInflate();
9346 } else {
9347 if (bin == fNcells-1) UpdateBinContent(bin, content);
9348 return;
9349 }
9350 }
9352}
9353
9354////////////////////////////////////////////////////////////////////////////////
9355/// See convention for numbering bins in TH1::GetBin
9356
9358{
9359 if (binx < 0 || binx > fXaxis.GetNbins() + 1) return;
9360 if (biny < 0 || biny > fYaxis.GetNbins() + 1) return;
9361 SetBinError(GetBin(binx, biny), error);
9362}
9363
9364////////////////////////////////////////////////////////////////////////////////
9365/// See convention for numbering bins in TH1::GetBin
9366
9368{
9369 if (binx < 0 || binx > fXaxis.GetNbins() + 1) return;
9370 if (biny < 0 || biny > fYaxis.GetNbins() + 1) return;
9371 if (binz < 0 || binz > fZaxis.GetNbins() + 1) return;
9372 SetBinError(GetBin(binx, biny, binz), error);
9373}
9374
9375////////////////////////////////////////////////////////////////////////////////
9376/// This function calculates the background spectrum in this histogram.
9377/// The background is returned as a histogram.
9378///
9379/// \param[in] niter number of iterations (default value = 2)
9380/// Increasing niter make the result smoother and lower.
9381/// \param[in] option may contain one of the following options
9382/// - to set the direction parameter
9383/// "BackDecreasingWindow". By default the direction is BackIncreasingWindow
9384/// - filterOrder-order of clipping filter (default "BackOrder2")
9385/// possible values= "BackOrder4" "BackOrder6" "BackOrder8"
9386/// - "nosmoothing" - if selected, the background is not smoothed
9387/// By default the background is smoothed.
9388/// - smoothWindow - width of smoothing window, (default is "BackSmoothing3")
9389/// possible values= "BackSmoothing5" "BackSmoothing7" "BackSmoothing9"
9390/// "BackSmoothing11" "BackSmoothing13" "BackSmoothing15"
9391/// - "nocompton" - if selected the estimation of Compton edge
9392/// will be not be included (by default the compton estimation is set)
9393/// - "same" if this option is specified, the resulting background
9394/// histogram is superimposed on the picture in the current pad.
9395/// This option is given by default.
9396///
9397/// NOTE that the background is only evaluated in the current range of this histogram.
9398/// i.e., if this has a bin range (set via h->GetXaxis()->SetRange(binmin, binmax),
9399/// the returned histogram will be created with the same number of bins
9400/// as this input histogram, but only bins from binmin to binmax will be filled
9401/// with the estimated background.
9402
9404{
9405 return (TH1*)gROOT->ProcessLineFast(TString::Format("TSpectrum::StaticBackground((TH1*)0x%zx,%d,\"%s\")",
9406 (size_t)this, niter, option).Data());
9407}
9408
9409////////////////////////////////////////////////////////////////////////////////
9410/// Interface to TSpectrum::Search.
9411/// The function finds peaks in this histogram where the width is > sigma
9412/// and the peak maximum greater than threshold*maximum bin content of this.
9413/// For more details see TSpectrum::Search.
9414/// Note the difference in the default value for option compared to TSpectrum::Search
9415/// option="" by default (instead of "goff").
9416
9418{
9419 return (Int_t)gROOT->ProcessLineFast(TString::Format("TSpectrum::StaticSearch((TH1*)0x%zx,%g,\"%s\",%g)",
9420 (size_t)this, sigma, option, threshold).Data());
9421}
9422
9423////////////////////////////////////////////////////////////////////////////////
9424/// For a given transform (first parameter), fills the histogram (second parameter)
9425/// with the transform output data, specified in the third parameter
9426/// If the 2nd parameter h_output is empty, a new histogram (TH1D or TH2D) is created
9427/// and the user is responsible for deleting it.
9428///
9429/// Available options:
9430/// - "RE" - real part of the output
9431/// - "IM" - imaginary part of the output
9432/// - "MAG" - magnitude of the output
9433/// - "PH" - phase of the output
9434
9436{
9437 if (!fft || !fft->GetN() ) {
9438 ::Error("TransformHisto","Invalid FFT transform class");
9439 return nullptr;
9440 }
9441
9442 if (fft->GetNdim()>2){
9443 ::Error("TransformHisto","Only 1d and 2D transform are supported");
9444 return nullptr;
9445 }
9446 Int_t binx,biny;
9447 TString opt = option;
9448 opt.ToUpper();
9449 Int_t *n = fft->GetN();
9450 TH1 *hout=nullptr;
9451 if (h_output) {
9452 hout = h_output;
9453 }
9454 else {
9455 TString name = TString::Format("out_%s", opt.Data());
9456 if (fft->GetNdim()==1)
9457 hout = new TH1D(name, name,n[0], 0, n[0]);
9458 else if (fft->GetNdim()==2)
9459 hout = new TH2D(name, name, n[0], 0, n[0], n[1], 0, n[1]);
9460 }
9461 R__ASSERT(hout != nullptr);
9462 TString type=fft->GetType();
9463 Int_t ind[2];
9464 if (opt.Contains("RE")){
9465 if (type.Contains("2C") || type.Contains("2HC")) {
9466 Double_t re, im;
9467 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9468 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9469 ind[0] = binx-1; ind[1] = biny-1;
9470 fft->GetPointComplex(ind, re, im);
9471 hout->SetBinContent(binx, biny, re);
9472 }
9473 }
9474 } else {
9475 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9476 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9477 ind[0] = binx-1; ind[1] = biny-1;
9478 hout->SetBinContent(binx, biny, fft->GetPointReal(ind));
9479 }
9480 }
9481 }
9482 }
9483 if (opt.Contains("IM")) {
9484 if (type.Contains("2C") || type.Contains("2HC")) {
9485 Double_t re, im;
9486 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9487 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9488 ind[0] = binx-1; ind[1] = biny-1;
9489 fft->GetPointComplex(ind, re, im);
9490 hout->SetBinContent(binx, biny, im);
9491 }
9492 }
9493 } else {
9494 ::Error("TransformHisto","No complex numbers in the output");
9495 return nullptr;
9496 }
9497 }
9498 if (opt.Contains("MA")) {
9499 if (type.Contains("2C") || type.Contains("2HC")) {
9500 Double_t re, im;
9501 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9502 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9503 ind[0] = binx-1; ind[1] = biny-1;
9504 fft->GetPointComplex(ind, re, im);
9505 hout->SetBinContent(binx, biny, TMath::Sqrt(re*re + im*im));
9506 }
9507 }
9508 } else {
9509 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9510 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9511 ind[0] = binx-1; ind[1] = biny-1;
9512 hout->SetBinContent(binx, biny, TMath::Abs(fft->GetPointReal(ind)));
9513 }
9514 }
9515 }
9516 }
9517 if (opt.Contains("PH")) {
9518 if (type.Contains("2C") || type.Contains("2HC")){
9519 Double_t re, im, ph;
9520 for (binx = 1; binx<=hout->GetNbinsX(); binx++){
9521 for (biny=1; biny<=hout->GetNbinsY(); biny++){
9522 ind[0] = binx-1; ind[1] = biny-1;
9523 fft->GetPointComplex(ind, re, im);
9524 if (TMath::Abs(re) > 1e-13){
9525 ph = TMath::ATan(im/re);
9526 //find the correct quadrant
9527 if (re<0 && im<0)
9528 ph -= TMath::Pi();
9529 if (re<0 && im>=0)
9530 ph += TMath::Pi();
9531 } else {
9532 if (TMath::Abs(im) < 1e-13)
9533 ph = 0;
9534 else if (im>0)
9535 ph = TMath::Pi()*0.5;
9536 else
9537 ph = -TMath::Pi()*0.5;
9538 }
9539 hout->SetBinContent(binx, biny, ph);
9540 }
9541 }
9542 } else {
9543 printf("Pure real output, no phase");
9544 return nullptr;
9545 }
9546 }
9547
9548 return hout;
9549}
9550
9551////////////////////////////////////////////////////////////////////////////////
9552/// Print value overload
9553
9554std::string cling::printValue(TH1 *val) {
9555 std::ostringstream strm;
9556 strm << cling::printValue((TObject*)val) << " NbinsX: " << val->GetNbinsX();
9557 return strm.str();
9558}
9559
9560//______________________________________________________________________________
9561// TH1C methods
9562// TH1C : histograms with one byte per channel. Maximum bin content = 127
9563//______________________________________________________________________________
9564
9565
9566////////////////////////////////////////////////////////////////////////////////
9567/// Constructor.
9568
9569TH1C::TH1C()
9570{
9571 fDimension = 1;
9572 SetBinsLength(3);
9573 if (fgDefaultSumw2) Sumw2();
9574}
9575
9576////////////////////////////////////////////////////////////////////////////////
9577/// Create a 1-Dim histogram with fix bins of type char (one byte per channel)
9578/// (see TH1::TH1 for explanation of parameters)
9579
9580TH1C::TH1C(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9581: TH1(name,title,nbins,xlow,xup)
9582{
9583 fDimension = 1;
9585
9586 if (xlow >= xup) SetBuffer(fgBufferSize);
9587 if (fgDefaultSumw2) Sumw2();
9588}
9589
9590////////////////////////////////////////////////////////////////////////////////
9591/// Create a 1-Dim histogram with variable bins of type char (one byte per channel)
9592/// (see TH1::TH1 for explanation of parameters)
9593
9594TH1C::TH1C(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9595: TH1(name,title,nbins,xbins)
9596{
9597 fDimension = 1;
9599 if (fgDefaultSumw2) Sumw2();
9600}
9601
9602////////////////////////////////////////////////////////////////////////////////
9603/// Create a 1-Dim histogram with variable bins of type char (one byte per channel)
9604/// (see TH1::TH1 for explanation of parameters)
9605
9606TH1C::TH1C(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9607: TH1(name,title,nbins,xbins)
9608{
9609 fDimension = 1;
9611 if (fgDefaultSumw2) Sumw2();
9612}
9613
9614////////////////////////////////////////////////////////////////////////////////
9615/// Destructor.
9616
9618{
9619}
9620
9621////////////////////////////////////////////////////////////////////////////////
9622/// Copy constructor.
9623/// The list of functions is not copied. (Use Clone() if needed)
9624
9625TH1C::TH1C(const TH1C &h1c) : TH1(), TArrayC()
9626{
9627 h1c.TH1C::Copy(*this);
9628}
9629
9630////////////////////////////////////////////////////////////////////////////////
9631/// Increment bin content by 1.
9632/// Passing an out-of-range bin leads to undefined behavior
9633
9634void TH1C::AddBinContent(Int_t bin)
9635{
9636 if (fArray[bin] < 127) fArray[bin]++;
9637}
9638
9639////////////////////////////////////////////////////////////////////////////////
9640/// Increment bin content by w.
9641/// \warning The value of w is cast to `Int_t` before being added.
9642/// Passing an out-of-range bin leads to undefined behavior
9643
9645{
9646 Int_t newval = fArray[bin] + Int_t(w);
9647 if (newval > -128 && newval < 128) {fArray[bin] = Char_t(newval); return;}
9648 if (newval < -127) fArray[bin] = -127;
9649 if (newval > 127) fArray[bin] = 127;
9650}
9651
9652////////////////////////////////////////////////////////////////////////////////
9653/// Copy this to newth1
9654
9655void TH1C::Copy(TObject &newth1) const
9656{
9658}
9659
9660////////////////////////////////////////////////////////////////////////////////
9661/// Reset.
9662
9664{
9667}
9668
9669////////////////////////////////////////////////////////////////////////////////
9670/// Set total number of bins including under/overflow
9671/// Reallocate bin contents array
9672
9674{
9675 if (n < 0) n = fXaxis.GetNbins() + 2;
9676 fNcells = n;
9677 TArrayC::Set(n);
9678}
9679
9680////////////////////////////////////////////////////////////////////////////////
9681/// Operator =
9682
9683TH1C& TH1C::operator=(const TH1C &h1)
9684{
9685 if (this != &h1)
9686 h1.TH1C::Copy(*this);
9687 return *this;
9688}
9689
9690////////////////////////////////////////////////////////////////////////////////
9691/// Operator *
9692
9694{
9695 TH1C hnew = h1;
9696 hnew.Scale(c1);
9697 hnew.SetDirectory(nullptr);
9698 return hnew;
9699}
9700
9701////////////////////////////////////////////////////////////////////////////////
9702/// Operator +
9703
9704TH1C operator+(const TH1C &h1, const TH1C &h2)
9705{
9706 TH1C hnew = h1;
9707 hnew.Add(&h2,1);
9708 hnew.SetDirectory(nullptr);
9709 return hnew;
9710}
9711
9712////////////////////////////////////////////////////////////////////////////////
9713/// Operator -
9714
9715TH1C operator-(const TH1C &h1, const TH1C &h2)
9716{
9717 TH1C hnew = h1;
9718 hnew.Add(&h2,-1);
9719 hnew.SetDirectory(nullptr);
9720 return hnew;
9721}
9722
9723////////////////////////////////////////////////////////////////////////////////
9724/// Operator *
9725
9726TH1C operator*(const TH1C &h1, const TH1C &h2)
9727{
9728 TH1C hnew = h1;
9729 hnew.Multiply(&h2);
9730 hnew.SetDirectory(nullptr);
9731 return hnew;
9732}
9733
9734////////////////////////////////////////////////////////////////////////////////
9735/// Operator /
9736
9737TH1C operator/(const TH1C &h1, const TH1C &h2)
9738{
9739 TH1C hnew = h1;
9740 hnew.Divide(&h2);
9741 hnew.SetDirectory(nullptr);
9742 return hnew;
9743}
9744
9745//______________________________________________________________________________
9746// TH1S methods
9747// TH1S : histograms with one short per channel. Maximum bin content = 32767
9748//______________________________________________________________________________
9749
9750
9751////////////////////////////////////////////////////////////////////////////////
9752/// Constructor.
9753
9754TH1S::TH1S()
9755{
9756 fDimension = 1;
9757 SetBinsLength(3);
9758 if (fgDefaultSumw2) Sumw2();
9759}
9760
9761////////////////////////////////////////////////////////////////////////////////
9762/// Create a 1-Dim histogram with fix bins of type short
9763/// (see TH1::TH1 for explanation of parameters)
9764
9765TH1S::TH1S(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9766: TH1(name,title,nbins,xlow,xup)
9767{
9768 fDimension = 1;
9770
9771 if (xlow >= xup) SetBuffer(fgBufferSize);
9772 if (fgDefaultSumw2) Sumw2();
9773}
9774
9775////////////////////////////////////////////////////////////////////////////////
9776/// Create a 1-Dim histogram with variable bins of type short
9777/// (see TH1::TH1 for explanation of parameters)
9778
9779TH1S::TH1S(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9780: TH1(name,title,nbins,xbins)
9781{
9782 fDimension = 1;
9784 if (fgDefaultSumw2) Sumw2();
9785}
9786
9787////////////////////////////////////////////////////////////////////////////////
9788/// Create a 1-Dim histogram with variable bins of type short
9789/// (see TH1::TH1 for explanation of parameters)
9790
9791TH1S::TH1S(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9792: TH1(name,title,nbins,xbins)
9793{
9794 fDimension = 1;
9796 if (fgDefaultSumw2) Sumw2();
9797}
9798
9799////////////////////////////////////////////////////////////////////////////////
9800/// Destructor.
9801
9803{
9804}
9805
9806////////////////////////////////////////////////////////////////////////////////
9807/// Copy constructor.
9808/// The list of functions is not copied. (Use Clone() if needed)
9809
9810TH1S::TH1S(const TH1S &h1s) : TH1(), TArrayS()
9811{
9812 h1s.TH1S::Copy(*this);
9813}
9814
9815////////////////////////////////////////////////////////////////////////////////
9816/// Increment bin content by 1.
9817/// Passing an out-of-range bin leads to undefined behavior
9818
9819void TH1S::AddBinContent(Int_t bin)
9820{
9821 if (fArray[bin] < 32767) fArray[bin]++;
9822}
9823
9824////////////////////////////////////////////////////////////////////////////////
9825/// Increment bin content by w.
9826/// \warning The value of w is cast to `Int_t` before being added.
9827/// Passing an out-of-range bin leads to undefined behavior
9828
9830{
9831 Int_t newval = fArray[bin] + Int_t(w);
9832 if (newval > -32768 && newval < 32768) {fArray[bin] = Short_t(newval); return;}
9833 if (newval < -32767) fArray[bin] = -32767;
9834 if (newval > 32767) fArray[bin] = 32767;
9835}
9836
9837////////////////////////////////////////////////////////////////////////////////
9838/// Copy this to newth1
9839
9840void TH1S::Copy(TObject &newth1) const
9841{
9843}
9844
9845////////////////////////////////////////////////////////////////////////////////
9846/// Reset.
9847
9849{
9852}
9853
9854////////////////////////////////////////////////////////////////////////////////
9855/// Set total number of bins including under/overflow
9856/// Reallocate bin contents array
9857
9859{
9860 if (n < 0) n = fXaxis.GetNbins() + 2;
9861 fNcells = n;
9862 TArrayS::Set(n);
9863}
9864
9865////////////////////////////////////////////////////////////////////////////////
9866/// Operator =
9867
9868TH1S& TH1S::operator=(const TH1S &h1)
9869{
9870 if (this != &h1)
9871 h1.TH1S::Copy(*this);
9872 return *this;
9873}
9874
9875////////////////////////////////////////////////////////////////////////////////
9876/// Operator *
9877
9879{
9880 TH1S hnew = h1;
9881 hnew.Scale(c1);
9882 hnew.SetDirectory(nullptr);
9883 return hnew;
9884}
9885
9886////////////////////////////////////////////////////////////////////////////////
9887/// Operator +
9888
9889TH1S operator+(const TH1S &h1, const TH1S &h2)
9890{
9891 TH1S hnew = h1;
9892 hnew.Add(&h2,1);
9893 hnew.SetDirectory(nullptr);
9894 return hnew;
9895}
9896
9897////////////////////////////////////////////////////////////////////////////////
9898/// Operator -
9899
9900TH1S operator-(const TH1S &h1, const TH1S &h2)
9901{
9902 TH1S hnew = h1;
9903 hnew.Add(&h2,-1);
9904 hnew.SetDirectory(nullptr);
9905 return hnew;
9906}
9907
9908////////////////////////////////////////////////////////////////////////////////
9909/// Operator *
9910
9911TH1S operator*(const TH1S &h1, const TH1S &h2)
9912{
9913 TH1S hnew = h1;
9914 hnew.Multiply(&h2);
9915 hnew.SetDirectory(nullptr);
9916 return hnew;
9917}
9918
9919////////////////////////////////////////////////////////////////////////////////
9920/// Operator /
9921
9922TH1S operator/(const TH1S &h1, const TH1S &h2)
9923{
9924 TH1S hnew = h1;
9925 hnew.Divide(&h2);
9926 hnew.SetDirectory(nullptr);
9927 return hnew;
9928}
9929
9930//______________________________________________________________________________
9931// TH1I methods
9932// TH1I : histograms with one int per channel. Maximum bin content = 2147483647
9933// 2147483647 = INT_MAX
9934//______________________________________________________________________________
9935
9936
9937////////////////////////////////////////////////////////////////////////////////
9938/// Constructor.
9939
9940TH1I::TH1I()
9941{
9942 fDimension = 1;
9943 SetBinsLength(3);
9944 if (fgDefaultSumw2) Sumw2();
9945}
9946
9947////////////////////////////////////////////////////////////////////////////////
9948/// Create a 1-Dim histogram with fix bins of type integer
9949/// (see TH1::TH1 for explanation of parameters)
9950
9951TH1I::TH1I(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9952: TH1(name,title,nbins,xlow,xup)
9953{
9954 fDimension = 1;
9956
9957 if (xlow >= xup) SetBuffer(fgBufferSize);
9958 if (fgDefaultSumw2) Sumw2();
9959}
9960
9961////////////////////////////////////////////////////////////////////////////////
9962/// Create a 1-Dim histogram with variable bins of type integer
9963/// (see TH1::TH1 for explanation of parameters)
9964
9965TH1I::TH1I(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9966: TH1(name,title,nbins,xbins)
9967{
9968 fDimension = 1;
9970 if (fgDefaultSumw2) Sumw2();
9971}
9972
9973////////////////////////////////////////////////////////////////////////////////
9974/// Create a 1-Dim histogram with variable bins of type integer
9975/// (see TH1::TH1 for explanation of parameters)
9976
9977TH1I::TH1I(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9978: TH1(name,title,nbins,xbins)
9979{
9980 fDimension = 1;
9982 if (fgDefaultSumw2) Sumw2();
9983}
9984
9985////////////////////////////////////////////////////////////////////////////////
9986/// Destructor.
9987
9989{
9990}
9991
9992////////////////////////////////////////////////////////////////////////////////
9993/// Copy constructor.
9994/// The list of functions is not copied. (Use Clone() if needed)
9995
9996TH1I::TH1I(const TH1I &h1i) : TH1(), TArrayI()
9997{
9998 h1i.TH1I::Copy(*this);
9999}
10000
10001////////////////////////////////////////////////////////////////////////////////
10002/// Increment bin content by 1.
10003/// Passing an out-of-range bin leads to undefined behavior
10004
10005void TH1I::AddBinContent(Int_t bin)
10006{
10007 if (fArray[bin] < INT_MAX) fArray[bin]++;
10008}
10009
10010////////////////////////////////////////////////////////////////////////////////
10011/// Increment bin content by w
10012/// \warning The value of w is cast to `Long64_t` before being added.
10013/// Passing an out-of-range bin leads to undefined behavior
10014
10016{
10017 Long64_t newval = fArray[bin] + Long64_t(w);
10018 if (newval > -INT_MAX && newval < INT_MAX) {fArray[bin] = Int_t(newval); return;}
10019 if (newval < -INT_MAX) fArray[bin] = -INT_MAX;
10020 if (newval > INT_MAX) fArray[bin] = INT_MAX;
10021}
10022
10023////////////////////////////////////////////////////////////////////////////////
10024/// Copy this to newth1
10025
10026void TH1I::Copy(TObject &newth1) const
10027{
10029}
10030
10031////////////////////////////////////////////////////////////////////////////////
10032/// Reset.
10033
10035{
10038}
10039
10040////////////////////////////////////////////////////////////////////////////////
10041/// Set total number of bins including under/overflow
10042/// Reallocate bin contents array
10043
10045{
10046 if (n < 0) n = fXaxis.GetNbins() + 2;
10047 fNcells = n;
10048 TArrayI::Set(n);
10049}
10050
10051////////////////////////////////////////////////////////////////////////////////
10052/// Operator =
10053
10054TH1I& TH1I::operator=(const TH1I &h1)
10055{
10056 if (this != &h1)
10057 h1.TH1I::Copy(*this);
10058 return *this;
10059}
10060
10061
10062////////////////////////////////////////////////////////////////////////////////
10063/// Operator *
10064
10066{
10067 TH1I hnew = h1;
10068 hnew.Scale(c1);
10069 hnew.SetDirectory(nullptr);
10070 return hnew;
10071}
10072
10073////////////////////////////////////////////////////////////////////////////////
10074/// Operator +
10075
10076TH1I operator+(const TH1I &h1, const TH1I &h2)
10077{
10078 TH1I hnew = h1;
10079 hnew.Add(&h2,1);
10080 hnew.SetDirectory(nullptr);
10081 return hnew;
10082}
10083
10084////////////////////////////////////////////////////////////////////////////////
10085/// Operator -
10086
10087TH1I operator-(const TH1I &h1, const TH1I &h2)
10088{
10089 TH1I hnew = h1;
10090 hnew.Add(&h2,-1);
10091 hnew.SetDirectory(nullptr);
10092 return hnew;
10093}
10094
10095////////////////////////////////////////////////////////////////////////////////
10096/// Operator *
10097
10098TH1I operator*(const TH1I &h1, const TH1I &h2)
10099{
10100 TH1I hnew = h1;
10101 hnew.Multiply(&h2);
10102 hnew.SetDirectory(nullptr);
10103 return hnew;
10104}
10105
10106////////////////////////////////////////////////////////////////////////////////
10107/// Operator /
10108
10109TH1I operator/(const TH1I &h1, const TH1I &h2)
10110{
10111 TH1I hnew = h1;
10112 hnew.Divide(&h2);
10113 hnew.SetDirectory(nullptr);
10114 return hnew;
10115}
10116
10117//______________________________________________________________________________
10118// TH1L methods
10119// TH1L : histograms with one long64 per channel. Maximum bin content = 9223372036854775807
10120// 9223372036854775807 = LLONG_MAX
10121//______________________________________________________________________________
10122
10123
10124////////////////////////////////////////////////////////////////////////////////
10125/// Constructor.
10126
10127TH1L::TH1L()
10128{
10129 fDimension = 1;
10130 SetBinsLength(3);
10131 if (fgDefaultSumw2) Sumw2();
10132}
10133
10134////////////////////////////////////////////////////////////////////////////////
10135/// Create a 1-Dim histogram with fix bins of type long64
10136/// (see TH1::TH1 for explanation of parameters)
10137
10138TH1L::TH1L(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10139: TH1(name,title,nbins,xlow,xup)
10140{
10141 fDimension = 1;
10143
10144 if (xlow >= xup) SetBuffer(fgBufferSize);
10145 if (fgDefaultSumw2) Sumw2();
10146}
10147
10148////////////////////////////////////////////////////////////////////////////////
10149/// Create a 1-Dim histogram with variable bins of type long64
10150/// (see TH1::TH1 for explanation of parameters)
10151
10152TH1L::TH1L(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10153: TH1(name,title,nbins,xbins)
10154{
10155 fDimension = 1;
10157 if (fgDefaultSumw2) Sumw2();
10158}
10159
10160////////////////////////////////////////////////////////////////////////////////
10161/// Create a 1-Dim histogram with variable bins of type long64
10162/// (see TH1::TH1 for explanation of parameters)
10163
10164TH1L::TH1L(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10165: TH1(name,title,nbins,xbins)
10166{
10167 fDimension = 1;
10169 if (fgDefaultSumw2) Sumw2();
10170}
10171
10172////////////////////////////////////////////////////////////////////////////////
10173/// Destructor.
10174
10176{
10177}
10178
10179////////////////////////////////////////////////////////////////////////////////
10180/// Copy constructor.
10181/// The list of functions is not copied. (Use Clone() if needed)
10182
10183TH1L::TH1L(const TH1L &h1l) : TH1(), TArrayL64()
10184{
10185 h1l.TH1L::Copy(*this);
10186}
10187
10188////////////////////////////////////////////////////////////////////////////////
10189/// Increment bin content by 1.
10190/// Passing an out-of-range bin leads to undefined behavior
10191
10192void TH1L::AddBinContent(Int_t bin)
10193{
10194 if (fArray[bin] < LLONG_MAX) fArray[bin]++;
10195}
10196
10197////////////////////////////////////////////////////////////////////////////////
10198/// Increment bin content by w.
10199/// \warning The value of w is cast to `Long64_t` before being added.
10200/// Passing an out-of-range bin leads to undefined behavior
10201
10203{
10204 Long64_t newval = fArray[bin] + Long64_t(w);
10205 if (newval > -LLONG_MAX && newval < LLONG_MAX) {fArray[bin] = newval; return;}
10206 if (newval < -LLONG_MAX) fArray[bin] = -LLONG_MAX;
10207 if (newval > LLONG_MAX) fArray[bin] = LLONG_MAX;
10208}
10209
10210////////////////////////////////////////////////////////////////////////////////
10211/// Copy this to newth1
10212
10213void TH1L::Copy(TObject &newth1) const
10214{
10216}
10217
10218////////////////////////////////////////////////////////////////////////////////
10219/// Reset.
10220
10222{
10225}
10226
10227////////////////////////////////////////////////////////////////////////////////
10228/// Set total number of bins including under/overflow
10229/// Reallocate bin contents array
10230
10232{
10233 if (n < 0) n = fXaxis.GetNbins() + 2;
10234 fNcells = n;
10236}
10237
10238////////////////////////////////////////////////////////////////////////////////
10239/// Operator =
10240
10241TH1L& TH1L::operator=(const TH1L &h1)
10242{
10243 if (this != &h1)
10244 h1.TH1L::Copy(*this);
10245 return *this;
10246}
10247
10248
10249////////////////////////////////////////////////////////////////////////////////
10250/// Operator *
10251
10253{
10254 TH1L hnew = h1;
10255 hnew.Scale(c1);
10256 hnew.SetDirectory(nullptr);
10257 return hnew;
10258}
10259
10260////////////////////////////////////////////////////////////////////////////////
10261/// Operator +
10262
10263TH1L operator+(const TH1L &h1, const TH1L &h2)
10264{
10265 TH1L hnew = h1;
10266 hnew.Add(&h2,1);
10267 hnew.SetDirectory(nullptr);
10268 return hnew;
10269}
10270
10271////////////////////////////////////////////////////////////////////////////////
10272/// Operator -
10273
10274TH1L operator-(const TH1L &h1, const TH1L &h2)
10275{
10276 TH1L hnew = h1;
10277 hnew.Add(&h2,-1);
10278 hnew.SetDirectory(nullptr);
10279 return hnew;
10280}
10281
10282////////////////////////////////////////////////////////////////////////////////
10283/// Operator *
10284
10285TH1L operator*(const TH1L &h1, const TH1L &h2)
10286{
10287 TH1L hnew = h1;
10288 hnew.Multiply(&h2);
10289 hnew.SetDirectory(nullptr);
10290 return hnew;
10291}
10292
10293////////////////////////////////////////////////////////////////////////////////
10294/// Operator /
10295
10296TH1L operator/(const TH1L &h1, const TH1L &h2)
10297{
10298 TH1L hnew = h1;
10299 hnew.Divide(&h2);
10300 hnew.SetDirectory(nullptr);
10301 return hnew;
10302}
10303
10304//______________________________________________________________________________
10305// TH1F methods
10306// TH1F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content = +/-16777216
10307//______________________________________________________________________________
10308
10309
10310////////////////////////////////////////////////////////////////////////////////
10311/// Constructor.
10312
10313TH1F::TH1F()
10314{
10315 fDimension = 1;
10316 SetBinsLength(3);
10317 if (fgDefaultSumw2) Sumw2();
10318}
10319
10320////////////////////////////////////////////////////////////////////////////////
10321/// Create a 1-Dim histogram with fix bins of type float
10322/// (see TH1::TH1 for explanation of parameters)
10323
10324TH1F::TH1F(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10325: TH1(name,title,nbins,xlow,xup)
10326{
10327 fDimension = 1;
10329
10330 if (xlow >= xup) SetBuffer(fgBufferSize);
10331 if (fgDefaultSumw2) Sumw2();
10332}
10333
10334////////////////////////////////////////////////////////////////////////////////
10335/// Create a 1-Dim histogram with variable bins of type float
10336/// (see TH1::TH1 for explanation of parameters)
10337
10338TH1F::TH1F(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10339: TH1(name,title,nbins,xbins)
10340{
10341 fDimension = 1;
10343 if (fgDefaultSumw2) Sumw2();
10344}
10345
10346////////////////////////////////////////////////////////////////////////////////
10347/// Create a 1-Dim histogram with variable bins of type float
10348/// (see TH1::TH1 for explanation of parameters)
10349
10350TH1F::TH1F(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10351: TH1(name,title,nbins,xbins)
10352{
10353 fDimension = 1;
10355 if (fgDefaultSumw2) Sumw2();
10356}
10357
10358////////////////////////////////////////////////////////////////////////////////
10359/// Create a histogram from a TVectorF
10360/// by default the histogram name is "TVectorF" and title = ""
10361
10362TH1F::TH1F(const TVectorF &v)
10363: TH1("TVectorF","",v.GetNrows(),0,v.GetNrows())
10364{
10366 fDimension = 1;
10367 Int_t ivlow = v.GetLwb();
10368 for (Int_t i=0;i<fNcells-2;i++) {
10369 SetBinContent(i+1,v(i+ivlow));
10370 }
10372 if (fgDefaultSumw2) Sumw2();
10373}
10374
10375////////////////////////////////////////////////////////////////////////////////
10376/// Copy Constructor.
10377/// The list of functions is not copied. (Use Clone() if needed)
10378
10379TH1F::TH1F(const TH1F &h1f) : TH1(), TArrayF()
10380{
10381 h1f.TH1F::Copy(*this);
10382}
10383
10384////////////////////////////////////////////////////////////////////////////////
10385/// Destructor.
10386
10388{
10389}
10390
10391////////////////////////////////////////////////////////////////////////////////
10392/// Copy this to newth1.
10393
10394void TH1F::Copy(TObject &newth1) const
10395{
10397}
10398
10399////////////////////////////////////////////////////////////////////////////////
10400/// Reset.
10401
10403{
10406}
10407
10408////////////////////////////////////////////////////////////////////////////////
10409/// Set total number of bins including under/overflow
10410/// Reallocate bin contents array
10411
10413{
10414 if (n < 0) n = fXaxis.GetNbins() + 2;
10415 fNcells = n;
10416 TArrayF::Set(n);
10417}
10418
10419////////////////////////////////////////////////////////////////////////////////
10420/// Operator =
10421
10423{
10424 if (this != &h1f)
10425 h1f.TH1F::Copy(*this);
10426 return *this;
10427}
10428
10429////////////////////////////////////////////////////////////////////////////////
10430/// Operator *
10431
10433{
10434 TH1F hnew = h1;
10435 hnew.Scale(c1);
10436 hnew.SetDirectory(nullptr);
10437 return hnew;
10438}
10439
10440////////////////////////////////////////////////////////////////////////////////
10441/// Operator +
10442
10443TH1F operator+(const TH1F &h1, const TH1F &h2)
10444{
10445 TH1F hnew = h1;
10446 hnew.Add(&h2,1);
10447 hnew.SetDirectory(nullptr);
10448 return hnew;
10449}
10450
10451////////////////////////////////////////////////////////////////////////////////
10452/// Operator -
10453
10454TH1F operator-(const TH1F &h1, const TH1F &h2)
10455{
10456 TH1F hnew = h1;
10457 hnew.Add(&h2,-1);
10458 hnew.SetDirectory(nullptr);
10459 return hnew;
10460}
10461
10462////////////////////////////////////////////////////////////////////////////////
10463/// Operator *
10464
10465TH1F operator*(const TH1F &h1, const TH1F &h2)
10466{
10467 TH1F hnew = h1;
10468 hnew.Multiply(&h2);
10469 hnew.SetDirectory(nullptr);
10470 return hnew;
10471}
10472
10473////////////////////////////////////////////////////////////////////////////////
10474/// Operator /
10475
10476TH1F operator/(const TH1F &h1, const TH1F &h2)
10477{
10478 TH1F hnew = h1;
10479 hnew.Divide(&h2);
10480 hnew.SetDirectory(nullptr);
10481 return hnew;
10482}
10483
10484//______________________________________________________________________________
10485// TH1D methods
10486// TH1D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content = +/-9007199254740992
10487//______________________________________________________________________________
10488
10489
10490////////////////////////////////////////////////////////////////////////////////
10491/// Constructor.
10492
10493TH1D::TH1D()
10494{
10495 fDimension = 1;
10496 SetBinsLength(3);
10497 if (fgDefaultSumw2) Sumw2();
10498}
10499
10500////////////////////////////////////////////////////////////////////////////////
10501/// Create a 1-Dim histogram with fix bins of type double
10502/// (see TH1::TH1 for explanation of parameters)
10503
10504TH1D::TH1D(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10505: TH1(name,title,nbins,xlow,xup)
10506{
10507 fDimension = 1;
10509
10510 if (xlow >= xup) SetBuffer(fgBufferSize);
10511 if (fgDefaultSumw2) Sumw2();
10512}
10513
10514////////////////////////////////////////////////////////////////////////////////
10515/// Create a 1-Dim histogram with variable bins of type double
10516/// (see TH1::TH1 for explanation of parameters)
10517
10518TH1D::TH1D(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10519: TH1(name,title,nbins,xbins)
10520{
10521 fDimension = 1;
10523 if (fgDefaultSumw2) Sumw2();
10524}
10525
10526////////////////////////////////////////////////////////////////////////////////
10527/// Create a 1-Dim histogram with variable bins of type double
10528/// (see TH1::TH1 for explanation of parameters)
10529
10530TH1D::TH1D(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10531: TH1(name,title,nbins,xbins)
10532{
10533 fDimension = 1;
10535 if (fgDefaultSumw2) Sumw2();
10536}
10537
10538////////////////////////////////////////////////////////////////////////////////
10539/// Create a histogram from a TVectorD
10540/// by default the histogram name is "TVectorD" and title = ""
10541
10542TH1D::TH1D(const TVectorD &v)
10543: TH1("TVectorD","",v.GetNrows(),0,v.GetNrows())
10544{
10546 fDimension = 1;
10547 Int_t ivlow = v.GetLwb();
10548 for (Int_t i=0;i<fNcells-2;i++) {
10549 SetBinContent(i+1,v(i+ivlow));
10550 }
10552 if (fgDefaultSumw2) Sumw2();
10553}
10554
10555////////////////////////////////////////////////////////////////////////////////
10556/// Destructor.
10557
10559{
10560}
10561
10562////////////////////////////////////////////////////////////////////////////////
10563/// Constructor.
10564
10565TH1D::TH1D(const TH1D &h1d) : TH1(), TArrayD()
10566{
10567 // intentially call virtual method to warn if TProfile is copying
10568 h1d.Copy(*this);
10569}
10570
10571////////////////////////////////////////////////////////////////////////////////
10572/// Copy this to newth1
10573
10574void TH1D::Copy(TObject &newth1) const
10575{
10577}
10578
10579////////////////////////////////////////////////////////////////////////////////
10580/// Reset.
10581
10583{
10586}
10587
10588////////////////////////////////////////////////////////////////////////////////
10589/// Set total number of bins including under/overflow
10590/// Reallocate bin contents array
10591
10593{
10594 if (n < 0) n = fXaxis.GetNbins() + 2;
10595 fNcells = n;
10596 TArrayD::Set(n);
10597}
10598
10599////////////////////////////////////////////////////////////////////////////////
10600/// Operator =
10601
10603{
10604 // intentially call virtual method to warn if TProfile is copying
10605 if (this != &h1d)
10606 h1d.Copy(*this);
10607 return *this;
10608}
10609
10610////////////////////////////////////////////////////////////////////////////////
10611/// Operator *
10612
10614{
10615 TH1D hnew = h1;
10616 hnew.Scale(c1);
10617 hnew.SetDirectory(nullptr);
10618 return hnew;
10619}
10620
10621////////////////////////////////////////////////////////////////////////////////
10622/// Operator +
10623
10624TH1D operator+(const TH1D &h1, const TH1D &h2)
10625{
10626 TH1D hnew = h1;
10627 hnew.Add(&h2,1);
10628 hnew.SetDirectory(nullptr);
10629 return hnew;
10630}
10631
10632////////////////////////////////////////////////////////////////////////////////
10633/// Operator -
10634
10635TH1D operator-(const TH1D &h1, const TH1D &h2)
10636{
10637 TH1D hnew = h1;
10638 hnew.Add(&h2,-1);
10639 hnew.SetDirectory(nullptr);
10640 return hnew;
10641}
10642
10643////////////////////////////////////////////////////////////////////////////////
10644/// Operator *
10645
10646TH1D operator*(const TH1D &h1, const TH1D &h2)
10647{
10648 TH1D hnew = h1;
10649 hnew.Multiply(&h2);
10650 hnew.SetDirectory(nullptr);
10651 return hnew;
10652}
10653
10654////////////////////////////////////////////////////////////////////////////////
10655/// Operator /
10656
10657TH1D operator/(const TH1D &h1, const TH1D &h2)
10658{
10659 TH1D hnew = h1;
10660 hnew.Divide(&h2);
10661 hnew.SetDirectory(nullptr);
10662 return hnew;
10663}
10664
10665////////////////////////////////////////////////////////////////////////////////
10666///return pointer to histogram with name
10667///hid if id >=0
10668///h_id if id <0
10669
10670TH1 *R__H(Int_t hid)
10671{
10672 TString hname;
10673 if(hid >= 0) hname.Form("h%d",hid);
10674 else hname.Form("h_%d",hid);
10675 return (TH1*)gDirectory->Get(hname);
10676}
10677
10678////////////////////////////////////////////////////////////////////////////////
10679///return pointer to histogram with name hname
10680
10681TH1 *R__H(const char * hname)
10682{
10683 return (TH1*)gDirectory->Get(hname);
10684}
10685
10686
10687/// \fn void TH1::SetBarOffset(Float_t offset)
10688/// Set the bar offset as fraction of the bin width for drawing mode "B".
10689/// This shifts bars to the right on the x axis, and helps to draw bars next to each other.
10690/// \see THistPainter, SetBarWidth()
10691
10692/// \fn void TH1::SetBarWidth(Float_t width)
10693/// Set the width of bars as fraction of the bin width for drawing mode "B".
10694/// This allows for making bars narrower than the bin width. With SetBarOffset(), this helps to draw multiple bars next to each other.
10695/// \see THistPainter, SetBarOffset()
#define b(i)
Definition RSha256.hxx:100
#define c(i)
Definition RSha256.hxx:101
#define a(i)
Definition RSha256.hxx:99
#define s1(x)
Definition RSha256.hxx:91
#define h(i)
Definition RSha256.hxx:106
#define e(i)
Definition RSha256.hxx:103
short Style_t
Style number (short)
Definition RtypesCore.h:96
bool Bool_t
Boolean (0=false, 1=true) (bool)
Definition RtypesCore.h:77
int Int_t
Signed integer 4 bytes (int)
Definition RtypesCore.h:59
short Color_t
Color number (short)
Definition RtypesCore.h:99
short Version_t
Class version identifier (short)
Definition RtypesCore.h:79
char Char_t
Character 1 byte (char)
Definition RtypesCore.h:51
float Float_t
Float 4 bytes (float)
Definition RtypesCore.h:71
short Short_t
Signed Short integer 2 bytes (short)
Definition RtypesCore.h:53
constexpr Bool_t kFALSE
Definition RtypesCore.h:108
double Double_t
Double 8 bytes.
Definition RtypesCore.h:73
long long Long64_t
Portable signed long integer 8 bytes.
Definition RtypesCore.h:83
constexpr Bool_t kTRUE
Definition RtypesCore.h:107
const char Option_t
Option string (const char)
Definition RtypesCore.h:80
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
#define gDirectory
Definition TDirectory.h:385
R__EXTERN TEnv * gEnv
Definition TEnv.h:170
#define R__ASSERT(e)
Checks condition e and reports a fatal error if it's false.
Definition TError.h:125
winID h TVirtualViewer3D TVirtualGLPainter p
Option_t Option_t option
Option_t Option_t SetLineWidth
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
Option_t Option_t SetFillStyle
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t del
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t np
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t index
Option_t Option_t SetLineColor
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void value
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t UChar_t len
Option_t Option_t TPoint TPoint const char x1
Option_t Option_t TPoint TPoint const char y2
Option_t Option_t SetFillColor
Option_t Option_t SetMarkerStyle
Option_t Option_t width
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h Atom_t Int_t ULong_t ULong_t unsigned char prop_list Atom_t Atom_t Atom_t Time_t type
Option_t Option_t TPoint TPoint const char y1
char name[80]
Definition TGX11.cxx:110
static bool IsEquidistantBinning(const TAxis &axis)
Test if the binning is equidistant.
Definition TH1.cxx:5940
void H1LeastSquareLinearFit(Int_t ndata, Double_t &a0, Double_t &a1, Int_t &ifail)
Least square linear fit without weights.
Definition TH1.cxx:4886
void H1InitGaus()
Compute Initial values of parameters for a gaussian.
Definition TH1.cxx:4721
void H1InitExpo()
Compute Initial values of parameters for an exponential.
Definition TH1.cxx:4777
TH1C operator+(const TH1C &h1, const TH1C &h2)
Operator +.
Definition TH1.cxx:9702
TH1C operator-(const TH1C &h1, const TH1C &h2)
Operator -.
Definition TH1.cxx:9713
TH1C operator/(const TH1C &h1, const TH1C &h2)
Operator /.
Definition TH1.cxx:9735
void H1LeastSquareSeqnd(Int_t n, Double_t *a, Int_t idim, Int_t &ifail, Int_t k, Double_t *b)
Extracted from CERN Program library routine DSEQN.
Definition TH1.cxx:4932
static Bool_t AlmostEqual(Double_t a, Double_t b, Double_t epsilon=0.00000001)
Test if two double are almost equal.
Definition TH1.cxx:5923
static Bool_t AlmostInteger(Double_t a, Double_t epsilon=0.00000001)
Test if a double is almost an integer.
Definition TH1.cxx:5931
TF1 * gF1
Definition TH1.cxx:590
TH1 * R__H(Int_t hid)
return pointer to histogram with name hid if id >=0 h_id if id <0
Definition TH1.cxx:10668
TH1C operator*(Double_t c1, const TH1C &h1)
Operator *.
Definition TH1.cxx:9691
void H1LeastSquareFit(Int_t n, Int_t m, Double_t *a)
Least squares lpolynomial fitting without weights.
Definition TH1.cxx:4827
void H1InitPolynom()
Compute Initial values of parameters for a polynom.
Definition TH1.cxx:4797
float xmin
int nentries
float ymin
float xmax
float ymax
#define gInterpreter
Int_t gDebug
Global variable setting the debug level. Set to 0 to disable, increase it in steps of 1 to increase t...
Definition TROOT.cxx:627
R__EXTERN TVirtualMutex * gROOTMutex
Definition TROOT.h:63
#define gROOT
Definition TROOT.h:414
R__EXTERN TRandom * gRandom
Definition TRandom.h:62
void Printf(const char *fmt,...)
Formats a string in a circular formatting buffer and prints the string.
Definition TString.cxx:2509
R__EXTERN TStyle * gStyle
Definition TStyle.h:442
#define R__LOCKGUARD(mutex)
#define gPad
#define R__WRITE_LOCKGUARD(mutex)
Class describing the binned data sets : vectors of x coordinates, y values and optionally error on y ...
Definition BinData.h:52
class describing the range in the coordinates it supports multiple range in a coordinate.
Definition DataRange.h:35
void AndersonDarling2SamplesTest(Double_t &pvalue, Double_t &testStat) const
Performs the Anderson-Darling 2-Sample Test.
Definition GoFTest.cxx:646
const_iterator begin() const
const_iterator end() const
Array of chars or bytes (8 bits per element).
Definition TArrayC.h:27
Char_t * fArray
Definition TArrayC.h:30
void Reset(Char_t val=0)
Definition TArrayC.h:47
void Set(Int_t n) override
Set size of this array to n chars.
Definition TArrayC.cxx:104
Array of doubles (64 bits per element).
Definition TArrayD.h:27
Double_t * fArray
Definition TArrayD.h:30
void Streamer(TBuffer &) override
Stream a TArrayD object.
Definition TArrayD.cxx:148
void Copy(TArrayD &array) const
Definition TArrayD.h:42
void Set(Int_t n) override
Set size of this array to n doubles.
Definition TArrayD.cxx:105
const Double_t * GetArray() const
Definition TArrayD.h:43
void Reset()
Definition TArrayD.h:47
Array of floats (32 bits per element).
Definition TArrayF.h:27
void Reset()
Definition TArrayF.h:47
void Set(Int_t n) override
Set size of this array to n floats.
Definition TArrayF.cxx:104
Array of integers (32 bits per element).
Definition TArrayI.h:27
Int_t * fArray
Definition TArrayI.h:30
void Set(Int_t n) override
Set size of this array to n ints.
Definition TArrayI.cxx:104
void Reset()
Definition TArrayI.h:47
Array of long64s (64 bits per element).
Definition TArrayL64.h:27
Long64_t * fArray
Definition TArrayL64.h:30
void Set(Int_t n) override
Set size of this array to n long64s.
void Reset()
Definition TArrayL64.h:47
Array of shorts (16 bits per element).
Definition TArrayS.h:27
void Set(Int_t n) override
Set size of this array to n shorts.
Definition TArrayS.cxx:104
void Reset()
Definition TArrayS.h:47
Short_t * fArray
Definition TArrayS.h:30
Abstract array base class.
Definition TArray.h:31
Int_t fN
Definition TArray.h:38
virtual void Set(Int_t n)=0
virtual Color_t GetTitleColor() const
Definition TAttAxis.h:47
virtual Color_t GetLabelColor() const
Definition TAttAxis.h:39
virtual Int_t GetNdivisions() const
Definition TAttAxis.h:37
virtual Color_t GetAxisColor() const
Definition TAttAxis.h:38
virtual void SetTitleOffset(Float_t offset=1)
Set distance between the axis and the axis title.
Definition TAttAxis.cxx:279
virtual Style_t GetTitleFont() const
Definition TAttAxis.h:48
virtual Float_t GetLabelOffset() const
Definition TAttAxis.h:41
virtual void SetAxisColor(Color_t color=1, Float_t alpha=1.)
Set color of the line axis and tick marks.
Definition TAttAxis.cxx:141
virtual void SetLabelSize(Float_t size=0.04)
Set size of axis labels.
Definition TAttAxis.cxx:184
virtual Style_t GetLabelFont() const
Definition TAttAxis.h:40
virtual void SetTitleFont(Style_t font=62)
Set the title font.
Definition TAttAxis.cxx:308
virtual void SetLabelOffset(Float_t offset=0.005)
Set distance between the axis and the labels.
Definition TAttAxis.cxx:172
virtual void SetLabelFont(Style_t font=62)
Set labels' font.
Definition TAttAxis.cxx:161
virtual void SetTitleSize(Float_t size=0.04)
Set size of axis title.
Definition TAttAxis.cxx:290
virtual void SetTitleColor(Color_t color=1)
Set color of axis title.
Definition TAttAxis.cxx:299
virtual Float_t GetTitleSize() const
Definition TAttAxis.h:45
virtual Float_t GetLabelSize() const
Definition TAttAxis.h:42
virtual Float_t GetTickLength() const
Definition TAttAxis.h:46
virtual void ResetAttAxis(Option_t *option="")
Reset axis attributes.
Definition TAttAxis.cxx:78
virtual Float_t GetTitleOffset() const
Definition TAttAxis.h:44
virtual void SetTickLength(Float_t length=0.03)
Set tick mark length.
Definition TAttAxis.cxx:265
virtual void SetNdivisions(Int_t n=510, Bool_t optim=kTRUE)
Set the number of divisions for this axis.
Definition TAttAxis.cxx:214
virtual void SetLabelColor(Color_t color=1, Float_t alpha=1.)
Set color of labels.
Definition TAttAxis.cxx:151
virtual void Streamer(TBuffer &)
virtual Color_t GetFillColor() const
Return the fill area color.
Definition TAttFill.h:31
void Copy(TAttFill &attfill) const
Copy this fill attributes to a new TAttFill.
Definition TAttFill.cxx:206
virtual Style_t GetFillStyle() const
Return the fill area style.
Definition TAttFill.h:32
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.
Definition TAttFill.cxx:238
virtual void Streamer(TBuffer &)
virtual Color_t GetLineColor() const
Return the line color.
Definition TAttLine.h:35
virtual void SetLineStyle(Style_t lstyle)
Set the line style.
Definition TAttLine.h:44
virtual Width_t GetLineWidth() const
Return the line width.
Definition TAttLine.h:37
virtual Style_t GetLineStyle() const
Return the line style.
Definition TAttLine.h:36
void Copy(TAttLine &attline) const
Copy this line attributes to a new TAttLine.
Definition TAttLine.cxx:176
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.
Definition TAttLine.cxx:274
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.
virtual Style_t GetMarkerStyle() const
Return the marker style.
Definition TAttMarker.h:33
virtual void SetMarkerColor(Color_t mcolor=1)
Set the marker color.
Definition TAttMarker.h:39
virtual Color_t GetMarkerColor() const
Return the marker color.
Definition TAttMarker.h:32
virtual Size_t GetMarkerSize() const
Return the marker size.
Definition TAttMarker.h:34
virtual void SetMarkerStyle(Style_t mstyle=1)
Set the marker style.
Definition TAttMarker.h:41
void Copy(TAttMarker &attmarker) const
Copy this marker attributes to a new TAttMarker.
virtual void Streamer(TBuffer &)
virtual void SetMarkerSize(Size_t msize=1)
Set the marker size.
Definition TAttMarker.h:46
Class to manage histogram axis.
Definition TAxis.h:32
virtual void GetCenter(Double_t *center) const
Return an array with the center of all bins.
Definition TAxis.cxx:558
virtual Bool_t GetTimeDisplay() const
Definition TAxis.h:133
Bool_t IsAlphanumeric() const
Definition TAxis.h:90
const char * GetTitle() const override
Returns title of object.
Definition TAxis.h:137
virtual Double_t GetBinCenter(Int_t bin) const
Return center of bin.
Definition TAxis.cxx:482
Bool_t CanExtend() const
Definition TAxis.h:88
virtual void SetParent(TObject *obj)
Definition TAxis.h:169
const TArrayD * GetXbins() const
Definition TAxis.h:138
void SetCanExtend(Bool_t canExtend)
Definition TAxis.h:92
void Copy(TObject &axis) const override
Copy axis structure to another axis.
Definition TAxis.cxx:211
Double_t GetXmax() const
Definition TAxis.h:142
@ kLabelsUp
Definition TAxis.h:75
@ kLabelsDown
Definition TAxis.h:74
@ kLabelsHori
Definition TAxis.h:72
@ kAxisRange
Definition TAxis.h:66
@ kLabelsVert
Definition TAxis.h:73
virtual Int_t FindBin(Double_t x)
Find bin number corresponding to abscissa x.
Definition TAxis.cxx:293
virtual Double_t GetBinLowEdge(Int_t bin) const
Return low edge of bin.
Definition TAxis.cxx:522
virtual void SetTimeDisplay(Int_t value)
Definition TAxis.h:173
virtual void Set(Int_t nbins, Double_t xmin, Double_t xmax)
Initialize axis with fix bins.
Definition TAxis.cxx:790
virtual Int_t FindFixBin(Double_t x) const
Find bin number corresponding to abscissa x
Definition TAxis.cxx:422
void SaveAttributes(std::ostream &out, const char *name, const char *subname) override
Save axis attributes as C++ statement(s) on output stream out.
Definition TAxis.cxx:715
Int_t GetLast() const
Return last bin on the axis i.e.
Definition TAxis.cxx:473
virtual void SetLimits(Double_t xmin, Double_t xmax)
Definition TAxis.h:166
Double_t GetXmin() const
Definition TAxis.h:141
void Streamer(TBuffer &) override
Stream an object of class TAxis.
Definition TAxis.cxx:1224
Int_t GetNbins() const
Definition TAxis.h:127
virtual void GetLowEdge(Double_t *edge) const
Return an array with the low edge of all bins.
Definition TAxis.cxx:567
virtual void SetRange(Int_t first=0, Int_t last=0)
Set the viewing range for the axis using bin numbers.
Definition TAxis.cxx:1061
virtual Double_t GetBinWidth(Int_t bin) const
Return bin width.
Definition TAxis.cxx:546
virtual Double_t GetBinUpEdge(Int_t bin) const
Return up edge of bin.
Definition TAxis.cxx:532
Int_t GetFirst() const
Return first bin on the axis i.e.
Definition TAxis.cxx:462
THashList * GetLabels() const
Definition TAxis.h:123
Using a TBrowser one can browse all ROOT objects.
Definition TBrowser.h:37
Buffer base class used for serializing objects.
Definition TBuffer.h:43
void * New(ENewType defConstructor=kClassNew, Bool_t quiet=kFALSE) const
Return a pointer to a newly allocated object of this class.
Definition TClass.cxx:5017
ROOT::NewFunc_t GetNew() const
Return the wrapper around new ThisClass().
Definition TClass.cxx:7549
Collection abstract base class.
Definition TCollection.h:65
virtual bool UseRWLock(Bool_t enable=true)
Set this collection to use a RW lock upon access, making it thread safe.
TObject * Clone(const char *newname="") const override
Make a clone of an collection using the Streamer facility.
virtual Int_t GetSize() const
Return the capacity of the collection, i.e.
Describe directory structure in memory.
Definition TDirectory.h:45
virtual void Append(TObject *obj, Bool_t replace=kFALSE)
Append object to this directory.
virtual TObject * Remove(TObject *)
Remove an object from the in-memory list.
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
Definition TEnv.cxx:503
1-Dim function class
Definition TF1.h:182
static void RejectPoint(Bool_t reject=kTRUE)
Static function to set the global flag to reject points the fgRejectPoint global flag is tested by al...
Definition TF1.cxx:3723
virtual TH1 * GetHistogram() const
Return a pointer to the histogram used to visualise the function Note that this histogram is managed ...
Definition TF1.cxx:1634
static TClass * Class()
virtual Int_t GetNpar() const
Definition TF1.h:446
virtual Double_t Integral(Double_t a, Double_t b, Double_t epsrel=1.e-12)
IntegralOneDim or analytical integral.
Definition TF1.cxx:2580
virtual void InitArgs(const Double_t *x, const Double_t *params)
Initialize parameters addresses.
Definition TF1.cxx:2530
virtual void GetRange(Double_t *xmin, Double_t *xmax) const
Return range of a generic N-D function.
Definition TF1.cxx:2329
virtual Double_t EvalPar(const Double_t *x, const Double_t *params=nullptr)
Evaluate function with given coordinates and parameters.
Definition TF1.cxx:1498
virtual void SetParLimits(Int_t ipar, Double_t parmin, Double_t parmax)
Set lower and upper limits for parameter ipar.
Definition TF1.cxx:3562
static Bool_t RejectedPoint()
See TF1::RejectPoint above.
Definition TF1.cxx:3732
virtual Double_t Eval(Double_t x, Double_t y=0, Double_t z=0, Double_t t=0) const
Evaluate this function.
Definition TF1.cxx:1446
virtual void SetParameter(Int_t param, Double_t value)
Definition TF1.h:608
virtual Bool_t IsInside(const Double_t *x) const
return kTRUE if the point is inside the function range
Definition TF1.h:567
A 2-Dim function with parameters.
Definition TF2.h:29
TF3 defines a 3D Function with Parameters.
Definition TF3.h:28
Provides an indirection to the TFitResult class and with a semantics identical to a TFitResult pointe...
1-D histogram with a byte per channel (see TH1 documentation)
Definition TH1.h:714
~TH1C() override
Destructor.
Definition TH1.cxx:9615
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:9671
TH1C & operator=(const TH1C &h1)
Operator =.
Definition TH1.cxx:9681
TH1C()
Constructor.
Definition TH1.cxx:9567
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:9653
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:9632
void Reset(Option_t *option="") override
Reset.
Definition TH1.cxx:9661
1-D histogram with a double per channel (see TH1 documentation)
Definition TH1.h:926
~TH1D() override
Destructor.
Definition TH1.cxx:10556
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10590
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10572
TH1D()
Constructor.
Definition TH1.cxx:10491
TH1D & operator=(const TH1D &h1)
Operator =.
Definition TH1.cxx:10600
1-D histogram with a float per channel (see TH1 documentation)
Definition TH1.h:878
Double_t RetrieveBinContent(Int_t bin) const override
Raw retrieval of bin content on internal data structure see convention for numbering bins in TH1::Get...
Definition TH1.h:912
TH1F & operator=(const TH1F &h1)
Operator =.
Definition TH1.cxx:10420
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10392
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10410
~TH1F() override
Destructor.
Definition TH1.cxx:10385
TH1F()
Constructor.
Definition TH1.cxx:10311
1-D histogram with an int per channel (see TH1 documentation)
Definition TH1.h:796
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10042
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:10003
~TH1I() override
Destructor.
Definition TH1.cxx:9986
TH1I()
Constructor.
Definition TH1.cxx:9938
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10024
TH1I & operator=(const TH1I &h1)
Operator =.
Definition TH1.cxx:10052
1-D histogram with a long64 per channel (see TH1 documentation)
Definition TH1.h:837
TH1L & operator=(const TH1L &h1)
Operator =.
Definition TH1.cxx:10239
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:10190
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10229
~TH1L() override
Destructor.
Definition TH1.cxx:10173
TH1L()
Constructor.
Definition TH1.cxx:10125
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10211
1-D histogram with a short per channel (see TH1 documentation)
Definition TH1.h:755
TH1S & operator=(const TH1S &h1)
Operator =.
Definition TH1.cxx:9866
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:9838
TH1S()
Constructor.
Definition TH1.cxx:9752
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:9856
~TH1S() override
Destructor.
Definition TH1.cxx:9800
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:9817
TH1 is the base class of all histogram classes in ROOT.
Definition TH1.h:109
~TH1() override
Histogram default destructor.
Definition TH1.cxx:636
virtual void SetError(const Double_t *error)
Replace bin errors by values in array error.
Definition TH1.cxx:9068
virtual void SetDirectory(TDirectory *dir)
By default, when a histogram is created, it is added to the list of histogram objects in the current ...
Definition TH1.cxx:9054
virtual void FitPanel()
Display a panel with all histogram fit options.
Definition TH1.cxx:4319
Double_t * fBuffer
[fBufferSize] entry buffer
Definition TH1.h:169
virtual Int_t AutoP2FindLimits(Double_t min, Double_t max)
Buffer-based estimate of the histogram range using the power of 2 algorithm.
Definition TH1.cxx:1338
virtual Double_t GetEffectiveEntries() const
Number of effective entries of the histogram.
Definition TH1.cxx:4483
char * GetObjectInfo(Int_t px, Int_t py) const override
Redefines TObject::GetObjectInfo.
Definition TH1.cxx:4537
virtual void Smooth(Int_t ntimes=1, Option_t *option="")
Smooth bin contents of this histogram.
Definition TH1.cxx:6984
virtual Double_t GetBinCenter(Int_t bin) const
Return bin center for 1D histogram.
Definition TH1.cxx:9255
virtual void Rebuild(Option_t *option="")
Using the current bin info, recompute the arrays for contents and errors.
Definition TH1.cxx:7192
virtual void SetBarOffset(Float_t offset=0.25)
Set the bar offset as fraction of the bin width for drawing mode "B".
Definition TH1.h:612
static Bool_t fgStatOverflows
! Flag to use under/overflows in statistics
Definition TH1.h:178
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 i...
Definition TH1.cxx:3831
TAxis * GetZaxis()
Definition TH1.h:573
Int_t DistancetoPrimitive(Int_t px, Int_t py) override
Compute distance from point px,py to a line.
Definition TH1.cxx:2835
virtual Bool_t Multiply(TF1 *f1, Double_t c1=1)
Performs the operation:
Definition TH1.cxx:6111
@ kXaxis
Definition TH1.h:123
@ kNoAxis
NOTE: Must always be 0 !!!
Definition TH1.h:122
@ kZaxis
Definition TH1.h:125
@ kYaxis
Definition TH1.h:124
Int_t fNcells
Number of bins(1D), cells (2D) +U/Overflows.
Definition TH1.h:150
virtual void GetStats(Double_t *stats) const
fill the array stats from the contents of this histogram The array stats must be correctly dimensione...
Definition TH1.cxx:7926
virtual void Normalize(Option_t *option="")
Normalize a histogram to its integral or to its maximum.
Definition TH1.cxx:6273
void Copy(TObject &hnew) const override
Copy this histogram structure to newth1.
Definition TH1.cxx:2683
void SetTitle(const char *title) override
Change/set the title.
Definition TH1.cxx:6816
Double_t fTsumw
Total Sum of weights.
Definition TH1.h:157
virtual Float_t GetBarWidth() const
Definition TH1.h:501
Double_t fTsumw2
Total Sum of squares of weights.
Definition TH1.h:158
static void StatOverflows(Bool_t flag=kTRUE)
if flag=kTRUE, underflows and overflows are used by the Fill functions in the computation of statisti...
Definition TH1.cxx:7030
virtual Float_t GetBarOffset() const
Definition TH1.h:500
Double_t GetSumOfAllWeights(const bool includeOverflow, Double_t *sumWeightSquare=nullptr) const
Return the sum of all weights and optionally also the sum of weight squares.
Definition TH1.cxx:8019
TList * fFunctions
->Pointer to list of functions (fits and user)
Definition TH1.h:167
static Bool_t fgAddDirectory
! Flag to add histograms to the directory
Definition TH1.h:177
static TClass * Class()
static Int_t GetDefaultBufferSize()
Static function return the default buffer size for automatic histograms the parameter fgBufferSize ma...
Definition TH1.cxx:4441
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 n...
Definition TH1.cxx:8090
Double_t fTsumwx2
Total Sum of weight*X*X.
Definition TH1.h:160
virtual Double_t GetStdDev(Int_t axis=1) const
Returns the Standard Deviation (Sigma).
Definition TH1.cxx:7700
TH1()
Histogram default constructor.
Definition TH1.cxx:608
static TH1 * TransformHisto(TVirtualFFT *fft, TH1 *h_output, Option_t *option)
For a given transform (first parameter), fills the histogram (second parameter) with the transform ou...
Definition TH1.cxx:9433
void UseCurrentStyle() override
Copy current attributes from/to current style.
Definition TH1.cxx:7562
virtual void LabelsOption(Option_t *option="h", Option_t *axis="X")
Sort bins with labels or set option(s) to draw axis with labels.
Definition TH1.cxx:5444
virtual Int_t GetNbinsY() const
Definition TH1.h:542
Short_t fBarOffset
(1000*offset) for bar charts or legos
Definition TH1.h:154
virtual Double_t Chi2TestX(const TH1 *h2, Double_t &chi2, Int_t &ndf, Int_t &igood, Option_t *option="UU", Double_t *res=nullptr) const
The computation routine of the Chisquare test.
Definition TH1.cxx:2064
static bool CheckBinLimits(const TAxis *a1, const TAxis *a2)
Check bin limits.
Definition TH1.cxx:1536
virtual Double_t GetBinError(Int_t bin) const
Return value of error associated to bin number bin.
Definition TH1.cxx:9177
static Int_t FitOptionsMake(Option_t *option, Foption_t &Foption)
Decode string choptin and fill fitOption structure.
Definition TH1.cxx:4712
virtual Int_t GetNbinsZ() const
Definition TH1.h:543
virtual Double_t GetNormFactor() const
Definition TH1.h:545
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.
Definition TH1.cxx:7628
virtual Double_t GetSkewness(Int_t axis=1) const
Definition TH1.cxx:7764
virtual void ClearUnderflowAndOverflow()
Remove all the content from the underflow and overflow bins, without changing the number of entries A...
Definition TH1.cxx:2518
virtual void FillRandom(TF1 *f1, Int_t ntimes=5000, TRandom *rng=nullptr)
Definition TH1.cxx:3556
virtual Double_t GetContourLevelPad(Int_t level) const
Return the value of contour number "level" in Pad coordinates.
Definition TH1.cxx:8553
virtual TH1 * DrawNormalized(Option_t *option="", Double_t norm=1) const
Draw a normalized copy of this histogram.
Definition TH1.cxx:3172
@ kNeutral
Adapt to the global flag.
Definition TH1.h:133
virtual Int_t GetDimension() const
Definition TH1.h:527
void Streamer(TBuffer &) override
Stream a class object.
Definition TH1.cxx:7038
static void AddDirectory(Bool_t add=kTRUE)
Sets the flag controlling the automatic add of histograms in memory.
Definition TH1.cxx:1289
@ kIsAverage
Bin contents are average (used by Add)
Definition TH1.h:409
@ kUserContour
User specified contour levels.
Definition TH1.h:404
@ kNoStats
Don't draw stats box.
Definition TH1.h:403
@ kAutoBinPTwo
different than 1.
Definition TH1.h:412
@ kIsNotW
Histogram is forced to be not weighted even when the histogram is filled with weighted.
Definition TH1.h:410
@ kIsHighlight
bit set if histo is highlight
Definition TH1.h:413
virtual void SetContourLevel(Int_t level, Double_t value)
Set value for one contour level.
Definition TH1.cxx:8639
virtual Bool_t CanExtendAllAxes() const
Returns true if all axes are extendable.
Definition TH1.cxx:6731
TDirectory * fDirectory
! Pointer to directory holding this histogram
Definition TH1.h:170
virtual void Reset(Option_t *option="")
Reset this histogram: contents, errors, etc.
Definition TH1.cxx:7208
void SetNameTitle(const char *name, const char *title) override
Change the name and title of this histogram.
Definition TH1.cxx:9091
TAxis * GetXaxis()
Definition TH1.h:571
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 abo...
Definition TH1.cxx:5034
TH1 * GetCumulative(Bool_t forward=kTRUE, const char *suffix="_cumulative") const
Return a pointer to a histogram containing the cumulative content.
Definition TH1.cxx:2628
static Double_t AutoP2GetPower2(Double_t x, Bool_t next=kTRUE)
Auxiliary function to get the power of 2 next (larger) or previous (smaller) a given x.
Definition TH1.cxx:1303
virtual Int_t GetNcells() const
Definition TH1.h:544
virtual Int_t ShowPeaks(Double_t sigma=2, Option_t *option="", Double_t threshold=0.05)
Interface to TSpectrum::Search.
Definition TH1.cxx:9415
static Bool_t RecomputeAxisLimits(TAxis &destAxis, const TAxis &anAxis)
Finds new limits for the axis for the Merge function.
Definition TH1.cxx:5970
virtual Double_t GetSumOfWeights() const
Return the sum of weights across all bins excluding under/overflows.
Definition TH1.h:559
virtual void PutStats(Double_t *stats)
Replace current statistics with the values in array stats.
Definition TH1.cxx:7977
TVirtualHistPainter * GetPainter(Option_t *option="")
Return pointer to painter.
Definition TH1.cxx:4546
TObject * FindObject(const char *name) const override
Search object named name in the list of functions.
Definition TH1.cxx:3891
void Print(Option_t *option="") const override
Print some global quantities for this histogram.
Definition TH1.cxx:7114
static Bool_t GetDefaultSumw2()
Return kTRUE if TH1::Sumw2 must be called when creating new histograms.
Definition TH1.cxx:4450
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 ...
Definition TH1.cxx:3768
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.
Definition TH1.cxx:3933
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.
Definition TH1.cxx:5021
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 b...
Definition TH1.cxx:8662
virtual Int_t GetNbinsX() const
Definition TH1.h:541
virtual void SetMaximum(Double_t maximum=-1111)
Definition TH1.h:652
virtual TH1 * FFT(TH1 *h_output, Option_t *option)
This function allows to do discrete Fourier transforms of TH1 and TH2.
Definition TH1.cxx:3312
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition TH1.cxx:5377
virtual TH1 * ShowBackground(Int_t niter=20, Option_t *option="same")
This function calculates the background spectrum in this histogram.
Definition TH1.cxx:9401
static Bool_t SameLimitsAndNBins(const TAxis &axis1, const TAxis &axis2)
Same limits and bins.
Definition TH1.cxx:5960
virtual Bool_t Add(TF1 *h1, Double_t c1=1, Option_t *option="")
Performs the operation: this = this + c1*f1 if errors are defined (see TH1::Sumw2),...
Definition TH1.cxx:819
Double_t fMaximum
Maximum value for plotting.
Definition TH1.h:161
Int_t fBufferSize
fBuffer size
Definition TH1.h:168
TString ProvideSaveName(Option_t *option, Bool_t testfdir=kFALSE)
Provide variable name for histogram for saving as primitive Histogram pointer has by default the hist...
Definition TH1.cxx:7347
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.
Definition TH1.cxx:8081
Int_t fDimension
! Histogram dimension (1, 2 or 3 dim)
Definition TH1.h:171
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-empt...
Definition TH1.cxx:9320
EBinErrorOpt fBinStatErrOpt
Option for bin statistical errors.
Definition TH1.h:174
static Int_t fgBufferSize
! Default buffer size for automatic histograms
Definition TH1.h:176
virtual void SetBinsLength(Int_t=-1)
Definition TH1.h:628
Double_t fNormFactor
Normalization factor.
Definition TH1.h:163
@ kFullyConsistent
Definition TH1.h:139
@ kDifferentNumberOfBins
Definition TH1.h:143
@ kDifferentDimensions
Definition TH1.h:144
@ kDifferentBinLimits
Definition TH1.h:141
@ kDifferentAxisLimits
Definition TH1.h:142
@ kDifferentLabels
Definition TH1.h:140
virtual Int_t Fill(Double_t x)
Increment bin with abscissa X by 1.
Definition TH1.cxx:3372
TAxis * GetYaxis()
Definition TH1.h:572
TArrayD fContour
Array to display contour levels.
Definition TH1.h:164
virtual Double_t GetBinErrorLow(Int_t bin) const
Return lower error associated to bin number bin.
Definition TH1.cxx:9193
void Browse(TBrowser *b) override
Browse the Histogram object.
Definition TH1.cxx:755
virtual void SetContent(const Double_t *content)
Replace bin contents by the contents of array content.
Definition TH1.cxx:8511
void Draw(Option_t *option="") override
Draw this histogram with options.
Definition TH1.cxx:3076
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,...
Definition TH1.cxx:7474
Short_t fBarWidth
(1000*width) for bar charts or legos
Definition TH1.h:155
virtual Double_t GetBinErrorSqUnchecked(Int_t bin) const
Definition TH1.h:705
Int_t AxisChoice(Option_t *axis) const
Choose an axis according to "axis".
Definition Haxis.cxx:14
virtual void SetMinimum(Double_t minimum=-1111)
Definition TH1.h:653
Bool_t IsBinUnderflow(Int_t bin, Int_t axis=0) const
Return true if the bin is underflow.
Definition TH1.cxx:5276
void SavePrimitive(std::ostream &out, Option_t *option="") override
Save primitive as a C++ statement(s) on output stream out.
Definition TH1.cxx:7369
static bool CheckBinLabels(const TAxis *a1, const TAxis *a2)
Check that axis have same labels.
Definition TH1.cxx:1563
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...
Definition TH1.cxx:5177
static void SetDefaultSumw2(Bool_t sumw2=kTRUE)
When this static function is called with sumw2=kTRUE, all new histograms will automatically activate ...
Definition TH1.cxx:6798
virtual void SetBuffer(Int_t bufsize, Option_t *option="")
Set the maximum number of entries to be kept in the buffer.
Definition TH1.cxx:8571
Bool_t IsBinOverflow(Int_t bin, Int_t axis=0) const
Return true if the bin is overflow.
Definition TH1.cxx:5244
UInt_t GetAxisLabelStatus() const
Internal function used in TH1::Fill to see which axis is full alphanumeric, i.e.
Definition TH1.cxx:6770
Double_t * fIntegral
! Integral of bins used by GetRandom
Definition TH1.h:172
Double_t fMinimum
Minimum value for plotting.
Definition TH1.h:162
virtual Double_t Integral(Option_t *option="") const
Return integral of bin contents.
Definition TH1.cxx:8054
static void SetDefaultBufferSize(Int_t bufsize=1000)
Static function to set the default buffer size for automatic histograms.
Definition TH1.cxx:6788
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 th...
Definition TH1.cxx:9336
virtual void DirectoryAutoAdd(TDirectory *)
Perform the automatic addition of the histogram to the given directory.
Definition TH1.cxx:2813
virtual void GetLowEdge(Double_t *edge) const
Fill array with low edge of bins for 1D histogram Better to use h1.GetXaxis()->GetLowEdge(edge)
Definition TH1.cxx:9301
virtual Double_t GetBinLowEdge(Int_t bin) const
Return bin lower edge for 1D histogram.
Definition TH1.cxx:9266
void Build()
Creates histogram basic data structure.
Definition TH1.cxx:764
virtual Double_t GetEntries() const
Return the current number of entries.
Definition TH1.cxx:4458
virtual Double_t RetrieveBinContent(Int_t bin) const =0
Raw retrieval of bin content on internal data structure see convention for numbering bins in TH1::Get...
virtual TF1 * GetFunction(const char *name) const
Return pointer to function with name.
Definition TH1.cxx:9165
virtual TH1 * Rebin(Int_t ngroup=2, const char *newname="", const Double_t *xbins=nullptr)
Rebin this histogram.
Definition TH1.cxx:6370
virtual Int_t BufferFill(Double_t x, Double_t w)
accumulate arguments in buffer.
Definition TH1.cxx:1501
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.
Definition TH1.cxx:5148
virtual UInt_t SetCanExtend(UInt_t extendBitMask)
Make the histogram axes extendable / not extendable according to the bit mask returns the previous bi...
Definition TH1.cxx:6744
TList * GetListOfFunctions() const
Definition TH1.h:488
void SetName(const char *name) override
Change the name of this histogram.
Definition TH1.cxx:9077
virtual TH1 * DrawCopy(Option_t *option="", const char *name_postfix="_copy") const
Copy this histogram and Draw in the current pad.
Definition TH1.cxx:3141
virtual Double_t GetRandom(TRandom *rng=nullptr, Option_t *option="") const
Return a random number distributed according the histogram bin contents.
Definition TH1.cxx:5071
Bool_t IsEmpty() const
Check if a histogram is empty (this is a protected method used mainly by TH1Merger )
Definition TH1.cxx:5226
virtual Double_t GetMeanError(Int_t axis=1) const
Return standard error of mean of this histogram along the X axis.
Definition TH1.cxx:7668
void Paint(Option_t *option="") override
Control routine to paint any kind of histograms.
Definition TH1.cxx:6301
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 ...
Definition TH1.cxx:8175
virtual void ResetStats()
Reset the statistics including the number of entries and replace with values calculated from bin cont...
Definition TH1.cxx:7995
virtual void SetBinErrorOption(EBinErrorOpt type)
Definition TH1.h:629
virtual void DrawPanel()
Display a panel with all histogram drawing options.
Definition TH1.cxx:3203
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 comput...
Definition TH1.cxx:2497
virtual Double_t Chi2Test(const TH1 *h2, Option_t *option="UU", Double_t *res=nullptr) const
test for comparing weighted and unweighted histograms.
Definition TH1.cxx:2005
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.
Definition TH1.cxx:3501
virtual void GetMinimumAndMaximum(Double_t &min, Double_t &max) const
Retrieve the minimum and maximum values in the histogram.
Definition TH1.cxx:8848
@ kNstat
Size of statistics data (up to TProfile3D)
Definition TH1.h:422
virtual Int_t GetMaximumBin() const
Return location of bin with maximum value in the range.
Definition TH1.cxx:8694
static Int_t AutoP2GetBins(Int_t n)
Auxiliary function to get the next power of 2 integer value larger then n.
Definition TH1.cxx:1316
Double_t fEntries
Number of entries.
Definition TH1.h:156
virtual Long64_t Merge(TCollection *list)
Definition TH1.h:592
virtual void SetColors(Color_t linecolor=-1, Color_t markercolor=-1, Color_t fillcolor=-1)
Shortcut to set the three histogram colors with a single call.
Definition TH1.cxx:4502
void ExecuteEvent(Int_t event, Int_t px, Int_t py) override
Execute action corresponding to one event.
Definition TH1.cxx:3268
virtual Double_t * GetIntegral()
Return a pointer to the array of bins integral.
Definition TH1.cxx:2598
TAxis fZaxis
Z axis descriptor.
Definition TH1.h:153
EStatOverflows fStatOverflows
Per object flag to use under/overflows in statistics.
Definition TH1.h:175
TClass * IsA() const override
Definition TH1.h:693
virtual void FillN(Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride=1)
Fill this histogram with an array x and weights w.
Definition TH1.cxx:3475
static bool CheckEqualAxes(const TAxis *a1, const TAxis *a2)
Check that the axis are the same.
Definition TH1.cxx:1606
@ kPoisson2
Errors from Poisson interval at 95% CL (~ 2 sigma)
Definition TH1.h:117
@ kNormal
Errors with Normal (Wald) approximation: errorUp=errorLow= sqrt(N)
Definition TH1.h:115
virtual Double_t GetBinContent(Int_t bin) const
Return content of bin number bin.
Definition TH1.cxx:5123
virtual Int_t GetContour(Double_t *levels=nullptr)
Return contour values into array levels if pointer levels is non zero.
Definition TH1.cxx:8524
TAxis fXaxis
X axis descriptor.
Definition TH1.h:151
virtual Bool_t IsHighlight() const
Definition TH1.h:585
virtual void ExtendAxis(Double_t x, TAxis *axis)
Histogram is resized along axis such that x is in the axis range.
Definition TH1.cxx:6599
virtual Double_t GetBinWidth(Int_t bin) const
Return bin width for 1D histogram.
Definition TH1.cxx:9277
TArrayD fSumw2
Array of sum of squares of weights.
Definition TH1.h:165
TH1 * GetAsymmetry(TH1 *h2, Double_t c2=1, Double_t dc2=0)
Return a histogram containing the asymmetry of this histogram with h2, where the asymmetry is defined...
Definition TH1.cxx:4374
virtual Double_t GetContourLevel(Int_t level) const
Return value of contour number level.
Definition TH1.cxx:8543
virtual void SetContour(Int_t nlevels, const Double_t *levels=nullptr)
Set the number and values of contour levels.
Definition TH1.cxx:8600
virtual void SetHighlight(Bool_t set=kTRUE)
Set highlight (enable/disable) mode for the histogram by default highlight mode is disable.
Definition TH1.cxx:4517
virtual Double_t GetBinErrorUp(Int_t bin) const
Return upper error associated to bin number bin.
Definition TH1.cxx:9224
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this histogram by a constant c1.
Definition TH1.cxx:6699
virtual Int_t GetMinimumBin() const
Return location of bin with minimum value in the range.
Definition TH1.cxx:8782
virtual Double_t ComputeIntegral(Bool_t onlyPositive=false, Option_t *option="")
Compute integral (normalized cumulative sum of bins) w/o under/overflows The result is stored in fInt...
Definition TH1.cxx:2543
virtual Int_t GetSumw2N() const
Definition TH1.h:562
virtual Int_t FindBin(Double_t x, Double_t y=0, Double_t z=0)
Return Global bin number corresponding to x,y,z.
Definition TH1.cxx:3706
Bool_t GetStatOverflowsBehaviour() const
Definition TH1.h:391
void SaveAs(const char *filename="hist", Option_t *option="") const override
Save the histogram as .csv, .tsv or .txt.
Definition TH1.cxx:7286
virtual Int_t GetQuantiles(Int_t n, Double_t *xp, const Double_t *p=nullptr)
Compute Quantiles for this histogram.
Definition TH1.cxx:4650
virtual void AddBinContent(Int_t bin)=0
Increment bin content by 1.
TObject * Clone(const char *newname="") const override
Make a complete copy of the underlying object.
Definition TH1.cxx:2764
virtual Double_t GetStdDevError(Int_t axis=1) const
Return error of standard deviation estimation for Normal distribution.
Definition TH1.cxx:7748
virtual Bool_t Divide(TF1 *f1, Double_t c1=1)
Performs the operation: this = this/(c1*f1) if errors are defined (see TH1::Sumw2),...
Definition TH1.cxx:2852
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...
Definition TH1.cxx:8752
int LoggedInconsistency(const char *name, const TH1 *h1, const TH1 *h2, bool useMerge=false) const
Definition TH1.cxx:876
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.
Definition TH1.cxx:1635
static Int_t CheckConsistency(const TH1 *h1, const TH1 *h2)
Check histogram compatibility.
Definition TH1.cxx:1674
void RecursiveRemove(TObject *obj) override
Recursively remove object from the list of functions.
Definition TH1.cxx:6671
TAxis fYaxis
Y axis descriptor.
Definition TH1.h:152
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.
Definition TH1.cxx:8291
static void SmoothArray(Int_t NN, Double_t *XX, Int_t ntimes=1)
Smooth array xx, translation of Hbook routine hsmoof.F.
Definition TH1.cxx:6873
virtual void GetCenter(Double_t *center) const
Fill array with center of bins for 1D histogram Better to use h1.GetXaxis()->GetCenter(center)
Definition TH1.cxx:9288
TVirtualHistPainter * fPainter
! Pointer to histogram painter
Definition TH1.h:173
virtual void SetBins(Int_t nx, Double_t xmin, Double_t xmax)
Redefine x axis parameters.
Definition TH1.cxx:8884
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.
Definition TH1.cxx:3739
virtual void Sumw2(Bool_t flag=kTRUE)
Create structure to store sum of squares of weights.
Definition TH1.cxx:9137
virtual void SetEntries(Double_t n)
Definition TH1.h:639
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 th...
Definition TH1.cxx:6555
static bool CheckAxisLimits(const TAxis *a1, const TAxis *a2)
Check that the axis limits of the histograms are the same.
Definition TH1.cxx:1592
static Bool_t AddDirectoryStatus()
Static function: cannot be inlined on Windows/NT.
Definition TH1.cxx:747
static Bool_t fgDefaultSumw2
! Flag to call TH1::Sumw2 automatically at histogram creation time
Definition TH1.h:179
static void SavePrimitiveFunctions(std::ostream &out, const char *varname, TList *lst)
Save list of functions Also can be used by TGraph classes.
Definition TH1.cxx:7528
virtual void UpdateBinContent(Int_t bin, Double_t content)=0
Raw update of bin content on internal data structure see convention for numbering bins in TH1::GetBin...
Double_t fTsumwx
Total Sum of weight*X.
Definition TH1.h:159
virtual void LabelsDeflate(Option_t *axis="X")
Reduce the number of bins for the axis passed in the option to the number of bins having a label.
Definition TH1.cxx:5307
TString fOption
Histogram options.
Definition TH1.h:166
virtual void Eval(TF1 *f1, Option_t *option="")
Evaluate function f1 at the center of bins of this histogram.
Definition TH1.cxx:3220
virtual void SetBarWidth(Float_t width=0.5)
Set the width of bars as fraction of the bin width for drawing mode "B".
Definition TH1.h:613
virtual Int_t BufferEmpty(Int_t action=0)
Fill histogram with all entries in the buffer.
Definition TH1.cxx:1409
virtual void SetStats(Bool_t stats=kTRUE)
Set statistics option on/off.
Definition TH1.cxx:9107
virtual Double_t GetKurtosis(Int_t axis=1) const
Definition TH1.cxx:7837
2-D histogram with a double per channel (see TH1 documentation)
Definition TH2.h:400
static THLimitsFinder * GetLimitsFinder()
Return pointer to the current finder.
THashList implements a hybrid collection class consisting of a hash table and a list to store TObject...
Definition THashList.h:34
void Clear(Option_t *option="") override
Remove all objects from the list.
A doubly linked list.
Definition TList.h:38
void Streamer(TBuffer &) override
Stream all objects in the collection to or from the I/O buffer.
Definition TList.cxx:1323
TObject * FindObject(const char *name) const override
Find an object in this list using its name.
Definition TList.cxx:708
void RecursiveRemove(TObject *obj) override
Remove object from this collection and recursively remove the object from all other objects (and coll...
Definition TList.cxx:894
void Add(TObject *obj) override
Definition TList.h:81
TObject * Remove(TObject *obj) override
Remove object from the list.
Definition TList.cxx:952
TObject * First() const override
Return the first object in the list. Returns 0 when list is empty.
Definition TList.cxx:789
void Delete(Option_t *option="") override
Remove all objects from the list AND delete all heap based objects.
Definition TList.cxx:600
TObject * At(Int_t idx) const override
Returns the object at position idx. Returns 0 if idx is out of range.
Definition TList.cxx:487
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
void Copy(TObject &named) const override
Copy this to obj.
Definition TNamed.cxx:93
virtual void SetTitle(const char *title="")
Set the title of the TNamed.
Definition TNamed.cxx:173
const char * GetName() const override
Returns name of object.
Definition TNamed.h:49
void Streamer(TBuffer &) override
Stream an object of class TObject.
const char * GetTitle() const override
Returns title of object.
Definition TNamed.h:50
TString fTitle
Definition TNamed.h:33
TString fName
Definition TNamed.h:32
virtual void SetName(const char *name)
Set the name of the TNamed.
Definition TNamed.cxx:149
Mother of all ROOT objects.
Definition TObject.h:42
virtual const char * GetName() const
Returns name of object.
Definition TObject.cxx:458
R__ALWAYS_INLINE Bool_t TestBit(UInt_t f) const
Definition TObject.h:204
virtual UInt_t GetUniqueID() const
Return the unique object id.
Definition TObject.cxx:476
virtual const char * ClassName() const
Returns name of class to which the object belongs.
Definition TObject.cxx:226
virtual void UseCurrentStyle()
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyl...
Definition TObject.cxx:903
virtual void Warning(const char *method, const char *msgfmt,...) const
Issue warning message.
Definition TObject.cxx:1075
virtual void AppendPad(Option_t *option="")
Append graphics object to current pad.
Definition TObject.cxx:203
virtual void SaveAs(const char *filename="", Option_t *option="") const
Save this object in the file specified by filename.
Definition TObject.cxx:706
void SetBit(UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.
Definition TObject.cxx:882
virtual Bool_t InheritsFrom(const char *classname) const
Returns kTRUE if object inherits from class "classname".
Definition TObject.cxx:544
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1089
virtual void SetUniqueID(UInt_t uid)
Set the unique object id.
Definition TObject.cxx:893
static void SavePrimitiveDraw(std::ostream &out, const char *variable_name, Option_t *option=nullptr)
Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
Definition TObject.cxx:840
static TString SavePrimitiveVector(std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
Save array in the output stream "out" as vector.
Definition TObject.cxx:791
void ResetBit(UInt_t f)
Definition TObject.h:203
@ kCanDelete
if object in a list can be deleted
Definition TObject.h:70
@ kInvalidObject
if object ctor succeeded but object should not be used
Definition TObject.h:80
@ kMustCleanup
if object destructor must call RecursiveRemove()
Definition TObject.h:72
virtual void Info(const char *method, const char *msgfmt,...) const
Issue info message.
Definition TObject.cxx:1063
Longptr_t ExecPlugin(int nargs)
Int_t LoadPlugin()
Load the plugin library for this handler.
static TClass * Class()
This is the base class for the ROOT Random number generators.
Definition TRandom.h:27
Double_t Rndm() override
Machine independent random number generator.
Definition TRandom.cxx:558
virtual Double_t PoissonD(Double_t mean)
Generates a random number according to a Poisson law.
Definition TRandom.cxx:460
virtual ULong64_t Poisson(Double_t mean)
Generates a random integer N according to a Poisson law.
Definition TRandom.cxx:403
Basic string class.
Definition TString.h:138
Ssiz_t Length() const
Definition TString.h:425
void ToLower()
Change string to lower-case.
Definition TString.cxx:1189
TString & ReplaceSpecialCppChars()
Find special characters which are typically used in printf() calls and replace them by appropriate es...
Definition TString.cxx:1121
const char * Data() const
Definition TString.h:384
TString & ReplaceAll(const TString &s1, const TString &s2)
Definition TString.h:713
@ kIgnoreCase
Definition TString.h:285
void ToUpper()
Change string to upper case.
Definition TString.cxx:1202
Bool_t IsNull() const
Definition TString.h:422
virtual void Streamer(TBuffer &)
Stream a string object.
Definition TString.cxx:1418
TString & Append(const char *cs)
Definition TString.h:581
static TString Format(const char *fmt,...)
Static method which formats a string using a printf style format descriptor and return a TString.
Definition TString.cxx:2384
Bool_t Contains(const char *pat, ECaseCompare cmp=kExact) const
Definition TString.h:641
Ssiz_t Index(const char *pat, Ssiz_t i=0, ECaseCompare cmp=kExact) const
Definition TString.h:660
Int_t GetOptStat() const
Definition TStyle.h:247
void SetOptStat(Int_t stat=1)
The type of information printed in the histogram statistics box can be selected via the parameter mod...
Definition TStyle.cxx:1641
void SetHistFillColor(Color_t color=1)
Definition TStyle.h:383
Color_t GetHistLineColor() const
Definition TStyle.h:235
Bool_t IsReading() const
Definition TStyle.h:300
Float_t GetBarOffset() const
Definition TStyle.h:184
void SetHistLineStyle(Style_t styl=0)
Definition TStyle.h:386
Style_t GetHistFillStyle() const
Definition TStyle.h:236
Color_t GetHistFillColor() const
Definition TStyle.h:234
Float_t GetBarWidth() const
Definition TStyle.h:185
Bool_t GetCanvasPreferGL() const
Definition TStyle.h:189
void SetHistLineColor(Color_t color=1)
Definition TStyle.h:384
void SetBarOffset(Float_t baroff=0.5)
Definition TStyle.h:339
Style_t GetHistLineStyle() const
Definition TStyle.h:237
void SetBarWidth(Float_t barwidth=0.5)
Definition TStyle.h:340
void SetHistFillStyle(Style_t styl=0)
Definition TStyle.h:385
Width_t GetHistLineWidth() const
Definition TStyle.h:238
Int_t GetOptFit() const
Definition TStyle.h:246
void SetHistLineWidth(Width_t width=1)
Definition TStyle.h:387
TVectorT.
Definition TVectorT.h:29
TVirtualFFT is an interface class for Fast Fourier Transforms.
Definition TVirtualFFT.h:88
static TVirtualFFT * FFT(Int_t ndim, Int_t *n, Option_t *option)
Returns a pointer to the FFT of requested size and type.
static TVirtualFFT * SineCosine(Int_t ndim, Int_t *n, Int_t *r2rkind, Option_t *option)
Returns a pointer to a sine or cosine transform of requested size and kind.
Abstract Base Class for Fitting.
static TVirtualFitter * GetFitter()
static: return the current Fitter
Abstract interface to a histogram painter.
virtual void DrawPanel()=0
Int_t DistancetoPrimitive(Int_t px, Int_t py) override=0
Computes distance from point (px,py) to the object.
void ExecuteEvent(Int_t event, Int_t px, Int_t py) override=0
Execute action corresponding to an event at (px,py).
virtual void SetHighlight()=0
static TVirtualHistPainter * HistPainter(TH1 *obj)
Static function returning a pointer to the current histogram painter.
void Paint(Option_t *option="") override=0
This method must be overridden if a class wants to paint itself.
double gamma_quantile_c(double z, double alpha, double theta)
Inverse ( ) of the cumulative distribution function of the upper tail of the gamma distribution (gamm...
double gamma_quantile(double z, double alpha, double theta)
Inverse ( ) of the cumulative distribution function of the lower tail of the gamma distribution (gamm...
const Double_t sigma
Double_t y[n]
Definition legend1.C:17
return c1
Definition legend1.C:41
Double_t x[n]
Definition legend1.C:17
const Int_t n
Definition legend1.C:16
TH1F * h1
Definition legend1.C:5
TF1 * f1
Definition legend1.C:11
return c2
Definition legend2.C:14
R__ALWAYS_INLINE bool HasBeenDeleted(const TObject *obj)
Check if the TObject's memory has been deleted.
Definition TObject.h:407
TFitResultPtr FitObject(TH1 *h1, TF1 *f1, Foption_t &option, const ROOT::Math::MinimizerOptions &moption, const char *goption, ROOT::Fit::DataRange &range)
fitting function for a TH1 (called from TH1::Fit)
Definition HFitImpl.cxx:977
double Chisquare(const TH1 &h1, TF1 &f1, bool useRange, EChisquareType type)
compute the chi2 value for an histogram given a function (see TH1::Chisquare for the documentation)
void FitOptionsMake(EFitObjectType type, const char *option, Foption_t &fitOption)
Decode list of options into fitOption.
Definition HFitImpl.cxx:685
void FillData(BinData &dv, const TH1 *hist, TF1 *func=nullptr)
fill the data vector from a TH1.
R__EXTERN TVirtualRWMutex * gCoreMutex
Bool_t IsNaN(Double_t x)
Definition TMath.h:903
Int_t Nint(T x)
Round to nearest integer. Rounds half integers to the nearest even integer.
Definition TMath.h:704
Short_t Max(Short_t a, Short_t b)
Returns the largest of a and b.
Definition TMathBase.h:249
Double_t Prob(Double_t chi2, Int_t ndf)
Computation of the probability for a certain Chi-squared (chi2) and number of degrees of freedom (ndf...
Definition TMath.cxx:637
Double_t Median(Long64_t n, const T *a, const Double_t *w=nullptr, Long64_t *work=nullptr)
Same as RMS.
Definition TMath.h:1359
Double_t QuietNaN()
Returns a quiet NaN as defined by IEEE 754.
Definition TMath.h:913
Double_t Floor(Double_t x)
Rounds x downward, returning the largest integral value that is not greater than x.
Definition TMath.h:691
Double_t ATan(Double_t)
Returns the principal value of the arc tangent of x, expressed in radians.
Definition TMath.h:651
Double_t Ceil(Double_t x)
Rounds x upward, returning the smallest integral value that is not less than x.
Definition TMath.h:679
T MinElement(Long64_t n, const T *a)
Returns minimum of array a of length n.
Definition TMath.h:971
Double_t Log(Double_t x)
Returns the natural logarithm of x.
Definition TMath.h:767
Double_t Sqrt(Double_t x)
Returns the square root of x.
Definition TMath.h:673
Short_t Min(Short_t a, Short_t b)
Returns the smallest of a and b.
Definition TMathBase.h:197
constexpr Double_t Pi()
Definition TMath.h:40
Bool_t AreEqualRel(Double_t af, Double_t bf, Double_t relPrec)
Comparing floating points.
Definition TMath.h:429
Bool_t AreEqualAbs(Double_t af, Double_t bf, Double_t epsilon)
Comparing floating points.
Definition TMath.h:421
Double_t KolmogorovProb(Double_t z)
Calculates the Kolmogorov distribution function,.
Definition TMath.cxx:679
void Sort(Index n, const Element *a, Index *index, Bool_t down=kTRUE)
Sort the n elements of the array a of generic templated type Element.
Definition TMathBase.h:413
Long64_t BinarySearch(Long64_t n, const T *array, T value)
Binary search in an array of n values to locate value.
Definition TMathBase.h:329
Double_t Log10(Double_t x)
Returns the common (base-10) logarithm of x.
Definition TMath.h:773
Short_t Abs(Short_t d)
Returns the absolute value of parameter Short_t d.
Definition TMathBase.h:122
Double_t Infinity()
Returns an infinity as defined by the IEEE standard.
Definition TMath.h:928
th1 Draw()
TMarker m
Definition textangle.C:8
TLine l
Definition textangle.C:4
static uint64_t sum(uint64_t i)
Definition Factory.cxx:2338