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// clang-format off
79
80/** \class TH1
81 \ingroup Histograms
82TH1 is the base class of all histogram classes in %ROOT.
83
84It provides the common interface for operations such as binning, filling, drawing, which
85will be detailed below.
86
87-# [Creating histograms](\ref creating-histograms)
88 - [Labelling axes](\ref labelling-axis)
89-# [Binning](\ref binning)
90 - [Fix or variable bin size](\ref fix-var)
91 - [Convention for numbering bins](\ref convention)
92 - [Alphanumeric Bin Labels](\ref alpha)
93 - [Histograms with automatic bins](\ref auto-bin)
94 - [Rebinning](\ref rebinning)
95-# [Filling histograms](\ref filling-histograms)
96 - [Associated errors](\ref associated-errors)
97 - [Associated functions](\ref associated-functions)
98 - [Projections of histograms](\ref prof-hist)
99 - [Random Numbers and histograms](\ref random-numbers)
100 - [Making a copy of a histogram](\ref making-a-copy)
101 - [Normalizing histograms](\ref normalizing)
102-# [Drawing histograms](\ref drawing-histograms)
103 - [Setting Drawing histogram contour levels (2-D hists only)](\ref cont-level)
104 - [Setting histogram graphics attributes](\ref graph-att)
105 - [Customising how axes are drawn](\ref axis-drawing)
106-# [Fitting histograms](\ref fitting-histograms)
107-# [Saving/reading histograms to/from a ROOT file](\ref saving-histograms)
108-# [Operations on histograms](\ref operations-on-histograms)
109-# [Miscellaneous operations](\ref misc)
110
111ROOT supports the following histogram types:
112
113 - 1-D histograms:
114 - TH1C : histograms with one byte per channel. Maximum bin content = 127
115 - TH1S : histograms with one short per channel. Maximum bin content = 32767
116 - TH1I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
117 - TH1L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
118 - TH1F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content =
119+/-16777216 (\ref floatmax "***")
120 - TH1D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content =
121+/-9007199254740992 (\ref doublemax "****")
122 - 2-D histograms:
123 - TH2C : histograms with one byte per channel. Maximum bin content = 127
124 - TH2S : histograms with one short per channel. Maximum bin content = 32767
125 - TH2I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
126 - TH2L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
127 - TH2F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content =
128+/-16777216 (\ref floatmax "***")
129 - TH2D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content =
130+/-9007199254740992 (\ref doublemax "****")
131 - 3-D histograms:
132 - TH3C : histograms with one byte per channel. Maximum bin content = 127
133 - TH3S : histograms with one short per channel. Maximum bin content = 32767
134 - TH3I : histograms with one int per channel. Maximum bin content = INT_MAX (\ref intmax "*")
135 - TH3L : histograms with one long64 per channel. Maximum bin content = LLONG_MAX (\ref llongmax "**")
136 - TH3F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content =
137+/-16777216 (\ref floatmax "***")
138 - TH3D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content =
139+/-9007199254740992 (\ref doublemax "****")
140 - Profile histograms: See classes TProfile, TProfile2D and TProfile3D.
141 Profile histograms are used to display the mean value of Y and its standard deviation
142 for each bin in X. Profile histograms are in many cases an elegant
143 replacement of two-dimensional histograms : the inter-relation of two
144 measured quantities X and Y can always be visualized by a two-dimensional
145 histogram or scatter-plot; If Y is an unknown (but single-valued)
146 approximate function of X, this function is displayed by a profile
147 histogram with much better precision than by a scatter-plot.
148
149<sup>
150\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>
151\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>
152\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>
153\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)
154</sup>
155
156The inheritance hierarchy looks as follows:
157
158\image html classTH1__inherit__graph_org.svg width=100%
159
160\anchor creating-histograms
161## Creating histograms
162
163Histograms are created by invoking one of the constructors, e.g.
164~~~ {.cpp}
165 TH1F *h1 = new TH1F("h1", "h1 title", 100, 0, 4.4);
166 TH2F *h2 = new TH2F("h2", "h2 title", 40, 0, 4, 30, -3, 3);
167~~~
168Histograms may also be created by:
169
170 - calling the Clone() function, see below
171 - making a projection from a 2-D or 3-D histogram, see below
172 - reading a histogram from a file
173
174 When a histogram is created in ROOT 6, a reference to it is automatically added
175 to the list of in-memory objects for the current file or directory.
176 Then the pointer to this histogram in the current directory can be found
177 by its name, doing:
178~~~ {.cpp}
179 TH1F *h1 = (TH1F*)gDirectory->FindObject(name);
180~~~
181
182 This default behaviour can be changed by:
183~~~ {.cpp}
184 h->SetDirectory(nullptr); // for one histogram h
185 TH1::AddDirectory(kFALSE); // deprecated, see below
186~~~
187 When the histogram is deleted, the reference to it is removed from
188 the list of objects in memory.
189 When a file is closed, all histograms in memory associated with this file
190 are automatically deleted.
191
192In ROOT 7, this auto registration will be phased out. This mode can be tested in ROOT 6 using
193ROOT::Experimental::DisableObjectAutoRegistration(). To opt in to the ROOT-6-style registration
194in ROOT 7, use ROOT::Experimental::EnableObjectAutoRegistration().
195
196\anchor labelling-axis
197### Labelling axes
198
199 Axis titles can be specified in the title argument of the constructor.
200 They must be separated by ";":
201~~~ {.cpp}
202 TH1F* h=new TH1F("h", "Histogram title;X Axis;Y Axis", 100, 0, 1);
203~~~
204 The histogram title and the axis titles can be any TLatex string, and
205 are persisted if a histogram is written to a file.
206
207 Any title can be omitted:
208~~~ {.cpp}
209 TH1F* h=new TH1F("h", "Histogram title;;Y Axis", 100, 0, 1);
210 TH1F* h=new TH1F("h", ";;Y Axis", 100, 0, 1);
211~~~
212 The method SetTitle() has the same syntax:
213~~~ {.cpp}
214 h->SetTitle("Histogram title;Another X title Axis");
215~~~
216Alternatively, the title of each axis can be set directly:
217~~~ {.cpp}
218 h->GetXaxis()->SetTitle("X axis title");
219 h->GetYaxis()->SetTitle("Y axis title");
220~~~
221For bin labels see \ref binning.
222
223\anchor binning
224## Binning
225
226\anchor fix-var
227### Fix or variable bin size
228
229 All histogram types support either fix or variable bin sizes.
230 2-D histograms may have fix size bins along X and variable size bins
231 along Y or vice-versa. The functions to fill, manipulate, draw or access
232 histograms are identical in both cases.
233
234 Each histogram always contains 3 axis objects of type TAxis: fXaxis, fYaxis and fZaxis.
235 To access the axis parameters, use:
236~~~ {.cpp}
237 TAxis *xaxis = h->GetXaxis(); etc.
238 Double_t binCenter = xaxis->GetBinCenter(bin), etc.
239~~~
240 See class TAxis for a description of all the access functions.
241 The axis range is always stored internally in double precision.
242
243\anchor convention
244### Convention for numbering bins
245
246 For all histogram types: nbins, xlow, xup
247~~~ {.cpp}
248 bin = 0; underflow bin
249 bin = 1; first bin with low-edge xlow INCLUDED
250 bin = nbins; last bin with upper-edge xup EXCLUDED
251 bin = nbins+1; overflow bin
252~~~
253 In case of 2-D or 3-D histograms, a "global bin" number is defined.
254 For example, assuming a 3-D histogram with (binx, biny, binz), the function
255~~~ {.cpp}
256 Int_t gbin = h->GetBin(binx, biny, binz);
257~~~
258 returns a global/linearized gbin number. This global gbin is useful
259 to access the bin content/error information independently of the dimension.
260 Note that to access the information other than bin content and errors
261 one should use the TAxis object directly with e.g.:
262~~~ {.cpp}
263 Double_t xcenter = h3->GetZaxis()->GetBinCenter(27);
264~~~
265 returns the center along z of bin number 27 (not the global bin)
266 in the 3-D histogram h3.
267
268\anchor alpha
269### Alphanumeric Bin Labels
270
271 By default, a histogram axis is drawn with its numeric bin labels.
272 One can specify alphanumeric labels instead with:
273
274 - call TAxis::SetBinLabel(bin, label);
275 This can always be done before or after filling.
276 When the histogram is drawn, bin labels will be automatically drawn.
277 See examples labels1.C and labels2.C
278 - call to a Fill function with one of the arguments being a string, e.g.
279~~~ {.cpp}
280 hist1->Fill(somename, weight);
281 hist2->Fill(x, somename, weight);
282 hist2->Fill(somename, y, weight);
283 hist2->Fill(somenamex, somenamey, weight);
284~~~
285 See examples hlabels1.C and hlabels2.C
286 - via TTree::Draw. see for example cernstaff.C
287~~~ {.cpp}
288 tree.Draw("Nation::Division");
289~~~
290 where "Nation" and "Division" are two branches of a Tree.
291
292When using the options 2 or 3 above, the labels are automatically
293 added to the list (THashList) of labels for a given axis.
294 By default, an axis is drawn with the order of bins corresponding
295 to the filling sequence. It is possible to reorder the axis
296
297 - alphabetically
298 - by increasing or decreasing values
299
300 The reordering can be triggered via the TAxis context menu by selecting
301 the menu item "LabelsOption" or by calling directly
302 TH1::LabelsOption(option, axis) where
303
304 - axis may be "X", "Y" or "Z"
305 - option may be:
306 - "a" sort by alphabetic order
307 - ">" sort by decreasing values
308 - "<" sort by increasing values
309 - "h" draw labels horizontal
310 - "v" draw labels vertical
311 - "u" draw labels up (end of label right adjusted)
312 - "d" draw labels down (start of label left adjusted)
313
314 When using the option 2 above, new labels are added by doubling the current
315 number of bins in case one label does not exist yet.
316 When the Filling is terminated, it is possible to trim the number
317 of bins to match the number of active labels by calling
318~~~ {.cpp}
319 TH1::LabelsDeflate(axis) with axis = "X", "Y" or "Z"
320~~~
321 This operation is automatic when using TTree::Draw.
322 Once bin labels have been created, they become persistent if the histogram
323 is written to a file or when generating the C++ code via SavePrimitive.
324
325\anchor auto-bin
326### Histograms with automatic bins
327
328 When a histogram is created with an axis lower limit greater or equal
329 to its upper limit, the SetBuffer is automatically called with an
330 argument fBufferSize equal to fgBufferSize (default value=1000).
331 fgBufferSize may be reset via the static function TH1::SetDefaultBufferSize.
332 The axis limits will be automatically computed when the buffer will
333 be full or when the function BufferEmpty is called.
334
335\anchor rebinning
336### Rebinning
337
338 At any time, a histogram can be rebinned via TH1::Rebin. This function
339 returns a new histogram with the rebinned contents.
340 If bin errors were stored, they are recomputed during the rebinning.
341
342
343\anchor filling-histograms
344## Filling histograms
345
346 A histogram is typically filled with statements like:
347~~~ {.cpp}
348 h1->Fill(x);
349 h1->Fill(x, w); //fill with weight
350 h2->Fill(x, y)
351 h2->Fill(x, y, w)
352 h3->Fill(x, y, z)
353 h3->Fill(x, y, z, w)
354~~~
355 or via one of the Fill functions accepting names described above.
356 The Fill functions compute the bin number corresponding to the given
357 x, y or z argument and increment this bin by the given weight.
358 The Fill functions return the bin number for 1-D histograms or global
359 bin number for 2-D and 3-D histograms.
360 If TH1::Sumw2 has been called before filling, the sum of squares of
361 weights is also stored.
362 One can also increment directly a bin number via TH1::AddBinContent
363 or replace the existing content via TH1::SetBinContent. Passing an
364 out-of-range bin to TH1::AddBinContent leads to undefined behavior.
365 To access the bin content of a given bin, do:
366~~~ {.cpp}
367 Double_t binContent = h->GetBinContent(bin);
368~~~
369
370 By default, the bin number is computed using the current axis ranges.
371 If the automatic binning option has been set via
372~~~ {.cpp}
373 h->SetCanExtend(TH1::kAllAxes);
374~~~
375 then, the Fill Function will automatically extend the axis range to
376 accommodate the new value specified in the Fill argument. The method
377 used is to double the bin size until the new value fits in the range,
378 merging bins two by two. This automatic binning options is extensively
379 used by the TTree::Draw function when histogramming Tree variables
380 with an unknown range.
381 This automatic binning option is supported for 1-D, 2-D and 3-D histograms.
382
383 During filling, some statistics parameters are incremented to compute
384 the mean value and Root Mean Square with the maximum precision.
385
386 In case of histograms of type TH1C, TH1S, TH2C, TH2S, TH3C, TH3S
387 a check is made that the bin contents do not exceed the maximum positive
388 capacity (127 or 32767). Histograms of all types may have positive
389 or/and negative bin contents.
390
391\anchor associated-errors
392### Associated errors
393 By default, for each bin, the sum of weights is computed at fill time.
394 One can also call TH1::Sumw2 to force the storage and computation
395 of the sum of the square of weights per bin.
396 If Sumw2 has been called, the error per bin is computed as the
397 sqrt(sum of squares of weights), otherwise the error is set equal
398 to the sqrt(bin content).
399 To return the error for a given bin number, do:
400~~~ {.cpp}
401 Double_t error = h->GetBinError(bin);
402~~~
403
404\anchor associated-functions
405### Associated functions
406 One or more objects (typically a TF1*) can be added to the list
407 of functions (fFunctions) associated to each histogram.
408 When TH1::Fit is invoked, the fitted function is added to this list.
409 Given a histogram (or TGraph) `h`, one can retrieve an associated function
410 with:
411~~~ {.cpp}
412 TF1 *myfunc = h->GetFunction("myfunc");
413~~~
414
415
416\anchor operations-on-histograms
417## Operations on histograms
418
419 Many types of operations are supported on histograms or between histograms
420
421 - Addition of a histogram to the current histogram.
422 - Additions of two histograms with coefficients and storage into the current
423 histogram.
424 - Multiplications and Divisions are supported in the same way as additions.
425 - The Add, Divide and Multiply functions also exist to add, divide or multiply
426 a histogram by a function.
427
428 If a histogram has associated error bars (TH1::Sumw2 has been called),
429 the resulting error bars are also computed assuming independent histograms.
430 In case of divisions, Binomial errors are also supported.
431 One can mark a histogram to be an "average" histogram by setting its bit kIsAverage via
432 myhist.SetBit(TH1::kIsAverage);
433 When adding (see TH1::Add) average histograms, the histograms are averaged and not summed.
434
435
436\anchor prof-hist
437### Projections of histograms
438
439 One can:
440
441 - make a 1-D projection of a 2-D histogram or Profile
442 see functions TH2::ProjectionX,Y, TH2::ProfileX,Y, TProfile::ProjectionX
443 - make a 1-D, 2-D or profile out of a 3-D histogram
444 see functions TH3::ProjectionZ, TH3::Project3D.
445
446 One can fit these projections via:
447~~~ {.cpp}
448 TH2::FitSlicesX,Y, TH3::FitSlicesZ.
449~~~
450
451\anchor random-numbers
452### Random Numbers and histograms
453
454 TH1::FillRandom can be used to randomly fill a histogram using
455 the contents of an existing TF1 function or another
456 TH1 histogram (for all dimensions).
457 For example, the following two statements create and fill a histogram
458 10000 times with a default gaussian distribution of mean 0 and sigma 1:
459~~~ {.cpp}
460 TH1F h1("h1", "histo from a gaussian", 100, -3, 3);
461 h1.FillRandom("gaus", 10000);
462~~~
463 TH1::GetRandom can be used to return a random number distributed
464 according to the contents of a histogram.
465
466\anchor making-a-copy
467### Making a copy of a histogram
468 Like for any other ROOT object derived from TObject, one can use
469 the Clone() function. This makes an identical copy of the original
470 histogram including all associated errors and functions, e.g.:
471~~~ {.cpp}
472 TH1F *hnew = (TH1F*)h->Clone("hnew");
473~~~
474
475\anchor normalizing
476### Normalizing histograms
477
478 One can scale a histogram such that the bins integral is equal to
479 the normalization parameter via TH1::Scale(Double_t norm), where norm
480 is the desired normalization divided by the integral of the histogram.
481
482
483\anchor drawing-histograms
484## Drawing histograms
485
486 Histograms are drawn via the THistPainter class. Each histogram has
487 a pointer to its own painter (to be usable in a multithreaded program).
488 Many drawing options are supported.
489 See THistPainter::Paint() for more details.
490
491 The same histogram can be drawn with different options in different pads.
492 When a histogram drawn in a pad is deleted, the histogram is
493 automatically removed from all pads where it was drawn.
494 If a histogram is drawn in a pad, then modified, the new status
495 of the histogram will be automatically shown in the pad next time
496 the pad is updated. One does not need to redraw the histogram.
497 To draw the current version of a histogram in a pad, one can use
498~~~ {.cpp}
499 h->DrawCopy();
500~~~
501 DrawCopy() is also useful when a temporary histogram should be drawn, for
502 example in
503~~~ {.cpp}
504 void drawHisto() {
505 TH1D histo("histo", "An example histogram", 10, 0, 10);
506 // ...
507 histo.DrawCopy();
508 } // histo goes out of scope here, but the copy stays visible
509~~~
510
511 One can use TH1::SetMaximum() and TH1::SetMinimum() to force a particular
512 value for the maximum or the minimum scale on the plot. (For 1-D
513 histograms this means the y-axis, while for 2-D histograms these
514 functions affect the z-axis).
516 TH1::UseCurrentStyle() can be used to change all histogram graphics
517 attributes to correspond to the current selected style.
518 This function must be called for each histogram.
519 In case one reads and draws many histograms from a file, one can force
520 the histograms to inherit automatically the current graphics style
521 by calling before gROOT->ForceStyle().
522
523\anchor cont-level
524### Setting Drawing histogram contour levels (2-D hists only)
525
526 By default contours are automatically generated at equidistant
527 intervals. A default value of 20 levels is used. This can be modified
528 via TH1::SetContour() or TH1::SetContourLevel().
529 the contours level info is used by the drawing options "cont", "surf",
530 and "lego".
531
532\anchor graph-att
533### Setting histogram graphics attributes
534
535 The histogram classes inherit from the attribute classes:
536 TAttLine, TAttFill, and TAttMarker.
537 See the member functions of these classes for the list of options.
538
539\anchor axis-drawing
540### Customizing how axes are drawn
541
542 Use the functions of TAxis, such as
543~~~ {.cpp}
544 histogram.GetXaxis()->SetTicks("+");
545 histogram.GetYaxis()->SetRangeUser(1., 5.);
546~~~
547
548\anchor fitting-histograms
549## Fitting histograms
550
551 Histograms (1-D, 2-D, 3-D and Profiles) can be fitted with a user
552 specified function or a pre-defined function via TH1::Fit.
553 See TH1::Fit(TF1*, Option_t *, Option_t *, Double_t, Double_t) for the fitting documentation and the possible [fitting options](\ref HFitOpt)
554
555 The FitPanel can also be used for fitting an histogram. See the [FitPanel documentation](https://root.cern/manual/fitting/#using-the-fit-panel).
556
557\anchor saving-histograms
558## Saving/reading histograms to/from a ROOT file
559
560 The following statements create a ROOT file and store a histogram
561 on the file. Because TH1 derives from TNamed, the key identifier on
562 the file is the histogram name:
563~~~ {.cpp}
564 TFile f("histos.root", "new");
565 TH1F h1("hgaus", "histo from a gaussian", 100, -3, 3);
566 h1.FillRandom("gaus", 10000);
567 h1->Write();
568~~~
569 To read this histogram in another Root session, do:
570~~~ {.cpp}
571 TFile f("histos.root");
572 TH1F *h = (TH1F*)f.Get("hgaus");
573~~~
574 One can save all histograms in memory to the file by:
575~~~ {.cpp}
576 file->Write();
577~~~
580\anchor misc
581## Miscellaneous operations
582
583~~~ {.cpp}
584 TH1::KolmogorovTest(): statistical test of compatibility in shape
585 between two histograms
586 TH1::Smooth() smooths the bin contents of a 1-d histogram
587 TH1::Integral() returns the integral of bin contents in a given bin range
588 TH1::GetMean(int axis) returns the mean value along axis
589 TH1::GetStdDev(int axis) returns the sigma distribution along axis
590 TH1::GetEntries() returns the number of entries
591 TH1::Reset() resets the bin contents and errors of a histogram
592~~~
593 IMPORTANT NOTE: The returned values for GetMean and GetStdDev depend on how the
594 histogram statistics are calculated. By default, if no range has been set, the
595 returned values are the (unbinned) ones calculated at fill time. If a range has been
596 set, however, the values are calculated using the bins in range; THIS IS TRUE EVEN
597 IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset the range.
598 To ensure that the returned values are always those of the binned data stored in the
599 histogram, call TH1::ResetStats. See TH1::GetStats.
600*/
601
602// clang-format on
603
604TF1 *gF1=nullptr; //left for back compatibility (use TVirtualFitter::GetUserFunc instead)
605
610
611extern void H1InitGaus();
612extern void H1InitExpo();
613extern void H1InitPolynom();
614extern void H1LeastSquareFit(Int_t n, Int_t m, Double_t *a);
617
618
619////////////////////////////////////////////////////////////////////////////////
620/// Histogram default constructor.
621
623{
624 fDirectory = nullptr;
625 fFunctions = new TList;
626 fNcells = 0;
627 fIntegral = nullptr;
628 fPainter = nullptr;
629 fEntries = 0;
630 fNormFactor = 0;
632 fMaximum = -1111;
633 fMinimum = -1111;
634 fBufferSize = 0;
635 fBuffer = nullptr;
638 fXaxis.SetName("xaxis");
639 fYaxis.SetName("yaxis");
640 fZaxis.SetName("zaxis");
641 fXaxis.SetParent(this);
642 fYaxis.SetParent(this);
643 fZaxis.SetParent(this);
645}
646
647////////////////////////////////////////////////////////////////////////////////
648/// Histogram default destructor.
649
651{
653 return;
654 }
655 delete[] fIntegral;
656 fIntegral = nullptr;
657 delete[] fBuffer;
658 fBuffer = nullptr;
659 if (fFunctions) {
661
663 TObject* obj = nullptr;
664 //special logic to support the case where the same object is
665 //added multiple times in fFunctions.
666 //This case happens when the same object is added with different
667 //drawing modes
668 //In the loop below we must be careful with objects (eg TCutG) that may
669 // have been added to the list of functions of several histograms
670 //and may have been already deleted.
671 while ((obj = fFunctions->First())) {
672 while(fFunctions->Remove(obj)) { }
674 break;
675 }
676 delete obj;
677 obj = nullptr;
678 }
679 delete fFunctions;
680 fFunctions = nullptr;
681 }
682 if (fDirectory) {
683 fDirectory->Remove(this);
684 fDirectory = nullptr;
685 }
686 delete fPainter;
687 fPainter = nullptr;
688}
689
690////////////////////////////////////////////////////////////////////////////////
691/// Constructor for fix bin size histograms.
692/// Creates the main histogram structure.
693///
694/// \param[in] name name of histogram (avoid blanks)
695/// \param[in] title histogram title.
696/// If title is of the form `stringt;stringx;stringy;stringz`,
697/// the histogram title is set to `stringt`,
698/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
699/// \param[in] nbins number of bins
700/// \param[in] xlow low edge of first bin
701/// \param[in] xup upper edge of last bin (not included in last bin)
702/// \note if xup <= xlow, automatic bins are calculated when buffer size is reached
703
704TH1::TH1(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
705 :TNamed(name,title)
706{
707 Build();
708 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
709 fXaxis.Set(nbins,xlow,xup);
710 fNcells = fXaxis.GetNbins()+2;
711}
712
713////////////////////////////////////////////////////////////////////////////////
714/// Constructor for variable bin size histograms using an input array of type float.
715/// Creates the main histogram structure.
716///
717/// \param[in] name name of histogram (avoid blanks)
718/// \param[in] title histogram title.
719/// If title is of the form `stringt;stringx;stringy;stringz`
720/// the histogram title is set to `stringt`,
721/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
722/// \param[in] nbins number of bins
723/// \param[in] xbins array of low-edges for each bin.
724/// This is an array of type float and size nbins+1
725
726TH1::TH1(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
727 :TNamed(name,title)
728{
729 Build();
730 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
731 if (xbins) fXaxis.Set(nbins,xbins);
732 else fXaxis.Set(nbins,0,1);
733 fNcells = fXaxis.GetNbins()+2;
734}
735
736////////////////////////////////////////////////////////////////////////////////
737/// Constructor for variable bin size histograms using an input array of type double.
738///
739/// \param[in] name name of histogram (avoid blanks)
740/// \param[in] title histogram title.
741/// If title is of the form `stringt;stringx;stringy;stringz`
742/// the histogram title is set to `stringt`,
743/// the x axis title to `stringx`, the y axis title to `stringy`, etc.
744/// \param[in] nbins number of bins
745/// \param[in] xbins array of low-edges for each bin.
746/// This is an array of type double and size nbins+1
747
748TH1::TH1(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
749 :TNamed(name,title)
750{
751 Build();
752 if (nbins <= 0) {Warning("TH1","nbins is <=0 - set to nbins = 1"); nbins = 1; }
753 if (xbins) fXaxis.Set(nbins,xbins);
754 else fXaxis.Set(nbins,0,1);
755 fNcells = fXaxis.GetNbins()+2;
756}
757
758////////////////////////////////////////////////////////////////////////////////
759/// Check whether TH1-derived classes should register themselves to the current gDirectory.
760/// \note Even if this returns true, the state of
761/// ROOT::Experimental::ObjectAutoRegistrationEnabled() might prevent the registration of
762/// histograms, since it has higher precedence.
763
768
769////////////////////////////////////////////////////////////////////////////////
770/// Browse the Histogram object.
771
773{
774 Draw(b ? b->GetDrawOption() : "");
775 gPad->Update();
776}
777
778////////////////////////////////////////////////////////////////////////////////
779/// Creates histogram basic data structure.
780
782{
783 fDirectory = nullptr;
784 fPainter = nullptr;
785 fIntegral = nullptr;
786 fEntries = 0;
787 fNormFactor = 0;
789 fMaximum = -1111;
790 fMinimum = -1111;
791 fBufferSize = 0;
792 fBuffer = nullptr;
795 fXaxis.SetName("xaxis");
796 fYaxis.SetName("yaxis");
797 fZaxis.SetName("zaxis");
798 fYaxis.Set(1,0.,1.);
799 fZaxis.Set(1,0.,1.);
800 fXaxis.SetParent(this);
801 fYaxis.SetParent(this);
802 fZaxis.SetParent(this);
803
805
806 fFunctions = new TList;
807
809
812 if (fDirectory) {
814 fDirectory->Append(this,kTRUE);
815 }
816 }
817}
818
819////////////////////////////////////////////////////////////////////////////////
820/// Performs the operation: `this = this + c1*f1`
821/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
822///
823/// By default, the function is computed at the centre of the bin.
824/// if option "I" is specified (1-d histogram only), the integral of the
825/// function in each bin is used instead of the value of the function at
826/// the centre of the bin.
827///
828/// Only bins inside the function range are recomputed.
829///
830/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
831/// you should call Sumw2 before making this operation.
832/// This is particularly important if you fit the histogram after TH1::Add
833///
834/// The function return kFALSE if the Add operation failed
835
837{
838 if (!f1) {
839 Error("Add","Attempt to add a non-existing function");
840 return kFALSE;
841 }
842
843 TString opt = option;
844 opt.ToLower();
845 Bool_t integral = kFALSE;
846 if (opt.Contains("i") && fDimension == 1) integral = kTRUE;
847
848 Int_t ncellsx = GetNbinsX() + 2; // cells = normal bins + underflow bin + overflow bin
849 Int_t ncellsy = GetNbinsY() + 2;
850 Int_t ncellsz = GetNbinsZ() + 2;
851 if (fDimension < 2) ncellsy = 1;
852 if (fDimension < 3) ncellsz = 1;
853
854 // delete buffer if it is there since it will become invalid
855 if (fBuffer) BufferEmpty(1);
856
857 // - Add statistics
858 Double_t s1[10];
859 for (Int_t i = 0; i < 10; ++i) s1[i] = 0;
860 PutStats(s1);
861 SetMinimum();
862 SetMaximum();
863
864 // - Loop on bins (including underflows/overflows)
866 Double_t cu=0;
867 Double_t xx[3];
868 Double_t *params = nullptr;
869 f1->InitArgs(xx,params);
870 for (binz = 0; binz < ncellsz; ++binz) {
872 for (biny = 0; biny < ncellsy; ++biny) {
874 for (binx = 0; binx < ncellsx; ++binx) {
876 if (!f1->IsInside(xx)) continue;
878 bin = binx + ncellsx * (biny + ncellsy * binz);
879 if (integral) {
881 } else {
882 cu = c1*f1->EvalPar(xx);
883 }
884 if (TF1::RejectedPoint()) continue;
886 }
887 }
888 }
889
890 return kTRUE;
891}
892
893int TH1::LoggedInconsistency(const char *name, const TH1 *h1, const TH1 *h2, bool useMerge) const
894{
895 const auto inconsistency = CheckConsistency(h1, h2);
896
898 if (useMerge)
899 Info(name, "Histograms have different dimensions - trying to use TH1::Merge");
900 else {
901 Error(name, "Histograms have different dimensions");
902 }
904 if (useMerge)
905 Info(name, "Histograms have different number of bins - trying to use TH1::Merge");
906 else {
907 Error(name, "Histograms have different number of bins");
908 }
909 } else if (inconsistency & kDifferentAxisLimits) {
910 if (useMerge)
911 Info(name, "Histograms have different axis limits - trying to use TH1::Merge");
912 else
913 Warning(name, "Histograms have different axis limits");
914 } else if (inconsistency & kDifferentBinLimits) {
915 if (useMerge)
916 Info(name, "Histograms have different bin limits - trying to use TH1::Merge");
917 else
918 Warning(name, "Histograms have different bin limits");
919 } else if (inconsistency & kDifferentLabels) {
920 // in case of different labels -
921 if (useMerge)
922 Info(name, "Histograms have different labels - trying to use TH1::Merge");
923 else
924 Info(name, "Histograms have different labels");
925 }
926
927 return inconsistency;
928}
929
930////////////////////////////////////////////////////////////////////////////////
931/// Performs the operation: `this = this + c1*h1`
932/// If errors are defined (see TH1::Sumw2), errors are also recalculated.
933///
934/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
935/// if not already set.
936///
937/// Note also that adding histogram with labels is not supported, histogram will be
938/// added merging them by bin number independently of the labels.
939/// For adding histogram with labels one should use TH1::Merge
940///
941/// SPECIAL CASE (Average/Efficiency histograms)
942/// For histograms representing averages or efficiencies, one should compute the average
943/// of the two histograms and not the sum. One can mark a histogram to be an average
944/// histogram by setting its bit kIsAverage with
945/// myhist.SetBit(TH1::kIsAverage);
946/// Note that the two histograms must have their kIsAverage bit set
947///
948/// IMPORTANT NOTE1: If you intend to use the errors of this histogram later
949/// you should call Sumw2 before making this operation.
950/// This is particularly important if you fit the histogram after TH1::Add
951///
952/// IMPORTANT NOTE2: if h1 has a normalisation factor, the normalisation factor
953/// is used , ie this = this + c1*factor*h1
954/// Use the other TH1::Add function if you do not want this feature
955///
956/// IMPORTANT NOTE3: You should be careful about the statistics of the
957/// returned histogram, whose statistics may be binned or unbinned,
958/// depending on whether c1 is negative, whether TAxis::kAxisRange is true,
959/// and whether TH1::ResetStats has been called on either this or h1.
960/// See TH1::GetStats.
961///
962/// The function return kFALSE if the Add operation failed
963
965{
966 if (!h1) {
967 Error("Add","Attempt to add a non-existing histogram");
968 return kFALSE;
969 }
970
971 // delete buffer if it is there since it will become invalid
972 if (fBuffer) BufferEmpty(1);
973
974 bool useMerge = false;
975 const bool considerMerge = (c1 == 1. && !this->TestBit(kIsAverage) && !h1->TestBit(kIsAverage) );
976 const auto inconsistency = LoggedInconsistency("Add", this, h1, considerMerge);
977 // If there is a bad inconsistency and we can't even consider merging, just give up
979 return false;
980 }
981 // If there is an inconsistency, we try to use merging
984 }
985
986 if (useMerge) {
987 TList l;
988 l.Add(const_cast<TH1*>(h1));
989 auto iret = Merge(&l);
990 return (iret >= 0);
991 }
992
993 // Create Sumw2 if h1 has Sumw2 set
994 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
995 // In addition, create Sumw2 if is not a simple addition, otherwise errors will not be correctly computed
996 if (fSumw2.fN == 0 && c1 != 1.0) Sumw2();
997
998 // - Add statistics (for c1=1)
999 Double_t entries = GetEntries() + h1->GetEntries();
1000
1001 // statistics can be preserved only in case of positive coefficients
1002 // otherwise with negative c1 (histogram subtraction) one risks to get negative variances
1003 Bool_t resetStats = (c1 < 0);
1004 Double_t s1[kNstat] = {0};
1005 Double_t s2[kNstat] = {0};
1006 if (!resetStats) {
1007 // need to initialize to zero s1 and s2 since
1008 // GetStats fills only used elements depending on dimension and type
1009 GetStats(s1);
1010 h1->GetStats(s2);
1011 }
1012
1013 SetMinimum();
1014 SetMaximum();
1015
1016 // - Loop on bins (including underflows/overflows)
1017 Double_t factor = 1;
1018 if (h1->GetNormFactor() != 0) factor = h1->GetNormFactor()/h1->GetSumOfWeights();
1019 Double_t c1sq = c1 * c1;
1020 Double_t factsq = factor * factor;
1021
1022 for (Int_t bin = 0; bin < fNcells; ++bin) {
1023 //special case where histograms have the kIsAverage bit set
1024 if (this->TestBit(kIsAverage) && h1->TestBit(kIsAverage)) {
1029 Double_t w1 = 1., w2 = 1.;
1030
1031 // consider all special cases when bin errors are zero
1032 // see http://root-forum.cern.ch/viewtopic.php?f=3&t=13299
1033 if (e1sq) w1 = 1. / e1sq;
1034 else if (h1->fSumw2.fN) {
1035 w1 = 1.E200; // use an arbitrary huge value
1036 if (y1 == 0) {
1037 // use an estimated error from the global histogram scale
1038 double sf = (s2[0] != 0) ? s2[1]/s2[0] : 1;
1039 w1 = 1./(sf*sf);
1040 }
1041 }
1042 if (e2sq) w2 = 1. / e2sq;
1043 else if (fSumw2.fN) {
1044 w2 = 1.E200; // use an arbitrary huge value
1045 if (y2 == 0) {
1046 // use an estimated error from the global histogram scale
1047 double sf = (s1[0] != 0) ? s1[1]/s1[0] : 1;
1048 w2 = 1./(sf*sf);
1049 }
1050 }
1051
1052 double y = (w1*y1 + w2*y2)/(w1 + w2);
1054 if (fSumw2.fN) {
1055 double err2 = 1./(w1 + w2);
1056 if (err2 < 1.E-200) err2 = 0; // to remove arbitrary value when e1=0 AND e2=0
1057 fSumw2.fArray[bin] = err2;
1058 }
1059 } else { // normal case of addition between histograms
1062 }
1063 }
1064
1065 // update statistics (do here to avoid changes by SetBinContent)
1066 if (resetStats) {
1067 // statistics need to be reset in case coefficient are negative
1068 ResetStats();
1069 }
1070 else {
1071 for (Int_t i=0;i<kNstat;i++) {
1072 if (i == 1) s1[i] += c1*c1*s2[i];
1073 else s1[i] += c1*s2[i];
1074 }
1075 PutStats(s1);
1076 if (c1 == 1.0)
1077 SetEntries(entries);
1078 else {
1079 // compute entries as effective entries in case of
1080 // weights different than 1
1081 double sumw2 = 0;
1082 double sumw = GetSumOfAllWeights(true, &sumw2);
1083 if (sumw2 > 0) SetEntries( sumw*sumw/sumw2);
1084 }
1085 }
1086 return kTRUE;
1087}
1088
1089////////////////////////////////////////////////////////////////////////////////
1090/// Replace contents of this histogram by the addition of h1 and h2.
1091///
1092/// `this = c1*h1 + c2*h2`
1093/// if errors are defined (see TH1::Sumw2), errors are also recalculated
1094///
1095/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
1096/// if not already set.
1097///
1098/// Note also that adding histogram with labels is not supported, histogram will be
1099/// added merging them by bin number independently of the labels.
1100/// For adding histogram ith labels one should use TH1::Merge
1101///
1102/// SPECIAL CASE (Average/Efficiency histograms)
1103/// For histograms representing averages or efficiencies, one should compute the average
1104/// of the two histograms and not the sum. One can mark a histogram to be an average
1105/// histogram by setting its bit kIsAverage with
1106/// myhist.SetBit(TH1::kIsAverage);
1107/// Note that the two histograms must have their kIsAverage bit set
1108///
1109/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
1110/// you should call Sumw2 before making this operation.
1111/// This is particularly important if you fit the histogram after TH1::Add
1112///
1113/// IMPORTANT NOTE2: You should be careful about the statistics of the
1114/// returned histogram, whose statistics may be binned or unbinned,
1115/// depending on whether c1 is negative, whether TAxis::kAxisRange is true,
1116/// and whether TH1::ResetStats has been called on either this or h1.
1117/// See TH1::GetStats.
1118///
1119/// ANOTHER SPECIAL CASE : h1 = h2 and c2 < 0
1120/// do a scaling this = c1 * h1 / (bin Volume)
1121///
1122/// The function returns kFALSE if the Add operation failed
1123
1125{
1126
1127 if (!h1 || !h2) {
1128 Error("Add","Attempt to add a non-existing histogram");
1129 return kFALSE;
1130 }
1131
1132 // delete buffer if it is there since it will become invalid
1133 if (fBuffer) BufferEmpty(1);
1134
1136 if (h1 == h2 && c2 < 0) {c2 = 0; normWidth = kTRUE;}
1137
1138 if (h1 != h2) {
1139 bool useMerge = false;
1140 const bool considerMerge = (c1 == 1. && c2 == 1. && !this->TestBit(kIsAverage) && !h1->TestBit(kIsAverage) );
1141
1142 // We can combine inconsistencies like this, since they are ordered and a
1143 // higher inconsistency is worse
1144 auto const inconsistency = std::max(LoggedInconsistency("Add", this, h1, considerMerge),
1145 LoggedInconsistency("Add", h1, h2, considerMerge));
1146
1147 // If there is a bad inconsistency and we can't even consider merging, just give up
1149 return false;
1150 }
1151 // If there is an inconsistency, we try to use merging
1154 }
1155
1156 if (useMerge) {
1157 TList l;
1158 // why TList takes non-const pointers ????
1159 l.Add(const_cast<TH1*>(h1));
1160 l.Add(const_cast<TH1*>(h2));
1161 Reset("ICE");
1162 auto iret = Merge(&l);
1163 return (iret >= 0);
1164 }
1165 }
1166
1167 // Create Sumw2 if h1 or h2 have Sumw2 set
1168 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0)) Sumw2();
1169 // Create also Sumw2 if not a simple addition (c1 = 1, c2 = 1)
1170 if (fSumw2.fN == 0 && (c1 != 1.0 || c2 != 1.0)) Sumw2();
1171 // - Add statistics
1173
1174 // TODO remove
1175 // statistics can be preserved only in case of positive coefficients
1176 // otherwise with negative c1 (histogram subtraction) one risks to get negative variances
1177 // also in case of scaling with the width we cannot preserve the statistics
1178 Double_t s1[kNstat] = {0};
1179 Double_t s2[kNstat] = {0};
1181
1182
1183 Bool_t resetStats = (c1*c2 < 0) || normWidth;
1184 if (!resetStats) {
1185 // need to initialize to zero s1 and s2 since
1186 // GetStats fills only used elements depending on dimension and type
1187 h1->GetStats(s1);
1188 h2->GetStats(s2);
1189 for (Int_t i=0;i<kNstat;i++) {
1190 if (i == 1) s3[i] = c1*c1*s1[i] + c2*c2*s2[i];
1191 //else s3[i] = TMath::Abs(c1)*s1[i] + TMath::Abs(c2)*s2[i];
1192 else s3[i] = c1*s1[i] + c2*s2[i];
1193 }
1194 }
1195
1196 SetMinimum();
1197 SetMaximum();
1198
1199 if (normWidth) { // DEPRECATED CASE: belongs to fitting / drawing modules
1200
1201 Int_t nbinsx = GetNbinsX() + 2; // normal bins + underflow, overflow
1202 Int_t nbinsy = GetNbinsY() + 2;
1203 Int_t nbinsz = GetNbinsZ() + 2;
1204
1205 if (fDimension < 2) nbinsy = 1;
1206 if (fDimension < 3) nbinsz = 1;
1207
1208 Int_t bin, binx, biny, binz;
1209 for (binz = 0; binz < nbinsz; ++binz) {
1211 for (biny = 0; biny < nbinsy; ++biny) {
1213 for (binx = 0; binx < nbinsx; ++binx) {
1215 bin = GetBin(binx, biny, binz);
1216 Double_t w = wx*wy*wz;
1218 if (fSumw2.fN) {
1220 fSumw2.fArray[bin] = c1*c1*e1*e1;
1221 }
1222 }
1223 }
1224 }
1225 } else if (h1->TestBit(kIsAverage) && h2->TestBit(kIsAverage)) {
1226 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
1227 // special case where histograms have the kIsAverage bit set
1232 Double_t w1 = 1., w2 = 1.;
1233
1234 // consider all special cases when bin errors are zero
1235 // see http://root-forum.cern.ch/viewtopic.php?f=3&t=13299
1236 if (e1sq) w1 = 1./ e1sq;
1237 else if (h1->fSumw2.fN) {
1238 w1 = 1.E200; // use an arbitrary huge value
1239 if (y1 == 0 ) { // use an estimated error from the global histogram scale
1240 double sf = (s1[0] != 0) ? s1[1]/s1[0] : 1;
1241 w1 = 1./(sf*sf);
1242 }
1243 }
1244 if (e2sq) w2 = 1./ e2sq;
1245 else if (h2->fSumw2.fN) {
1246 w2 = 1.E200; // use an arbitrary huge value
1247 if (y2 == 0) { // use an estimated error from the global histogram scale
1248 double sf = (s2[0] != 0) ? s2[1]/s2[0] : 1;
1249 w2 = 1./(sf*sf);
1250 }
1251 }
1252
1253 double y = (w1*y1 + w2*y2)/(w1 + w2);
1254 UpdateBinContent(i, y);
1255 if (fSumw2.fN) {
1256 double err2 = 1./(w1 + w2);
1257 if (err2 < 1.E-200) err2 = 0; // to remove arbitrary value when e1=0 AND e2=0
1258 fSumw2.fArray[i] = err2;
1259 }
1260 }
1261 } else { // case of simple histogram addition
1262 Double_t c1sq = c1 * c1;
1263 Double_t c2sq = c2 * c2;
1264 for (Int_t i = 0; i < fNcells; ++i) { // Loop on cells (bins including underflows/overflows)
1266 if (fSumw2.fN) {
1268 }
1269 }
1270 }
1271
1272 if (resetStats) {
1273 // statistics need to be reset in case coefficient are negative
1274 ResetStats();
1275 }
1276 else {
1277 // update statistics
1278 PutStats(s3);
1279 // previous entries are correct only if c1=1 and c2=1
1280 if (c1 == 1.0 && c2 == 1.0)
1282 else {
1283 // compute entries as effective entries in case of
1284 // weights different than 1
1285 double sumw2 = 0;
1286 double sumw = GetSumOfAllWeights(true, &sumw2);
1287 if (sumw2 > 0) SetEntries( sumw*sumw/sumw2);
1288 }
1289 }
1290
1291 return kTRUE;
1292}
1293
1294////////////////////////////////////////////////////////////////////////////////
1295/// Sets the flag controlling the automatic add of histograms in memory.
1296///
1297/// By default (fAddDirectory = kTRUE), histograms are automatically added
1298/// to the current directory (gDirectory).
1299/// Note that one histogram can be removed from its support directory
1300/// by calling h->SetDirectory(nullptr) or h->SetDirectory(dir) to add it
1301/// to the list of objects in the directory dir.
1302///
1303/// This is a static function. To call it, use `TH1::AddDirectory`
1304///
1305/// \deprecated Use ROOT::Experimental::ObjectAutoRegistrationEnabled(). It can be
1306/// set using an entry in rootrc or an environment variable, is initialised in a
1307/// thread-safe manner and covers more cases.
1308
1310{
1311 fgAddDirectory = add;
1312}
1313
1314////////////////////////////////////////////////////////////////////////////////
1315/// Auxiliary function to get the power of 2 next (larger) or previous (smaller)
1316/// a given x
1317///
1318/// next = kTRUE : next larger
1319/// next = kFALSE : previous smaller
1320///
1321/// Used by the autobin power of 2 algorithm
1322
1324{
1325 Int_t nn;
1326 Double_t f2 = std::frexp(x, &nn);
1327 return ((next && x > 0.) || (!next && x <= 0.)) ? std::ldexp(std::copysign(1., f2), nn)
1328 : std::ldexp(std::copysign(1., f2), --nn);
1329}
1330
1331////////////////////////////////////////////////////////////////////////////////
1332/// Auxiliary function to get the next power of 2 integer value larger then n
1333///
1334/// Used by the autobin power of 2 algorithm
1335
1337{
1338 Int_t nn;
1339 Double_t f2 = std::frexp(n, &nn);
1340 if (TMath::Abs(f2 - .5) > 0.001)
1341 return (Int_t)std::ldexp(1., nn);
1342 return n;
1343}
1344
1345////////////////////////////////////////////////////////////////////////////////
1346/// Buffer-based estimate of the histogram range using the power of 2 algorithm.
1347///
1348/// Used by the autobin power of 2 algorithm.
1349///
1350/// Works on arguments (min and max from fBuffer) and internal inputs: fXmin,
1351/// fXmax, NBinsX (from fXaxis), ...
1352/// Result save internally in fXaxis.
1353///
1354/// Overloaded by TH2 and TH3.
1355///
1356/// Return -1 if internal inputs are inconsistent, 0 otherwise.
1357
1359{
1360 // We need meaningful raw limits
1361 if (xmi >= xma)
1362 return -1;
1363
1364 THLimitsFinder::GetLimitsFinder()->FindGoodLimits(this, xmi, xma);
1367
1368 // Now adjust
1369 if (TMath::Abs(xhma) > TMath::Abs(xhmi)) {
1370 // Start from the upper limit
1373 } else {
1374 // Start from the lower limit
1377 }
1378
1379 // Round the bins to the next power of 2; take into account the possible inflation
1380 // of the range
1381 Double_t rr = (xhma - xhmi) / (xma - xmi);
1383
1384 // Adjust using the same bin width and offsets
1385 Double_t bw = (xhma - xhmi) / nb;
1386 // Bins to left free on each side
1387 Double_t autoside = gEnv->GetValue("Hist.Binning.Auto.Side", 0.05);
1388 Int_t nbside = (Int_t)(nb * autoside);
1389
1390 // Side up
1391 Int_t nbup = (xhma - xma) / bw;
1392 if (nbup % 2 != 0)
1393 nbup++; // Must be even
1394 if (nbup != nbside) {
1395 // Accounts also for both case: larger or smaller
1396 xhma -= bw * (nbup - nbside);
1397 nb -= (nbup - nbside);
1398 }
1399
1400 // Side low
1401 Int_t nblw = (xmi - xhmi) / bw;
1402 if (nblw % 2 != 0)
1403 nblw++; // Must be even
1404 if (nblw != nbside) {
1405 // Accounts also for both case: larger or smaller
1406 xhmi += bw * (nblw - nbside);
1407 nb -= (nblw - nbside);
1408 }
1409
1410 // Set everything and project
1411 SetBins(nb, xhmi, xhma);
1412
1413 // Done
1414 return 0;
1415}
1416
1417/// Fill histogram with all entries in the buffer.
1418///
1419/// - action = -1 histogram is reset and refilled from the buffer (called by THistPainter::Paint)
1420/// - action = 0 histogram is reset and filled from the buffer. When the histogram is filled from the
1421/// buffer the value fBuffer[0] is set to a negative number (= - number of entries)
1422/// When calling with action == 0 the histogram is NOT refilled when fBuffer[0] is < 0
1423/// While when calling with action = -1 the histogram is reset and ALWAYS refilled independently if
1424/// the histogram was filled before. This is needed when drawing the histogram
1425/// - action = 1 histogram is filled and buffer is deleted
1426/// The buffer is automatically deleted when filling the histogram and the entries is
1427/// larger than the buffer size
1428
1430{
1431 // do we need to compute the bin size?
1432 if (!fBuffer) return 0;
1434
1435 // nbentries correspond to the number of entries of histogram
1436
1437 if (nbentries == 0) {
1438 // if action is 1 we delete the buffer
1439 // this will avoid infinite recursion
1440 if (action > 0) {
1441 delete [] fBuffer;
1442 fBuffer = nullptr;
1443 fBufferSize = 0;
1444 }
1445 return 0;
1446 }
1447 if (nbentries < 0 && action == 0) return 0; // case histogram has been already filled from the buffer
1448
1449 Double_t *buffer = fBuffer;
1450 if (nbentries < 0) {
1452 // a reset might call BufferEmpty() giving an infinite recursion
1453 // Protect it by setting fBuffer = nullptr
1454 fBuffer = nullptr;
1455 //do not reset the list of functions
1456 Reset("ICES");
1457 fBuffer = buffer;
1458 }
1459 if (CanExtendAllAxes() || (fXaxis.GetXmax() <= fXaxis.GetXmin())) {
1460 //find min, max of entries in buffer
1463 for (Int_t i=0;i<nbentries;i++) {
1464 Double_t x = fBuffer[2*i+2];
1465 // skip infinity or NaN values
1466 if (!std::isfinite(x)) continue;
1467 if (x < xmin) xmin = x;
1468 if (x > xmax) xmax = x;
1469 }
1470 if (fXaxis.GetXmax() <= fXaxis.GetXmin()) {
1471 Int_t rc = -1;
1473 if ((rc = AutoP2FindLimits(xmin, xmax)) < 0)
1474 Warning("BufferEmpty",
1475 "inconsistency found by power-of-2 autobin algorithm: fallback to standard method");
1476 }
1477 if (rc < 0)
1478 THLimitsFinder::GetLimitsFinder()->FindGoodLimits(this, xmin, xmax);
1479 } else {
1480 fBuffer = nullptr;
1483 if (xmax >= fXaxis.GetXmax()) ExtendAxis(xmax, &fXaxis);
1484 fBuffer = buffer;
1485 fBufferSize = keep;
1486 }
1487 }
1488
1489 // call DoFillN which will not put entries in the buffer as FillN does
1490 // set fBuffer to zero to avoid re-emptying the buffer from functions called
1491 // by DoFillN (e.g Sumw2)
1492 buffer = fBuffer; fBuffer = nullptr;
1493 DoFillN(nbentries,&buffer[2],&buffer[1],2);
1494 fBuffer = buffer;
1495
1496 // if action == 1 - delete the buffer
1497 if (action > 0) {
1498 delete [] fBuffer;
1499 fBuffer = nullptr;
1500 fBufferSize = 0;
1501 } else {
1502 // if number of entries is consistent with buffer - set it negative to avoid
1503 // refilling the histogram every time BufferEmpty(0) is called
1504 // In case it is not consistent, by setting fBuffer[0]=0 is like resetting the buffer
1505 // (it will not be used anymore the next time BufferEmpty is called)
1506 if (nbentries == (Int_t)fEntries)
1507 fBuffer[0] = -nbentries;
1508 else
1509 fBuffer[0] = 0;
1510 }
1511 return nbentries;
1512}
1513
1514////////////////////////////////////////////////////////////////////////////////
1515/// accumulate arguments in buffer. When buffer is full, empty the buffer
1516///
1517/// - `fBuffer[0]` = number of entries in buffer
1518/// - `fBuffer[1]` = w of first entry
1519/// - `fBuffer[2]` = x of first entry
1520
1522{
1523 if (!fBuffer) return -2;
1525
1526
1527 if (nbentries < 0) {
1528 // reset nbentries to a positive value so next time BufferEmpty() is called
1529 // the histogram will be refilled
1531 fBuffer[0] = nbentries;
1532 if (fEntries > 0) {
1533 // set fBuffer to zero to avoid calling BufferEmpty in Reset
1534 Double_t *buffer = fBuffer; fBuffer=nullptr;
1535 Reset("ICES"); // do not reset list of functions
1536 fBuffer = buffer;
1537 }
1538 }
1539 if (2*nbentries+2 >= fBufferSize) {
1540 BufferEmpty(1);
1541 if (!fBuffer)
1542 // to avoid infinite recursion Fill->BufferFill->Fill
1543 return Fill(x,w);
1544 // this cannot happen
1545 R__ASSERT(0);
1546 }
1547 fBuffer[2*nbentries+1] = w;
1548 fBuffer[2*nbentries+2] = x;
1549 fBuffer[0] += 1;
1550 return -2;
1551}
1552
1553////////////////////////////////////////////////////////////////////////////////
1554/// Check bin limits.
1555
1556bool TH1::CheckBinLimits(const TAxis* a1, const TAxis * a2)
1557{
1558 const TArrayD * h1Array = a1->GetXbins();
1559 const TArrayD * h2Array = a2->GetXbins();
1560 Int_t fN = h1Array->fN;
1561 if ( fN != 0 ) {
1562 if ( h2Array->fN != fN ) {
1563 return false;
1564 }
1565 else {
1566 for ( int i = 0; i < fN; ++i ) {
1567 // for i==fN (nbin+1) a->GetBinWidth() returns last bin width
1568 // we do not need to exclude that case
1569 double binWidth = a1->GetBinWidth(i);
1570 if ( ! TMath::AreEqualAbs( h1Array->GetAt(i), h2Array->GetAt(i), binWidth*1E-10 ) ) {
1571 return false;
1572 }
1573 }
1574 }
1575 }
1576
1577 return true;
1578}
1579
1580////////////////////////////////////////////////////////////////////////////////
1581/// Check that axis have same labels.
1582
1583bool TH1::CheckBinLabels(const TAxis* a1, const TAxis * a2)
1584{
1585 THashList *l1 = a1->GetLabels();
1586 THashList *l2 = a2->GetLabels();
1587
1588 if (!l1 && !l2 )
1589 return true;
1590 if (!l1 || !l2 ) {
1591 return false;
1592 }
1593 // check now labels sizes are the same
1594 if (l1->GetSize() != l2->GetSize() ) {
1595 return false;
1596 }
1597 for (int i = 1; i <= a1->GetNbins(); ++i) {
1598 TString label1 = a1->GetBinLabel(i);
1599 TString label2 = a2->GetBinLabel(i);
1600 if (label1 != label2) {
1601 return false;
1602 }
1603 }
1604
1605 return true;
1606}
1607
1608////////////////////////////////////////////////////////////////////////////////
1609/// Check that the axis limits of the histograms are the same.
1610/// If a first and last bin is passed the axis is compared between the given range
1611
1612bool TH1::CheckAxisLimits(const TAxis *a1, const TAxis *a2 )
1613{
1614 double firstBin = a1->GetBinWidth(1);
1615 double lastBin = a1->GetBinWidth( a1->GetNbins() );
1616 if ( ! TMath::AreEqualAbs(a1->GetXmin(), a2->GetXmin(), firstBin* 1.E-10) ||
1617 ! TMath::AreEqualAbs(a1->GetXmax(), a2->GetXmax(), lastBin*1.E-10) ) {
1618 return false;
1619 }
1620 return true;
1621}
1622
1623////////////////////////////////////////////////////////////////////////////////
1624/// Check that the axis are the same
1625
1626bool TH1::CheckEqualAxes(const TAxis *a1, const TAxis *a2 )
1627{
1628 if (a1->GetNbins() != a2->GetNbins() ) {
1629 ::Info("CheckEqualAxes","Axes have different number of bins : nbin1 = %d nbin2 = %d",a1->GetNbins(),a2->GetNbins() );
1630 return false;
1631 }
1632 if(!CheckAxisLimits(a1,a2)) {
1633 ::Info("CheckEqualAxes","Axes have different limits");
1634 return false;
1635 }
1636 if(!CheckBinLimits(a1,a2)) {
1637 ::Info("CheckEqualAxes","Axes have different bin limits");
1638 return false;
1639 }
1640
1641 // check labels
1642 if(!CheckBinLabels(a1,a2)) {
1643 ::Info("CheckEqualAxes","Axes have different labels");
1644 return false;
1645 }
1646
1647 return true;
1648}
1649
1650////////////////////////////////////////////////////////////////////////////////
1651/// Check that two sub axis are the same.
1652/// The limits are defined by first bin and last bin
1653/// N.B. no check is done in this case for variable bins
1654
1656{
1657 // By default is assumed that no bins are given for the second axis
1659 Double_t xmin1 = a1->GetBinLowEdge(firstBin1);
1660 Double_t xmax1 = a1->GetBinUpEdge(lastBin1);
1661
1662 Int_t nbins2 = a2->GetNbins();
1663 Double_t xmin2 = a2->GetXmin();
1664 Double_t xmax2 = a2->GetXmax();
1665
1666 if (firstBin2 < lastBin2) {
1667 // in this case assume no bins are given for the second axis
1669 xmin2 = a1->GetBinLowEdge(firstBin1);
1670 xmax2 = a1->GetBinUpEdge(lastBin1);
1671 }
1672
1673 if (nbins1 != nbins2 ) {
1674 ::Info("CheckConsistentSubAxes","Axes have different number of bins");
1675 return false;
1676 }
1677
1678 Double_t firstBin = a1->GetBinWidth(firstBin1);
1679 Double_t lastBin = a1->GetBinWidth(lastBin1);
1680 if ( ! TMath::AreEqualAbs(xmin1,xmin2,1.E-10 * firstBin) ||
1681 ! TMath::AreEqualAbs(xmax1,xmax2,1.E-10 * lastBin) ) {
1682 ::Info("CheckConsistentSubAxes","Axes have different limits");
1683 return false;
1684 }
1685
1686 return true;
1687}
1688
1689////////////////////////////////////////////////////////////////////////////////
1690/// Check histogram compatibility.
1691/// The returned integer is part of EInconsistencyBits
1692/// The value 0 means that the histograms are compatible
1693
1695{
1696 if (h1 == h2) return kFullyConsistent;
1697
1698 if (h1->GetDimension() != h2->GetDimension() ) {
1699 return kDifferentDimensions;
1700 }
1701 Int_t dim = h1->GetDimension();
1702
1703 // returns kTRUE if number of bins and bin limits are identical
1704 Int_t nbinsx = h1->GetNbinsX();
1705 Int_t nbinsy = h1->GetNbinsY();
1706 Int_t nbinsz = h1->GetNbinsZ();
1707
1708 // Check whether the histograms have the same number of bins.
1709 if (nbinsx != h2->GetNbinsX() ||
1710 (dim > 1 && nbinsy != h2->GetNbinsY()) ||
1711 (dim > 2 && nbinsz != h2->GetNbinsZ()) ) {
1713 }
1714
1715 bool ret = true;
1716
1717 // check axis limits
1718 ret &= CheckAxisLimits(h1->GetXaxis(), h2->GetXaxis());
1719 if (dim > 1) ret &= CheckAxisLimits(h1->GetYaxis(), h2->GetYaxis());
1720 if (dim > 2) ret &= CheckAxisLimits(h1->GetZaxis(), h2->GetZaxis());
1721 if (!ret) return kDifferentAxisLimits;
1722
1723 // check bin limits
1724 ret &= CheckBinLimits(h1->GetXaxis(), h2->GetXaxis());
1725 if (dim > 1) ret &= CheckBinLimits(h1->GetYaxis(), h2->GetYaxis());
1726 if (dim > 2) ret &= CheckBinLimits(h1->GetZaxis(), h2->GetZaxis());
1727 if (!ret) return kDifferentBinLimits;
1728
1729 // check labels if histograms are both not empty
1730 if ( !h1->IsEmpty() && !h2->IsEmpty() ) {
1731 ret &= CheckBinLabels(h1->GetXaxis(), h2->GetXaxis());
1732 if (dim > 1) ret &= CheckBinLabels(h1->GetYaxis(), h2->GetYaxis());
1733 if (dim > 2) ret &= CheckBinLabels(h1->GetZaxis(), h2->GetZaxis());
1734 if (!ret) return kDifferentLabels;
1735 }
1736
1737 return kFullyConsistent;
1738}
1739
1740////////////////////////////////////////////////////////////////////////////////
1741/// \f$ \chi^{2} \f$ test for comparing weighted and unweighted histograms.
1742///
1743/// Compares the histograms' adjusted (normalized) residuals.
1744/// Function: Returns p-value. Other return values are specified by the 3rd parameter
1745///
1746/// \param[in] h2 the second histogram
1747/// \param[in] option
1748/// - "UU" = experiment experiment comparison (unweighted-unweighted)
1749/// - "UW" = experiment MC comparison (unweighted-weighted). Note that
1750/// the first histogram should be unweighted
1751/// - "WW" = MC MC comparison (weighted-weighted)
1752/// - "NORM" = to be used when one or both of the histograms is scaled
1753/// but the histogram originally was unweighted
1754/// - by default underflows and overflows are not included:
1755/// * "OF" = overflows included
1756/// * "UF" = underflows included
1757/// - "P" = print chi2, ndf, p_value, igood
1758/// - "CHI2" = returns chi2 instead of p-value
1759/// - "CHI2/NDF" = returns \f$ \chi^{2} \f$/ndf
1760/// \param[in] res not empty - computes normalized residuals and returns them in this array
1761///
1762/// The current implementation is based on the papers \f$ \chi^{2} \f$ test for comparison
1763/// of weighted and unweighted histograms" in Proceedings of PHYSTAT05 and
1764/// "Comparison weighted and unweighted histograms", arXiv:physics/0605123
1765/// by N.Gagunashvili. This function has been implemented by Daniel Haertl in August 2006.
1766///
1767/// #### Introduction:
1768///
1769/// A frequently used technique in data analysis is the comparison of
1770/// histograms. First suggested by Pearson [1] the \f$ \chi^{2} \f$ test of
1771/// homogeneity is used widely for comparing usual (unweighted) histograms.
1772/// This paper describes the implementation modified \f$ \chi^{2} \f$ tests
1773/// for comparison of weighted and unweighted histograms and two weighted
1774/// histograms [2] as well as usual Pearson's \f$ \chi^{2} \f$ test for
1775/// comparison two usual (unweighted) histograms.
1776///
1777/// #### Overview:
1778///
1779/// Comparison of two histograms expect hypotheses that two histograms
1780/// represent identical distributions. To make a decision p-value should
1781/// be calculated. The hypotheses of identity is rejected if the p-value is
1782/// lower then some significance level. Traditionally significance levels
1783/// 0.1, 0.05 and 0.01 are used. The comparison procedure should include an
1784/// analysis of the residuals which is often helpful in identifying the
1785/// bins of histograms responsible for a significant overall \f$ \chi^{2} \f$ value.
1786/// Residuals are the difference between bin contents and expected bin
1787/// contents. Most convenient for analysis are the normalized residuals. If
1788/// hypotheses of identity are valid then normalized residuals are
1789/// approximately independent and identically distributed random variables
1790/// having N(0,1) distribution. Analysis of residuals expect test of above
1791/// mentioned properties of residuals. Notice that indirectly the analysis
1792/// of residuals increase the power of \f$ \chi^{2} \f$ test.
1793///
1794/// #### Methods of comparison:
1795///
1796/// \f$ \chi^{2} \f$ test for comparison two (unweighted) histograms:
1797/// Let us consider two histograms with the same binning and the number
1798/// of bins equal to r. Let us denote the number of events in the ith bin
1799/// in the first histogram as ni and as mi in the second one. The total
1800/// number of events in the first histogram is equal to:
1801/// \f[
1802/// N = \sum_{i=1}^{r} n_{i}
1803/// \f]
1804/// and
1805/// \f[
1806/// M = \sum_{i=1}^{r} m_{i}
1807/// \f]
1808/// in the second histogram. The hypothesis of identity (homogeneity) [3]
1809/// is that the two histograms represent random values with identical
1810/// distributions. It is equivalent that there exist r constants p1,...,pr,
1811/// such that
1812/// \f[
1813///\sum_{i=1}^{r} p_{i}=1
1814/// \f]
1815/// and the probability of belonging to the ith bin for some measured value
1816/// in both experiments is equal to pi. The number of events in the ith
1817/// bin is a random variable with a distribution approximated by a Poisson
1818/// probability distribution
1819/// \f[
1820///\frac{e^{-Np_{i}}(Np_{i})^{n_{i}}}{n_{i}!}
1821/// \f]
1822///for the first histogram and with distribution
1823/// \f[
1824///\frac{e^{-Mp_{i}}(Mp_{i})^{m_{i}}}{m_{i}!}
1825/// \f]
1826/// for the second histogram. If the hypothesis of homogeneity is valid,
1827/// then the maximum likelihood estimator of pi, i=1,...,r, is
1828/// \f[
1829///\hat{p}_{i}= \frac{n_{i}+m_{i}}{N+M}
1830/// \f]
1831/// and then
1832/// \f[
1833/// 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}}
1834/// \f]
1835/// has approximately a \f$ \chi^{2}_{(r-1)} \f$ distribution [3].
1836/// The comparison procedure can include an analysis of the residuals which
1837/// is often helpful in identifying the bins of histograms responsible for
1838/// a significant overall \f$ \chi^{2} \f$ value. Most convenient for
1839/// analysis are the adjusted (normalized) residuals [4]
1840/// \f[
1841/// 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))}}
1842/// \f]
1843/// If hypotheses of homogeneity are valid then residuals ri are
1844/// approximately independent and identically distributed random variables
1845/// having N(0,1) distribution. The application of the \f$ \chi^{2} \f$ test has
1846/// restrictions related to the value of the expected frequencies Npi,
1847/// Mpi, i=1,...,r. A conservative rule formulated in [5] is that all the
1848/// expectations must be 1 or greater for both histograms. In practical
1849/// cases when expected frequencies are not known the estimated expected
1850/// frequencies \f$ M\hat{p}_{i}, N\hat{p}_{i}, i=1,...,r \f$ can be used.
1851///
1852/// #### Unweighted and weighted histograms comparison:
1853///
1854/// A simple modification of the ideas described above can be used for the
1855/// comparison of the usual (unweighted) and weighted histograms. Let us
1856/// denote the number of events in the ith bin in the unweighted
1857/// histogram as ni and the common weight of events in the ith bin of the
1858/// weighted histogram as wi. The total number of events in the
1859/// unweighted histogram is equal to
1860///\f[
1861/// N = \sum_{i=1}^{r} n_{i}
1862///\f]
1863/// and the total weight of events in the weighted histogram is equal to
1864///\f[
1865/// W = \sum_{i=1}^{r} w_{i}
1866///\f]
1867/// Let us formulate the hypothesis of identity of an unweighted histogram
1868/// to a weighted histogram so that there exist r constants p1,...,pr, such
1869/// that
1870///\f[
1871/// \sum_{i=1}^{r} p_{i} = 1
1872///\f]
1873/// for the unweighted histogram. The weight wi is a random variable with a
1874/// distribution approximated by the normal probability distribution
1875/// \f$ N(Wp_{i},\sigma_{i}^{2}) \f$ where \f$ \sigma_{i}^{2} \f$ is the variance of the weight wi.
1876/// If we replace the variance \f$ \sigma_{i}^{2} \f$
1877/// with estimate \f$ s_{i}^{2} \f$ (sum of squares of weights of
1878/// events in the ith bin) and the hypothesis of identity is valid, then the
1879/// maximum likelihood estimator of pi,i=1,...,r, is
1880///\f[
1881/// \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}}
1882///\f]
1883/// We may then use the test statistic
1884///\f[
1885/// 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}}
1886///\f]
1887/// and it has approximately a \f$ \sigma^{2}_{(r-1)} \f$ distribution [2]. This test, as well
1888/// as the original one [3], has a restriction on the expected frequencies. The
1889/// expected frequencies recommended for the weighted histogram is more than 25.
1890/// The value of the minimal expected frequency can be decreased down to 10 for
1891/// the case when the weights of the events are close to constant. In the case
1892/// of a weighted histogram if the number of events is unknown, then we can
1893/// apply this recommendation for the equivalent number of events as
1894///\f[
1895/// n_{i}^{equiv} = \frac{ w_{i}^{2} }{ s_{i}^{2} }
1896///\f]
1897/// The minimal expected frequency for an unweighted histogram must be 1. Notice
1898/// that any usual (unweighted) histogram can be considered as a weighted
1899/// histogram with events that have constant weights equal to 1.
1900/// The variance \f$ z_{i}^{2} \f$ of the difference between the weight wi
1901/// and the estimated expectation value of the weight is approximately equal to:
1902///\f[
1903/// 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}
1904///\f]
1905/// The residuals
1906///\f[
1907/// r_{i} = \frac{w_{i}-W\hat{p}_{i}}{z_{i}}
1908///\f]
1909/// have approximately a normal distribution with mean equal to 0 and standard
1910/// deviation equal to 1.
1911///
1912/// #### Two weighted histograms comparison:
1913///
1914/// Let us denote the common weight of events of the ith bin in the first
1915/// histogram as w1i and as w2i in the second one. The total weight of events
1916/// in the first histogram is equal to
1917///\f[
1918/// W_{1} = \sum_{i=1}^{r} w_{1i}
1919///\f]
1920/// and
1921///\f[
1922/// W_{2} = \sum_{i=1}^{r} w_{2i}
1923///\f]
1924/// in the second histogram. Let us formulate the hypothesis of identity of
1925/// weighted histograms so that there exist r constants p1,...,pr, such that
1926///\f[
1927/// \sum_{i=1}^{r} p_{i} = 1
1928///\f]
1929/// and also expectation value of weight w1i equal to W1pi and expectation value
1930/// of weight w2i equal to W2pi. Weights in both the histograms are random
1931/// variables with distributions which can be approximated by a normal
1932/// probability distribution \f$ N(W_{1}p_{i},\sigma_{1i}^{2}) \f$ for the first histogram
1933/// and by a distribution \f$ N(W_{2}p_{i},\sigma_{2i}^{2}) \f$ for the second.
1934/// Here \f$ \sigma_{1i}^{2} \f$ and \f$ \sigma_{2i}^{2} \f$ are the variances
1935/// of w1i and w2i with estimators \f$ s_{1i}^{2} \f$ and \f$ s_{2i}^{2} \f$ respectively.
1936/// If the hypothesis of identity is valid, then the maximum likelihood and
1937/// Least Square Method estimator of pi,i=1,...,r, is
1938///\f[
1939/// \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}}
1940///\f]
1941/// We may then use the test statistic
1942///\f[
1943/// 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}}
1944///\f]
1945/// and it has approximately a \f$ \chi^{2}_{(r-1)} \f$ distribution [2].
1946/// The normalized or studentised residuals [6]
1947///\f[
1948/// 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})}}}
1949///\f]
1950/// have approximately a normal distribution with mean equal to 0 and standard
1951/// deviation 1. A recommended minimal expected frequency is equal to 10 for
1952/// the proposed test.
1953///
1954/// #### Numerical examples:
1955///
1956/// The method described herein is now illustrated with an example.
1957/// We take a distribution
1958///\f[
1959/// \phi(x) = \frac{2}{(x-10)^{2}+1} + \frac{1}{(x-14)^{2}+1} (1)
1960///\f]
1961/// defined on the interval [4,16]. Events distributed according to the formula
1962/// (1) are simulated to create the unweighted histogram. Uniformly distributed
1963/// events are simulated for the weighted histogram with weights calculated by
1964/// formula (1). Each histogram has the same number of bins: 20. Fig.1 shows
1965/// the result of comparison of the unweighted histogram with 200 events
1966/// (minimal expected frequency equal to one) and the weighted histogram with
1967/// 500 events (minimal expected frequency equal to 25)
1968/// Begin_Macro
1969/// ../../../tutorials/math/chi2test.C
1970/// End_Macro
1971/// Fig 1. An example of comparison of the unweighted histogram with 200 events
1972/// and the weighted histogram with 500 events:
1973/// 1. unweighted histogram;
1974/// 2. weighted histogram;
1975/// 3. normalized residuals plot;
1976/// 4. normal Q-Q plot of residuals.
1977///
1978/// The value of the test statistic \f$ \chi^{2} \f$ is equal to
1979/// 21.09 with p-value equal to 0.33, therefore the hypothesis of identity of
1980/// the two histograms can be accepted for 0.05 significant level. The behavior
1981/// of the normalized residuals plot (see Fig. 1c) and the normal Q-Q plot
1982/// (see Fig. 1d) of residuals are regular and we cannot identify the outliers
1983/// or bins with a big influence on \f$ \chi^{2} \f$.
1984///
1985/// The second example presents the same two histograms but 17 events was added
1986/// to content of bin number 15 in unweighted histogram. Fig.2 shows the result
1987/// of comparison of the unweighted histogram with 217 events (minimal expected
1988/// frequency equal to one) and the weighted histogram with 500 events (minimal
1989/// expected frequency equal to 25)
1990/// Begin_Macro
1991/// ../../../tutorials/math/chi2test.C(17)
1992/// End_Macro
1993/// Fig 2. An example of comparison of the unweighted histogram with 217 events
1994/// and the weighted histogram with 500 events:
1995/// 1. unweighted histogram;
1996/// 2. weighted histogram;
1997/// 3. normalized residuals plot;
1998/// 4. normal Q-Q plot of residuals.
1999///
2000/// The value of the test statistic \f$ \chi^{2} \f$ is equal to
2001/// 32.33 with p-value equal to 0.029, therefore the hypothesis of identity of
2002/// the two histograms is rejected for 0.05 significant level. The behavior of
2003/// the normalized residuals plot (see Fig. 2c) and the normal Q-Q plot (see
2004/// Fig. 2d) of residuals are not regular and we can identify the outlier or
2005/// bin with a big influence on \f$ \chi^{2} \f$.
2006///
2007/// #### References:
2008///
2009/// - [1] Pearson, K., 1904. On the Theory of Contingency and Its Relation to
2010/// Association and Normal Correlation. Drapers' Co. Memoirs, Biometric
2011/// Series No. 1, London.
2012/// - [2] Gagunashvili, N., 2006. \f$ \sigma^{2} \f$ test for comparison
2013/// of weighted and unweighted histograms. Statistical Problems in Particle
2014/// Physics, Astrophysics and Cosmology, Proceedings of PHYSTAT05,
2015/// Oxford, UK, 12-15 September 2005, Imperial College Press, London, 43-44.
2016/// Gagunashvili,N., Comparison of weighted and unweighted histograms,
2017/// arXiv:physics/0605123, 2006.
2018/// - [3] Cramer, H., 1946. Mathematical methods of statistics.
2019/// Princeton University Press, Princeton.
2020/// - [4] Haberman, S.J., 1973. The analysis of residuals in cross-classified tables.
2021/// Biometrics 29, 205-220.
2022/// - [5] Lewontin, R.C. and Felsenstein, J., 1965. The robustness of homogeneity
2023/// test in 2xN tables. Biometrics 21, 19-33.
2024/// - [6] Seber, G.A.F., Lee, A.J., 2003, Linear Regression Analysis.
2025/// John Wiley & Sons Inc., New York.
2026
2027Double_t TH1::Chi2Test(const TH1* h2, Option_t *option, Double_t *res) const
2028{
2029 Double_t chi2 = 0;
2030 Int_t ndf = 0, igood = 0;
2031
2032 TString opt = option;
2033 opt.ToUpper();
2034
2035 Double_t prob = Chi2TestX(h2,chi2,ndf,igood,option,res);
2036
2037 if(opt.Contains("P")) {
2038 printf("Chi2 = %f, Prob = %g, NDF = %d, igood = %d\n", chi2,prob,ndf,igood);
2039 }
2040 if(opt.Contains("CHI2/NDF")) {
2041 if (ndf == 0) return 0;
2042 return chi2/ndf;
2043 }
2044 if(opt.Contains("CHI2")) {
2045 return chi2;
2046 }
2047
2048 return prob;
2049}
2050
2051////////////////////////////////////////////////////////////////////////////////
2052/// The computation routine of the Chisquare test. For the method description,
2053/// see Chi2Test() function.
2054///
2055/// \return p-value
2056/// \param[in] h2 the second histogram
2057/// \param[in] option
2058/// - "UU" = experiment experiment comparison (unweighted-unweighted)
2059/// - "UW" = experiment MC comparison (unweighted-weighted). Note that the first
2060/// histogram should be unweighted
2061/// - "WW" = MC MC comparison (weighted-weighted)
2062/// - "NORM" = if one or both histograms is scaled
2063/// - "OF" = overflows included
2064/// - "UF" = underflows included
2065/// by default underflows and overflows are not included
2066/// \param[out] igood test output
2067/// - igood=0 - no problems
2068/// - For unweighted unweighted comparison
2069/// - igood=1'There is a bin in the 1st histogram with less than 1 event'
2070/// - igood=2'There is a bin in the 2nd histogram with less than 1 event'
2071/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2072/// - For unweighted weighted comparison
2073/// - igood=1'There is a bin in the 1st histogram with less then 1 event'
2074/// - igood=2'There is a bin in the 2nd histogram with less then 10 effective number of events'
2075/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2076/// - For weighted weighted comparison
2077/// - igood=1'There is a bin in the 1st histogram with less then 10 effective
2078/// number of events'
2079/// - igood=2'There is a bin in the 2nd histogram with less then 10 effective
2080/// number of events'
2081/// - igood=3'when the conditions for igood=1 and igood=2 are satisfied'
2082/// \param[out] chi2 chisquare of the test
2083/// \param[out] ndf number of degrees of freedom (important, when both histograms have the same empty bins)
2084/// \param[out] res normalized residuals for further analysis
2085
2086Double_t TH1::Chi2TestX(const TH1* h2, Double_t &chi2, Int_t &ndf, Int_t &igood, Option_t *option, Double_t *res) const
2087{
2088
2092
2093 Double_t sum1 = 0.0, sumw1 = 0.0;
2094 Double_t sum2 = 0.0, sumw2 = 0.0;
2095
2096 chi2 = 0.0;
2097 ndf = 0;
2098
2099 TString opt = option;
2100 opt.ToUpper();
2101
2102 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
2103
2104 const TAxis *xaxis1 = GetXaxis();
2105 const TAxis *xaxis2 = h2->GetXaxis();
2106 const TAxis *yaxis1 = GetYaxis();
2107 const TAxis *yaxis2 = h2->GetYaxis();
2108 const TAxis *zaxis1 = GetZaxis();
2109 const TAxis *zaxis2 = h2->GetZaxis();
2110
2111 Int_t nbinx1 = xaxis1->GetNbins();
2112 Int_t nbinx2 = xaxis2->GetNbins();
2113 Int_t nbiny1 = yaxis1->GetNbins();
2114 Int_t nbiny2 = yaxis2->GetNbins();
2115 Int_t nbinz1 = zaxis1->GetNbins();
2116 Int_t nbinz2 = zaxis2->GetNbins();
2117
2118 //check dimensions
2119 if (this->GetDimension() != h2->GetDimension() ){
2120 Error("Chi2TestX","Histograms have different dimensions.");
2121 return 0.0;
2122 }
2123
2124 //check number of channels
2125 if (nbinx1 != nbinx2) {
2126 Error("Chi2TestX","different number of x channels");
2127 }
2128 if (nbiny1 != nbiny2) {
2129 Error("Chi2TestX","different number of y channels");
2130 }
2131 if (nbinz1 != nbinz2) {
2132 Error("Chi2TestX","different number of z channels");
2133 }
2134
2135 //check for ranges
2136 i_start = j_start = k_start = 1;
2137 i_end = nbinx1;
2138 j_end = nbiny1;
2139 k_end = nbinz1;
2140
2141 if (xaxis1->TestBit(TAxis::kAxisRange)) {
2142 i_start = xaxis1->GetFirst();
2143 i_end = xaxis1->GetLast();
2144 }
2145 if (yaxis1->TestBit(TAxis::kAxisRange)) {
2146 j_start = yaxis1->GetFirst();
2147 j_end = yaxis1->GetLast();
2148 }
2149 if (zaxis1->TestBit(TAxis::kAxisRange)) {
2150 k_start = zaxis1->GetFirst();
2151 k_end = zaxis1->GetLast();
2152 }
2153
2154
2155 if (opt.Contains("OF")) {
2156 if (GetDimension() == 3) k_end = ++nbinz1;
2157 if (GetDimension() >= 2) j_end = ++nbiny1;
2158 if (GetDimension() >= 1) i_end = ++nbinx1;
2159 }
2160
2161 if (opt.Contains("UF")) {
2162 if (GetDimension() == 3) k_start = 0;
2163 if (GetDimension() >= 2) j_start = 0;
2164 if (GetDimension() >= 1) i_start = 0;
2165 }
2166
2167 ndf = (i_end - i_start + 1) * (j_end - j_start + 1) * (k_end - k_start + 1) - 1;
2168
2169 Bool_t comparisonUU = opt.Contains("UU");
2170 Bool_t comparisonUW = opt.Contains("UW");
2171 Bool_t comparisonWW = opt.Contains("WW");
2172 Bool_t scaledHistogram = opt.Contains("NORM");
2173
2174 if (scaledHistogram && !comparisonUU) {
2175 Info("Chi2TestX", "NORM option should be used together with UU option. It is ignored");
2176 }
2177
2178 // look at histo global bin content and effective entries
2179 Stat_t s[kNstat];
2180 GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
2181 Double_t sumBinContent1 = s[0];
2182 Double_t effEntries1 = (s[1] ? s[0] * s[0] / s[1] : 0.0);
2183
2184 h2->GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
2185 Double_t sumBinContent2 = s[0];
2186 Double_t effEntries2 = (s[1] ? s[0] * s[0] / s[1] : 0.0);
2187
2188 if (!comparisonUU && !comparisonUW && !comparisonWW ) {
2189 // deduce automatically from type of histogram
2192 else comparisonUW = true;
2193 }
2194 else comparisonWW = true;
2195 }
2196 // check unweighted histogram
2197 if (comparisonUW) {
2199 Warning("Chi2TestX","First histogram is not unweighted and option UW has been requested");
2200 }
2201 }
2202 if ( (!scaledHistogram && comparisonUU) ) {
2204 Warning("Chi2TestX","Both histograms are not unweighted and option UU has been requested");
2205 }
2206 }
2207
2208
2209 //get number of events in histogram
2211 for (Int_t i = i_start; i <= i_end; ++i) {
2212 for (Int_t j = j_start; j <= j_end; ++j) {
2213 for (Int_t k = k_start; k <= k_end; ++k) {
2214
2215 Int_t bin = GetBin(i, j, k);
2216
2221
2222 if (e1sq > 0.0) cnt1 = TMath::Floor(cnt1 * cnt1 / e1sq + 0.5); // avoid rounding errors
2223 else cnt1 = 0.0;
2224
2225 if (e2sq > 0.0) cnt2 = TMath::Floor(cnt2 * cnt2 / e2sq + 0.5); // avoid rounding errors
2226 else cnt2 = 0.0;
2227
2228 // sum contents
2229 sum1 += cnt1;
2230 sum2 += cnt2;
2231 sumw1 += e1sq;
2232 sumw2 += e2sq;
2233 }
2234 }
2235 }
2236 if (sumw1 <= 0.0 || sumw2 <= 0.0) {
2237 Error("Chi2TestX", "Cannot use option NORM when one histogram has all zero errors");
2238 return 0.0;
2239 }
2240
2241 } else {
2242 for (Int_t i = i_start; i <= i_end; ++i) {
2243 for (Int_t j = j_start; j <= j_end; ++j) {
2244 for (Int_t k = k_start; k <= k_end; ++k) {
2245
2246 Int_t bin = GetBin(i, j, k);
2247
2249 sum2 += h2->RetrieveBinContent(bin);
2250
2253 }
2254 }
2255 }
2256 }
2257 //checks that the histograms are not empty
2258 if (sum1 == 0.0 || sum2 == 0.0) {
2259 Error("Chi2TestX","one histogram is empty");
2260 return 0.0;
2261 }
2262
2263 if ( comparisonWW && ( sumw1 <= 0.0 && sumw2 <= 0.0 ) ){
2264 Error("Chi2TestX","Hist1 and Hist2 have both all zero errors\n");
2265 return 0.0;
2266 }
2267
2268 //THE TEST
2269 Int_t m = 0, n = 0;
2270 //Experiment - experiment comparison
2271 if (comparisonUU) {
2272 Int_t resIndex = 0;
2273 Double_t sum = sum1 + sum2;
2274 for (Int_t i = i_start; i <= i_end; ++i) {
2275 for (Int_t j = j_start; j <= j_end; ++j) {
2276 for (Int_t k = k_start; k <= k_end; ++k) {
2277
2278 Int_t bin = GetBin(i, j, k);
2279
2282
2283 if (scaledHistogram) {
2284 // scale bin value to effective bin entries
2287
2288 if (e1sq > 0) cnt1 = TMath::Floor(cnt1 * cnt1 / e1sq + 0.5); // avoid rounding errors
2289 else cnt1 = 0;
2290
2291 if (e2sq > 0) cnt2 = TMath::Floor(cnt2 * cnt2 / e2sq + 0.5); // avoid rounding errors
2292 else cnt2 = 0;
2293 }
2294
2295 if (Int_t(cnt1) == 0 && Int_t(cnt2) == 0) --ndf; // no data means one degree of freedom less
2296 else {
2297
2300 //Double_t nexp2 = binsum*sum2/sum;
2301
2302 if (res) res[resIndex] = (cnt1 - nexp1) / TMath::Sqrt(nexp1);
2303
2304 if (cnt1 < 1) ++m;
2305 if (cnt2 < 1) ++n;
2306
2307 //Habermann correction for residuals
2308 Double_t correc = (1. - sum1 / sum) * (1. - cntsum / sum);
2309 if (res) res[resIndex] /= TMath::Sqrt(correc);
2310 if (res) resIndex++;
2311 Double_t delta = sum2 * cnt1 - sum1 * cnt2;
2312 chi2 += delta * delta / cntsum;
2313 }
2314 }
2315 }
2316 }
2317 chi2 /= sum1 * sum2;
2318
2319 // flag error only when of the two histogram is zero
2320 if (m) {
2321 igood += 1;
2322 Info("Chi2TestX","There is a bin in h1 with less than 1 event.\n");
2323 }
2324 if (n) {
2325 igood += 2;
2326 Info("Chi2TestX","There is a bin in h2 with less than 1 event.\n");
2327 }
2328
2330 return prob;
2331
2332 }
2333
2334 // unweighted - weighted comparison
2335 // case of error = 0 and content not zero is treated without problems by excluding second chi2 sum
2336 // and can be considered as a data-theory comparison
2337 if ( comparisonUW ) {
2338 Int_t resIndex = 0;
2339 for (Int_t i = i_start; i <= i_end; ++i) {
2340 for (Int_t j = j_start; j <= j_end; ++j) {
2341 for (Int_t k = k_start; k <= k_end; ++k) {
2342
2343 Int_t bin = GetBin(i, j, k);
2344
2348
2349 // case both histogram have zero bin contents
2350 if (cnt1 * cnt1 == 0 && cnt2 * cnt2 == 0) {
2351 --ndf; //no data means one degree of freedom less
2352 continue;
2353 }
2354
2355 // case weighted histogram has zero bin content and error
2356 if (cnt2 * cnt2 == 0 && e2sq == 0) {
2357 if (sumw2 > 0) {
2358 // use as approximated error as 1 scaled by a scaling ratio
2359 // estimated from the total sum weight and sum weight squared
2360 e2sq = sumw2 / sum2;
2361 }
2362 else {
2363 // return error because infinite discrepancy here:
2364 // bin1 != 0 and bin2 =0 in a histogram with all errors zero
2365 Error("Chi2TestX","Hist2 has in bin (%d,%d,%d) zero content and zero errors\n", i, j, k);
2366 chi2 = 0; return 0;
2367 }
2368 }
2369
2370 if (cnt1 < 1) m++;
2371 if (e2sq > 0 && cnt2 * cnt2 / e2sq < 10) n++;
2372
2373 Double_t var1 = sum2 * cnt2 - sum1 * e2sq;
2374 Double_t var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2375
2376 // if cnt1 is zero and cnt2 = 1 and sum1 = sum2 var1 = 0 && var2 == 0
2377 // approximate by incrementing cnt1
2378 // LM (this need to be fixed for numerical errors)
2379 while (var1 * var1 + cnt1 == 0 || var1 + var2 == 0) {
2380 sum1++;
2381 cnt1++;
2382 var1 = sum2 * cnt2 - sum1 * e2sq;
2383 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2384 }
2386
2387 while (var1 + var2 == 0) {
2388 sum1++;
2389 cnt1++;
2390 var1 = sum2 * cnt2 - sum1 * e2sq;
2391 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2392 while (var1 * var1 + cnt1 == 0 || var1 + var2 == 0) {
2393 sum1++;
2394 cnt1++;
2395 var1 = sum2 * cnt2 - sum1 * e2sq;
2396 var2 = var1 * var1 + 4. * sum2 * sum2 * cnt1 * e2sq;
2397 }
2399 }
2400
2401 Double_t probb = (var1 + var2) / (2. * sum2 * sum2);
2402
2405
2408
2409 chi2 += delta1 * delta1 / nexp1;
2410
2411 if (e2sq > 0) {
2412 chi2 += delta2 * delta2 / e2sq;
2413 }
2414
2415 if (res) {
2416 if (e2sq > 0) {
2417 Double_t temp1 = sum2 * e2sq / var2;
2418 Double_t temp2 = 1.0 + (sum1 * e2sq - sum2 * cnt2) / var2;
2419 temp2 = temp1 * temp1 * sum1 * probb * (1.0 - probb) + temp2 * temp2 * e2sq / 4.0;
2420 // invert sign here
2421 res[resIndex] = - delta2 / TMath::Sqrt(temp2);
2422 }
2423 else
2424 res[resIndex] = delta1 / TMath::Sqrt(nexp1);
2425 resIndex++;
2426 }
2427 }
2428 }
2429 }
2430
2431 if (m) {
2432 igood += 1;
2433 Info("Chi2TestX","There is a bin in h1 with less than 1 event.\n");
2434 }
2435 if (n) {
2436 igood += 2;
2437 Info("Chi2TestX","There is a bin in h2 with less than 10 effective events.\n");
2438 }
2439
2440 Double_t prob = TMath::Prob(chi2, ndf);
2441
2442 return prob;
2443 }
2444
2445 // weighted - weighted comparison
2446 if (comparisonWW) {
2447 Int_t resIndex = 0;
2448 for (Int_t i = i_start; i <= i_end; ++i) {
2449 for (Int_t j = j_start; j <= j_end; ++j) {
2450 for (Int_t k = k_start; k <= k_end; ++k) {
2451
2452 Int_t bin = GetBin(i, j, k);
2457
2458 // case both histogram have zero bin contents
2459 // (use square of content to avoid numerical errors)
2460 if (cnt1 * cnt1 == 0 && cnt2 * cnt2 == 0) {
2461 --ndf; //no data means one degree of freedom less
2462 continue;
2463 }
2464
2465 if (e1sq == 0 && e2sq == 0) {
2466 // cannot treat case of booth histogram have zero zero errors
2467 Error("Chi2TestX","h1 and h2 both have bin %d,%d,%d with all zero errors\n", i,j,k);
2468 chi2 = 0; return 0;
2469 }
2470
2471 Double_t sigma = sum1 * sum1 * e2sq + sum2 * sum2 * e1sq;
2472 Double_t delta = sum2 * cnt1 - sum1 * cnt2;
2473 chi2 += delta * delta / sigma;
2474
2475 if (res) {
2476 Double_t temp = cnt1 * sum1 * e2sq + cnt2 * sum2 * e1sq;
2477 Double_t probb = temp / sigma;
2478 Double_t z = 0;
2479 if (e1sq > e2sq) {
2480 Double_t d1 = cnt1 - sum1 * probb;
2481 Double_t s1 = e1sq * ( 1. - e2sq * sum1 * sum1 / sigma );
2482 z = d1 / TMath::Sqrt(s1);
2483 }
2484 else {
2485 Double_t d2 = cnt2 - sum2 * probb;
2486 Double_t s2 = e2sq * ( 1. - e1sq * sum2 * sum2 / sigma );
2487 z = -d2 / TMath::Sqrt(s2);
2488 }
2489 res[resIndex] = z;
2490 resIndex++;
2491 }
2492
2493 if (e1sq > 0 && cnt1 * cnt1 / e1sq < 10) m++;
2494 if (e2sq > 0 && cnt2 * cnt2 / e2sq < 10) n++;
2495 }
2496 }
2497 }
2498 if (m) {
2499 igood += 1;
2500 Info("Chi2TestX","There is a bin in h1 with less than 10 effective events.\n");
2501 }
2502 if (n) {
2503 igood += 2;
2504 Info("Chi2TestX","There is a bin in h2 with less than 10 effective events.\n");
2505 }
2506 Double_t prob = TMath::Prob(chi2, ndf);
2507 return prob;
2508 }
2509 return 0;
2510}
2511////////////////////////////////////////////////////////////////////////////////
2512/// Compute and return the chisquare of this histogram with respect to a function
2513/// The chisquare is computed by weighting each histogram point by the bin error
2514/// By default the full range of the histogram is used, unless TAxis::SetRange or TAxis::SetRangeUser was called before.
2515/// Use option "R" for restricting the chisquare calculation to the given range of the function
2516/// Use option "L" for using the chisquare based on the poisson likelihood (Baker-Cousins Chisquare)
2517/// Use option "P" for using the Pearson chisquare based on the expected bin errors
2518/// Use option "I" for using the integral of the function in each bin instead of the value at the bin center
2519
2521{
2522 if (!func) {
2523 Error("Chisquare","Function pointer is Null - return -1");
2524 return -1;
2525 }
2526
2527 TString opt(option); opt.ToUpper();
2528 bool useRange = opt.Contains("R");
2529 bool useIntegral = opt.Contains("I");
2530 ROOT::Fit::EChisquareType type = ROOT::Fit::EChisquareType::kNeyman; // default chi2 with observed error
2533
2534 return ROOT::Fit::Chisquare(*this, *func, useRange, type, useIntegral);
2535}
2536
2537////////////////////////////////////////////////////////////////////////////////
2538/// Remove all the content from the underflow and overflow bins, without changing the number of entries
2539/// After calling this method, every undeflow and overflow bins will have content 0.0
2540/// The Sumw2 is also cleared, since there is no more content in the bins
2541
2543{
2544 for (Int_t bin = 0; bin < fNcells; ++bin)
2546 UpdateBinContent(bin, 0.0);
2547 if (fSumw2.fN) fSumw2.fArray[bin] = 0.0;
2548 }
2549}
2550
2551////////////////////////////////////////////////////////////////////////////////
2552/// Compute integral (normalized cumulative sum of bins) w/o under/overflows
2553/// The result is stored in fIntegral and used by the GetRandom functions.
2554/// This function is automatically called by GetRandom when the fIntegral
2555/// array does not exist or when the number of entries in the histogram
2556/// has changed since the previous call to GetRandom.
2557/// The resulting integral is normalized to 1.
2558/// If the routine is called with the onlyPositive flag set an error will
2559/// be produced in case of negative bin content and a NaN value returned
2560/// \param onlyPositive If set to true, an error will be produced and NaN will be returned
2561/// when a bin with negative number of entries is encountered.
2562/// \param option
2563/// - `""` (default) Compute the cumulative density function assuming current bin contents represent counts.
2564/// - `"width"` Computes the cumulative density function assuming current bin contents represent densities.
2565/// \return 1 if success, 0 if integral is zero, NAN if onlyPositive-test fails
2566
2568{
2569 if (fBuffer) BufferEmpty();
2571 // delete previously computed integral (if any)
2572 if (fIntegral) delete [] fIntegral;
2573
2574 // - Allocate space to store the integral and compute integral
2578 Int_t nbins = nbinsx * nbinsy * nbinsz;
2579
2580 fIntegral = new Double_t[nbins + 2];
2581 Int_t ibin = 0; fIntegral[ibin] = 0;
2582
2583 for (Int_t binz=1; binz <= nbinsz; ++binz) {
2585 for (Int_t biny=1; biny <= nbinsy; ++biny) {
2587 for (Int_t binx=1; binx <= nbinsx; ++binx) {
2589 ++ibin;
2591 if (useArea)
2592 y *= xWidth * yWidth * zWidth;
2593
2594 if (onlyPositive && y < 0) {
2595 Error("ComputeIntegral","Bin content is negative - return a NaN value");
2596 fIntegral[nbins] = TMath::QuietNaN();
2597 break;
2598 }
2599 fIntegral[ibin] = fIntegral[ibin - 1] + y;
2600 }
2601 }
2602 }
2603
2604 // - Normalize integral to 1
2605 if (fIntegral[nbins] == 0 ) {
2606 Error("ComputeIntegral", "Integral = 0, no hits in histogram bins (excluding over/underflow).");
2607 return 0;
2608 }
2609 for (Int_t bin=1; bin <= nbins; ++bin) fIntegral[bin] /= fIntegral[nbins];
2610 fIntegral[nbins+1] = fEntries;
2611 return fIntegral[nbins];
2612}
2613
2614////////////////////////////////////////////////////////////////////////////////
2615/// Return a pointer to the array of bins integral.
2616/// if the pointer fIntegral is null, TH1::ComputeIntegral is called
2617/// The array dimension is the number of bins in the histograms
2618/// including underflow and overflow (fNCells)
2619/// the last value integral[fNCells] is set to the number of entries of
2620/// the histogram
2621
2623{
2624 if (!fIntegral) ComputeIntegral();
2625 return fIntegral;
2626}
2627
2628////////////////////////////////////////////////////////////////////////////////
2629/// Return a pointer to a histogram containing the cumulative content.
2630/// The cumulative can be computed both in the forward (default) or backward
2631/// direction; the name of the new histogram is constructed from
2632/// the name of this histogram with the suffix "suffix" appended provided
2633/// by the user. If not provided a default suffix="_cumulative" is used.
2634///
2635/// The cumulative distribution is formed by filling each bin of the
2636/// resulting histogram with the sum of that bin and all previous
2637/// (forward == kTRUE) or following (forward = kFALSE) bins.
2638///
2639/// Note: while cumulative distributions make sense in one dimension, you
2640/// may not be getting what you expect in more than 1D because the concept
2641/// of a cumulative distribution is much trickier to define; make sure you
2642/// understand the order of summation before you use this method with
2643/// histograms of dimension >= 2.
2644///
2645/// Note 2: By default the cumulative is computed from bin 1 to Nbins
2646/// If an axis range is set, values between the minimum and maximum of the range
2647/// are set.
2648/// Setting an axis range can also be used for including underflow and overflow in
2649/// the cumulative (e.g. by setting h->GetXaxis()->SetRange(0, h->GetNbinsX()+1); )
2651
2652TH1 *TH1::GetCumulative(Bool_t forward, const char* suffix) const
2653{
2654 const Int_t firstX = fXaxis.GetFirst();
2655 const Int_t lastX = fXaxis.GetLast();
2656 const Int_t firstY = (fDimension > 1) ? fYaxis.GetFirst() : 1;
2657 const Int_t lastY = (fDimension > 1) ? fYaxis.GetLast() : 1;
2658 const Int_t firstZ = (fDimension > 1) ? fZaxis.GetFirst() : 1;
2659 const Int_t lastZ = (fDimension > 1) ? fZaxis.GetLast() : 1;
2660
2662 hintegrated->Reset();
2663 Double_t sum = 0.;
2664 Double_t esum = 0;
2665 if (forward) { // Forward computation
2666 for (Int_t binz = firstZ; binz <= lastZ; ++binz) {
2667 for (Int_t biny = firstY; biny <= lastY; ++biny) {
2668 for (Int_t binx = firstX; binx <= lastX; ++binx) {
2669 const Int_t bin = hintegrated->GetBin(binx, biny, binz);
2671 hintegrated->AddBinContent(bin, sum);
2672 if (fSumw2.fN) {
2674 hintegrated->fSumw2.fArray[bin] = esum;
2675 }
2676 }
2677 }
2678 }
2679 } else { // Backward computation
2680 for (Int_t binz = lastZ; binz >= firstZ; --binz) {
2681 for (Int_t biny = lastY; biny >= firstY; --biny) {
2682 for (Int_t binx = lastX; binx >= firstX; --binx) {
2683 const Int_t bin = hintegrated->GetBin(binx, biny, binz);
2685 hintegrated->AddBinContent(bin, sum);
2686 if (fSumw2.fN) {
2688 hintegrated->fSumw2.fArray[bin] = esum;
2689 }
2690 }
2691 }
2692 }
2693 }
2694 return hintegrated;
2695}
2696
2697////////////////////////////////////////////////////////////////////////////////
2698/// Copy this histogram structure to newth1.
2699///
2700/// Note that this function does not copy the list of associated functions.
2701/// Use TObject::Clone to make a full copy of a histogram.
2702///
2703/// Note also that the histogram it will be created in gDirectory (if AddDirectoryStatus()=true)
2704/// or will not be added to any directory if AddDirectoryStatus()=false
2705/// independently of the current directory stored in the original histogram
2706
2707void TH1::Copy(TObject &obj) const
2708{
2709 if (((TH1&)obj).fDirectory) {
2710 // We are likely to change the hash value of this object
2711 // with TNamed::Copy, to keep things correct, we need to
2712 // clean up its existing entries.
2713 ((TH1&)obj).fDirectory->Remove(&obj);
2714 ((TH1&)obj).fDirectory = nullptr;
2715 }
2716 TNamed::Copy(obj);
2717 ((TH1&)obj).fDimension = fDimension;
2718 ((TH1&)obj).fNormFactor= fNormFactor;
2719 ((TH1&)obj).fNcells = fNcells;
2720 ((TH1&)obj).fBarOffset = fBarOffset;
2721 ((TH1&)obj).fBarWidth = fBarWidth;
2722 ((TH1&)obj).fOption = fOption;
2723 ((TH1&)obj).fBinStatErrOpt = fBinStatErrOpt;
2724 ((TH1&)obj).fBufferSize= fBufferSize;
2725 // copy the Buffer
2726 // delete first a previously existing buffer
2727 if (((TH1&)obj).fBuffer != nullptr) {
2728 delete [] ((TH1&)obj).fBuffer;
2729 ((TH1&)obj).fBuffer = nullptr;
2730 }
2731 if (fBuffer) {
2732 Double_t *buf = new Double_t[fBufferSize];
2733 for (Int_t i=0;i<fBufferSize;i++) buf[i] = fBuffer[i];
2734 // obj.fBuffer has been deleted before
2735 ((TH1&)obj).fBuffer = buf;
2736 }
2737
2738 // copy bin contents (this should be done by the derived classes, since TH1 does not store the bin content)
2739 // Do this in case derived from TArray
2740 TArray* a = dynamic_cast<TArray*>(&obj);
2741 if (a) {
2742 a->Set(fNcells);
2743 for (Int_t i = 0; i < fNcells; i++)
2745 }
2746
2747 ((TH1&)obj).fEntries = fEntries;
2748
2749 // which will call BufferEmpty(0) and set fBuffer[0] to a Maybe one should call
2750 // assignment operator on the TArrayD
2751
2752 ((TH1&)obj).fTsumw = fTsumw;
2753 ((TH1&)obj).fTsumw2 = fTsumw2;
2754 ((TH1&)obj).fTsumwx = fTsumwx;
2755 ((TH1&)obj).fTsumwx2 = fTsumwx2;
2756 ((TH1&)obj).fMaximum = fMaximum;
2757 ((TH1&)obj).fMinimum = fMinimum;
2758
2759 TAttLine::Copy(((TH1&)obj));
2760 TAttFill::Copy(((TH1&)obj));
2761 TAttMarker::Copy(((TH1&)obj));
2762 fXaxis.Copy(((TH1&)obj).fXaxis);
2763 fYaxis.Copy(((TH1&)obj).fYaxis);
2764 fZaxis.Copy(((TH1&)obj).fZaxis);
2765 ((TH1&)obj).fXaxis.SetParent(&obj);
2766 ((TH1&)obj).fYaxis.SetParent(&obj);
2767 ((TH1&)obj).fZaxis.SetParent(&obj);
2768 fContour.Copy(((TH1&)obj).fContour);
2769 fSumw2.Copy(((TH1&)obj).fSumw2);
2770 // fFunctions->Copy(((TH1&)obj).fFunctions);
2771 // when copying an histogram if the AddDirectoryStatus() is true it
2772 // will be added to gDirectory independently of the fDirectory stored.
2773 // and if the AddDirectoryStatus() is false it will not be added to
2774 // any directory (fDirectory = nullptr)
2776 gDirectory->Append(&obj);
2777 ((TH1&)obj).fFunctions->UseRWLock();
2778 ((TH1&)obj).fDirectory = gDirectory;
2779 } else
2780 ((TH1&)obj).fDirectory = nullptr;
2781
2782}
2783
2784////////////////////////////////////////////////////////////////////////////////
2785/// Make a complete copy of the underlying object. If 'newname' is set,
2786/// the copy's name will be set to that name.
2787
2788TObject* TH1::Clone(const char* newname) const
2789{
2790 TH1* obj = (TH1*)IsA()->GetNew()(nullptr);
2791 Copy(*obj);
2792
2793 // Now handle the parts that Copy doesn't do
2794 if(fFunctions) {
2795 // The Copy above might have published 'obj' to the ListOfCleanups.
2796 // Clone can call RecursiveRemove, for example via TCheckHashRecursiveRemoveConsistency
2797 // when dictionary information is initialized, so we need to
2798 // keep obj->fFunction valid during its execution and
2799 // protect the update with the write lock.
2800
2801 // Reset stats parent - else cloning the stats will clone this histogram, too.
2802 auto oldstats = dynamic_cast<TVirtualPaveStats*>(fFunctions->FindObject("stats"));
2803 TObject *oldparent = nullptr;
2804 if (oldstats) {
2805 oldparent = oldstats->GetParent();
2806 oldstats->SetParent(nullptr);
2807 }
2808
2809 auto newlist = (TList*)fFunctions->Clone();
2810
2811 if (oldstats)
2812 oldstats->SetParent(oldparent);
2813 auto newstats = dynamic_cast<TVirtualPaveStats*>(obj->fFunctions->FindObject("stats"));
2814 if (newstats)
2815 newstats->SetParent(obj);
2816
2817 auto oldlist = obj->fFunctions;
2818 {
2820 obj->fFunctions = newlist;
2821 }
2822 delete oldlist;
2823 }
2824 if(newname && strlen(newname) ) {
2825 obj->SetName(newname);
2826 }
2827 return obj;
2828}
2829
2830////////////////////////////////////////////////////////////////////////////////
2831/// Callback to perform the automatic addition of the histogram to the given directory.
2832///
2833/// This callback is used to register a histogram to the current directory when a TKey
2834/// is read or an object is being cloned using TDirectory::CloneObject().
2835
2837{
2839 if (addStatus) {
2840 SetDirectory(dir);
2841 if (dir) {
2843 }
2844 }
2845}
2846
2847////////////////////////////////////////////////////////////////////////////////
2848/// Compute distance from point px,py to a line.
2849///
2850/// Compute the closest distance of approach from point px,py to elements
2851/// of a histogram.
2852/// The distance is computed in pixels units.
2853///
2854/// #### Algorithm:
2855/// Currently, this simple model computes the distance from the mouse
2856/// to the histogram contour only.
2857
2859{
2860 if (!fPainter) return 9999;
2861 return fPainter->DistancetoPrimitive(px,py);
2862}
2863
2864////////////////////////////////////////////////////////////////////////////////
2865/// Performs the operation: `this = this/(c1*f1)`
2866/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
2867///
2868/// Only bins inside the function range are recomputed.
2869/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2870/// you should call Sumw2 before making this operation.
2871/// This is particularly important if you fit the histogram after TH1::Divide
2872///
2873/// The function return kFALSE if the divide operation failed
2874
2876{
2877 if (!f1) {
2878 Error("Divide","Attempt to divide by a non-existing function");
2879 return kFALSE;
2880 }
2881
2882 // delete buffer if it is there since it will become invalid
2883 if (fBuffer) BufferEmpty(1);
2884
2885 Int_t nx = GetNbinsX() + 2; // normal bins + uf / of
2886 Int_t ny = GetNbinsY() + 2;
2887 Int_t nz = GetNbinsZ() + 2;
2888 if (fDimension < 2) ny = 1;
2889 if (fDimension < 3) nz = 1;
2890
2891
2892 SetMinimum();
2893 SetMaximum();
2894
2895 // - Loop on bins (including underflows/overflows)
2896 Int_t bin, binx, biny, binz;
2897 Double_t cu, w;
2898 Double_t xx[3];
2899 Double_t *params = nullptr;
2900 f1->InitArgs(xx,params);
2901 for (binz = 0; binz < nz; ++binz) {
2902 xx[2] = fZaxis.GetBinCenter(binz);
2903 for (biny = 0; biny < ny; ++biny) {
2904 xx[1] = fYaxis.GetBinCenter(biny);
2905 for (binx = 0; binx < nx; ++binx) {
2906 xx[0] = fXaxis.GetBinCenter(binx);
2907 if (!f1->IsInside(xx)) continue;
2909 bin = binx + nx * (biny + ny * binz);
2910 cu = c1 * f1->EvalPar(xx);
2911 if (TF1::RejectedPoint()) continue;
2912 if (cu) w = RetrieveBinContent(bin) / cu;
2913 else w = 0;
2915 if (fSumw2.fN) {
2916 if (cu != 0) fSumw2.fArray[bin] = GetBinErrorSqUnchecked(bin) / (cu * cu);
2917 else fSumw2.fArray[bin] = 0;
2918 }
2919 }
2920 }
2921 }
2922 ResetStats();
2923 return kTRUE;
2924}
2925
2926////////////////////////////////////////////////////////////////////////////////
2927/// Divide this histogram by h1.
2928///
2929/// `this = this/h1`
2930/// if errors are defined (see TH1::Sumw2), errors are also recalculated.
2931/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
2932/// if not already set.
2933/// The resulting errors are calculated assuming uncorrelated histograms.
2934/// See the other TH1::Divide that gives the possibility to optionally
2935/// compute binomial errors.
2936///
2937/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2938/// you should call Sumw2 before making this operation.
2939/// This is particularly important if you fit the histogram after TH1::Scale
2940///
2941/// The function return kFALSE if the divide operation failed
2942
2943Bool_t TH1::Divide(const TH1 *h1)
2944{
2945 if (!h1) {
2946 Error("Divide", "Input histogram passed does not exist (NULL).");
2947 return kFALSE;
2948 }
2949
2950 // delete buffer if it is there since it will become invalid
2951 if (fBuffer) BufferEmpty(1);
2952
2953 if (LoggedInconsistency("Divide", this, h1) >= kDifferentNumberOfBins) {
2954 return false;
2955 }
2956
2957 // Create Sumw2 if h1 has Sumw2 set
2958 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
2959
2960 // - Loop on bins (including underflows/overflows)
2961 for (Int_t i = 0; i < fNcells; ++i) {
2964 if (c1) UpdateBinContent(i, c0 / c1);
2965 else UpdateBinContent(i, 0);
2966
2967 if(fSumw2.fN) {
2968 if (c1 == 0) { fSumw2.fArray[i] = 0; continue; }
2969 Double_t c1sq = c1 * c1;
2971 }
2972 }
2973 ResetStats();
2974 return kTRUE;
2975}
2976
2977////////////////////////////////////////////////////////////////////////////////
2978/// Replace contents of this histogram by the division of h1 by h2.
2979///
2980/// `this = c1*h1/(c2*h2)`
2981///
2982/// If errors are defined (see TH1::Sumw2), errors are also recalculated
2983/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
2984/// if not already set.
2985/// The resulting errors are calculated assuming uncorrelated histograms.
2986/// However, if option ="B" is specified, Binomial errors are computed.
2987/// In this case c1 and c2 do not make real sense and they are ignored.
2988///
2989/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
2990/// you should call Sumw2 before making this operation.
2991/// This is particularly important if you fit the histogram after TH1::Divide
2992///
2993/// Please note also that in the binomial case errors are calculated using standard
2994/// binomial statistics, which means when b1 = b2, the error is zero.
2995/// If you prefer to have efficiency errors not going to zero when the efficiency is 1, you must
2996/// use the function TGraphAsymmErrors::BayesDivide, which will return an asymmetric and non-zero lower
2997/// error for the case b1=b2.
2998///
2999/// The function return kFALSE if the divide operation failed
3000
3002{
3003
3004 TString opt = option;
3005 opt.ToLower();
3006 Bool_t binomial = kFALSE;
3007 if (opt.Contains("b")) binomial = kTRUE;
3008 if (!h1 || !h2) {
3009 Error("Divide", "At least one of the input histograms passed does not exist (NULL).");
3010 return kFALSE;
3011 }
3012
3013 // delete buffer if it is there since it will become invalid
3014 if (fBuffer) BufferEmpty(1);
3015
3016 if (LoggedInconsistency("Divide", this, h1) >= kDifferentNumberOfBins ||
3017 LoggedInconsistency("Divide", h1, h2) >= kDifferentNumberOfBins) {
3018 return false;
3019 }
3020
3021 if (!c2) {
3022 Error("Divide","Coefficient of dividing histogram cannot be zero");
3023 return kFALSE;
3024 }
3025
3026 // Create Sumw2 if h1 or h2 have Sumw2 set, or if binomial errors are explicitly requested
3027 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0 || binomial)) Sumw2();
3028
3029 SetMinimum();
3030 SetMaximum();
3031
3032 // - Loop on bins (including underflows/overflows)
3033 for (Int_t i = 0; i < fNcells; ++i) {
3035 Double_t b2 = h2->RetrieveBinContent(i);
3036 if (b2) UpdateBinContent(i, c1 * b1 / (c2 * b2));
3037 else UpdateBinContent(i, 0);
3038
3039 if (fSumw2.fN) {
3040 if (b2 == 0) { fSumw2.fArray[i] = 0; continue; }
3041 Double_t b1sq = b1 * b1; Double_t b2sq = b2 * b2;
3042 Double_t c1sq = c1 * c1; Double_t c2sq = c2 * c2;
3045 if (binomial) {
3046 if (b1 != b2) {
3047 // in the case of binomial statistics c1 and c2 must be 1 otherwise it does not make sense
3048 // c1 and c2 are ignored
3049 //fSumw2.fArray[bin] = TMath::Abs(w*(1-w)/(c2*b2));//this is the formula in Hbook/Hoper1
3050 //fSumw2.fArray[bin] = TMath::Abs(w*(1-w)/b2); // old formula from G. Flucke
3051 // formula which works also for weighted histogram (see http://root-forum.cern.ch/viewtopic.php?t=3753 )
3052 fSumw2.fArray[i] = TMath::Abs( ( (1. - 2.* b1 / b2) * e1sq + b1sq * e2sq / b2sq ) / b2sq );
3053 } else {
3054 //in case b1=b2 error is zero
3055 //use TGraphAsymmErrors::BayesDivide for getting the asymmetric error not equal to zero
3056 fSumw2.fArray[i] = 0;
3057 }
3058 } else {
3059 fSumw2.fArray[i] = c1sq * c2sq * (e1sq * b2sq + e2sq * b1sq) / (c2sq * c2sq * b2sq * b2sq);
3060 }
3061 }
3062 }
3063 ResetStats();
3064 if (binomial)
3065 // in case of binomial division use denominator for number of entries
3066 SetEntries ( h2->GetEntries() );
3067
3068 return kTRUE;
3069}
3070
3071////////////////////////////////////////////////////////////////////////////////
3072/// Draw this histogram with options.
3073///
3074/// Histograms are drawn via the THistPainter class. Each histogram has
3075/// a pointer to its own painter (to be usable in a multithreaded program).
3076/// The same histogram can be drawn with different options in different pads.
3077/// If a histogram is updated after it has been drawn, the updated data will
3078/// be shown the next time the pad is updated. One does not need to
3079/// redraw the histogram.
3080///
3081/// When a histogram is deleted, the histogram is **automatically removed from
3082/// all pads where it was drawn**. If a histogram should be modified or deleted
3083/// without affecting what is drawn, it should be drawn using DrawCopy().
3084///
3085/// By default, TH1::Draw clears the current pad. Passing the option "SAME", the
3086/// histogram will be drawn on top of what's in the pad.
3087/// One can use TH1::SetMaximum and TH1::SetMinimum to force a particular
3088/// value for the maximum or the minimum scale on the plot.
3089///
3090/// TH1::UseCurrentStyle can be used to change all histogram graphics
3091/// attributes to correspond to the current selected style.
3092/// This function must be called for each histogram.
3093/// In case one reads and draws many histograms from a file, one can force
3094/// the histograms to inherit automatically the current graphics style
3095/// by calling before gROOT->ForceStyle();
3096///
3097/// See the THistPainter class for a description of all the drawing options.
3098
3100{
3101 TString opt1 = option; opt1.ToLower();
3103 Int_t index = opt1.Index("same");
3104
3105 // Check if the string "same" is part of a TCutg name.
3106 if (index>=0) {
3107 Int_t indb = opt1.Index("[");
3108 if (indb>=0) {
3109 Int_t indk = opt1.Index("]");
3110 if (index>indb && index<indk) index = -1;
3111 }
3112 }
3113
3114 // If there is no pad or an empty pad the "same" option is ignored.
3115 if (gPad) {
3116 if (!gPad->IsEditable()) gROOT->MakeDefCanvas();
3117 if (index>=0) {
3118 if (gPad->GetX1() == 0 && gPad->GetX2() == 1 &&
3119 gPad->GetY1() == 0 && gPad->GetY2() == 1 &&
3120 gPad->GetListOfPrimitives()->GetSize()==0) opt2.Remove(index,4);
3121 } else {
3122 //the following statement is necessary in case one attempts to draw
3123 //a temporary histogram already in the current pad
3124 if (TestBit(kCanDelete)) gPad->Remove(this);
3125 gPad->Clear();
3126 }
3127 gPad->IncrementPaletteColor(1, opt1);
3128 } else {
3129 if (index>=0) opt2.Remove(index,4);
3130 }
3131
3132 AppendPad(opt2.Data());
3133}
3134
3135////////////////////////////////////////////////////////////////////////////////
3136/// Copy this histogram and Draw in the current pad.
3137///
3138/// Once the histogram is drawn into the pad, the original and its drawn copy can be modified or deleted without
3139/// affecting each other. The copied histogram will be owned by the pad, and is deleted when the pad is cleared.
3140///
3141/// DrawCopy() is useful if the original histogram is a temporary, e.g. from code such as
3142/// ~~~ {.cpp}
3143/// void someFunction(...) {
3144/// TH1D histogram(...);
3145/// histogram.DrawCopy();
3146///
3147/// // or equivalently
3148/// std::unique_ptr<TH1F> histogram(...);
3149/// histogram->DrawCopy();
3150/// }
3151/// ~~~
3152/// If Draw() has been used, the histograms would disappear from the canvas at the end of this function.
3153///
3154/// By default a postfix "_copy" is added to the histogram name. Pass an empty postfix in case
3155/// you want to draw a histogram with the same name.
3156///
3157/// See Draw() for the list of options.
3158///
3159/// In contrast to TObject::DrawClone(), DrawCopy
3160/// - Ignores `gROOT->SetSelectedPad()`.
3161/// - Does not register the histogram to any directory.
3162/// - And can cycle through a colour palette when multiple objects are drawn with auto colouring.
3163
3164TH1 *TH1::DrawCopy(Option_t *option, const char * name_postfix) const
3165{
3166 TString opt = option;
3167 opt.ToLower();
3168 if (gPad && !opt.Contains("same")) gPad->Clear();
3170 if (name_postfix) newName.Form("%s%s", GetName(), name_postfix);
3171 TH1 *newth1 = (TH1 *)Clone(newName.Data());
3172 newth1->SetDirectory(nullptr);
3173 newth1->SetBit(kCanDelete);
3174 if (gPad) gPad->IncrementPaletteColor(1, opt);
3175
3176 newth1->AppendPad(option);
3177 return newth1;
3178}
3179
3180////////////////////////////////////////////////////////////////////////////////
3181/// Draw a normalized copy of this histogram.
3182///
3183/// A clone of this histogram is normalized to norm and drawn with option.
3184/// A pointer to the normalized histogram is returned.
3185/// The contents of the histogram copy are scaled such that the new
3186/// sum of weights (excluding under and overflow) is equal to norm.
3187/// Note that the returned normalized histogram is not added to the list
3188/// of histograms in the current directory in memory.
3189/// It is the user's responsibility to delete this histogram.
3190/// The kCanDelete bit is set for the returned object. If a pad containing
3191/// this copy is cleared, the histogram will be automatically deleted.
3192///
3193/// See Draw for the list of options
3194
3196{
3198 if (sum == 0) {
3199 Error("DrawNormalized","Sum of weights is null. Cannot normalize histogram: %s",GetName());
3200 return nullptr;
3201 }
3202
3203 TDirectory::TContext ctx{nullptr};
3204 TH1 *h = (TH1*)Clone();
3206 // in case of drawing with error options - scale correctly the error
3207 TString opt(option); opt.ToUpper();
3208 if (fSumw2.fN == 0) {
3209 h->Sumw2();
3210 // do not use in this case the "Error option " for drawing which is enabled by default since the normalized histogram has now errors
3211 if (opt.IsNull() || opt == "SAME") opt += "HIST";
3212 }
3213 h->Scale(norm/sum);
3214 if (TMath::Abs(fMaximum+1111) > 1e-3) h->SetMaximum(fMaximum*norm/sum);
3215 if (TMath::Abs(fMinimum+1111) > 1e-3) h->SetMinimum(fMinimum*norm/sum);
3216 h->Draw(opt);
3217
3218 return h;
3219}
3220
3221////////////////////////////////////////////////////////////////////////////////
3222/// Display a panel with all histogram drawing options.
3223///
3224/// See class TDrawPanelHist for example
3225
3226void TH1::DrawPanel()
3227{
3228 if (!fPainter) {Draw(); if (gPad) gPad->Update();}
3229 if (fPainter) fPainter->DrawPanel();
3230}
3231
3232////////////////////////////////////////////////////////////////////////////////
3233/// Evaluate function f1 at the center of bins of this histogram.
3234///
3235/// - If option "R" is specified, the function is evaluated only
3236/// for the bins included in the function range.
3237/// - If option "A" is specified, the value of the function is added to the
3238/// existing bin contents
3239/// - If option "S" is specified, the value of the function is used to
3240/// generate a value, distributed according to the Poisson
3241/// distribution, with f1 as the mean.
3242
3244{
3245 Double_t x[3];
3246 Int_t range, stat, add;
3247 if (!f1) return;
3248
3249 TString opt = option;
3250 opt.ToLower();
3251 if (opt.Contains("a")) add = 1;
3252 else add = 0;
3253 if (opt.Contains("s")) stat = 1;
3254 else stat = 0;
3255 if (opt.Contains("r")) range = 1;
3256 else range = 0;
3257
3258 // delete buffer if it is there since it will become invalid
3259 if (fBuffer) BufferEmpty(1);
3260
3264 if (!add) Reset();
3265
3266 for (Int_t binz = 1; binz <= nbinsz; ++binz) {
3267 x[2] = fZaxis.GetBinCenter(binz);
3268 for (Int_t biny = 1; biny <= nbinsy; ++biny) {
3269 x[1] = fYaxis.GetBinCenter(biny);
3270 for (Int_t binx = 1; binx <= nbinsx; ++binx) {
3272 x[0] = fXaxis.GetBinCenter(binx);
3273 if (range && !f1->IsInside(x)) continue;
3274 Double_t fu = f1->Eval(x[0], x[1], x[2]);
3275 if (stat) fu = gRandom->PoissonD(fu);
3278 }
3279 }
3280 }
3281}
3282
3283////////////////////////////////////////////////////////////////////////////////
3284/// Execute action corresponding to one event.
3285///
3286/// This member function is called when a histogram is clicked with the locator
3287///
3288/// If Left button clicked on the bin top value, then the content of this bin
3289/// is modified according to the new position of the mouse when it is released.
3290
3291void TH1::ExecuteEvent(Int_t event, Int_t px, Int_t py)
3292{
3293 if (fPainter) fPainter->ExecuteEvent(event, px, py);
3294}
3295
3296////////////////////////////////////////////////////////////////////////////////
3297/// This function allows to do discrete Fourier transforms of TH1 and TH2.
3298/// Available transform types and flags are described below.
3299///
3300/// To extract more information about the transform, use the function
3301/// TVirtualFFT::GetCurrentTransform() to get a pointer to the current
3302/// transform object.
3303///
3304/// \param[out] h_output histogram for the output. If a null pointer is passed, a new histogram is created
3305/// and returned, otherwise, the provided histogram is used and should be big enough
3306/// \param[in] option option parameters consists of 3 parts:
3307/// - option on what to return
3308/// - "RE" - returns a histogram of the real part of the output
3309/// - "IM" - returns a histogram of the imaginary part of the output
3310/// - "MAG"- returns a histogram of the magnitude of the output
3311/// - "PH" - returns a histogram of the phase of the output
3312/// - option of transform type
3313/// - "R2C" - real to complex transforms - default
3314/// - "R2HC" - real to halfcomplex (special format of storing output data,
3315/// results the same as for R2C)
3316/// - "DHT" - discrete Hartley transform
3317/// real to real transforms (sine and cosine):
3318/// - "R2R_0", "R2R_1", "R2R_2", "R2R_3" - discrete cosine transforms of types I-IV
3319/// - "R2R_4", "R2R_5", "R2R_6", "R2R_7" - discrete sine transforms of types I-IV
3320/// To specify the type of each dimension of a 2-dimensional real to real
3321/// transform, use options of form "R2R_XX", for example, "R2R_02" for a transform,
3322/// which is of type "R2R_0" in 1st dimension and "R2R_2" in the 2nd.
3323/// - option of transform flag
3324/// - "ES" (from "estimate") - no time in preparing the transform, but probably sub-optimal
3325/// performance
3326/// - "M" (from "measure") - some time spend in finding the optimal way to do the transform
3327/// - "P" (from "patient") - more time spend in finding the optimal way to do the transform
3328/// - "EX" (from "exhaustive") - the most optimal way is found
3329/// This option should be chosen depending on how many transforms of the same size and
3330/// type are going to be done. Planning is only done once, for the first transform of this
3331/// size and type. Default is "ES".
3332///
3333/// Examples of valid options: "Mag R2C M" "Re R2R_11" "Im R2C ES" "PH R2HC EX"
3334
3336{
3337
3338 Int_t ndim[3];
3339 ndim[0] = this->GetNbinsX();
3340 ndim[1] = this->GetNbinsY();
3341 ndim[2] = this->GetNbinsZ();
3342
3344 TString opt = option;
3345 opt.ToUpper();
3346 if (!opt.Contains("2R")){
3347 if (!opt.Contains("2C") && !opt.Contains("2HC") && !opt.Contains("DHT")) {
3348 //no type specified, "R2C" by default
3349 opt.Append("R2C");
3350 }
3351 fft = TVirtualFFT::FFT(this->GetDimension(), ndim, opt.Data());
3352 }
3353 else {
3354 //find the kind of transform
3355 Int_t ind = opt.Index("R2R", 3);
3356 Int_t *kind = new Int_t[2];
3357 char t;
3358 t = opt[ind+4];
3359 kind[0] = atoi(&t);
3360 if (h_output->GetDimension()>1) {
3361 t = opt[ind+5];
3362 kind[1] = atoi(&t);
3363 }
3364 fft = TVirtualFFT::SineCosine(this->GetDimension(), ndim, kind, option);
3365 delete [] kind;
3366 }
3367
3368 if (!fft) return nullptr;
3369 Int_t in=0;
3370 for (Int_t binx = 1; binx<=ndim[0]; binx++) {
3371 for (Int_t biny=1; biny<=ndim[1]; biny++) {
3372 for (Int_t binz=1; binz<=ndim[2]; binz++) {
3373 fft->SetPoint(in, this->GetBinContent(binx, biny, binz));
3374 in++;
3375 }
3376 }
3377 }
3378 fft->Transform();
3380 return h_output;
3381}
3382
3383////////////////////////////////////////////////////////////////////////////////
3384/// Increment bin with abscissa X by 1.
3385///
3386/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3387/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3388///
3389/// If the storage of the sum of squares of weights has been triggered,
3390/// via the function Sumw2, then the sum of the squares of weights is incremented
3391/// by 1 in the bin corresponding to x.
3392///
3393/// The function returns the corresponding bin number which has its content incremented by 1
3394
3396{
3397 if (fBuffer) return BufferFill(x,1);
3398
3399 Int_t bin;
3400 fEntries++;
3401 bin =fXaxis.FindBin(x);
3402 if (bin <0) return -1;
3404 if (fSumw2.fN) ++fSumw2.fArray[bin];
3405 if (bin == 0 || bin > fXaxis.GetNbins()) {
3406 if (!GetStatOverflowsBehaviour()) return -1;
3407 }
3408 ++fTsumw;
3409 ++fTsumw2;
3410 fTsumwx += x;
3411 fTsumwx2 += x*x;
3412 return bin;
3413}
3414
3415////////////////////////////////////////////////////////////////////////////////
3416/// Increment bin with abscissa X with a weight w.
3417///
3418/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3419/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3420///
3421/// If the weight is not equal to 1, the storage of the sum of squares of
3422/// weights is automatically triggered and the sum of the squares of weights is incremented
3423/// by \f$ w^2 \f$ in the bin corresponding to x.
3424///
3425/// The function returns the corresponding bin number which has its content incremented by w
3426
3428{
3429
3430 if (fBuffer) return BufferFill(x,w);
3431
3432 Int_t bin;
3433 fEntries++;
3434 bin =fXaxis.FindBin(x);
3435 if (bin <0) return -1;
3436 if (!fSumw2.fN && w != 1.0 && !TestBit(TH1::kIsNotW) ) Sumw2(); // must be called before AddBinContent
3437 if (fSumw2.fN) fSumw2.fArray[bin] += w*w;
3439 if (bin == 0 || bin > fXaxis.GetNbins()) {
3440 if (!GetStatOverflowsBehaviour()) return -1;
3441 }
3442 Double_t z= w;
3443 fTsumw += z;
3444 fTsumw2 += z*z;
3445 fTsumwx += z*x;
3446 fTsumwx2 += z*x*x;
3447 return bin;
3448}
3449
3450////////////////////////////////////////////////////////////////////////////////
3451/// Increment bin with namex with a weight w
3452///
3453/// if x is less than the low-edge of the first bin, the Underflow bin is incremented
3454/// if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented
3455///
3456/// If the weight is not equal to 1, the storage of the sum of squares of
3457/// weights is automatically triggered and the sum of the squares of weights is incremented
3458/// by \f$ w^2 \f$ in the bin corresponding to x.
3459///
3460/// The function returns the corresponding bin number which has its content
3461/// incremented by w.
3462
3463Int_t TH1::Fill(const char *namex, Double_t w)
3464{
3465 Int_t bin;
3466 fEntries++;
3468 if (bin <0) return -1;
3469 if (!fSumw2.fN && w != 1.0 && !TestBit(TH1::kIsNotW)) Sumw2();
3470 if (fSumw2.fN) fSumw2.fArray[bin] += w*w;
3472 if (bin == 0 || bin > fXaxis.GetNbins()) return -1;
3473 Double_t z= w;
3474 fTsumw += z;
3475 fTsumw2 += z*z;
3476 // this make sense if the histogram is not expanding (the x axis cannot be extended)
3477 if (!fXaxis.CanExtend() || !fXaxis.IsAlphanumeric()) {
3479 fTsumwx += z*x;
3480 fTsumwx2 += z*x*x;
3481 }
3482 return bin;
3483}
3484
3485////////////////////////////////////////////////////////////////////////////////
3486/// Fill this histogram with an array x and weights w.
3487///
3488/// \param[in] ntimes number of entries in arrays x and w (array size must be ntimes*stride)
3489/// \param[in] x array of values to be histogrammed
3490/// \param[in] w array of weighs
3491/// \param[in] stride step size through arrays x and w
3492///
3493/// If the weight is not equal to 1, the storage of the sum of squares of
3494/// weights is automatically triggered and the sum of the squares of weights is incremented
3495/// by \f$ w^2 \f$ in the bin corresponding to x.
3496/// if w is NULL each entry is assumed a weight=1
3497
3498void TH1::FillN(Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride)
3499{
3500 //If a buffer is activated, fill buffer
3501 if (fBuffer) {
3502 ntimes *= stride;
3503 Int_t i = 0;
3504 for (i=0;i<ntimes;i+=stride) {
3505 if (!fBuffer) break; // buffer can be deleted in BufferFill when is empty
3506 if (w) BufferFill(x[i],w[i]);
3507 else BufferFill(x[i], 1.);
3508 }
3509 // fill the remaining entries if the buffer has been deleted
3510 if (i < ntimes && !fBuffer) {
3511 auto weights = w ? &w[i] : nullptr;
3512 DoFillN((ntimes-i)/stride,&x[i],weights,stride);
3513 }
3514 return;
3515 }
3516 // call internal method
3517 DoFillN(ntimes, x, w, stride);
3518}
3519
3520////////////////////////////////////////////////////////////////////////////////
3521/// Internal method to fill histogram content from a vector
3522/// called directly by TH1::BufferEmpty
3523
3524void TH1::DoFillN(Int_t ntimes, const Double_t *x, const Double_t *w, Int_t stride)
3525{
3526 Int_t bin,i;
3527
3528 fEntries += ntimes;
3529 Double_t ww = 1;
3530 Int_t nbins = fXaxis.GetNbins();
3531 ntimes *= stride;
3532 for (i=0;i<ntimes;i+=stride) {
3533 bin =fXaxis.FindBin(x[i]);
3534 if (bin <0) continue;
3535 if (w) ww = w[i];
3536 if (!fSumw2.fN && ww != 1.0 && !TestBit(TH1::kIsNotW)) Sumw2();
3537 if (fSumw2.fN) fSumw2.fArray[bin] += ww*ww;
3538 AddBinContent(bin, ww);
3539 if (bin == 0 || bin > nbins) {
3540 if (!GetStatOverflowsBehaviour()) continue;
3541 }
3542 Double_t z= ww;
3543 fTsumw += z;
3544 fTsumw2 += z*z;
3545 fTsumwx += z*x[i];
3546 fTsumwx2 += z*x[i]*x[i];
3547 }
3548}
3549
3550////////////////////////////////////////////////////////////////////////////////
3551/// Fill histogram following distribution in function fname.
3552///
3553/// @param fname : Function name used for filling the histogram
3554/// @param ntimes : number of times the histogram is filled
3555/// @param rng : (optional) Random number generator used to sample
3556///
3557///
3558/// The distribution contained in the function fname (TF1) is integrated
3559/// over the channel contents for the bin range of this histogram.
3560/// It is normalized to 1.
3561///
3562/// Getting one random number implies:
3563/// - Generating a random number between 0 and 1 (say r1)
3564/// - Look in which bin in the normalized integral r1 corresponds to
3565/// - Fill histogram channel
3566/// ntimes random numbers are generated
3567///
3568/// One can also call TF1::GetRandom to get a random variate from a function.
3569
3570void TH1::FillRandom(const char *fname, Int_t ntimes, TRandom * rng)
3571{
3572 // - Search for fname in the list of ROOT defined functions
3573 TF1 *f1 = (TF1*)gROOT->GetFunction(fname);
3574 if (!f1) { Error("FillRandom", "Unknown function: %s",fname); return; }
3575
3578
3580{
3581 Int_t bin, binx, ibin, loop;
3582 Double_t r1, x;
3583
3584 // - Allocate temporary space to store the integral and compute integral
3585
3586 TAxis * xAxis = &fXaxis;
3587
3588 // in case axis of histogram is not defined use the function axis
3589 if (fXaxis.GetXmax() <= fXaxis.GetXmin()) {
3591 f1->GetRange(xmin,xmax);
3592 Info("FillRandom","Using function axis and range [%g,%g]",xmin, xmax);
3593 xAxis = f1->GetHistogram()->GetXaxis();
3594 }
3595
3596 Int_t first = xAxis->GetFirst();
3597 Int_t last = xAxis->GetLast();
3598 Int_t nbinsx = last-first+1;
3599
3600 Double_t *integral = new Double_t[nbinsx+1];
3601 integral[0] = 0;
3602 for (binx=1;binx<=nbinsx;binx++) {
3603 Double_t fint = f1->Integral(xAxis->GetBinLowEdge(binx+first-1),xAxis->GetBinUpEdge(binx+first-1), 0.);
3604 integral[binx] = integral[binx-1] + fint;
3605 }
3606
3607 // - Normalize integral to 1
3608 if (integral[nbinsx] == 0 ) {
3609 delete [] integral;
3610 Error("FillRandom", "Integral = zero"); return;
3611 }
3612 for (bin=1;bin<=nbinsx;bin++) integral[bin] /= integral[nbinsx];
3613
3614 // --------------Start main loop ntimes
3615 for (loop=0;loop<ntimes;loop++) {
3616 r1 = (rng) ? rng->Rndm() : gRandom->Rndm();
3617 ibin = TMath::BinarySearch(nbinsx,&integral[0],r1);
3618 //binx = 1 + ibin;
3619 //x = xAxis->GetBinCenter(binx); //this is not OK when SetBuffer is used
3620 x = xAxis->GetBinLowEdge(ibin+first)
3621 +xAxis->GetBinWidth(ibin+first)*(r1-integral[ibin])/(integral[ibin+1] - integral[ibin]);
3622 Fill(x);
3623 }
3624 delete [] integral;
3625}
3626
3627////////////////////////////////////////////////////////////////////////////////
3628/// Fill histogram following distribution in histogram h.
3629///
3630/// @param h : Histogram pointer used for sampling random number
3631/// @param ntimes : number of times the histogram is filled
3632/// @param rng : (optional) Random number generator used for sampling
3633///
3634/// The distribution contained in the histogram h (TH1) is integrated
3635/// over the channel contents for the bin range of this histogram.
3636/// It is normalized to 1.
3637///
3638/// Getting one random number implies:
3639/// - Generating a random number between 0 and 1 (say r1)
3640/// - Look in which bin in the normalized integral r1 corresponds to
3641/// - Fill histogram channel ntimes random numbers are generated
3642///
3643/// SPECIAL CASE when the target histogram has the same binning as the source.
3644/// in this case we simply use a poisson distribution where
3645/// the mean value per bin = bincontent/integral.
3646
3648{
3649 if (!h) { Error("FillRandom", "Null histogram"); return; }
3650 if (fDimension != h->GetDimension()) {
3651 Error("FillRandom", "Histograms with different dimensions"); return;
3652 }
3653 if (std::isnan(h->ComputeIntegral(true))) {
3654 Error("FillRandom", "Histograms contains negative bins, does not represent probabilities");
3655 return;
3656 }
3657
3658 //in case the target histogram has the same binning and ntimes much greater
3659 //than the number of bins we can use a fast method
3660 Int_t first = fXaxis.GetFirst();
3661 Int_t last = fXaxis.GetLast();
3662 Int_t nbins = last-first+1;
3663 if (ntimes > 10*nbins) {
3664 auto inconsistency = CheckConsistency(this,h);
3665 if (inconsistency != kFullyConsistent) return; // do nothing
3666 Double_t sumw = h->Integral(first,last);
3667 if (sumw == 0) return;
3668 Double_t sumgen = 0;
3669 for (Int_t bin=first;bin<=last;bin++) {
3670 Double_t mean = h->RetrieveBinContent(bin)*ntimes/sumw;
3671 Double_t cont = (rng) ? rng->Poisson(mean) : gRandom->Poisson(mean);
3672 sumgen += cont;
3674 if (fSumw2.fN) fSumw2.fArray[bin] += cont;
3675 }
3676
3677 // fix for the fluctuations in the total number n
3678 // since we use Poisson instead of multinomial
3679 // add a correction to have ntimes as generated entries
3680 Int_t i;
3681 if (sumgen < ntimes) {
3682 // add missing entries
3683 for (i = Int_t(sumgen+0.5); i < ntimes; ++i)
3684 {
3685 Double_t x = h->GetRandom();
3686 Fill(x);
3687 }
3688 }
3689 else if (sumgen > ntimes) {
3690 // remove extra entries
3691 i = Int_t(sumgen+0.5);
3692 while( i > ntimes) {
3693 Double_t x = h->GetRandom(rng);
3696 // skip in case bin is empty
3697 if (y > 0) {
3698 SetBinContent(ibin, y-1.);
3699 i--;
3700 }
3701 }
3702 }
3703
3704 ResetStats();
3705 return;
3706 }
3707 // case of different axis and not too large ntimes
3708
3709 if (h->ComputeIntegral() ==0) return;
3710 Int_t loop;
3711 Double_t x;
3712 for (loop=0;loop<ntimes;loop++) {
3713 x = h->GetRandom();
3714 Fill(x);
3715 }
3716}
3717
3718////////////////////////////////////////////////////////////////////////////////
3719/// Return Global bin number corresponding to x,y,z
3720///
3721/// 2-D and 3-D histograms are represented with a one dimensional
3722/// structure. This has the advantage that all existing functions, such as
3723/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
3724/// This function tries to extend the axis if the given point belongs to an
3725/// under-/overflow bin AND if CanExtendAllAxes() is true.
3726///
3727/// See also TH1::GetBin, TAxis::FindBin and TAxis::FindFixBin
3728
3730{
3731 if (GetDimension() < 2) {
3732 return fXaxis.FindBin(x);
3733 }
3734 if (GetDimension() < 3) {
3735 Int_t nx = fXaxis.GetNbins()+2;
3738 return binx + nx*biny;
3739 }
3740 if (GetDimension() < 4) {
3741 Int_t nx = fXaxis.GetNbins()+2;
3742 Int_t ny = fYaxis.GetNbins()+2;
3745 Int_t binz = fZaxis.FindBin(z);
3746 return binx + nx*(biny +ny*binz);
3747 }
3748 return -1;
3749}
3750
3751////////////////////////////////////////////////////////////////////////////////
3752/// Return Global bin number corresponding to x,y,z.
3753///
3754/// 2-D and 3-D histograms are represented with a one dimensional
3755/// structure. This has the advantage that all existing functions, such as
3756/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
3757/// This function DOES NOT try to extend the axis if the given point belongs
3758/// to an under-/overflow bin.
3759///
3760/// See also TH1::GetBin, TAxis::FindBin and TAxis::FindFixBin
3761
3763{
3764 if (GetDimension() < 2) {
3765 return fXaxis.FindFixBin(x);
3766 }
3767 if (GetDimension() < 3) {
3768 Int_t nx = fXaxis.GetNbins()+2;
3771 return binx + nx*biny;
3772 }
3773 if (GetDimension() < 4) {
3774 Int_t nx = fXaxis.GetNbins()+2;
3775 Int_t ny = fYaxis.GetNbins()+2;
3779 return binx + nx*(biny +ny*binz);
3780 }
3781 return -1;
3782}
3783
3784////////////////////////////////////////////////////////////////////////////////
3785/// Find first bin with content > threshold for axis (1=x, 2=y, 3=z)
3786/// if no bins with content > threshold is found the function returns -1.
3787/// The search will occur between the specified first and last bin. Specifying
3788/// the value of the last bin to search to less than zero will search until the
3789/// last defined bin.
3790
3792{
3793 if (fBuffer) ((TH1*)this)->BufferEmpty();
3794
3795 if (axis < 1 || (axis > 1 && GetDimension() == 1 ) ||
3796 ( axis > 2 && GetDimension() == 2 ) || ( axis > 3 && GetDimension() > 3 ) ) {
3797 Warning("FindFirstBinAbove","Invalid axis number : %d, axis x assumed\n",axis);
3798 axis = 1;
3799 }
3800 if (firstBin < 1) {
3801 firstBin = 1;
3802 }
3804 Int_t nbinsy = (GetDimension() > 1 ) ? fYaxis.GetNbins() : 1;
3805 Int_t nbinsz = (GetDimension() > 2 ) ? fZaxis.GetNbins() : 1;
3806
3807 if (axis == 1) {
3810 }
3811 for (Int_t binx = firstBin; binx <= lastBin; binx++) {
3812 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3813 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3815 }
3816 }
3817 }
3818 }
3819 else if (axis == 2) {
3822 }
3823 for (Int_t biny = firstBin; biny <= lastBin; biny++) {
3824 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3825 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3827 }
3828 }
3829 }
3830 }
3831 else if (axis == 3) {
3834 }
3835 for (Int_t binz = firstBin; binz <= lastBin; binz++) {
3836 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3837 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3839 }
3840 }
3841 }
3842 }
3843
3844 return -1;
3845}
3846
3847////////////////////////////////////////////////////////////////////////////////
3848/// Find last bin with content > threshold for axis (1=x, 2=y, 3=z)
3849/// if no bins with content > threshold is found the function returns -1.
3850/// The search will occur between the specified first and last bin. Specifying
3851/// the value of the last bin to search to less than zero will search until the
3852/// last defined bin.
3853
3855{
3856 if (fBuffer) ((TH1*)this)->BufferEmpty();
3857
3858
3859 if (axis < 1 || ( axis > 1 && GetDimension() == 1 ) ||
3860 ( axis > 2 && GetDimension() == 2 ) || ( axis > 3 && GetDimension() > 3) ) {
3861 Warning("FindFirstBinAbove","Invalid axis number : %d, axis x assumed\n",axis);
3862 axis = 1;
3863 }
3864 if (firstBin < 1) {
3865 firstBin = 1;
3866 }
3868 Int_t nbinsy = (GetDimension() > 1 ) ? fYaxis.GetNbins() : 1;
3869 Int_t nbinsz = (GetDimension() > 2 ) ? fZaxis.GetNbins() : 1;
3870
3871 if (axis == 1) {
3874 }
3875 for (Int_t binx = lastBin; binx >= firstBin; binx--) {
3876 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3877 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3879 }
3880 }
3881 }
3882 }
3883 else if (axis == 2) {
3886 }
3887 for (Int_t biny = lastBin; biny >= firstBin; biny--) {
3888 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3889 for (Int_t binz = 1; binz <= nbinsz; binz++) {
3891 }
3892 }
3893 }
3894 }
3895 else if (axis == 3) {
3898 }
3899 for (Int_t binz = lastBin; binz >= firstBin; binz--) {
3900 for (Int_t binx = 1; binx <= nbinsx; binx++) {
3901 for (Int_t biny = 1; biny <= nbinsy; biny++) {
3903 }
3904 }
3905 }
3906 }
3907
3908 return -1;
3909}
3910
3911////////////////////////////////////////////////////////////////////////////////
3912/// Search object named name in the list of functions.
3913
3914TObject *TH1::FindObject(const char *name) const
3915{
3916 if (fFunctions) return fFunctions->FindObject(name);
3917 return nullptr;
3918}
3919
3920////////////////////////////////////////////////////////////////////////////////
3921/// Search object obj in the list of functions.
3922
3923TObject *TH1::FindObject(const TObject *obj) const
3924{
3925 if (fFunctions) return fFunctions->FindObject(obj);
3926 return nullptr;
3927}
3928
3929////////////////////////////////////////////////////////////////////////////////
3930/// Fit histogram with function fname.
3931///
3932///
3933/// fname is the name of a function available in the global ROOT list of functions
3934/// `gROOT->GetListOfFunctions`. Note that this is not thread safe.
3935/// The list include any TF1 object created by the user plus some pre-defined functions
3936/// which are automatically created by ROOT the first time a pre-defined function is requested from `gROOT`
3937/// (i.e. when calling `gROOT->GetFunction(const char *name)`).
3938/// These pre-defined functions are:
3939/// - `gaus, gausn` where gausn is the normalized Gaussian
3940/// - `landau, landaun`
3941/// - `expo`
3942/// - `pol1,...9, chebyshev1,...9`.
3943///
3944/// For printing the list of all available functions do:
3945///
3946/// TF1::InitStandardFunctions(); // not needed if `gROOT->GetFunction` is called before
3947/// TF2::InitStandardFunctions(); TF3::InitStandardFunctions(); // For 2D or 3D
3948/// gROOT->GetListOfFunctions()->ls()
3949///
3950/// `fname` can also be a formula that is accepted by the linear fitter containing the special operator `++`,
3951/// representing linear components separated by `++` sign, for example `x++sin(x)` for fitting `[0]*x+[1]*sin(x)`
3952///
3953/// This function finds a pointer to the TF1 object with name `fname` and calls TH1::Fit(TF1 *, Option_t *, Option_t *,
3954/// Double_t, Double_t). See there for the fitting options and the details about fitting histograms
3955
3957{
3958 char *linear;
3959 linear= (char*)strstr(fname, "++");
3960 Int_t ndim=GetDimension();
3961 if (linear){
3962 if (ndim<2){
3964 return Fit(&f1,option,goption,xxmin,xxmax);
3965 }
3966 else if (ndim<3){
3967 TF2 f2(fname, fname);
3968 return Fit(&f2,option,goption,xxmin,xxmax);
3969 }
3970 else{
3971 TF3 f3(fname, fname);
3972 return Fit(&f3,option,goption,xxmin,xxmax);
3973 }
3974 }
3975 else{
3976 TF1 * f1 = (TF1*)gROOT->GetFunction(fname);
3977 if (!f1) { Printf("Unknown function: %s",fname); return -1; }
3978 return Fit(f1,option,goption,xxmin,xxmax);
3979 }
3980}
3981
3982////////////////////////////////////////////////////////////////////////////////
3983/// Fit histogram with the function pointer f1.
3984///
3985/// \param[in] f1 pointer to the function object
3986/// \param[in] option string defining the fit options (see table below).
3987/// \param[in] goption specify a list of graphics options. See TH1::Draw for a complete list of these options.
3988/// \param[in] xxmin lower fitting range
3989/// \param[in] xxmax upper fitting range
3990/// \return A smart pointer to the TFitResult class
3991///
3992/// \anchor HFitOpt
3993/// ### Histogram Fitting Options
3994///
3995/// Here is the full list of fit options that can be given in the parameter `option`.
3996/// Several options can be used together by concatanating the strings without the need of any delimiters.
3997///
3998/// option | description
3999/// -------|------------
4000/// "L" | Uses a log likelihood method (default is chi-square method). To be used when the histogram represents counts.
4001/// "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.
4002/// "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.
4003/// "MULTI" | Uses Loglikelihood method based on multi-nomial distribution. In this case the function must be normalized and one fits only the function shape.
4004/// "W" | Fit using the chi-square method and ignoring the bin uncertainties and skip empty bins.
4005/// "WW" | Fit using the chi-square method and ignoring the bin uncertainties and include the empty bins.
4006/// "I" | Uses the integral of function in the bin instead of the default bin center value.
4007/// "F" | Uses the default minimizer (e.g. Minuit) when fitting a linear function (e.g. polN) instead of the linear fitter.
4008/// "U" | Uses a user specified objective function (e.g. user providedlikelihood function) defined using `TVirtualFitter::SetFCN`
4009/// "E" | Performs a better parameter errors estimation using the Minos technique for all fit parameters.
4010/// "M" | Uses the IMPROVE algorithm (available only in TMinuit). This algorithm attempts improve the found local minimum by searching for a better one.
4011/// "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`.
4012/// "Q" | Quiet mode (minimum printing)
4013/// "V" | Verbose mode (default is between Q and V)
4014/// "+" | 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.
4015/// "N" | Does not store the graphics function, does not draw the histogram with the function after fitting.
4016/// "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.
4017/// "R" | Fit using a fitting range specified in the function range with `TF1::SetRange`.
4018/// "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.
4019/// "C" | In case of linear fitting, do no calculate the chisquare (saves CPU time).
4020/// "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.
4021/// "WIDTH" | Scales the histogran bin content by the bin width (useful for variable bins histograms)
4022/// "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
4023/// "MULTITHREAD" | Forces usage of multi-thread execution whenever possible
4024///
4025/// The default fitting of an histogram (when no option is given) is perfomed as following:
4026/// - a chi-square fit (see below Chi-square Fits) computed using the bin histogram errors and excluding bins with zero errors (empty bins);
4027/// - the full range of the histogram is used, unless TAxis::SetRange or TAxis::SetRangeUser was called before;
4028/// - the default Minimizer with its default configuration is used (see below Minimizer Configuration) except for linear function;
4029/// - for linear functions (`polN`, `chenbyshev` or formula expressions combined using operator `++`) a linear minimization is used.
4030/// - only the status of the fit is returned;
4031/// - the fit is performed in Multithread whenever is enabled in ROOT;
4032/// - only the last fitted function is saved in the histogram;
4033/// - the histogram is drawn after fitting overalyed with the resulting fitting function
4034///
4035/// \anchor HFitMinimizer
4036/// ### Minimizer Configuration
4037///
4038/// The Fit is perfomed using the default Minimizer, defined in the `ROOT::Math::MinimizerOptions` class.
4039/// It is possible to change the default minimizer and its configuration parameters by calling these static functions before fitting (before calling `TH1::Fit`):
4040/// - `ROOT::Math::MinimizerOptions::SetDefaultMinimizer(minimizerName, minimizerAgorithm)` for changing the minmizer and/or the corresponding algorithm.
4041/// For example `ROOT::Math::MinimizerOptions::SetDefaultMinimizer("GSLMultiMin","BFGS");` will set the usage of the BFGS algorithm of the GSL multi-dimensional minimization
4042/// The current defaults are ("Minuit","Migrad").
4043/// See the documentation of the `ROOT::Math::MinimizerOptions` for the available minimizers in ROOT and their corresponding algorithms.
4044/// - `ROOT::Math::MinimizerOptions::SetDefaultTolerance` for setting a different tolerance value for the minimization.
4045/// - `ROOT::Math::MinimizerOptions::SetDefaultMaxFunctionCalls` for setting the maximum number of function calls.
4046/// - `ROOT::Math::MinimizerOptions::SetDefaultPrintLevel` for changing the minimizer print level from level=0 (minimal printing) to level=3 maximum printing
4047///
4048/// Other options are possible depending on the Minimizer used, see the corresponding documentation.
4049/// The default minimizer can be also set in the resource file in etc/system.rootrc. For example
4050///
4051/// ~~~ {.cpp}
4052/// Root.Fitter: Minuit2
4053/// ~~~
4054///
4055/// \anchor HFitChi2
4056/// ### Chi-square Fits
4057///
4058/// By default a chi-square (least-square) fit is performed on the histogram. The so-called modified least-square method
4059/// is used where the residual for each bin is computed using as error the observed value (the bin error) returned by `TH1::GetBinError`
4060///
4061/// \f[
4062/// Chi2 = \sum_{i}{ \left(\frac{y(i) - f(x(i) | p )}{e(i)} \right)^2 }
4063/// \f]
4064///
4065/// 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
4066/// an un-weighted histogram). Bins with zero errors are excluded from the fit. See also later the note on the treatment
4067/// of empty bins. When using option "I" the residual is computed not using the function value at the bin center, `f(x(i)|p)`,
4068/// but the integral of the function in the bin, Integral{ f(x|p)dx }, divided by the bin volume.
4069/// When using option `P` (Pearson chi2), the expected error computed as `e(i) = sqrt(f(x(i)|p))` is used.
4070/// In this case empty bins are considered in the fit.
4071/// Both chi-square methods should not be used when the bin content represent counts, especially in case of low bin statistics,
4072/// because they could return a biased result.
4073///
4074/// \anchor HFitNLL
4075/// ### Likelihood Fits
4076///
4077/// When using option "L" a likelihood fit is used instead of the default chi-square fit.
4078/// The likelihood is built assuming a Poisson probability density function for each bin.
4079/// The negative log-likelihood to be minimized is
4080///
4081/// \f[
4082/// NLL = - \sum_{i}{ \log {\mathrm P} ( y(i) | f(x(i) | p ) ) }
4083/// \f]
4084/// 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)`.
4085/// The exact likelihood used is the Poisson likelihood described in this paper:
4086/// S. Baker and R. D. Cousins, “Clarification of the use of chi-square and likelihood functions in fits to histograms,”
4087/// Nucl. Instrum. Meth. 221 (1984) 437.
4088///
4089/// \f[
4090/// NLL = \sum_{i}{( f(x(i) | p ) + y(i)\log(y(i)/ f(x(i) | p )) - y(i)) }
4091/// \f]
4092/// By using this formulation, `2*NLL` can be interpreted as the chi-square resulting from the fit.
4093///
4094/// This method should be always used when the bin content represents counts (i.e. errors are sqrt(N) ).
4095/// The likelihood method has the advantage of treating correctly bins with low statistics. In case of high
4096/// statistics/bin the distribution of the bin content becomes a normal distribution and the likelihood and the chi2 fit
4097/// give the same result.
4098///
4099/// The likelihood method, although a bit slower, it is therefore the recommended method,
4100/// when the histogram represent counts (Poisson statistics), where the chi-square methods may
4101/// give incorrect results, especially in case of low statistics.
4102/// In case of a weighted histogram, it is possible to perform also a likelihood fit by using the
4103/// option "WL". Note a weighted histogram is a histogram which has been filled with weights and it
4104/// has the information on the sum of the weight square for each bin ( TH1::Sumw2() has been called).
4105/// The bin error for a weighted histogram is the square root of the sum of the weight square.
4106///
4107/// \anchor HFitRes
4108/// ### Fit Result
4109///
4110/// The function returns a TFitResultPtr which can hold a pointer to a TFitResult object.
4111/// By default the TFitResultPtr contains only the status of the fit which is return by an
4112/// automatic conversion of the TFitResultPtr to an integer. One can write in this case directly:
4113///
4114/// ~~~ {.cpp}
4115/// Int_t fitStatus = h->Fit(myFunc);
4116/// ~~~
4117///
4118/// If the option "S" is instead used, TFitResultPtr behaves as a smart
4119/// pointer to the TFitResult object. This is useful for retrieving the full result information from the fit, such as the covariance matrix,
4120/// as shown in this example code:
4121///
4122/// ~~~ {.cpp}
4123/// TFitResultPtr r = h->Fit(myFunc,"S");
4124/// TMatrixDSym cov = r->GetCovarianceMatrix(); // to access the covariance matrix
4125/// Double_t chi2 = r->Chi2(); // to retrieve the fit chi2
4126/// Double_t par0 = r->Parameter(0); // retrieve the value for the parameter 0
4127/// Double_t err0 = r->ParError(0); // retrieve the error for the parameter 0
4128/// r->Print("V"); // print full information of fit including covariance matrix
4129/// r->Write(); // store the result in a file
4130/// ~~~
4131///
4132/// The fit parameters, error and chi-square (but not covariance matrix) can be retrieved also
4133/// directly from the fitted function that is passed to this call.
4134/// Given a pointer to an associated fitted function `myfunc`, one can retrieve the function/fit
4135/// parameters with calls such as:
4136///
4137/// ~~~ {.cpp}
4138/// Double_t chi2 = myfunc->GetChisquare();
4139/// Double_t par0 = myfunc->GetParameter(0); //value of 1st parameter
4140/// Double_t err0 = myfunc->GetParError(0); //error on first parameter
4141/// ~~~
4142///
4143/// ##### Associated functions
4144///
4145/// One or more objects (typically a TF1*) can be added to the list
4146/// of functions (fFunctions) associated to each histogram.
4147/// When TH1::Fit is invoked, the fitted function is added to the histogram list of functions (fFunctions).
4148/// If the histogram is made persistent, the list of associated functions is also persistent.
4149/// Given a histogram h, one can retrieve an associated function with:
4150///
4151/// ~~~ {.cpp}
4152/// TF1 *myfunc = h->GetFunction("myfunc");
4153/// ~~~
4154/// or by quering directly the list obtained by calling `TH1::GetListOfFunctions`.
4155///
4156/// \anchor HFitStatus
4157/// ### Fit status
4158///
4159/// The status of the fit is obtained converting the TFitResultPtr to an integer
4160/// independently if the fit option "S" is used or not:
4161///
4162/// ~~~ {.cpp}
4163/// TFitResultPtr r = h->Fit(myFunc,opt);
4164/// Int_t fitStatus = r;
4165/// ~~~
4166///
4167/// - `status = 0` : the fit has been performed successfully (i.e no error occurred).
4168/// - `status < 0` : there is an error not connected with the minimization procedure, for example when a wrong function is used.
4169/// - `status > 0` : return status from Minimizer, depends on used Minimizer. For example for TMinuit and Minuit2 we have:
4170/// - `status = migradStatus + 10*minosStatus + 100*hesseStatus + 1000*improveStatus`.
4171/// 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
4172/// only in Minos but not in Migrad a fitStatus of 40 will be returned.
4173/// Minuit2 returns 0 in case of success and different values in migrad,minos or
4174/// hesse depending on the error. See in this case the documentation of
4175/// Minuit2Minimizer::Minimize for the migrad return status, Minuit2Minimizer::GetMinosError for the
4176/// minos return status and Minuit2Minimizer::Hesse for the hesse return status.
4177/// If other minimizers are used see their specific documentation for the status code returned.
4178/// For example in the case of Fumili, see TFumili::Minimize.
4179///
4180/// \anchor HFitRange
4181/// ### Fitting in a range
4182///
4183/// In order to fit in a sub-range of the histogram you have two options:
4184/// - pass to this function the lower (`xxmin`) and upper (`xxmax`) values for the fitting range;
4185/// - define a specific range in the fitted function and use the fitting option "R".
4186/// For example, if your histogram has a defined range between -4 and 4 and you want to fit a gaussian
4187/// only in the interval 1 to 3, you can do:
4188///
4189/// ~~~ {.cpp}
4190/// TF1 *f1 = new TF1("f1", "gaus", 1, 3);
4191/// histo->Fit("f1", "R");
4192/// ~~~
4193///
4194/// The fitting range is also limited by the histogram range defined using TAxis::SetRange
4195/// or TAxis::SetRangeUser. Therefore the fitting range is the smallest range between the
4196/// histogram one and the one defined by one of the two previous options described above.
4197///
4198/// \anchor HFitInitial
4199/// ### Setting initial conditions
4200///
4201/// Parameters must be initialized before invoking the Fit function.
4202/// The setting of the parameter initial values is automatic for the
4203/// predefined functions such as poln, expo, gaus, landau. One can however disable
4204/// this automatic computation by using the option "B".
4205/// Note that if a predefined function is defined with an argument,
4206/// eg, gaus(0), expo(1), you must specify the initial values for
4207/// the parameters.
4208/// You can specify boundary limits for some or all parameters via
4209///
4210/// ~~~ {.cpp}
4211/// f1->SetParLimits(p_number, parmin, parmax);
4212/// ~~~
4213///
4214/// if `parmin >= parmax`, the parameter is fixed
4215/// Note that you are not forced to fix the limits for all parameters.
4216/// For example, if you fit a function with 6 parameters, you can do:
4217///
4218/// ~~~ {.cpp}
4219/// func->SetParameters(0, 3.1, 1.e-6, -8, 0, 100);
4220/// func->SetParLimits(3, -10, -4);
4221/// func->FixParameter(4, 0);
4222/// func->SetParLimits(5, 1, 1);
4223/// ~~~
4224///
4225/// With this setup, parameters 0->2 can vary freely
4226/// Parameter 3 has boundaries [-10,-4] with initial value -8
4227/// Parameter 4 is fixed to 0
4228/// Parameter 5 is fixed to 100.
4229/// When the lower limit and upper limit are equal, the parameter is fixed.
4230/// However to fix a parameter to 0, one must call the FixParameter function.
4231///
4232/// \anchor HFitStatBox
4233/// ### Fit Statistics Box
4234///
4235/// The statistics box can display the result of the fit.
4236/// You can change the statistics box to display the fit parameters with
4237/// the TStyle::SetOptFit(mode) method. This mode has four digits.
4238/// mode = pcev (default = 0111)
4239///
4240/// v = 1; print name/values of parameters
4241/// e = 1; print errors (if e=1, v must be 1)
4242/// c = 1; print Chisquare/Number of degrees of freedom
4243/// p = 1; print Probability
4244///
4245/// For example: gStyle->SetOptFit(1011);
4246/// prints the fit probability, parameter names/values, and errors.
4247/// You can change the position of the statistics box with these lines
4248/// (where g is a pointer to the TGraph):
4249///
4250/// TPaveStats *st = (TPaveStats*)g->GetListOfFunctions()->FindObject("stats");
4251/// st->SetX1NDC(newx1); //new x start position
4252/// st->SetX2NDC(newx2); //new x end position
4253///
4254/// \anchor HFitExtra
4255/// ### Additional Notes on Fitting
4256///
4257/// #### Fitting a histogram of dimension N with a function of dimension N-1
4258///
4259/// It is possible to fit a TH2 with a TF1 or a TH3 with a TF2.
4260/// 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.
4261/// For correct error scaling, the obtained parameter error are corrected as in the case when the
4262/// option "W" is used.
4263///
4264/// #### User defined objective functions
4265///
4266/// By default when fitting a chi square function is used for fitting. When option "L" is used
4267/// a Poisson likelihood function is used. Using option "MULTI" a multinomial likelihood fit is used.
4268/// Thes functions are defined in the header Fit/Chi2Func.h or Fit/PoissonLikelihoodFCN and they
4269/// are implemented using the routines FitUtil::EvaluateChi2 or FitUtil::EvaluatePoissonLogL in
4270/// the file math/mathcore/src/FitUtil.cxx.
4271/// It is possible to specify a user defined fitting function, using option "U" and
4272/// calling the following functions:
4273///
4274/// ~~~ {.cpp}
4275/// TVirtualFitter::Fitter(myhist)->SetFCN(MyFittingFunction);
4276/// ~~~
4277///
4278/// where MyFittingFunction is of type:
4279///
4280/// ~~~ {.cpp}
4281/// extern void MyFittingFunction(Int_t &npar, Double_t *gin, Double_t &f, Double_t *u, Int_t flag);
4282/// ~~~
4283///
4284/// #### Note on treatment of empty bins
4285///
4286/// Empty bins, which have the content equal to zero AND error equal to zero,
4287/// are excluded by default from the chi-square fit, but they are considered in the likelihood fit.
4288/// since they affect the likelihood if the function value in these bins is not negligible.
4289/// Note that if the histogram is having bins with zero content and non zero-errors they are considered as
4290/// any other bins in the fit. Instead bins with zero error and non-zero content are by default excluded in the chi-squared fit.
4291/// In general, one should not fit a histogram with non-empty bins and zero errors.
4292///
4293/// 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
4294/// fit). When using option "WW" the empty bins will be also considered in the chi-square fit with an error of 1.
4295/// Note that in this fitting case (option "W" or "WW") the resulting fitted parameter errors
4296/// are corrected by the obtained chi2 value using this scaling expression:
4297/// `errorp *= sqrt(chisquare/(ndf-1))` as it is done when fitting a TGraph with
4298/// no point errors.
4299///
4300/// #### Excluding points
4301///
4302/// You can use TF1::RejectPoint inside your fitting function to exclude some points
4303/// within a certain range from the fit. See the tutorial `fit/fitExclude.C`.
4304///
4305///
4306/// #### Warning when using the option "0"
4307///
4308/// When selecting the option "0", the fitted function is added to
4309/// the list of functions of the histogram, but it is not drawn when the histogram is drawn.
4310/// You can undo this behaviour resetting its corresponding bit in the TF1 object as following:
4311///
4312/// ~~~ {.cpp}
4313/// h.Fit("myFunction", "0"); // fit, store function but do not draw
4314/// h.Draw(); // function is not drawn
4315/// h.GetFunction("myFunction")->ResetBit(TF1::kNotDraw);
4316/// h.Draw(); // function is visible again
4317/// ~~~
4319
4321{
4322 // implementation of Fit method is in file hist/src/HFitImpl.cxx
4325
4326 // create range and minimizer options with default values
4329
4330 // need to empty the buffer before
4331 // (t.b.d. do a ML unbinned fit with buffer data)
4332 if (fBuffer) BufferEmpty();
4333
4335}
4336
4337////////////////////////////////////////////////////////////////////////////////
4338/// Display a panel with all histogram fit options.
4339///
4340/// See class TFitPanel for example
4341
4342void TH1::FitPanel()
4343{
4344 if (!gPad)
4345 gROOT->MakeDefCanvas();
4346
4347 if (!gPad) {
4348 Error("FitPanel", "Unable to create a default canvas");
4349 return;
4350 }
4351
4352
4353 // use plugin manager to create instance of TFitEditor
4354 TPluginHandler *handler = gROOT->GetPluginManager()->FindHandler("TFitEditor");
4355 if (handler && handler->LoadPlugin() != -1) {
4356 if (handler->ExecPlugin(2, gPad, this) == 0)
4357 Error("FitPanel", "Unable to create the FitPanel");
4358 }
4359 else
4360 Error("FitPanel", "Unable to find the FitPanel plug-in");
4361}
4362
4363////////////////////////////////////////////////////////////////////////////////
4364/// Return a histogram containing the asymmetry of this histogram with h2,
4365/// where the asymmetry is defined as:
4366///
4367/// ~~~ {.cpp}
4368/// Asymmetry = (h1 - h2)/(h1 + h2) where h1 = this
4369/// ~~~
4370///
4371/// works for 1D, 2D, etc. histograms
4372/// c2 is an optional argument that gives a relative weight between the two
4373/// histograms, and dc2 is the error on this weight. This is useful, for example,
4374/// when forming an asymmetry between two histograms from 2 different data sets that
4375/// need to be normalized to each other in some way. The function calculates
4376/// the errors assuming Poisson statistics on h1 and h2 (that is, dh = sqrt(h)).
4377///
4378/// example: assuming 'h1' and 'h2' are already filled
4379///
4380/// ~~~ {.cpp}
4381/// h3 = h1->GetAsymmetry(h2)
4382/// ~~~
4383///
4384/// then 'h3' is created and filled with the asymmetry between 'h1' and 'h2';
4385/// h1 and h2 are left intact.
4386///
4387/// Note that it is the user's responsibility to manage the created histogram.
4388/// The name of the returned histogram will be `Asymmetry_nameOfh1-nameOfh2`
4389///
4390/// code proposed by Jason Seely (seely@mit.edu) and adapted by R.Brun
4391///
4392/// clone the histograms so top and bottom will have the
4393/// correct dimensions:
4394/// Sumw2 just makes sure the errors will be computed properly
4395/// when we form sums and ratios below.
4396
4398{
4399 TH1 *h1 = this;
4400 TString name = TString::Format("Asymmetry_%s-%s",h1->GetName(),h2->GetName() );
4401 TH1 *asym = (TH1*)Clone(name);
4402
4403 // set also the title
4404 TString title = TString::Format("(%s - %s)/(%s+%s)",h1->GetName(),h2->GetName(),h1->GetName(),h2->GetName() );
4405 asym->SetTitle(title);
4406
4407 asym->Sumw2();
4408
4409 TDirectory::TContext ctx{nullptr};
4410 TH1 *top = (TH1*)asym->Clone();
4411 TH1 *bottom = (TH1*)asym->Clone();
4412
4413 // form the top and bottom of the asymmetry, and then divide:
4414 top->Add(h1,h2,1,-c2);
4415 bottom->Add(h1,h2,1,c2);
4416 asym->Divide(top,bottom);
4417
4418 Int_t xmax = asym->GetNbinsX();
4419 Int_t ymax = asym->GetNbinsY();
4420 Int_t zmax = asym->GetNbinsZ();
4421
4422 if (h1->fBuffer) h1->BufferEmpty(1);
4423 if (h2->fBuffer) h2->BufferEmpty(1);
4424 if (bottom->fBuffer) bottom->BufferEmpty(1);
4425
4426 // now loop over bins to calculate the correct errors
4427 // the reason this error calculation looks complex is because of c2
4428 for(Int_t i=1; i<= xmax; i++){
4429 for(Int_t j=1; j<= ymax; j++){
4430 for(Int_t k=1; k<= zmax; k++){
4431 Int_t bin = GetBin(i, j, k);
4432 // here some bin contents are written into variables to make the error
4433 // calculation a little more legible:
4437
4438 // make sure there are some events, if not, then the errors are set = 0
4439 // automatically.
4440 //if(bot < 1){} was changed to the next line from recommendation of Jason Seely (28 Nov 2005)
4441 if(bot < 1e-6){}
4442 else{
4443 // computation of errors by Christos Leonidopoulos
4446 Double_t error = 2*TMath::Sqrt(a*a*c2*c2*dbsq + c2*c2*b*b*dasq+a*a*b*b*dc2*dc2)/(bot*bot);
4447 asym->SetBinError(i,j,k,error);
4448 }
4449 }
4450 }
4451 }
4452 delete top;
4453 delete bottom;
4454
4455 return asym;
4456}
4457
4458////////////////////////////////////////////////////////////////////////////////
4459/// Static function
4460/// return the default buffer size for automatic histograms
4461/// the parameter fgBufferSize may be changed via SetDefaultBufferSize
4462
4464{
4465 return fgBufferSize;
4466}
4467
4468////////////////////////////////////////////////////////////////////////////////
4469/// Return kTRUE if TH1::Sumw2 must be called when creating new histograms.
4470/// see TH1::SetDefaultSumw2.
4471
4473{
4474 return fgDefaultSumw2;
4475}
4476
4477////////////////////////////////////////////////////////////////////////////////
4478/// Return the current number of entries.
4479
4481{
4482 if (fBuffer) {
4483 Int_t nentries = (Int_t) fBuffer[0];
4484 if (nentries > 0) return nentries;
4485 }
4486
4487 return fEntries;
4488}
4489
4490////////////////////////////////////////////////////////////////////////////////
4491/// Number of effective entries of the histogram.
4492///
4493/// \f[
4494/// neff = \frac{(\sum Weights )^2}{(\sum Weight^2 )}
4495/// \f]
4496///
4497/// In case of an unweighted histogram this number is equivalent to the
4498/// number of entries of the histogram.
4499/// For a weighted histogram, this number corresponds to the hypothetical number of unweighted entries
4500/// a histogram would need to have the same statistical power as this weighted histogram.
4501/// Note: The underflow/overflow are included if one has set the TH1::StatOverFlows flag
4502/// and if the statistics has been computed at filling time.
4503/// If a range is set in the histogram the number is computed from the given range.
4504
4506{
4507 Stat_t s[kNstat];
4508 this->GetStats(s);// s[1] sum of squares of weights, s[0] sum of weights
4509 return (s[1] ? s[0]*s[0]/s[1] : TMath::Abs(s[0]) );
4510}
4511
4512////////////////////////////////////////////////////////////////////////////////
4513/// Shortcut to set the three histogram colors with a single call.
4514///
4515/// By default: linecolor = markercolor = fillcolor = -1
4516/// If a color is < 0 this method does not change the corresponding color if positive or null it set the color.
4517///
4518/// For instance:
4519/// ~~~ {.cpp}
4520/// h->SetColors(kRed, kRed);
4521/// ~~~
4522/// will set the line color and the marker color to red.
4523
4525{
4526 if (linecolor >= 0)
4528 if (markercolor >= 0)
4530 if (fillcolor >= 0)
4532}
4533
4534
4535////////////////////////////////////////////////////////////////////////////////
4536/// Set highlight (enable/disable) mode for the histogram
4537/// by default highlight mode is disable
4538
4539void TH1::SetHighlight(Bool_t set)
4540{
4541 if (IsHighlight() == set)
4542 return;
4543 if (fDimension > 2) {
4544 Info("SetHighlight", "Supported only 1-D or 2-D histograms");
4545 return;
4546 }
4547
4548 SetBit(kIsHighlight, set);
4549
4550 if (fPainter)
4552}
4553
4554////////////////////////////////////////////////////////////////////////////////
4555/// Redefines TObject::GetObjectInfo.
4556/// Displays the histogram info (bin number, contents, integral up to bin
4557/// corresponding to cursor position px,py
4558
4559char *TH1::GetObjectInfo(Int_t px, Int_t py) const
4560{
4561 return ((TH1*)this)->GetPainter()->GetObjectInfo(px,py);
4562}
4563
4564////////////////////////////////////////////////////////////////////////////////
4565/// Return pointer to painter.
4566/// If painter does not exist, it is created
4567
4569{
4570 if (!fPainter) {
4571 TString opt = option;
4572 opt.ToLower();
4573 if (opt.Contains("gl") || gStyle->GetCanvasPreferGL()) {
4574 //try to create TGLHistPainter
4575 TPluginHandler *handler = gROOT->GetPluginManager()->FindHandler("TGLHistPainter");
4576
4577 if (handler && handler->LoadPlugin() != -1)
4578 fPainter = reinterpret_cast<TVirtualHistPainter *>(handler->ExecPlugin(1, this));
4579 }
4580 }
4581
4583
4584 return fPainter;
4585}
4586
4587////////////////////////////////////////////////////////////////////////////////
4588/// Compute Quantiles for this histogram.
4589/// A quantile x_p := Q(p) is defined as the value x_p such that the cumulative
4590/// probability distribution Function F of variable X yields:
4591///
4592/// ~~~ {.cpp}
4593/// F(x_p) = Pr(X <= x_p) = p with 0 <= p <= 1.
4594/// x_p = Q(p) = F_inv(p)
4595/// ~~~
4596///
4597/// For instance the median x_0.5 of a distribution is defined as that value
4598/// of the random variable X for which the distribution function equals 0.5:
4599///
4600/// ~~~ {.cpp}
4601/// F(x_0.5) = Probability(X < x_0.5) = 0.5
4602/// x_0.5 = Q(0.5)
4603/// ~~~
4604///
4605/// \author Eddy Offermann
4606/// code from Eddy Offermann, Renaissance
4607///
4608/// \param[in] n maximum size of the arrays xp and p (if given)
4609/// \param[out] xp array to be filled with nq quantiles evaluated at (p). Memory has to be preallocated by caller.
4610/// - If `p == nullptr`, the quantiles are computed at the (first `n`) probabilities p given by the CDF of the histogram;
4611/// `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`.
4612/// If all bins have non-zero entries, the quantiles happen to be the bin centres.
4613/// Empty bins will, however, be skipped in the quantiles.
4614/// If the CDF is e.g. [0., 0., 0.1, ...], the quantiles would be, [3., 3., 3., ...], with the third bin starting
4615/// at 3.
4616/// \param[in] p array of cumulative probabilities where quantiles should be evaluated.
4617/// - if `p == nullptr`, the CDF of the histogram will be used to compute the quantiles, and will
4618/// have a size of n.
4619/// - Otherwise, it is assumed to contain at least n values.
4620/// \return number of quantiles computed
4621/// \note Unlike in TF1::GetQuantiles, `p` is here an optional argument
4622///
4623/// Note that the Integral of the histogram is automatically recomputed
4624/// if the number of entries is different of the number of entries when
4625/// the integral was computed last time. In case you do not use the Fill
4626/// functions to fill your histogram, but SetBinContent, you must call
4627/// TH1::ComputeIntegral before calling this function.
4628///
4629/// Getting quantiles xp from two histograms and storing results in a TGraph,
4630/// a so-called QQ-plot
4631///
4632/// ~~~ {.cpp}
4633/// TGraph *gr = new TGraph(nprob);
4634/// h1->GetQuantiles(nprob,gr->GetX());
4635/// h2->GetQuantiles(nprob,gr->GetY());
4636/// gr->Draw("alp");
4637/// ~~~
4638///
4639/// Example:
4640///
4641/// ~~~ {.cpp}
4642/// void quantiles() {
4643/// // demo for quantiles
4644/// const Int_t nq = 20;
4645/// TH1F *h = new TH1F("h","demo quantiles",100,-3,3);
4646/// h->FillRandom("gaus",5000);
4647/// h->GetXaxis()->SetTitle("x");
4648/// h->GetYaxis()->SetTitle("Counts");
4649///
4650/// Double_t p[nq]; // probabilities where to evaluate the quantiles in [0,1]
4651/// Double_t xp[nq]; // array of positions X to store the resulting quantiles
4652/// for (Int_t i=0;i<nq;i++) p[i] = Float_t(i+1)/nq;
4653/// h->GetQuantiles(nq,xp,p);
4654///
4655/// //show the original histogram in the top pad
4656/// TCanvas *c1 = new TCanvas("c1","demo quantiles",10,10,700,900);
4657/// c1->Divide(1,2);
4658/// c1->cd(1);
4659/// h->Draw();
4660///
4661/// // show the quantiles in the bottom pad
4662/// c1->cd(2);
4663/// gPad->SetGrid();
4664/// TGraph *gr = new TGraph(nq,p,xp);
4665/// gr->SetMarkerStyle(21);
4666/// gr->GetXaxis()->SetTitle("p");
4667/// gr->GetYaxis()->SetTitle("x");
4668/// gr->Draw("alp");
4669/// }
4670/// ~~~
4671
4673{
4674 if (GetDimension() > 1) {
4675 Error("GetQuantiles","Only available for 1-d histograms");
4676 return 0;
4677 }
4678
4679 const Int_t nbins = GetXaxis()->GetNbins();
4680 if (!fIntegral) ComputeIntegral();
4681 if (fIntegral[nbins+1] != fEntries) ComputeIntegral();
4682
4683 Int_t i, ibin;
4684 Int_t nq = n;
4685 std::unique_ptr<Double_t[]> localProb;
4686 if (p == nullptr) {
4687 nq = nbins+1;
4688 localProb.reset(new Double_t[nq]);
4689 localProb[0] = 0;
4690 for (i=1;i<nq;i++) {
4691 localProb[i] = fIntegral[i] / fIntegral[nbins];
4692 }
4693 }
4694 Double_t const *const prob = p ? p : localProb.get();
4695
4696 for (i = 0; i < nq; i++) {
4698 if (fIntegral[ibin] == prob[i]) {
4699 if (prob[i] == 0.) {
4700 for (; ibin+1 <= nbins && fIntegral[ibin+1] == 0.; ++ibin) {
4701
4702 }
4703 xp[i] = fXaxis.GetBinUpEdge(ibin);
4704 }
4705 else if (prob[i] == 1.) {
4706 xp[i] = fXaxis.GetBinUpEdge(ibin);
4707 }
4708 else {
4709 // Find equal integral in later bins (ie their entries are zero)
4710 Double_t width = 0;
4711 for (Int_t j = ibin+1; j <= nbins; ++j) {
4712 if (prob[i] == fIntegral[j]) {
4714 }
4715 else
4716 break;
4717 }
4719 }
4720 }
4721 else {
4722 xp[i] = GetBinLowEdge(ibin+1);
4724 if (dint > 0) xp[i] += GetBinWidth(ibin+1)*(prob[i]-fIntegral[ibin])/dint;
4725 }
4726 }
4727
4728 return nq;
4729}
4730
4731////////////////////////////////////////////////////////////////////////////////
4737 return 1;
4738}
4739
4740////////////////////////////////////////////////////////////////////////////////
4741/// Compute Initial values of parameters for a gaussian.
4742
4743void H1InitGaus()
4744{
4745 Double_t allcha, sumx, sumx2, x, val, stddev, mean;
4746 Int_t bin;
4747 const Double_t sqrtpi = 2.506628;
4748
4749 // - Compute mean value and StdDev of the histogram in the given range
4751 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4752 Int_t hxfirst = hFitter->GetXfirst();
4753 Int_t hxlast = hFitter->GetXlast();
4754 Double_t valmax = curHist->GetBinContent(hxfirst);
4755 Double_t binwidx = curHist->GetBinWidth(hxfirst);
4756 allcha = sumx = sumx2 = 0;
4757 for (bin=hxfirst;bin<=hxlast;bin++) {
4758 x = curHist->GetBinCenter(bin);
4759 val = TMath::Abs(curHist->GetBinContent(bin));
4760 if (val > valmax) valmax = val;
4761 sumx += val*x;
4762 sumx2 += val*x*x;
4763 allcha += val;
4764 }
4765 if (allcha == 0) return;
4766 mean = sumx/allcha;
4767 stddev = sumx2/allcha - mean*mean;
4768 if (stddev > 0) stddev = TMath::Sqrt(stddev);
4769 else stddev = 0;
4770 if (stddev == 0) stddev = binwidx*(hxlast-hxfirst+1)/4;
4771 //if the distribution is really gaussian, the best approximation
4772 //is binwidx*allcha/(sqrtpi*stddev)
4773 //However, in case of non-gaussian tails, this underestimates
4774 //the normalisation constant. In this case the maximum value
4775 //is a better approximation.
4776 //We take the average of both quantities
4778
4779 //In case the mean value is outside the histo limits and
4780 //the StdDev is bigger than the range, we take
4781 // mean = center of bins
4782 // stddev = half range
4783 Double_t xmin = curHist->GetXaxis()->GetXmin();
4784 Double_t xmax = curHist->GetXaxis()->GetXmax();
4785 if ((mean < xmin || mean > xmax) && stddev > (xmax-xmin)) {
4786 mean = 0.5*(xmax+xmin);
4787 stddev = 0.5*(xmax-xmin);
4788 }
4789 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4791 f1->SetParameter(1,mean);
4793 f1->SetParLimits(2,0,10*stddev);
4794}
4795
4796////////////////////////////////////////////////////////////////////////////////
4797/// Compute Initial values of parameters for an exponential.
4798
4799void H1InitExpo()
4800{
4802 Int_t ifail;
4804 Int_t hxfirst = hFitter->GetXfirst();
4805 Int_t hxlast = hFitter->GetXlast();
4806 Int_t nchanx = hxlast - hxfirst + 1;
4807
4809
4810 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4812 f1->SetParameter(1,slope);
4813
4814}
4815
4816////////////////////////////////////////////////////////////////////////////////
4817/// Compute Initial values of parameters for a polynom.
4818
4819void H1InitPolynom()
4820{
4821 Double_t fitpar[25];
4822
4824 TF1 *f1 = (TF1*)hFitter->GetUserFunc();
4825 Int_t hxfirst = hFitter->GetXfirst();
4826 Int_t hxlast = hFitter->GetXlast();
4827 Int_t nchanx = hxlast - hxfirst + 1;
4828 Int_t npar = f1->GetNpar();
4829
4830 if (nchanx <=1 || npar == 1) {
4831 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4832 fitpar[0] = curHist->GetSumOfWeights()/Double_t(nchanx);
4833 } else {
4835 }
4836 for (Int_t i=0;i<npar;i++) f1->SetParameter(i, fitpar[i]);
4837}
4838
4839////////////////////////////////////////////////////////////////////////////////
4840/// Least squares lpolynomial fitting without weights.
4841///
4842/// \param[in] n number of points to fit
4843/// \param[in] m number of parameters
4844/// \param[in] a array of parameters
4845///
4846/// based on CERNLIB routine LSQ: Translated to C++ by Rene Brun
4847/// (E.Keil. revised by B.Schorr, 23.10.1981.)
4848
4850{
4851 const Double_t zero = 0.;
4852 const Double_t one = 1.;
4853 const Int_t idim = 20;
4854
4855 Double_t b[400] /* was [20][20] */;
4856 Int_t i, k, l, ifail;
4858 Double_t da[20], xk, yk;
4859
4860 if (m <= 2) {
4861 H1LeastSquareLinearFit(n, a[0], a[1], ifail);
4862 return;
4863 }
4864 if (m > idim || m > n) return;
4865 b[0] = Double_t(n);
4866 da[0] = zero;
4867 for (l = 2; l <= m; ++l) {
4868 b[l-1] = zero;
4869 b[m + l*20 - 21] = zero;
4870 da[l-1] = zero;
4871 }
4873 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4874 Int_t hxfirst = hFitter->GetXfirst();
4875 Int_t hxlast = hFitter->GetXlast();
4876 for (k = hxfirst; k <= hxlast; ++k) {
4877 xk = curHist->GetBinCenter(k);
4878 yk = curHist->GetBinContent(k);
4879 power = one;
4880 da[0] += yk;
4881 for (l = 2; l <= m; ++l) {
4882 power *= xk;
4883 b[l-1] += power;
4884 da[l-1] += power*yk;
4885 }
4886 for (l = 2; l <= m; ++l) {
4887 power *= xk;
4888 b[m + l*20 - 21] += power;
4889 }
4890 }
4891 for (i = 3; i <= m; ++i) {
4892 for (k = i; k <= m; ++k) {
4893 b[k - 1 + (i-1)*20 - 21] = b[k + (i-2)*20 - 21];
4894 }
4895 }
4897
4898 for (i=0; i<m; ++i) a[i] = da[i];
4899
4900}
4901
4902////////////////////////////////////////////////////////////////////////////////
4903/// Least square linear fit without weights.
4904///
4905/// extracted from CERNLIB LLSQ: Translated to C++ by Rene Brun
4906/// (added to LSQ by B. Schorr, 15.02.1982.)
4907
4909{
4911 Int_t i, n;
4913 Double_t fn, xk, yk;
4914 Double_t det;
4915
4916 n = TMath::Abs(ndata);
4917 ifail = -2;
4918 xbar = ybar = x2bar = xybar = 0;
4920 TH1 *curHist = (TH1*)hFitter->GetObjectFit();
4921 Int_t hxfirst = hFitter->GetXfirst();
4922 Int_t hxlast = hFitter->GetXlast();
4923 for (i = hxfirst; i <= hxlast; ++i) {
4924 xk = curHist->GetBinCenter(i);
4925 yk = curHist->GetBinContent(i);
4926 if (ndata < 0) {
4927 if (yk <= 0) yk = 1e-9;
4928 yk = TMath::Log(yk);
4929 }
4930 xbar += xk;
4931 ybar += yk;
4932 x2bar += xk*xk;
4933 xybar += xk*yk;
4934 }
4935 fn = Double_t(n);
4936 det = fn*x2bar - xbar*xbar;
4937 ifail = -1;
4938 if (det <= 0) {
4939 a0 = ybar/fn;
4940 a1 = 0;
4941 return;
4942 }
4943 ifail = 0;
4944 a0 = (x2bar*ybar - xbar*xybar) / det;
4945 a1 = (fn*xybar - xbar*ybar) / det;
4946
4947}
4948
4949////////////////////////////////////////////////////////////////////////////////
4950/// Extracted from CERN Program library routine DSEQN.
4951///
4952/// Translated to C++ by Rene Brun
4953
4955{
4957 Int_t nmjp1, i, j, l;
4958 Int_t im1, jp1, nm1, nmi;
4959 Double_t s1, s21, s22;
4960 const Double_t one = 1.;
4961
4962 /* Parameter adjustments */
4963 b_dim1 = idim;
4964 b_offset = b_dim1 + 1;
4965 b -= b_offset;
4966 a_dim1 = idim;
4967 a_offset = a_dim1 + 1;
4968 a -= a_offset;
4969
4970 if (idim < n) return;
4971
4972 ifail = 0;
4973 for (j = 1; j <= n; ++j) {
4974 if (a[j + j*a_dim1] <= 0) { ifail = -1; return; }
4975 a[j + j*a_dim1] = one / a[j + j*a_dim1];
4976 if (j == n) continue;
4977 jp1 = j + 1;
4978 for (l = jp1; l <= n; ++l) {
4979 a[j + l*a_dim1] = a[j + j*a_dim1] * a[l + j*a_dim1];
4980 s1 = -a[l + (j+1)*a_dim1];
4981 for (i = 1; i <= j; ++i) { s1 = a[l + i*a_dim1] * a[i + (j+1)*a_dim1] + s1; }
4982 a[l + (j+1)*a_dim1] = -s1;
4983 }
4984 }
4985 if (k <= 0) return;
4986
4987 for (l = 1; l <= k; ++l) {
4988 b[l*b_dim1 + 1] = a[a_dim1 + 1]*b[l*b_dim1 + 1];
4989 }
4990 if (n == 1) return;
4991 for (l = 1; l <= k; ++l) {
4992 for (i = 2; i <= n; ++i) {
4993 im1 = i - 1;
4994 s21 = -b[i + l*b_dim1];
4995 for (j = 1; j <= im1; ++j) {
4996 s21 = a[i + j*a_dim1]*b[j + l*b_dim1] + s21;
4997 }
4998 b[i + l*b_dim1] = -a[i + i*a_dim1]*s21;
4999 }
5000 nm1 = n - 1;
5001 for (i = 1; i <= nm1; ++i) {
5002 nmi = n - i;
5003 s22 = -b[nmi + l*b_dim1];
5004 for (j = 1; j <= i; ++j) {
5005 nmjp1 = n - j + 1;
5006 s22 = a[nmi + nmjp1*a_dim1]*b[nmjp1 + l*b_dim1] + s22;
5007 }
5008 b[nmi + l*b_dim1] = -s22;
5009 }
5010 }
5011}
5012
5013////////////////////////////////////////////////////////////////////////////////
5014/// Return Global bin number corresponding to binx,y,z.
5015///
5016/// 2-D and 3-D histograms are represented with a one dimensional
5017/// structure.
5018/// This has the advantage that all existing functions, such as
5019/// GetBinContent, GetBinError, GetBinFunction work for all dimensions.
5020///
5021/// In case of a TH1x, returns binx directly.
5022/// see TH1::GetBinXYZ for the inverse transformation.
5023///
5024/// Convention for numbering bins
5025///
5026/// For all histogram types: nbins, xlow, xup
5027///
5028/// - bin = 0; underflow bin
5029/// - bin = 1; first bin with low-edge xlow INCLUDED
5030/// - bin = nbins; last bin with upper-edge xup EXCLUDED
5031/// - bin = nbins+1; overflow bin
5032///
5033/// In case of 2-D or 3-D histograms, a "global bin" number is defined.
5034/// For example, assuming a 3-D histogram with binx,biny,binz, the function
5035///
5036/// ~~~ {.cpp}
5037/// Int_t bin = h->GetBin(binx,biny,binz);
5038/// ~~~
5039///
5040/// returns a global/linearized bin number. This global bin is useful
5041/// to access the bin information independently of the dimension.
5042
5044{
5045 Int_t ofx = fXaxis.GetNbins() + 1; // overflow bin
5046 if (binx < 0) binx = 0;
5047 if (binx > ofx) binx = ofx;
5048
5049 return binx;
5050}
5051
5052////////////////////////////////////////////////////////////////////////////////
5053/// Return binx, biny, binz corresponding to the global bin number globalbin
5054/// see TH1::GetBin function above
5055
5057{
5058 Int_t nx = fXaxis.GetNbins()+2;
5059 Int_t ny = fYaxis.GetNbins()+2;
5060
5061 if (GetDimension() == 1) {
5062 binx = binglobal%nx;
5063 biny = 0;
5064 binz = 0;
5065 return;
5066 }
5067 if (GetDimension() == 2) {
5068 binx = binglobal%nx;
5069 biny = ((binglobal-binx)/nx)%ny;
5070 binz = 0;
5071 return;
5072 }
5073 if (GetDimension() == 3) {
5074 binx = binglobal%nx;
5075 biny = ((binglobal-binx)/nx)%ny;
5076 binz = ((binglobal-binx)/nx -biny)/ny;
5077 }
5078}
5079
5080////////////////////////////////////////////////////////////////////////////////
5081/// Return a random number distributed according the histogram bin contents.
5082/// This function checks if the bins integral exists. If not, the integral
5083/// is evaluated, normalized to one.
5084///
5085/// @param rng (optional) Random number generator pointer used (default is gRandom)
5086/// @param option (optional) Set it to "width" if your non-uniform bin contents represent a density rather than counts
5087///
5088/// The integral is automatically recomputed if the number of entries
5089/// is not the same then when the integral was computed.
5090/// @note Only valid for 1-d histograms. Use GetRandom2 or GetRandom3 otherwise.
5091/// If the histogram has a bin with negative content, a NaN is returned.
5092
5094{
5095 if (fDimension > 1) {
5096 Error("GetRandom","Function only valid for 1-d histograms");
5097 return 0;
5098 }
5100 Double_t integral = 0;
5101 // compute integral checking that all bins have positive content (see ROOT-5894)
5102 if (fIntegral) {
5103 if (fIntegral[nbinsx + 1] != fEntries)
5104 integral = const_cast<TH1 *>(this)->ComputeIntegral(true, option);
5105 else integral = fIntegral[nbinsx];
5106 } else {
5107 integral = const_cast<TH1 *>(this)->ComputeIntegral(true, option);
5108 }
5109 if (integral == 0) return 0;
5110 // return a NaN in case some bins have negative content
5111 if (integral == TMath::QuietNaN() ) return TMath::QuietNaN();
5112
5113 Double_t r1 = (rng) ? rng->Rndm() : gRandom->Rndm();
5116 if (r1 > fIntegral[ibin]) x +=
5118 return x;
5119}
5120
5121////////////////////////////////////////////////////////////////////////////////
5122/// Return content of bin number bin.
5123///
5124/// Implemented in TH1C,S,F,D
5125///
5126/// Convention for numbering bins
5127///
5128/// For all histogram types: nbins, xlow, xup
5129///
5130/// - bin = 0; underflow bin
5131/// - bin = 1; first bin with low-edge xlow INCLUDED
5132/// - bin = nbins; last bin with upper-edge xup EXCLUDED
5133/// - bin = nbins+1; overflow bin
5134///
5135/// In case of 2-D or 3-D histograms, a "global bin" number is defined.
5136/// For example, assuming a 3-D histogram with binx,biny,binz, the function
5137///
5138/// ~~~ {.cpp}
5139/// Int_t bin = h->GetBin(binx,biny,binz);
5140/// ~~~
5141///
5142/// returns a global/linearized bin number. This global bin is useful
5143/// to access the bin information independently of the dimension.
5144
5146{
5147 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
5148 if (bin < 0) bin = 0;
5149 if (bin >= fNcells) bin = fNcells-1;
5150
5151 return RetrieveBinContent(bin);
5152}
5153
5154////////////////////////////////////////////////////////////////////////////////
5155/// Compute first binx in the range [firstx,lastx] for which
5156/// diff = abs(bin_content-c) <= maxdiff
5157///
5158/// In case several bins in the specified range with diff=0 are found
5159/// the first bin found is returned in binx.
5160/// In case several bins in the specified range satisfy diff <=maxdiff
5161/// the bin with the smallest difference is returned in binx.
5162/// In all cases the function returns the smallest difference.
5163///
5164/// NOTE1: if firstx <= 0, firstx is set to bin 1
5165/// if (lastx < firstx then firstx is set to the number of bins
5166/// ie if firstx=0 and lastx=0 (default) the search is on all bins.
5167///
5168/// NOTE2: if maxdiff=0 (default), the first bin with content=c is returned.
5169
5171{
5172 if (fDimension > 1) {
5173 binx = 0;
5174 Error("GetBinWithContent","function is only valid for 1-D histograms");
5175 return 0;
5176 }
5177
5178 if (fBuffer) ((TH1*)this)->BufferEmpty();
5179
5180 if (firstx <= 0) firstx = 1;
5181 if (lastx < firstx) lastx = fXaxis.GetNbins();
5182 Int_t binminx = 0;
5183 Double_t diff, curmax = 1.e240;
5184 for (Int_t i=firstx;i<=lastx;i++) {
5186 if (diff <= 0) {binx = i; return diff;}
5187 if (diff < curmax && diff <= maxdiff) {curmax = diff, binminx=i;}
5188 }
5189 binx = binminx;
5190 return curmax;
5191}
5192
5193////////////////////////////////////////////////////////////////////////////////
5194/// Given a point x, approximates the value via linear interpolation
5195/// based on the two nearest bin centers
5196///
5197/// Andy Mastbaum 10/21/08
5198
5200{
5201 if (fBuffer) ((TH1*)this)->BufferEmpty();
5202
5204 Double_t x0,x1,y0,y1;
5205
5206 if(x<=GetBinCenter(1)) {
5207 return RetrieveBinContent(1);
5208 } else if(x>=GetBinCenter(GetNbinsX())) {
5209 return RetrieveBinContent(GetNbinsX());
5210 } else {
5211 if(x<=GetBinCenter(xbin)) {
5213 x0 = GetBinCenter(xbin-1);
5215 x1 = GetBinCenter(xbin);
5216 } else {
5218 x0 = GetBinCenter(xbin);
5220 x1 = GetBinCenter(xbin+1);
5221 }
5222 return y0 + (x-x0)*((y1-y0)/(x1-x0));
5223 }
5224}
5225
5226////////////////////////////////////////////////////////////////////////////////
5227/// 2d Interpolation. Not yet implemented.
5228
5230{
5231 Error("Interpolate","This function must be called with 1 argument for a TH1");
5232 return 0;
5233}
5234
5235////////////////////////////////////////////////////////////////////////////////
5236/// 3d Interpolation. Not yet implemented.
5237
5239{
5240 Error("Interpolate","This function must be called with 1 argument for a TH1");
5241 return 0;
5242}
5243
5244///////////////////////////////////////////////////////////////////////////////
5245/// Check if a histogram is empty
5246/// (this is a protected method used mainly by TH1Merger )
5247
5248Bool_t TH1::IsEmpty() const
5249{
5250 // if fTsumw or fentries are not zero histogram is not empty
5251 // need to use GetEntries() instead of fEntries in case of bugger histograms
5252 // so we will flash the buffer
5253 if (fTsumw != 0) return kFALSE;
5254 if (GetEntries() != 0) return kFALSE;
5255 // case fTSumw == 0 amd entries are also zero
5256 // this should not really happening, but if one sets content by hand
5257 // it can happen. a call to ResetStats() should be done in such cases
5258 double sumw = 0;
5259 for (int i = 0; i< GetNcells(); ++i) sumw += RetrieveBinContent(i);
5260 return (sumw != 0) ? kFALSE : kTRUE;
5261}
5262
5263////////////////////////////////////////////////////////////////////////////////
5264/// Return true if the bin is overflow.
5265
5267{
5268 Int_t binx, biny, binz;
5270
5271 if (iaxis == 0) {
5272 if ( fDimension == 1 )
5273 return binx >= GetNbinsX() + 1;
5274 if ( fDimension == 2 )
5275 return (binx >= GetNbinsX() + 1) ||
5276 (biny >= GetNbinsY() + 1);
5277 if ( fDimension == 3 )
5278 return (binx >= GetNbinsX() + 1) ||
5279 (biny >= GetNbinsY() + 1) ||
5280 (binz >= GetNbinsZ() + 1);
5281 return kFALSE;
5282 }
5283 if (iaxis == 1)
5284 return binx >= GetNbinsX() + 1;
5285 if (iaxis == 2)
5286 return biny >= GetNbinsY() + 1;
5287 if (iaxis == 3)
5288 return binz >= GetNbinsZ() + 1;
5289
5290 Error("IsBinOverflow","Invalid axis value");
5291 return kFALSE;
5292}
5293
5294////////////////////////////////////////////////////////////////////////////////
5295/// Return true if the bin is underflow.
5296/// If iaxis = 0 make OR with all axes otherwise check only for the given axis
5297
5299{
5300 Int_t binx, biny, binz;
5302
5303 if (iaxis == 0) {
5304 if ( fDimension == 1 )
5305 return (binx <= 0);
5306 else if ( fDimension == 2 )
5307 return (binx <= 0 || biny <= 0);
5308 else if ( fDimension == 3 )
5309 return (binx <= 0 || biny <= 0 || binz <= 0);
5310 else
5311 return kFALSE;
5312 }
5313 if (iaxis == 1)
5314 return (binx <= 0);
5315 if (iaxis == 2)
5316 return (biny <= 0);
5317 if (iaxis == 3)
5318 return (binz <= 0);
5319
5320 Error("IsBinUnderflow","Invalid axis value");
5321 return kFALSE;
5322}
5323
5324////////////////////////////////////////////////////////////////////////////////
5325/// Reduce the number of bins for the axis passed in the option to the number of bins having a label.
5326/// The method will remove only the extra bins existing after the last "labeled" bin.
5327/// Note that if there are "un-labeled" bins present between "labeled" bins they will not be removed
5328
5330{
5332 TAxis *axis = nullptr;
5333 if (iaxis == 1) axis = GetXaxis();
5334 if (iaxis == 2) axis = GetYaxis();
5335 if (iaxis == 3) axis = GetZaxis();
5336 if (!axis) {
5337 Error("LabelsDeflate","Invalid axis option %s",ax);
5338 return;
5339 }
5340 if (!axis->GetLabels()) return;
5341
5342 // find bin with last labels
5343 // bin number is object ID in list of labels
5344 // therefore max bin number is number of bins of the deflated histograms
5345 TIter next(axis->GetLabels());
5346 TObject *obj;
5347 Int_t nbins = 0;
5348 while ((obj = next())) {
5349 Int_t ibin = obj->GetUniqueID();
5350 if (ibin > nbins) nbins = ibin;
5351 }
5352 if (nbins < 1) nbins = 1;
5353
5354 // Do nothing in case it was the last bin
5355 if (nbins==axis->GetNbins()) return;
5356
5357 TH1 *hold = (TH1*)IsA()->New();
5358 R__ASSERT(hold);
5359 hold->SetDirectory(nullptr);
5360 Copy(*hold);
5361
5362 Bool_t timedisp = axis->GetTimeDisplay();
5363 Double_t xmin = axis->GetXmin();
5364 Double_t xmax = axis->GetBinUpEdge(nbins);
5365 if (xmax <= xmin) xmax = xmin +nbins;
5366 axis->SetRange(0,0);
5367 axis->Set(nbins,xmin,xmax);
5368 SetBinsLength(-1); // reset the number of cells
5370 if (errors) fSumw2.Set(fNcells);
5371 axis->SetTimeDisplay(timedisp);
5372 // reset histogram content
5373 Reset("ICE");
5374
5375 //now loop on all bins and refill
5376 // NOTE that if the bins without labels have content
5377 // it will be put in the underflow/overflow.
5378 // For this reason we use AddBinContent method
5381 for (bin=0; bin < hold->fNcells; ++bin) {
5382 hold->GetBinXYZ(bin,binx,biny,binz);
5384 Double_t cu = hold->RetrieveBinContent(bin);
5386 if (errors) {
5387 fSumw2.fArray[ibin] += hold->fSumw2.fArray[bin];
5388 }
5389 }
5391 delete hold;
5392}
5393
5394////////////////////////////////////////////////////////////////////////////////
5395/// Double the number of bins for axis.
5396/// Refill histogram.
5397/// This function is called by TAxis::FindBin(const char *label)
5398
5400{
5402 TAxis *axis = nullptr;
5403 if (iaxis == 1) axis = GetXaxis();
5404 if (iaxis == 2) axis = GetYaxis();
5405 if (iaxis == 3) axis = GetZaxis();
5406 if (!axis) return;
5407
5408 TH1 *hold = (TH1*)IsA()->New();
5409 hold->SetDirectory(nullptr);
5410 Copy(*hold);
5411 hold->ResetBit(kMustCleanup);
5412
5413 Bool_t timedisp = axis->GetTimeDisplay();
5414 Int_t nbins = axis->GetNbins();
5415 Double_t xmin = axis->GetXmin();
5416 Double_t xmax = axis->GetXmax();
5417 xmax = xmin + 2*(xmax-xmin);
5418 axis->SetRange(0,0);
5419 // double the bins and recompute ncells
5420 axis->Set(2*nbins,xmin,xmax);
5421 SetBinsLength(-1);
5423 if (errors) fSumw2.Set(fNcells);
5424 axis->SetTimeDisplay(timedisp);
5425
5426 Reset("ICE"); // reset content and error
5427
5428 //now loop on all bins and refill
5431 for (ibin =0; ibin < hold->fNcells; ibin++) {
5432 // get the binx,y,z values . The x-y-z (axis) bin values will stay the same between new-old after the expanding
5433 hold->GetBinXYZ(ibin,binx,biny,binz);
5434 bin = GetBin(binx,biny,binz);
5435
5436 // underflow and overflow will be cleaned up because their meaning has been altered
5437 if (hold->IsBinUnderflow(ibin,iaxis) || hold->IsBinOverflow(ibin,iaxis)) {
5438 continue;
5439 }
5440 else {
5441 AddBinContent(bin, hold->RetrieveBinContent(ibin));
5442 if (errors) fSumw2.fArray[bin] += hold->fSumw2.fArray[ibin];
5443 }
5444 }
5446 delete hold;
5447}
5448
5449////////////////////////////////////////////////////////////////////////////////
5450/// Sort bins with labels or set option(s) to draw axis with labels
5451/// \param[in] option
5452/// - "a" sort by alphabetic order
5453/// - ">" sort by decreasing values
5454/// - "<" sort by increasing values
5455/// - "h" draw labels horizontal
5456/// - "v" draw labels vertical
5457/// - "u" draw labels up (end of label right adjusted)
5458/// - "d" draw labels down (start of label left adjusted)
5459///
5460/// In case not all bins have labels sorting will work only in the case
5461/// the first `n` consecutive bins have all labels and sorting will be performed on
5462/// those label bins.
5463///
5464/// \param[in] ax axis
5465
5467{
5469 TAxis *axis = nullptr;
5470 if (iaxis == 1)
5471 axis = GetXaxis();
5472 if (iaxis == 2)
5473 axis = GetYaxis();
5474 if (iaxis == 3)
5475 axis = GetZaxis();
5476 if (!axis)
5477 return;
5478 THashList *labels = axis->GetLabels();
5479 if (!labels) {
5480 Warning("LabelsOption", "Axis %s has no labels!",axis->GetName());
5481 return;
5482 }
5483 TString opt = option;
5484 opt.ToLower();
5485 Int_t iopt = -1;
5486 if (opt.Contains("h")) {
5491 iopt = 0;
5492 }
5493 if (opt.Contains("v")) {
5498 iopt = 1;
5499 }
5500 if (opt.Contains("u")) {
5501 axis->SetBit(TAxis::kLabelsUp);
5505 iopt = 2;
5506 }
5507 if (opt.Contains("d")) {
5512 iopt = 3;
5513 }
5514 Int_t sort = -1;
5515 if (opt.Contains("a"))
5516 sort = 0;
5517 if (opt.Contains(">"))
5518 sort = 1;
5519 if (opt.Contains("<"))
5520 sort = 2;
5521 if (sort < 0) {
5522 if (iopt < 0)
5523 Error("LabelsOption", "%s is an invalid label placement option!",opt.Data());
5524 return;
5525 }
5526
5527 // Code works only if first n bins have labels if we uncomment following line
5528 // but we don't want to support this special case
5529 // Int_t n = TMath::Min(axis->GetNbins(), labels->GetSize());
5530
5531 // support only cases where each bin has a labels (should be when axis is alphanumeric)
5532 Int_t n = labels->GetSize();
5533 if (n != axis->GetNbins()) {
5534 // check if labels are all consecutive and starts from the first bin
5535 // in that case the current code will work fine
5536 Int_t firstLabelBin = axis->GetNbins()+1;
5537 Int_t lastLabelBin = -1;
5538 for (Int_t i = 0; i < n; ++i) {
5539 Int_t bin = labels->At(i)->GetUniqueID();
5542 }
5543 if (firstLabelBin != 1 || lastLabelBin-firstLabelBin +1 != n) {
5544 Error("LabelsOption", "%s of Histogram %s contains bins without labels. Sorting will not work correctly - return",
5545 axis->GetName(), GetName());
5546 return;
5547 }
5548 // case where label bins are consecutive starting from first bin will work
5549 // calling before a TH1::LabelsDeflate() will avoid this error message
5550 Warning("LabelsOption", "axis %s of Histogram %s has extra following bins without labels. Sorting will work only for first label bins",
5551 axis->GetName(), GetName());
5552 }
5553 std::vector<Int_t> a(n);
5554 std::vector<Int_t> b(n);
5555
5556
5557 Int_t i, j, k;
5558 std::vector<Double_t> cont;
5559 std::vector<Double_t> errors2;
5560 THashList *labold = new THashList(labels->GetSize(), 1);
5561 TIter nextold(labels);
5562 TObject *obj = nullptr;
5563 labold->AddAll(labels);
5564 labels->Clear();
5565
5566 // delete buffer if it is there since bins will be reordered.
5567 if (fBuffer)
5568 BufferEmpty(1);
5569
5570 if (sort > 0) {
5571 //---sort by values of bins
5572 if (GetDimension() == 1) {
5573 cont.resize(n);
5574 if (fSumw2.fN)
5575 errors2.resize(n);
5576 for (i = 0; i < n; i++) {
5577 cont[i] = RetrieveBinContent(i + 1);
5578 if (!errors2.empty())
5579 errors2[i] = GetBinErrorSqUnchecked(i + 1);
5580 b[i] = labold->At(i)->GetUniqueID(); // this is the bin corresponding to the label
5581 a[i] = i;
5582 }
5583 if (sort == 1)
5584 TMath::Sort(n, cont.data(), a.data(), kTRUE); // sort by decreasing values
5585 else
5586 TMath::Sort(n, cont.data(), a.data(), kFALSE); // sort by increasing values
5587 for (i = 0; i < n; i++) {
5588 // use UpdateBinCOntent to not screw up histogram entries
5589 UpdateBinContent(i + 1, cont[b[a[i]] - 1]); // b[a[i]] returns bin number. .we need to subtract 1
5590 if (gDebug)
5591 Info("LabelsOption","setting bin %d value %f from bin %d label %s at pos %d ",
5592 i+1,cont[b[a[i]] - 1],b[a[i]],labold->At(a[i])->GetName(),a[i]);
5593 if (!errors2.empty())
5594 fSumw2.fArray[i + 1] = errors2[b[a[i]] - 1];
5595 }
5596 for (i = 0; i < n; i++) {
5597 obj = labold->At(a[i]);
5598 labels->Add(obj);
5599 obj->SetUniqueID(i + 1);
5600 }
5601 } else if (GetDimension() == 2) {
5602 std::vector<Double_t> pcont(n + 2);
5603 Int_t nx = fXaxis.GetNbins() + 2;
5604 Int_t ny = fYaxis.GetNbins() + 2;
5605 cont.resize((nx + 2) * (ny + 2));
5606 if (fSumw2.fN)
5607 errors2.resize((nx + 2) * (ny + 2));
5608 for (i = 0; i < nx; i++) {
5609 for (j = 0; j < ny; j++) {
5610 Int_t bin = GetBin(i,j);
5611 cont[i + nx * j] = RetrieveBinContent(bin);
5612 if (!errors2.empty())
5614 if (axis == GetXaxis())
5615 k = i - 1;
5616 else
5617 k = j - 1;
5618 if (k >= 0 && k < n) { // we consider underflow/overflows in y for ordering the bins
5619 pcont[k] += cont[i + nx * j];
5620 a[k] = k;
5621 }
5622 }
5623 }
5624 if (sort == 1)
5625 TMath::Sort(n, pcont.data(), a.data(), kTRUE); // sort by decreasing values
5626 else
5627 TMath::Sort(n, pcont.data(), a.data(), kFALSE); // sort by increasing values
5628 for (i = 0; i < n; i++) {
5629 // iterate on old label list to find corresponding bin match
5630 TIter next(labold);
5631 UInt_t bin = a[i] + 1;
5632 while ((obj = next())) {
5633 if (obj->GetUniqueID() == (UInt_t)bin)
5634 break;
5635 else
5636 obj = nullptr;
5637 }
5638 if (!obj) {
5639 // this should not really happen
5640 R__ASSERT("LabelsOption - No corresponding bin found when ordering labels");
5641 return;
5642 }
5643
5644 labels->Add(obj);
5645 if (gDebug)
5646 std::cout << " set label " << obj->GetName() << " to bin " << i + 1 << " from order " << a[i] << " bin "
5647 << b[a[i]] << "content " << pcont[a[i]] << std::endl;
5648 }
5649 // need to set here new ordered labels - otherwise loop before does not work since labold and labels list
5650 // contain same objects
5651 for (i = 0; i < n; i++) {
5652 labels->At(i)->SetUniqueID(i + 1);
5653 }
5654 // set now the bin contents
5655 if (axis == GetXaxis()) {
5656 for (i = 0; i < n; i++) {
5657 Int_t ix = a[i] + 1;
5658 for (j = 0; j < ny; j++) {
5659 Int_t bin = GetBin(i + 1, j);
5660 UpdateBinContent(bin, cont[ix + nx * j]);
5661 if (!errors2.empty())
5662 fSumw2.fArray[bin] = errors2[ix + nx * j];
5663 }
5664 }
5665 } else {
5666 // using y axis
5667 for (i = 0; i < nx; i++) {
5668 for (j = 0; j < n; j++) {
5669 Int_t iy = a[j] + 1;
5670 Int_t bin = GetBin(i, j + 1);
5671 UpdateBinContent(bin, cont[i + nx * iy]);
5672 if (!errors2.empty())
5673 fSumw2.fArray[bin] = errors2[i + nx * iy];
5674 }
5675 }
5676 }
5677 } else {
5678 // sorting histograms: 3D case
5679 std::vector<Double_t> pcont(n + 2);
5680 Int_t nx = fXaxis.GetNbins() + 2;
5681 Int_t ny = fYaxis.GetNbins() + 2;
5682 Int_t nz = fZaxis.GetNbins() + 2;
5683 Int_t l = 0;
5684 cont.resize((nx + 2) * (ny + 2) * (nz + 2));
5685 if (fSumw2.fN)
5686 errors2.resize((nx + 2) * (ny + 2) * (nz + 2));
5687 for (i = 0; i < nx; i++) {
5688 for (j = 0; j < ny; j++) {
5689 for (k = 0; k < nz; k++) {
5690 Int_t bin = GetBin(i,j,k);
5692 if (axis == GetXaxis())
5693 l = i - 1;
5694 else if (axis == GetYaxis())
5695 l = j - 1;
5696 else
5697 l = k - 1;
5698 if (l >= 0 && l < n) { // we consider underflow/overflows in y for ordering the bins
5699 pcont[l] += c;
5700 a[l] = l;
5701 }
5702 cont[i + nx * (j + ny * k)] = c;
5703 if (!errors2.empty())
5704 errors2[i + nx * (j + ny * k)] = GetBinErrorSqUnchecked(bin);
5705 }
5706 }
5707 }
5708 if (sort == 1)
5709 TMath::Sort(n, pcont.data(), a.data(), kTRUE); // sort by decreasing values
5710 else
5711 TMath::Sort(n, pcont.data(), a.data(), kFALSE); // sort by increasing values
5712 for (i = 0; i < n; i++) {
5713 // iterate on the old label list to find corresponding bin match
5714 TIter next(labold);
5715 UInt_t bin = a[i] + 1;
5716 obj = nullptr;
5717 while ((obj = next())) {
5718 if (obj->GetUniqueID() == (UInt_t)bin) {
5719 break;
5720 }
5721 else
5722 obj = nullptr;
5723 }
5724 if (!obj) {
5725 R__ASSERT("LabelsOption - No corresponding bin found when ordering labels");
5726 return;
5727 }
5728 labels->Add(obj);
5729 if (gDebug)
5730 std::cout << " set label " << obj->GetName() << " to bin " << i + 1 << " from bin " << a[i] << "content "
5731 << pcont[a[i]] << std::endl;
5732 }
5733
5734 // need to set here new ordered labels - otherwise loop before does not work since labold and llabels list
5735 // contain same objects
5736 for (i = 0; i < n; i++) {
5737 labels->At(i)->SetUniqueID(i + 1);
5738 }
5739 // set now the bin contents
5740 if (axis == GetXaxis()) {
5741 for (i = 0; i < n; i++) {
5742 Int_t ix = a[i] + 1;
5743 for (j = 0; j < ny; j++) {
5744 for (k = 0; k < nz; k++) {
5745 Int_t bin = GetBin(i + 1, j, k);
5746 UpdateBinContent(bin, cont[ix + nx * (j + ny * k)]);
5747 if (!errors2.empty())
5748 fSumw2.fArray[bin] = errors2[ix + nx * (j + ny * k)];
5749 }
5750 }
5751 }
5752 } else if (axis == GetYaxis()) {
5753 // using y axis
5754 for (i = 0; i < nx; i++) {
5755 for (j = 0; j < n; j++) {
5756 Int_t iy = a[j] + 1;
5757 for (k = 0; k < nz; k++) {
5758 Int_t bin = GetBin(i, j + 1, k);
5759 UpdateBinContent(bin, cont[i + nx * (iy + ny * k)]);
5760 if (!errors2.empty())
5761 fSumw2.fArray[bin] = errors2[i + nx * (iy + ny * k)];
5762 }
5763 }
5764 }
5765 } else {
5766 // using z axis
5767 for (i = 0; i < nx; i++) {
5768 for (j = 0; j < ny; j++) {
5769 for (k = 0; k < n; k++) {
5770 Int_t iz = a[k] + 1;
5771 Int_t bin = GetBin(i, j , k +1);
5772 UpdateBinContent(bin, cont[i + nx * (j + ny * iz)]);
5773 if (!errors2.empty())
5774 fSumw2.fArray[bin] = errors2[i + nx * (j + ny * iz)];
5775 }
5776 }
5777 }
5778 }
5779 }
5780 } else {
5781 //---alphabetic sort
5782 // sort labels using vector of strings and TMath::Sort
5783 // I need to array because labels order in list is not necessary that of the bins
5784 std::vector<std::string> vecLabels(n);
5785 for (i = 0; i < n; i++) {
5786 vecLabels[i] = labold->At(i)->GetName();
5787 b[i] = labold->At(i)->GetUniqueID(); // this is the bin corresponding to the label
5788 a[i] = i;
5789 }
5790 // sort in ascending order for strings
5791 TMath::Sort(n, vecLabels.data(), a.data(), kFALSE);
5792 // set the new labels
5793 for (i = 0; i < n; i++) {
5794 TObject *labelObj = labold->At(a[i]);
5795 labels->Add(labold->At(a[i]));
5796 // set the corresponding bin. NB bin starts from 1
5797 labelObj->SetUniqueID(i + 1);
5798 if (gDebug)
5799 std::cout << "bin " << i + 1 << " setting new labels for axis " << labold->At(a[i])->GetName() << " from "
5800 << b[a[i]] << std::endl;
5801 }
5802
5803 if (GetDimension() == 1) {
5804 cont.resize(n + 2);
5805 if (fSumw2.fN)
5806 errors2.resize(n + 2);
5807 for (i = 0; i < n; i++) {
5808 cont[i] = RetrieveBinContent(b[a[i]]);
5809 if (!errors2.empty())
5811 }
5812 for (i = 0; i < n; i++) {
5813 UpdateBinContent(i + 1, cont[i]);
5814 if (!errors2.empty())
5815 fSumw2.fArray[i+1] = errors2[i];
5816 }
5817 } else if (GetDimension() == 2) {
5818 Int_t nx = fXaxis.GetNbins() + 2;
5819 Int_t ny = fYaxis.GetNbins() + 2;
5820 cont.resize(nx * ny);
5821 if (fSumw2.fN)
5822 errors2.resize(nx * ny);
5823 // copy old bin contents and then set to new ordered bins
5824 // N.B. bin in histograms starts from 1, but in y we consider under/overflows
5825 for (i = 0; i < nx; i++) {
5826 for (j = 0; j < ny; j++) { // ny is nbins+2
5827 Int_t bin = GetBin(i, j);
5828 cont[i + nx * j] = RetrieveBinContent(bin);
5829 if (!errors2.empty())
5831 }
5832 }
5833 if (axis == GetXaxis()) {
5834 for (i = 0; i < n; i++) {
5835 for (j = 0; j < ny; j++) {
5836 Int_t bin = GetBin(i + 1 , j);
5837 UpdateBinContent(bin, cont[b[a[i]] + nx * j]);
5838 if (!errors2.empty())
5839 fSumw2.fArray[bin] = errors2[b[a[i]] + nx * j];
5840 }
5841 }
5842 } else {
5843 for (i = 0; i < nx; i++) {
5844 for (j = 0; j < n; j++) {
5845 Int_t bin = GetBin(i, j + 1);
5846 UpdateBinContent(bin, cont[i + nx * b[a[j]]]);
5847 if (!errors2.empty())
5848 fSumw2.fArray[bin] = errors2[i + nx * b[a[j]]];
5849 }
5850 }
5851 }
5852 } else {
5853 // case of 3D (needs to be tested)
5854 Int_t nx = fXaxis.GetNbins() + 2;
5855 Int_t ny = fYaxis.GetNbins() + 2;
5856 Int_t nz = fZaxis.GetNbins() + 2;
5857 cont.resize(nx * ny * nz);
5858 if (fSumw2.fN)
5859 errors2.resize(nx * ny * nz);
5860 for (i = 0; i < nx; i++) {
5861 for (j = 0; j < ny; j++) {
5862 for (k = 0; k < nz; k++) {
5863 Int_t bin = GetBin(i, j, k);
5864 cont[i + nx * (j + ny * k)] = RetrieveBinContent(bin);
5865 if (!errors2.empty())
5866 errors2[i + nx * (j + ny * k)] = GetBinErrorSqUnchecked(bin);
5867 }
5868 }
5869 }
5870 if (axis == GetXaxis()) {
5871 // labels on x axis
5872 for (i = 0; i < n; i++) { // for x we loop only on bins with the labels
5873 for (j = 0; j < ny; j++) {
5874 for (k = 0; k < nz; k++) {
5875 Int_t bin = GetBin(i + 1, j, k);
5876 UpdateBinContent(bin, cont[b[a[i]] + nx * (j + ny * k)]);
5877 if (!errors2.empty())
5878 fSumw2.fArray[bin] = errors2[b[a[i]] + nx * (j + ny * k)];
5879 }
5880 }
5881 }
5882 } else if (axis == GetYaxis()) {
5883 // labels on y axis
5884 for (i = 0; i < nx; i++) {
5885 for (j = 0; j < n; j++) {
5886 for (k = 0; k < nz; k++) {
5887 Int_t bin = GetBin(i, j+1, k);
5888 UpdateBinContent(bin, cont[i + nx * (b[a[j]] + ny * k)]);
5889 if (!errors2.empty())
5890 fSumw2.fArray[bin] = errors2[i + nx * (b[a[j]] + ny * k)];
5891 }
5892 }
5893 }
5894 } else {
5895 // labels on z axis
5896 for (i = 0; i < nx; i++) {
5897 for (j = 0; j < ny; j++) {
5898 for (k = 0; k < n; k++) {
5899 Int_t bin = GetBin(i, j, k+1);
5900 UpdateBinContent(bin, cont[i + nx * (j + ny * b[a[k]])]);
5901 if (!errors2.empty())
5902 fSumw2.fArray[bin] = errors2[i + nx * (j + ny * b[a[k]])];
5903 }
5904 }
5905 }
5906 }
5907 }
5908 }
5909 // need to set to zero the statistics if axis has been sorted
5910 // see for example TH3::PutStats for definition of s vector
5911 bool labelsAreSorted = kFALSE;
5912 for (i = 0; i < n; ++i) {
5913 if (a[i] != i) {
5915 break;
5916 }
5917 }
5918 if (labelsAreSorted) {
5919 double s[TH1::kNstat];
5920 GetStats(s);
5921 if (iaxis == 1) {
5922 s[2] = 0; // fTsumwx
5923 s[3] = 0; // fTsumwx2
5924 s[6] = 0; // fTsumwxy
5925 s[9] = 0; // fTsumwxz
5926 } else if (iaxis == 2) {
5927 s[4] = 0; // fTsumwy
5928 s[5] = 0; // fTsumwy2
5929 s[6] = 0; // fTsumwxy
5930 s[10] = 0; // fTsumwyz
5931 } else if (iaxis == 3) {
5932 s[7] = 0; // fTsumwz
5933 s[8] = 0; // fTsumwz2
5934 s[9] = 0; // fTsumwxz
5935 s[10] = 0; // fTsumwyz
5936 }
5937 PutStats(s);
5938 }
5939 delete labold;
5940}
5941
5942////////////////////////////////////////////////////////////////////////////////
5943/// Test if two double are almost equal.
5944
5945static inline Bool_t AlmostEqual(Double_t a, Double_t b, Double_t epsilon = 0.00000001)
5946{
5947 return TMath::Abs(a - b) < epsilon;
5948}
5949
5950////////////////////////////////////////////////////////////////////////////////
5951/// Test if a double is almost an integer.
5952
5953static inline Bool_t AlmostInteger(Double_t a, Double_t epsilon = 0.00000001)
5954{
5955 return AlmostEqual(a - TMath::Floor(a), 0, epsilon) ||
5956 AlmostEqual(a - TMath::Floor(a), 1, epsilon);
5957}
5958
5959////////////////////////////////////////////////////////////////////////////////
5960/// Test if the binning is equidistant.
5961
5962static inline bool IsEquidistantBinning(const TAxis& axis)
5963{
5964 // check if axis bin are equals
5965 if (!axis.GetXbins()->fN) return true; //
5966 // not able to check if there is only one axis entry
5967 bool isEquidistant = true;
5968 const Double_t firstBinWidth = axis.GetBinWidth(1);
5969 for (int i = 1; i < axis.GetNbins(); ++i) {
5970 const Double_t binWidth = axis.GetBinWidth(i);
5971 const bool match = TMath::AreEqualRel(firstBinWidth, binWidth, 1.E-10);
5972 isEquidistant &= match;
5973 if (!match)
5974 break;
5975 }
5976 return isEquidistant;
5977}
5978
5979////////////////////////////////////////////////////////////////////////////////
5980/// Same limits and bins.
5981
5983 return axis1.GetNbins() == axis2.GetNbins() &&
5984 TMath::AreEqualAbs(axis1.GetXmin(), axis2.GetXmin(), axis1.GetBinWidth(axis1.GetNbins()) * 1.E-10) &&
5985 TMath::AreEqualAbs(axis1.GetXmax(), axis2.GetXmax(), axis1.GetBinWidth(axis1.GetNbins()) * 1.E-10);
5986}
5987
5988////////////////////////////////////////////////////////////////////////////////
5989/// Finds new limits for the axis for the Merge function.
5990/// returns false if the limits are incompatible
5991
5993{
5995 return kTRUE;
5996
5998 return kFALSE; // not equidistant user binning not supported
5999
6000 Double_t width1 = destAxis.GetBinWidth(0);
6001 Double_t width2 = anAxis.GetBinWidth(0);
6002 if (width1 == 0 || width2 == 0)
6003 return kFALSE; // no binning not supported
6004
6005 Double_t xmin = TMath::Min(destAxis.GetXmin(), anAxis.GetXmin());
6006 Double_t xmax = TMath::Max(destAxis.GetXmax(), anAxis.GetXmax());
6008
6009 // check the bin size
6011 return kFALSE;
6012
6013 // std::cout << "Find new limit using given axis " << anAxis.GetXmin() << " , " << anAxis.GetXmax() << " bin width " << width2 << std::endl;
6014 // std::cout << " and destination axis " << destAxis.GetXmin() << " , " << destAxis.GetXmax() << " bin width " << width1 << std::endl;
6015
6016
6017 // check the limits
6018 Double_t delta;
6019 delta = (destAxis.GetXmin() - xmin)/width1;
6020 if (!AlmostInteger(delta))
6021 xmin -= (TMath::Ceil(delta) - delta)*width1;
6022
6023 delta = (anAxis.GetXmin() - xmin)/width2;
6024 if (!AlmostInteger(delta))
6025 xmin -= (TMath::Ceil(delta) - delta)*width2;
6026
6027
6028 delta = (destAxis.GetXmin() - xmin)/width1;
6029 if (!AlmostInteger(delta))
6030 return kFALSE;
6031
6032
6033 delta = (xmax - destAxis.GetXmax())/width1;
6034 if (!AlmostInteger(delta))
6035 xmax += (TMath::Ceil(delta) - delta)*width1;
6036
6037
6038 delta = (xmax - anAxis.GetXmax())/width2;
6039 if (!AlmostInteger(delta))
6040 xmax += (TMath::Ceil(delta) - delta)*width2;
6041
6042
6043 delta = (xmax - destAxis.GetXmax())/width1;
6044 if (!AlmostInteger(delta))
6045 return kFALSE;
6046#ifdef DEBUG
6047 if (!AlmostInteger((xmax - xmin) / width)) { // unnecessary check
6048 printf("TH1::RecomputeAxisLimits - Impossible\n");
6049 return kFALSE;
6050 }
6051#endif
6052
6053
6055
6056 //std::cout << "New re-computed axis : [ " << xmin << " , " << xmax << " ] width = " << width << " nbins " << destAxis.GetNbins() << std::endl;
6057
6058 return kTRUE;
6059}
6060
6061////////////////////////////////////////////////////////////////////////////////
6062/// Add all histograms in the collection to this histogram.
6063/// This function computes the min/max for the x axis,
6064/// compute a new number of bins, if necessary,
6065/// add bin contents, errors and statistics.
6066/// If all histograms have bin labels, bins with identical labels
6067/// will be merged, no matter what their order is.
6068/// If overflows are present and limits are different the function will fail.
6069/// The function returns the total number of entries in the result histogram
6070/// if the merge is successful, -1 otherwise.
6071///
6072/// Possible option:
6073/// -NOL : the merger will ignore the labels and merge the histograms bin by bin using bin center values to match bins
6074/// -NOCHECK: the histogram will not perform a check for duplicate labels in case of axes with labels. The check
6075/// (enabled by default) slows down the merging
6076///
6077/// IMPORTANT remark. The axis x may have different number
6078/// of bins and different limits, BUT the largest bin width must be
6079/// a multiple of the smallest bin width and the upper limit must also
6080/// be a multiple of the bin width.
6081/// Example:
6082///
6083/// ~~~ {.cpp}
6084/// void atest() {
6085/// TH1F *h1 = new TH1F("h1","h1",110,-110,0);
6086/// TH1F *h2 = new TH1F("h2","h2",220,0,110);
6087/// TH1F *h3 = new TH1F("h3","h3",330,-55,55);
6088/// TRandom r;
6089/// for (Int_t i=0;i<10000;i++) {
6090/// h1->Fill(r.Gaus(-55,10));
6091/// h2->Fill(r.Gaus(55,10));
6092/// h3->Fill(r.Gaus(0,10));
6093/// }
6094///
6095/// TList *list = new TList;
6096/// list->Add(h1);
6097/// list->Add(h2);
6098/// list->Add(h3);
6099/// TH1F *h = (TH1F*)h1->Clone("h");
6100/// h->Reset();
6101/// h->Merge(list);
6102/// h->Draw();
6103/// }
6104/// ~~~
6105
6107{
6108 if (!li) return 0;
6109 if (li->IsEmpty()) return (Long64_t) GetEntries();
6110
6111 // use TH1Merger class
6112 TH1Merger merger(*this,*li,opt);
6113 Bool_t ret = merger();
6114
6115 return (ret) ? GetEntries() : -1;
6116}
6117
6118
6119////////////////////////////////////////////////////////////////////////////////
6120/// Performs the operation:
6121///
6122/// `this = this*c1*f1`
6123///
6124/// If errors are defined (see TH1::Sumw2), errors are also recalculated.
6125///
6126/// Only bins inside the function range are recomputed.
6127/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6128/// you should call Sumw2 before making this operation.
6129/// This is particularly important if you fit the histogram after TH1::Multiply
6130///
6131/// The function return kFALSE if the Multiply operation failed
6132
6134{
6135 if (!f1) {
6136 Error("Multiply","Attempt to multiply by a non-existing function");
6137 return kFALSE;
6138 }
6139
6140 // delete buffer if it is there since it will become invalid
6141 if (fBuffer) BufferEmpty(1);
6142
6143 Int_t nx = GetNbinsX() + 2; // normal bins + uf / of (cells)
6144 Int_t ny = GetNbinsY() + 2;
6145 Int_t nz = GetNbinsZ() + 2;
6146 if (fDimension < 2) ny = 1;
6147 if (fDimension < 3) nz = 1;
6148
6149 // reset min-maximum
6150 SetMinimum();
6151 SetMaximum();
6152
6153 // - Loop on bins (including underflows/overflows)
6154 Double_t xx[3];
6155 Double_t *params = nullptr;
6156 f1->InitArgs(xx,params);
6157
6158 for (Int_t binz = 0; binz < nz; ++binz) {
6159 xx[2] = fZaxis.GetBinCenter(binz);
6160 for (Int_t biny = 0; biny < ny; ++biny) {
6161 xx[1] = fYaxis.GetBinCenter(biny);
6162 for (Int_t binx = 0; binx < nx; ++binx) {
6163 xx[0] = fXaxis.GetBinCenter(binx);
6164 if (!f1->IsInside(xx)) continue;
6166 Int_t bin = binx + nx * (biny + ny *binz);
6167 Double_t cu = c1*f1->EvalPar(xx);
6168 if (TF1::RejectedPoint()) continue;
6170 if (fSumw2.fN) {
6172 }
6173 }
6174 }
6175 }
6176 ResetStats();
6177 return kTRUE;
6178}
6179
6180////////////////////////////////////////////////////////////////////////////////
6181/// Multiply this histogram by h1.
6182///
6183/// `this = this*h1`
6184///
6185/// If errors of this are available (TH1::Sumw2), errors are recalculated.
6186/// Note that if h1 has Sumw2 set, Sumw2 is automatically called for this
6187/// if not already set.
6188///
6189/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6190/// you should call Sumw2 before making this operation.
6191/// This is particularly important if you fit the histogram after TH1::Multiply
6192///
6193/// The function return kFALSE if the Multiply operation failed
6194
6195Bool_t TH1::Multiply(const TH1 *h1)
6196{
6197 if (!h1) {
6198 Error("Multiply","Attempt to multiply by a non-existing histogram");
6199 return kFALSE;
6200 }
6201
6202 // delete buffer if it is there since it will become invalid
6203 if (fBuffer) BufferEmpty(1);
6204
6205 if (LoggedInconsistency("Multiply", this, h1) >= kDifferentNumberOfBins) {
6206 return false;
6207 }
6208
6209 // Create Sumw2 if h1 has Sumw2 set
6210 if (fSumw2.fN == 0 && h1->GetSumw2N() != 0) Sumw2();
6211
6212 // - Reset min- maximum
6213 SetMinimum();
6214 SetMaximum();
6215
6216 // - Loop on bins (including underflows/overflows)
6217 for (Int_t i = 0; i < fNcells; ++i) {
6220 UpdateBinContent(i, c0 * c1);
6221 if (fSumw2.fN) {
6223 }
6224 }
6225 ResetStats();
6226 return kTRUE;
6227}
6228
6229////////////////////////////////////////////////////////////////////////////////
6230/// Replace contents of this histogram by multiplication of h1 by h2.
6231///
6232/// `this = (c1*h1)*(c2*h2)`
6233///
6234/// If errors of this are available (TH1::Sumw2), errors are recalculated.
6235/// Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this
6236/// if not already set.
6237///
6238/// IMPORTANT NOTE: If you intend to use the errors of this histogram later
6239/// you should call Sumw2 before making this operation.
6240/// This is particularly important if you fit the histogram after TH1::Multiply
6241///
6242/// The function return kFALSE if the Multiply operation failed
6243
6245{
6246 TString opt = option;
6247 opt.ToLower();
6248 // Bool_t binomial = kFALSE;
6249 // if (opt.Contains("b")) binomial = kTRUE;
6250 if (!h1 || !h2) {
6251 Error("Multiply","Attempt to multiply by a non-existing histogram");
6252 return kFALSE;
6253 }
6254
6255 // delete buffer if it is there since it will become invalid
6256 if (fBuffer) BufferEmpty(1);
6257
6258 if (LoggedInconsistency("Multiply", this, h1) >= kDifferentNumberOfBins ||
6259 LoggedInconsistency("Multiply", h1, h2) >= kDifferentNumberOfBins) {
6260 return false;
6261 }
6262
6263 // Create Sumw2 if h1 or h2 have Sumw2 set
6264 if (fSumw2.fN == 0 && (h1->GetSumw2N() != 0 || h2->GetSumw2N() != 0)) Sumw2();
6265
6266 // - Reset min - maximum
6267 SetMinimum();
6268 SetMaximum();
6269
6270 // - Loop on bins (including underflows/overflows)
6271 Double_t c1sq = c1 * c1; Double_t c2sq = c2 * c2;
6272 for (Int_t i = 0; i < fNcells; ++i) {
6274 Double_t b2 = h2->RetrieveBinContent(i);
6275 UpdateBinContent(i, c1 * b1 * c2 * b2);
6276 if (fSumw2.fN) {
6277 fSumw2.fArray[i] = c1sq * c2sq * (h1->GetBinErrorSqUnchecked(i) * b2 * b2 + h2->GetBinErrorSqUnchecked(i) * b1 * b1);
6278 }
6279 }
6280 ResetStats();
6281 return kTRUE;
6282}
6283
6284////////////////////////////////////////////////////////////////////////////////
6285/// @brief Normalize a histogram to its integral or to its maximum.
6286/// @note Works for TH1, TH2, TH3, ...
6287/// @param option: normalization strategy ("", "max" or "sum")
6288/// - "": Scale to `1/(sum*bin_width)`.
6289/// - max: Scale to `1/GetMaximum()`
6290/// - sum: Scale to `1/sum`.
6291///
6292/// In case the norm is zero, it raises an error.
6293/// @sa https://root-forum.cern.ch/t/different-ways-of-normalizing-histograms/15582/
6294
6296{
6297 TString opt = option;
6298 opt.ToLower();
6299 if (!opt.IsNull() && (opt != "max") && (opt != "sum")) {
6300 Error("Normalize", "Unrecognized option %s", option);
6301 return;
6302 }
6303
6304 const Double_t norm = (opt == "max") ? GetMaximum() : Integral(opt.IsNull() ? "width" : "");
6305
6306 if (norm == 0) {
6307 Error("Normalize", "Attempt to normalize histogram with zero integral");
6308 } else {
6309 Scale(1.0 / norm, "");
6310 // An alternative could have been to call Integral("") and Scale(1/norm, "width"), but this
6311 // will lead to a different value of GetEntries.
6312 // Instead, doing simultaneously Integral("width") and Scale(1/norm, "width") leads to an error since you are
6313 // dividing twice by bin width.
6314 }
6315}
6316
6317////////////////////////////////////////////////////////////////////////////////
6318/// Control routine to paint any kind of histograms.
6319///
6320/// This function is automatically called by TCanvas::Update.
6321/// (see TH1::Draw for the list of options)
6322
6324{
6326
6327 if (fPainter) {
6328 if (option && strlen(option) > 0)
6330 else
6332 }
6333}
6334
6335////////////////////////////////////////////////////////////////////////////////
6336/// Rebin this histogram
6337///
6338/// #### case 1 xbins=0
6339///
6340/// If newname is blank (default), the current histogram is modified and
6341/// a pointer to it is returned.
6342///
6343/// If newname is not blank, the current histogram is not modified, and a
6344/// new histogram is returned which is a Clone of the current histogram
6345/// with its name set to newname.
6346///
6347/// The parameter ngroup indicates how many bins of this have to be merged
6348/// into one bin of the result.
6349///
6350/// If the original histogram has errors stored (via Sumw2), the resulting
6351/// histograms has new errors correctly calculated.
6352///
6353/// examples: if h1 is an existing TH1F histogram with 100 bins
6354///
6355/// ~~~ {.cpp}
6356/// h1->Rebin(); //merges two bins in one in h1: previous contents of h1 are lost
6357/// h1->Rebin(5); //merges five bins in one in h1
6358/// TH1F *hnew = dynamic_cast<TH1F*>(h1->Rebin(5,"hnew")); // creates a new histogram hnew
6359/// // merging 5 bins of h1 in one bin
6360/// ~~~
6361///
6362/// NOTE: If ngroup is not an exact divider of the number of bins,
6363/// the top limit of the rebinned histogram is reduced
6364/// to the upper edge of the last bin that can make a complete
6365/// group. The remaining bins are added to the overflow bin.
6366/// Statistics will be recomputed from the new bin contents.
6367///
6368/// #### case 2 xbins!=0
6369///
6370/// A new histogram is created (you should specify newname).
6371/// The parameter ngroup is the number of variable size bins in the created histogram.
6372/// The array xbins must contain ngroup+1 elements that represent the low-edges
6373/// of the bins.
6374/// If the original histogram has errors stored (via Sumw2), the resulting
6375/// histograms has new errors correctly calculated.
6376///
6377/// NOTE: The bin edges specified in xbins should correspond to bin edges
6378/// in the original histogram. If a bin edge in the new histogram is
6379/// in the middle of a bin in the original histogram, all entries in
6380/// the split bin in the original histogram will be transferred to the
6381/// lower of the two possible bins in the new histogram. This is
6382/// probably not what you want. A warning message is emitted in this
6383/// case
6384///
6385/// examples: if h1 is an existing TH1F histogram with 100 bins
6386///
6387/// ~~~ {.cpp}
6388/// Double_t xbins[25] = {...} array of low-edges (xbins[25] is the upper edge of last bin
6389/// h1->Rebin(24,"hnew",xbins); //creates a new variable bin size histogram hnew
6390/// ~~~
6391
6392TH1 *TH1::Rebin(Int_t ngroup, const char*newname, const Double_t *xbins)
6393{
6394 Int_t nbins = fXaxis.GetNbins();
6397 if ((ngroup <= 0) || (ngroup > nbins)) {
6398 Error("Rebin", "Illegal value of ngroup=%d",ngroup);
6399 return nullptr;
6400 }
6401
6402 if (fDimension > 1 || InheritsFrom(TProfile::Class())) {
6403 Error("Rebin", "Operation valid on 1-D histograms only");
6404 return nullptr;
6405 }
6406 if (!newname && xbins) {
6407 Error("Rebin","if xbins is specified, newname must be given");
6408 return nullptr;
6409 }
6410
6411 Int_t newbins = nbins/ngroup;
6412 if (!xbins) {
6413 Int_t nbg = nbins/ngroup;
6414 if (nbg*ngroup != nbins) {
6415 Warning("Rebin", "ngroup=%d is not an exact divider of nbins=%d.",ngroup,nbins);
6416 }
6417 }
6418 else {
6419 // in the case that xbins is given (rebinning in variable bins), ngroup is
6420 // the new number of bins and number of grouped bins is not constant.
6421 // when looping for setting the contents for the new histogram we
6422 // need to loop on all bins of original histogram. Then set ngroup=nbins
6423 newbins = ngroup;
6424 ngroup = nbins;
6425 }
6426
6427 // Save old bin contents into a new array
6428 Double_t entries = fEntries;
6429 Double_t *oldBins = new Double_t[nbins+2];
6430 Int_t bin, i;
6431 for (bin=0;bin<nbins+2;bin++) oldBins[bin] = RetrieveBinContent(bin);
6432 Double_t *oldErrors = nullptr;
6433 if (fSumw2.fN != 0) {
6434 oldErrors = new Double_t[nbins+2];
6435 for (bin=0;bin<nbins+2;bin++) oldErrors[bin] = GetBinError(bin);
6436 }
6437 // rebin will not include underflow/overflow if new axis range is larger than old axis range
6438 if (xbins) {
6439 if (xbins[0] < fXaxis.GetXmin() && oldBins[0] != 0 )
6440 Warning("Rebin","underflow entries will not be used when rebinning");
6441 if (xbins[newbins] > fXaxis.GetXmax() && oldBins[nbins+1] != 0 )
6442 Warning("Rebin","overflow entries will not be used when rebinning");
6443 }
6444
6445
6446 // create a clone of the old histogram if newname is specified
6447 TH1 *hnew = this;
6448 if ((newname && strlen(newname) > 0) || xbins) {
6449 hnew = (TH1*)Clone(newname);
6450 }
6451
6452 //reset can extend bit to avoid an axis extension in SetBinContent
6453 UInt_t oldExtendBitMask = hnew->SetCanExtend(kNoAxis);
6454
6455 // save original statistics
6456 Double_t stat[kNstat];
6457 GetStats(stat);
6458 bool resetStat = false;
6459 // change axis specs and rebuild bin contents array::RebinAx
6460 if(!xbins && (newbins*ngroup != nbins)) {
6462 resetStat = true; //stats must be reset because top bins will be moved to overflow bin
6463 }
6464 // save the TAttAxis members (reset by SetBins)
6476
6477 if(!xbins && (fXaxis.GetXbins()->GetSize() > 0)){ // variable bin sizes
6478 Double_t *bins = new Double_t[newbins+1];
6479 for(i = 0; i <= newbins; ++i) bins[i] = fXaxis.GetBinLowEdge(1+i*ngroup);
6480 hnew->SetBins(newbins,bins); //this also changes errors array (if any)
6481 delete [] bins;
6482 } else if (xbins) {
6483 hnew->SetBins(newbins,xbins);
6484 } else {
6485 hnew->SetBins(newbins,xmin,xmax);
6486 }
6487
6488 // Restore axis attributes
6500
6501 // copy merged bin contents (ignore under/overflows)
6502 // Start merging only once the new lowest edge is reached
6503 Int_t startbin = 1;
6504 const Double_t newxmin = hnew->GetXaxis()->GetBinLowEdge(1);
6505 while( fXaxis.GetBinCenter(startbin) < newxmin && startbin <= nbins ) {
6506 startbin++;
6507 }
6510 for (bin = 1;bin<=newbins;bin++) {
6511 binContent = 0;
6512 binError = 0;
6513 Int_t imax = ngroup;
6514 Double_t xbinmax = hnew->GetXaxis()->GetBinUpEdge(bin);
6515 // check bin edges for the cases when we provide an array of bins
6516 // be careful in case bins can have zero width
6518 hnew->GetXaxis()->GetBinLowEdge(bin),
6519 TMath::Max(1.E-8 * fXaxis.GetBinWidth(oldbin), 1.E-16 )) )
6520 {
6521 Warning("Rebin","Bin edge %d of rebinned histogram does not match any bin edges of the old histogram. Result can be inconsistent",bin);
6522 }
6523 for (i=0;i<ngroup;i++) {
6524 if( (oldbin+i > nbins) ||
6525 ( hnew != this && (fXaxis.GetBinCenter(oldbin+i) > xbinmax)) ) {
6526 imax = i;
6527 break;
6528 }
6531 }
6532 hnew->SetBinContent(bin,binContent);
6533 if (oldErrors) hnew->SetBinError(bin,TMath::Sqrt(binError));
6534 oldbin += imax;
6535 }
6536
6537 // sum underflow and overflow contents until startbin
6538 binContent = 0;
6539 binError = 0;
6540 for (i = 0; i < startbin; ++i) {
6541 binContent += oldBins[i];
6542 if (oldErrors) binError += oldErrors[i]*oldErrors[i];
6543 }
6544 hnew->SetBinContent(0,binContent);
6545 if (oldErrors) hnew->SetBinError(0,TMath::Sqrt(binError));
6546 // sum overflow
6547 binContent = 0;
6548 binError = 0;
6549 for (i = oldbin; i <= nbins+1; ++i) {
6550 binContent += oldBins[i];
6551 if (oldErrors) binError += oldErrors[i]*oldErrors[i];
6552 }
6553 hnew->SetBinContent(newbins+1,binContent);
6554 if (oldErrors) hnew->SetBinError(newbins+1,TMath::Sqrt(binError));
6555
6556 hnew->SetCanExtend(oldExtendBitMask); // restore previous state
6557
6558 // restore statistics and entries modified by SetBinContent
6559 hnew->SetEntries(entries);
6560 if (!resetStat) hnew->PutStats(stat);
6561 delete [] oldBins;
6562 if (oldErrors) delete [] oldErrors;
6563 return hnew;
6564}
6565
6566////////////////////////////////////////////////////////////////////////////////
6567/// finds new limits for the axis so that *point* is within the range and
6568/// the limits are compatible with the previous ones (see TH1::Merge).
6569/// new limits are put into *newMin* and *newMax* variables.
6570/// axis - axis whose limits are to be recomputed
6571/// point - point that should fit within the new axis limits
6572/// newMin - new minimum will be stored here
6573/// newMax - new maximum will be stored here.
6574/// false if failed (e.g. if the initial axis limits are wrong
6575/// or the new range is more than \f$ 2^{64} \f$ times the old one).
6576
6578{
6579 Double_t xmin = axis->GetXmin();
6580 Double_t xmax = axis->GetXmax();
6581 if (xmin >= xmax) return kFALSE;
6583
6584 //recompute new axis limits by doubling the current range
6585 Int_t ntimes = 0;
6586 while (point < xmin) {
6587 if (ntimes++ > 64)
6588 return kFALSE;
6589 xmin = xmin - range;
6590 range *= 2;
6591 }
6592 while (point >= xmax) {
6593 if (ntimes++ > 64)
6594 return kFALSE;
6595 xmax = xmax + range;
6596 range *= 2;
6597 }
6598 newMin = xmin;
6599 newMax = xmax;
6600 // Info("FindNewAxisLimits", "OldAxis: (%lf, %lf), new: (%lf, %lf), point: %lf",
6601 // axis->GetXmin(), axis->GetXmax(), xmin, xmax, point);
6602
6603 return kTRUE;
6604}
6605
6606////////////////////////////////////////////////////////////////////////////////
6607/// Histogram is resized along axis such that x is in the axis range.
6608/// The new axis limits are recomputed by doubling iteratively
6609/// the current axis range until the specified value x is within the limits.
6610/// The algorithm makes a copy of the histogram, then loops on all bins
6611/// of the old histogram to fill the extended histogram.
6612/// Takes into account errors (Sumw2) if any.
6613/// The algorithm works for 1-d, 2-D and 3-D histograms.
6614/// The axis must be extendable before invoking this function.
6615/// Ex:
6616///
6617/// ~~~ {.cpp}
6618/// h->GetXaxis()->SetCanExtend(kTRUE);
6619/// ~~~
6620
6621void TH1::ExtendAxis(Double_t x, TAxis *axis)
6622{
6623 if (!axis->CanExtend()) return;
6624 if (TMath::IsNaN(x)) { // x may be a NaN
6626 return;
6627 }
6628
6629 if (axis->GetXmin() >= axis->GetXmax()) return;
6630 if (axis->GetNbins() <= 0) return;
6631
6633 if (!FindNewAxisLimits(axis, x, xmin, xmax))
6634 return;
6635
6636 //save a copy of this histogram
6637 TH1 *hold = (TH1*)IsA()->New();
6638 hold->SetDirectory(nullptr);
6639 Copy(*hold);
6640 //set new axis limits
6641 axis->SetLimits(xmin,xmax);
6642
6643
6644 //now loop on all bins and refill
6646
6647 Reset("ICE"); //reset only Integral, contents and Errors
6648
6649 int iaxis = 0;
6650 if (axis == &fXaxis) iaxis = 1;
6651 if (axis == &fYaxis) iaxis = 2;
6652 if (axis == &fZaxis) iaxis = 3;
6653 bool firstw = kTRUE;
6654 Int_t binx,biny, binz = 0;
6655 Int_t ix = 0,iy = 0,iz = 0;
6656 Double_t bx,by,bz;
6657 Int_t ncells = hold->GetNcells();
6658 for (Int_t bin = 0; bin < ncells; ++bin) {
6659 hold->GetBinXYZ(bin,binx,biny,binz);
6660 bx = hold->GetXaxis()->GetBinCenter(binx);
6661 ix = fXaxis.FindFixBin(bx);
6662 if (fDimension > 1) {
6663 by = hold->GetYaxis()->GetBinCenter(biny);
6664 iy = fYaxis.FindFixBin(by);
6665 if (fDimension > 2) {
6666 bz = hold->GetZaxis()->GetBinCenter(binz);
6667 iz = fZaxis.FindFixBin(bz);
6668 }
6669 }
6670 // exclude underflow/overflow
6671 double content = hold->RetrieveBinContent(bin);
6672 if (content == 0) continue;
6674 if (firstw) {
6675 Warning("ExtendAxis","Histogram %s has underflow or overflow in the axis that is extendable"
6676 " their content will be lost",GetName() );
6677 firstw= kFALSE;
6678 }
6679 continue;
6680 }
6681 Int_t ibin= GetBin(ix,iy,iz);
6683 if (errors) {
6684 fSumw2.fArray[ibin] += hold->GetBinErrorSqUnchecked(bin);
6685 }
6686 }
6687 delete hold;
6688}
6689
6690////////////////////////////////////////////////////////////////////////////////
6691/// Recursively remove object from the list of functions
6692
6694{
6695 // Rely on TROOT::RecursiveRemove to take the readlock.
6696
6697 if (fFunctions) {
6699 }
6700}
6701
6702////////////////////////////////////////////////////////////////////////////////
6703/// Multiply this histogram by a constant c1.
6704///
6705/// `this = c1*this`
6706///
6707/// Note that both contents and errors (if any) are scaled.
6708/// This function uses the services of TH1::Add
6709///
6710/// IMPORTANT NOTE: Sumw2() is called automatically when scaling.
6711/// If you are not interested in the histogram statistics you can call
6712/// Sumw2(kFALSE) or use the option "nosw2"
6713///
6714/// One can scale a histogram such that the bins integral is equal to
6715/// the normalization parameter via TH1::Scale(Double_t norm), where norm
6716/// is the desired normalization divided by the integral of the histogram.
6717///
6718/// If option contains "width" the bin contents and errors are divided
6719/// by the bin width.
6720
6722{
6723
6724 TString opt = option; opt.ToLower();
6725 // store bin errors when scaling since cannot anymore be computed as sqrt(N)
6726 if (!opt.Contains("nosw2") && GetSumw2N() == 0) Sumw2();
6727 if (opt.Contains("width")) Add(this, this, c1, -1);
6728 else {
6729 if (fBuffer) BufferEmpty(1);
6730 for(Int_t i = 0; i < fNcells; ++i) UpdateBinContent(i, c1 * RetrieveBinContent(i));
6731 if (fSumw2.fN) for(Int_t i = 0; i < fNcells; ++i) fSumw2.fArray[i] *= (c1 * c1); // update errors
6732 // update global histograms statistics
6733 Double_t s[kNstat] = {0};
6734 GetStats(s);
6735 for (Int_t i=0 ; i < kNstat; i++) {
6736 if (i == 1) s[i] = c1*c1*s[i];
6737 else s[i] = c1*s[i];
6738 }
6739 PutStats(s);
6740 SetMinimum(); SetMaximum(); // minimum and maximum value will be recalculated the next time
6741 }
6742
6743 // if contours set, must also scale contours
6745 if (ncontours == 0) return;
6747 for (Int_t i = 0; i < ncontours; ++i) levels[i] *= c1;
6748}
6749
6750////////////////////////////////////////////////////////////////////////////////
6751/// Returns true if all axes are extendable.
6752
6754{
6756 if (GetDimension() > 1) canExtend &= fYaxis.CanExtend();
6757 if (GetDimension() > 2) canExtend &= fZaxis.CanExtend();
6758
6759 return canExtend;
6760}
6761
6762////////////////////////////////////////////////////////////////////////////////
6763/// Make the histogram axes extendable / not extendable according to the bit mask
6764/// returns the previous bit mask specifying which axes are extendable
6765
6767{
6769
6773
6774 if (GetDimension() > 1) {
6778 }
6779
6780 if (GetDimension() > 2) {
6784 }
6785
6786 return oldExtendBitMask;
6787}
6788
6789///////////////////////////////////////////////////////////////////////////////
6790/// Internal function used in TH1::Fill to see which axis is full alphanumeric,
6791/// i.e. can be extended and is alphanumeric
6793{
6797 bitMask |= kYaxis;
6799 bitMask |= kZaxis;
6800
6801 return bitMask;
6802}
6803
6804////////////////////////////////////////////////////////////////////////////////
6805/// Static function to set the default buffer size for automatic histograms.
6806/// When a histogram is created with one of its axis lower limit greater
6807/// or equal to its upper limit, the function SetBuffer is automatically
6808/// called with the default buffer size.
6809
6811{
6812 fgBufferSize = bufsize > 0 ? bufsize : 0;
6813}
6814
6815////////////////////////////////////////////////////////////////////////////////
6816/// When this static function is called with `sumw2=kTRUE`, all new
6817/// histograms will automatically activate the storage
6818/// of the sum of squares of errors, ie TH1::Sumw2 is automatically called.
6819
6821{
6823}
6824
6825////////////////////////////////////////////////////////////////////////////////
6826/// Change/set the title.
6827///
6828/// If title is in the form `stringt;stringx;stringy;stringz;stringc`
6829/// the histogram title is set to `stringt`, the x axis title to `stringx`,
6830/// the y axis title to `stringy`, the z axis title to `stringz`, and the c
6831/// axis title for the palette is ignored at this stage.
6832/// Note that you can use e.g. `stringt;stringx` if you only want to specify
6833/// title and x axis title.
6834///
6835/// To insert the character `;` in one of the titles, one should use `#;`
6836/// or `#semicolon`.
6837
6838void TH1::SetTitle(const char *title)
6839{
6840 fTitle = title;
6841 fTitle.ReplaceAll("#;",2,"#semicolon",10);
6842
6843 // Decode fTitle. It may contain X, Y and Z titles
6845 Int_t isc = str1.Index(";");
6846 Int_t lns = str1.Length();
6847
6848 if (isc >=0 ) {
6849 fTitle = str1(0,isc);
6850 str1 = str1(isc+1, lns);
6851 isc = str1.Index(";");
6852 if (isc >=0 ) {
6853 str2 = str1(0,isc);
6854 str2.ReplaceAll("#semicolon",10,";",1);
6855 fXaxis.SetTitle(str2.Data());
6856 lns = str1.Length();
6857 str1 = str1(isc+1, lns);
6858 isc = str1.Index(";");
6859 if (isc >=0 ) {
6860 str2 = str1(0,isc);
6861 str2.ReplaceAll("#semicolon",10,";",1);
6862 fYaxis.SetTitle(str2.Data());
6863 lns = str1.Length();
6864 str1 = str1(isc+1, lns);
6865 isc = str1.Index(";");
6866 if (isc >=0 ) {
6867 str2 = str1(0,isc);
6868 str2.ReplaceAll("#semicolon",10,";",1);
6869 fZaxis.SetTitle(str2.Data());
6870 } else {
6871 str1.ReplaceAll("#semicolon",10,";",1);
6872 fZaxis.SetTitle(str1.Data());
6873 }
6874 } else {
6875 str1.ReplaceAll("#semicolon",10,";",1);
6876 fYaxis.SetTitle(str1.Data());
6877 }
6878 } else {
6879 str1.ReplaceAll("#semicolon",10,";",1);
6880 fXaxis.SetTitle(str1.Data());
6881 }
6882 }
6883
6884 fTitle.ReplaceAll("#semicolon",10,";",1);
6885
6886 if (gPad && TestBit(kMustCleanup)) gPad->Modified();
6887}
6888
6889////////////////////////////////////////////////////////////////////////////////
6890/// Smooth array xx, translation of Hbook routine `hsmoof.F`.
6891/// Based on algorithm 353QH twice presented by J. Friedman
6892/// in [Proc. of the 1974 CERN School of Computing, Norway, 11-24 August, 1974](https://cds.cern.ch/record/186223).
6893/// 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).
6894
6896{
6897 if (nn < 3 ) {
6898 ::Error("SmoothArray","Need at least 3 points for smoothing: n = %d",nn);
6899 return;
6900 }
6901
6902 Int_t ii;
6903 std::array<double, 3> hh{};
6904
6905 std::vector<double> yy(nn);
6906 std::vector<double> zz(nn);
6907 std::vector<double> rr(nn);
6908
6909 for (Int_t pass=0;pass<ntimes;pass++) {
6910 // first copy original data into temp array
6911 std::copy(xx, xx+nn, zz.begin() );
6912
6913 for (int noent = 0; noent < 2; ++noent) { // run algorithm two times
6914
6915 // do 353 i.e. running median 3, 5, and 3 in a single loop
6916 for (int kk = 0; kk < 3; kk++) {
6917 std::copy(zz.begin(), zz.end(), yy.begin());
6918 int medianType = (kk != 1) ? 3 : 5;
6919 int ifirst = (kk != 1 ) ? 1 : 2;
6920 int ilast = (kk != 1 ) ? nn-1 : nn -2;
6921 //nn2 = nn - ik - 1;
6922 // do all elements beside the first and last point for median 3
6923 // and first two and last 2 for median 5
6924 for ( ii = ifirst; ii < ilast; ii++) {
6925 zz[ii] = TMath::Median(medianType, yy.data() + ii - ifirst);
6926 }
6927
6928 if (kk == 0) { // first median 3
6929 // first point
6930 hh[0] = zz[1];
6931 hh[1] = zz[0];
6932 hh[2] = 3*zz[1] - 2*zz[2];
6933 zz[0] = TMath::Median(3, hh.data());
6934 // last point
6935 hh[0] = zz[nn - 2];
6936 hh[1] = zz[nn - 1];
6937 hh[2] = 3*zz[nn - 2] - 2*zz[nn - 3];
6938 zz[nn - 1] = TMath::Median(3, hh.data());
6939 }
6940
6941 if (kk == 1) { // median 5
6942 // second point with window length 3
6943 zz[1] = TMath::Median(3, yy.data());
6944 // second-to-last point with window length 3
6945 zz[nn - 2] = TMath::Median(3, yy.data() + nn - 3);
6946 }
6947
6948 // In the third iteration (kk == 2), the first and last point stay
6949 // the same (see paper linked in the documentation).
6950 }
6951
6952 std::copy ( zz.begin(), zz.end(), yy.begin() );
6953
6954 // quadratic interpolation for flat segments
6955 for (ii = 2; ii < (nn - 2); ii++) {
6956 if (zz[ii - 1] != zz[ii]) continue;
6957 if (zz[ii] != zz[ii + 1]) continue;
6958 const double tmp0 = zz[ii - 2] - zz[ii];
6959 const double tmp1 = zz[ii + 2] - zz[ii];
6960 if (tmp0 * tmp1 <= 0) continue;
6961 int jk = 1;
6962 if ( std::abs(tmp1) > std::abs(tmp0) ) jk = -1;
6963 yy[ii] = -0.5*zz[ii - 2*jk] + zz[ii]/0.75 + zz[ii + 2*jk] /6.;
6964 yy[ii + jk] = 0.5*(zz[ii + 2*jk] - zz[ii - 2*jk]) + zz[ii];
6965 }
6966
6967 // running means
6968 //std::copy(zz.begin(), zz.end(), yy.begin());
6969 for (ii = 1; ii < nn - 1; ii++) {
6970 zz[ii] = 0.25*yy[ii - 1] + 0.5*yy[ii] + 0.25*yy[ii + 1];
6971 }
6972 zz[0] = yy[0];
6973 zz[nn - 1] = yy[nn - 1];
6974
6975 if (noent == 0) {
6976
6977 // save computed values
6978 std::copy(zz.begin(), zz.end(), rr.begin());
6979
6980 // COMPUTE residuals
6981 for (ii = 0; ii < nn; ii++) {
6982 zz[ii] = xx[ii] - zz[ii];
6983 }
6984 }
6985
6986 } // end loop on noent
6987
6988
6989 double xmin = TMath::MinElement(nn,xx);
6990 for (ii = 0; ii < nn; ii++) {
6991 if (xmin < 0) xx[ii] = rr[ii] + zz[ii];
6992 // make smoothing defined positive - not better using 0 ?
6993 else xx[ii] = std::max((rr[ii] + zz[ii]),0.0 );
6994 }
6995 }
6996}
6997
6998////////////////////////////////////////////////////////////////////////////////
6999/// Smooth bin contents of this histogram.
7000/// if option contains "R" smoothing is applied only to the bins
7001/// defined in the X axis range (default is to smooth all bins)
7002/// Bin contents are replaced by their smooth values.
7003/// Errors (if any) are not modified.
7004/// the smoothing procedure is repeated ntimes (default=1)
7005
7007{
7008 if (fDimension != 1) {
7009 Error("Smooth","Smooth only supported for 1-d histograms");
7010 return;
7011 }
7012 Int_t nbins = fXaxis.GetNbins();
7013 if (nbins < 3) {
7014 Error("Smooth","Smooth only supported for histograms with >= 3 bins. Nbins = %d",nbins);
7015 return;
7016 }
7017
7018 // delete buffer if it is there since it will become invalid
7019 if (fBuffer) BufferEmpty(1);
7020
7021 Int_t firstbin = 1, lastbin = nbins;
7022 TString opt = option;
7023 opt.ToLower();
7024 if (opt.Contains("r")) {
7027 }
7028 nbins = lastbin - firstbin + 1;
7029 Double_t *xx = new Double_t[nbins];
7031 Int_t i;
7032 for (i=0;i<nbins;i++) {
7034 }
7035
7036 TH1::SmoothArray(nbins,xx,ntimes);
7037
7038 for (i=0;i<nbins;i++) {
7040 }
7041 fEntries = nent;
7042 delete [] xx;
7043
7044 if (gPad) gPad->Modified();
7045}
7046
7047////////////////////////////////////////////////////////////////////////////////
7048/// if flag=kTRUE, underflows and overflows are used by the Fill functions
7049/// in the computation of statistics (mean value, StdDev).
7050/// By default, underflows or overflows are not used.
7051
7053{
7055}
7056
7057////////////////////////////////////////////////////////////////////////////////
7058/// Stream a class object.
7059
7060void TH1::Streamer(TBuffer &b)
7061{
7062 if (b.IsReading()) {
7063 UInt_t R__s, R__c;
7064 Version_t R__v = b.ReadVersion(&R__s, &R__c);
7065 if (fDirectory) fDirectory->Remove(this);
7066 fDirectory = nullptr;
7067 if (R__v > 2) {
7068 b.ReadClassBuffer(TH1::Class(), this, R__v, R__s, R__c);
7069
7071 fXaxis.SetParent(this);
7072 fYaxis.SetParent(this);
7073 fZaxis.SetParent(this);
7074 TIter next(fFunctions);
7075 TObject *obj;
7076 while ((obj=next())) {
7077 if (obj->InheritsFrom(TF1::Class())) ((TF1*)obj)->SetParent(this);
7078 }
7079 return;
7080 }
7081 //process old versions before automatic schema evolution
7086 b >> fNcells;
7087 fXaxis.Streamer(b);
7088 fYaxis.Streamer(b);
7089 fZaxis.Streamer(b);
7090 fXaxis.SetParent(this);
7091 fYaxis.SetParent(this);
7092 fZaxis.SetParent(this);
7093 b >> fBarOffset;
7094 b >> fBarWidth;
7095 b >> fEntries;
7096 b >> fTsumw;
7097 b >> fTsumw2;
7098 b >> fTsumwx;
7099 b >> fTsumwx2;
7100 if (R__v < 2) {
7102 Float_t *contour=nullptr;
7103 b >> maximum; fMaximum = maximum;
7104 b >> minimum; fMinimum = minimum;
7105 b >> norm; fNormFactor = norm;
7106 Int_t n = b.ReadArray(contour);
7107 fContour.Set(n);
7108 for (Int_t i=0;i<n;i++) fContour.fArray[i] = contour[i];
7109 delete [] contour;
7110 } else {
7111 b >> fMaximum;
7112 b >> fMinimum;
7113 b >> fNormFactor;
7115 }
7116 fSumw2.Streamer(b);
7118 fFunctions->Delete();
7120 b.CheckByteCount(R__s, R__c, TH1::IsA());
7121
7122 } else {
7123 b.WriteClassBuffer(TH1::Class(),this);
7124 }
7125}
7126
7127////////////////////////////////////////////////////////////////////////////////
7128/// Print some global quantities for this histogram.
7129/// \param[in] option
7130/// - "base" is given, number of bins and ranges are also printed
7131/// - "range" is given, bin contents and errors are also printed
7132/// for all bins in the current range (default 1-->nbins)
7133/// - "all" is given, bin contents and errors are also printed
7134/// for all bins including under and overflows.
7135
7136void TH1::Print(Option_t *option) const
7137{
7138 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
7139 printf( "TH1.Print Name = %s, Entries= %d, Total sum= %g\n",GetName(),Int_t(fEntries),GetSumOfWeights());
7140 TString opt = option;
7141 opt.ToLower();
7142 Int_t all;
7143 if (opt.Contains("all")) all = 0;
7144 else if (opt.Contains("range")) all = 1;
7145 else if (opt.Contains("base")) all = 2;
7146 else return;
7147
7148 Int_t bin, binx, biny, binz;
7150 if (all == 0) {
7151 lastx = fXaxis.GetNbins()+1;
7152 if (fDimension > 1) lasty = fYaxis.GetNbins()+1;
7153 if (fDimension > 2) lastz = fZaxis.GetNbins()+1;
7154 } else {
7156 if (fDimension > 1) {firsty = fYaxis.GetFirst(); lasty = fYaxis.GetLast();}
7157 if (fDimension > 2) {firstz = fZaxis.GetFirst(); lastz = fZaxis.GetLast();}
7158 }
7159
7160 if (all== 2) {
7161 printf(" Title = %s\n", GetTitle());
7162 printf(" NbinsX= %d, xmin= %g, xmax=%g", fXaxis.GetNbins(), fXaxis.GetXmin(), fXaxis.GetXmax());
7163 if( fDimension > 1) printf(", NbinsY= %d, ymin= %g, ymax=%g", fYaxis.GetNbins(), fYaxis.GetXmin(), fYaxis.GetXmax());
7164 if( fDimension > 2) printf(", NbinsZ= %d, zmin= %g, zmax=%g", fZaxis.GetNbins(), fZaxis.GetXmin(), fZaxis.GetXmax());
7165 printf("\n");
7166 return;
7167 }
7168
7169 Double_t w,e;
7170 Double_t x,y,z;
7171 if (fDimension == 1) {
7172 for (binx=firstx;binx<=lastx;binx++) {
7175 e = GetBinError(binx);
7176 if(fSumw2.fN) printf(" fSumw[%d]=%g, x=%g, error=%g\n",binx,w,x,e);
7177 else printf(" fSumw[%d]=%g, x=%g\n",binx,w,x);
7178 }
7179 }
7180 if (fDimension == 2) {
7181 for (biny=firsty;biny<=lasty;biny++) {
7183 for (binx=firstx;binx<=lastx;binx++) {
7184 bin = GetBin(binx,biny);
7187 e = GetBinError(bin);
7188 if(fSumw2.fN) printf(" fSumw[%d][%d]=%g, x=%g, y=%g, error=%g\n",binx,biny,w,x,y,e);
7189 else printf(" fSumw[%d][%d]=%g, x=%g, y=%g\n",binx,biny,w,x,y);
7190 }
7191 }
7192 }
7193 if (fDimension == 3) {
7194 for (binz=firstz;binz<=lastz;binz++) {
7196 for (biny=firsty;biny<=lasty;biny++) {
7198 for (binx=firstx;binx<=lastx;binx++) {
7199 bin = GetBin(binx,biny,binz);
7202 e = GetBinError(bin);
7203 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);
7204 else printf(" fSumw[%d][%d][%d]=%g, x=%g, y=%g, z=%g\n",binx,biny,binz,w,x,y,z);
7205 }
7206 }
7207 }
7208 }
7209}
7210
7211////////////////////////////////////////////////////////////////////////////////
7212/// Using the current bin info, recompute the arrays for contents and errors
7213
7214void TH1::Rebuild(Option_t *)
7215{
7216 SetBinsLength();
7217 if (fSumw2.fN) {
7219 }
7220}
7221
7222////////////////////////////////////////////////////////////////////////////////
7223/// Reset this histogram: contents, errors, etc.
7224/// \param[in] option
7225/// - if "ICE" is specified, resets only Integral, Contents and Errors.
7226/// - if "ICES" is specified, resets only Integral, Contents, Errors and Statistics
7227/// This option is used
7228/// - if "M" is specified, resets also Minimum and Maximum
7229
7231{
7232 // The option "ICE" is used when extending the histogram (in ExtendAxis, LabelInflate, etc..)
7233 // The option "ICES is used in combination with the buffer (see BufferEmpty and BufferFill)
7234
7235 TString opt = option;
7236 opt.ToUpper();
7237 fSumw2.Reset();
7238 if (fIntegral) {
7239 delete [] fIntegral;
7240 fIntegral = nullptr;
7241 }
7242
7243 if (opt.Contains("M")) {
7244 SetMinimum();
7245 SetMaximum();
7246 }
7247
7248 if (opt.Contains("ICE") && !opt.Contains("S")) return;
7249
7250 // Setting fBuffer[0] = 0 is like resetting the buffer but not deleting it
7251 // But what is the sense of calling BufferEmpty() ? For making the axes ?
7252 // BufferEmpty will update contents that later will be
7253 // reset in calling TH1D::Reset. For this we need to reset the stats afterwards
7254 // It may be needed for computing the axis limits....
7255 if (fBuffer) {BufferEmpty(); fBuffer[0] = 0;}
7256
7257 // need to reset also the statistics
7258 // (needs to be done after calling BufferEmpty() )
7259 fTsumw = 0;
7260 fTsumw2 = 0;
7261 fTsumwx = 0;
7262 fTsumwx2 = 0;
7263 fEntries = 0;
7264
7265 if (opt == "ICES") return;
7266
7267
7268 TObject *stats = fFunctions->FindObject("stats");
7269 fFunctions->Remove(stats);
7270 //special logic to support the case where the same object is
7271 //added multiple times in fFunctions.
7272 //This case happens when the same object is added with different
7273 //drawing modes
7274 TObject *obj;
7275 while ((obj = fFunctions->First())) {
7276 while(fFunctions->Remove(obj)) { }
7277 delete obj;
7278 }
7279 if(stats) fFunctions->Add(stats);
7280 fContour.Set(0);
7281}
7282
7283////////////////////////////////////////////////////////////////////////////////
7284/// Save the histogram as .csv, .tsv or .txt. In case of any other extension, fall
7285/// back to TObject::SaveAs, which saves as a .C macro (but with the file name
7286/// extension specified by the user)
7287///
7288/// The Under/Overflow bins are also exported (as first and last lines)
7289/// The fist 2 columns are the lower and upper edges of the bins
7290/// Column 3 contains the bin contents
7291/// The last column contains the error in y. If errors are not present, the column
7292/// is left empty
7293///
7294/// The result can be immediately imported into Excel, gnuplot, Python or whatever,
7295/// without the needing to install pyroot, etc.
7296///
7297/// \param filename the name of the file where to store the histogram
7298/// \param option some tuning options
7299///
7300/// The file extension defines the delimiter used:
7301/// - `.csv` : comma
7302/// - `.tsv` : tab
7303/// - `.txt` : space
7304///
7305/// If option = "title" a title line is generated. If the y-axis has a title,
7306/// this title is displayed as column 3 name, otherwise, it shows "BinContent"
7307
7308void TH1::SaveAs(const char *filename, Option_t *option) const
7309{
7310 char del = '\0';
7311 TString ext = "";
7313 TString opt = option;
7314
7315 if (filename) {
7316 if (fname.EndsWith(".csv")) {
7317 del = ',';
7318 ext = "csv";
7319 } else if (fname.EndsWith(".tsv")) {
7320 del = '\t';
7321 ext = "tsv";
7322 } else if (fname.EndsWith(".txt")) {
7323 del = ' ';
7324 ext = "txt";
7325 }
7326 }
7327 if (!del) {
7329 return;
7330 }
7331 std::ofstream out;
7332 out.open(filename, std::ios::out);
7333 if (!out.good()) {
7334 Error("SaveAs", "cannot open file: %s", filename);
7335 return;
7336 }
7337 if (opt.Contains("title")) {
7338 if (std::strcmp(GetYaxis()->GetTitle(), "") == 0) {
7339 out << "# " << "BinLowEdge" << del << "BinUpEdge" << del
7340 << "BinContent"
7341 << del << "ey" << std::endl;
7342 } else {
7343 out << "# " << "BinLowEdge" << del << "BinUpEdge" << del << GetYaxis()->GetTitle() << del << "ey" << std::endl;
7344 }
7345 }
7346 if (fSumw2.fN) {
7347 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
7348 out << GetXaxis()->GetBinLowEdge(i) << del << GetXaxis()->GetBinUpEdge(i) << del << GetBinContent(i) << del
7349 << GetBinError(i) << std::endl;
7350 }
7351 } else {
7352 for (Int_t i = 0; i < fNcells; ++i) { // loop on cells (bins including underflow / overflow)
7353 out << GetXaxis()->GetBinLowEdge(i) << del << GetXaxis()->GetBinUpEdge(i) << del << GetBinContent(i) << del
7354 << std::endl;
7355 }
7356 }
7357 out.close();
7358 Info("SaveAs", "%s file: %s has been generated", ext.Data(), filename);
7359}
7360
7361////////////////////////////////////////////////////////////////////////////////
7362/// Provide variable name for histogram for saving as primitive
7363/// Histogram pointer has by default the histogram name with an incremental suffix.
7364/// If the histogram belongs to a graph or a stack the suffix is not added because
7365/// the graph and stack objects are not aware of this new name. Same thing if
7366/// the histogram is drawn with the option COLZ because the TPaletteAxis drawn
7367/// when this option is selected, does not know this new name either.
7368
7370{
7371 thread_local Int_t storeNumber = 0;
7372
7373 TString opt = option;
7374 opt.ToLower();
7375 TString histName = GetName();
7376 // for TProfile and TH2Poly also fDirectory should be tested
7377 if (!histName.Contains("Graph") && !histName.Contains("_stack_") && !opt.Contains("colz") &&
7378 (!testfdir || !fDirectory)) {
7379 storeNumber++;
7380 histName += "__";
7381 histName += storeNumber;
7382 }
7383 if (histName.IsNull())
7384 histName = "unnamed";
7385 return gInterpreter->MapCppName(histName);
7386}
7387
7388////////////////////////////////////////////////////////////////////////////////
7389/// Save primitive as a C++ statement(s) on output stream out
7390
7391void TH1::SavePrimitive(std::ostream &out, Option_t *option /*= ""*/)
7392{
7393 // empty the buffer before if it exists
7394 if (fBuffer)
7395 BufferEmpty();
7396
7398
7401 SetName(hname);
7402
7403 out <<" \n";
7404
7405 // Check if the histogram has equidistant X bins or not. If not, we
7406 // create an array holding the bins.
7407 if (GetXaxis()->GetXbins()->fN && GetXaxis()->GetXbins()->fArray)
7408 sxaxis = SavePrimitiveVector(out, hname + "_x", GetXaxis()->GetXbins()->fN, GetXaxis()->GetXbins()->fArray);
7409 // If the histogram is 2 or 3 dimensional, check if the histogram
7410 // has equidistant Y bins or not. If not, we create an array
7411 // holding the bins.
7412 if (fDimension > 1 && GetYaxis()->GetXbins()->fN && GetYaxis()->GetXbins()->fArray)
7413 syaxis = SavePrimitiveVector(out, hname + "_y", GetYaxis()->GetXbins()->fN, GetYaxis()->GetXbins()->fArray);
7414 // IF the histogram is 3 dimensional, check if the histogram
7415 // has equidistant Z bins or not. If not, we create an array
7416 // holding the bins.
7417 if (fDimension > 2 && GetZaxis()->GetXbins()->fN && GetZaxis()->GetXbins()->fArray)
7418 szaxis = SavePrimitiveVector(out, hname + "_z", GetZaxis()->GetXbins()->fN, GetZaxis()->GetXbins()->fArray);
7419
7420 const auto old_precision{out.precision()};
7421 constexpr auto max_precision{std::numeric_limits<double>::digits10 + 1};
7422 out << std::setprecision(max_precision);
7423
7424 out << " " << ClassName() << " *" << hname << " = new " << ClassName() << "(\"" << TString(savedName).ReplaceSpecialCppChars() << "\", \""
7425 << TString(GetTitle()).ReplaceSpecialCppChars() << "\", " << GetXaxis()->GetNbins();
7426 if (!sxaxis.IsNull())
7427 out << ", " << sxaxis << ".data()";
7428 else
7429 out << ", " << GetXaxis()->GetXmin() << ", " << GetXaxis()->GetXmax();
7430 if (fDimension > 1) {
7431 out << ", " << GetYaxis()->GetNbins();
7432 if (!syaxis.IsNull())
7433 out << ", " << syaxis << ".data()";
7434 else
7435 out << ", " << GetYaxis()->GetXmin() << ", " << GetYaxis()->GetXmax();
7436 }
7437 if (fDimension > 2) {
7438 out << ", " << GetZaxis()->GetNbins();
7439 if (!szaxis.IsNull())
7440 out << ", " << szaxis << ".data()";
7441 else
7442 out << ", " << GetZaxis()->GetXmin() << ", " << GetZaxis()->GetXmax();
7443 }
7444 out << ");\n";
7445
7447 Int_t numbins = 0, numerrors = 0;
7448
7449 std::vector<Double_t> content(fNcells), errors(save_errors ? fNcells : 0);
7450 for (Int_t bin = 0; bin < fNcells; bin++) {
7452 if (content[bin])
7453 numbins++;
7454 if (save_errors) {
7456 if (errors[bin])
7457 numerrors++;
7458 }
7459 }
7460
7461 if ((numbins < 100) && (numerrors < 100)) {
7462 // in case of few non-empty bins store them as before
7463 for (Int_t bin = 0; bin < fNcells; bin++) {
7464 if (content[bin])
7465 out << " " << hname << "->SetBinContent(" << bin << "," << content[bin] << ");\n";
7466 }
7467 if (save_errors)
7468 for (Int_t bin = 0; bin < fNcells; bin++) {
7469 if (errors[bin])
7470 out << " " << hname << "->SetBinError(" << bin << "," << errors[bin] << ");\n";
7471 }
7472 } else {
7473 if (numbins > 0) {
7475 out << " for (Int_t bin = 0; bin < " << fNcells << "; bin++)\n";
7476 out << " if (" << vectname << "[bin])\n";
7477 out << " " << hname << "->SetBinContent(bin, " << vectname << "[bin]);\n";
7478 }
7479 if (numerrors > 0) {
7481 out << " for (Int_t bin = 0; bin < " << fNcells << "; bin++)\n";
7482 out << " if (" << vectname << "[bin])\n";
7483 out << " " << hname << "->SetBinError(bin, " << vectname << "[bin]);\n";
7484 }
7485 }
7486
7488 out << std::setprecision(old_precision);
7489 SetName(savedName.Data());
7490}
7491
7492////////////////////////////////////////////////////////////////////////////////
7493/// Helper function for the SavePrimitive functions from TH1
7494/// or classes derived from TH1, eg TProfile, TProfile2D.
7495
7496void TH1::SavePrimitiveHelp(std::ostream &out, const char *hname, Option_t *option /*= ""*/)
7497{
7498 if (TMath::Abs(GetBarOffset()) > 1e-5)
7499 out << " " << hname << "->SetBarOffset(" << GetBarOffset() << ");\n";
7500 if (TMath::Abs(GetBarWidth() - 1) > 1e-5)
7501 out << " " << hname << "->SetBarWidth(" << GetBarWidth() << ");\n";
7502 if (fMinimum != -1111)
7503 out << " " << hname << "->SetMinimum(" << fMinimum << ");\n";
7504 if (fMaximum != -1111)
7505 out << " " << hname << "->SetMaximum(" << fMaximum << ");\n";
7506 if (fNormFactor != 0)
7507 out << " " << hname << "->SetNormFactor(" << fNormFactor << ");\n";
7508 if (fEntries != 0)
7509 out << " " << hname << "->SetEntries(" << fEntries << ");\n";
7510 if (!fDirectory)
7511 out << " " << hname << "->SetDirectory(nullptr);\n";
7512 if (TestBit(kNoStats))
7513 out << " " << hname << "->SetStats(0);\n";
7514 if (fOption.Length() != 0)
7515 out << " " << hname << "->SetOption(\n" << TString(fOption).ReplaceSpecialCppChars() << "\");\n";
7516
7517 // save contour levels
7519 if (ncontours > 0) {
7521 if (TestBit(kUserContour)) {
7522 std::vector<Double_t> levels(ncontours);
7523 for (Int_t bin = 0; bin < ncontours; bin++)
7526 }
7527 out << " " << hname << "->SetContour(" << ncontours;
7528 if (!vectname.IsNull())
7529 out << ", " << vectname << ".data()";
7530 out << ");\n";
7531 }
7532
7534
7535 // save attributes
7536 SaveFillAttributes(out, hname, -1, -1);
7537 SaveLineAttributes(out, hname, 1, 1, 1);
7538 SaveMarkerAttributes(out, hname, 1, 1, 1);
7539 fXaxis.SaveAttributes(out, hname, "->GetXaxis()");
7540 fYaxis.SaveAttributes(out, hname, "->GetYaxis()");
7541 fZaxis.SaveAttributes(out, hname, "->GetZaxis()");
7542
7544}
7545
7546////////////////////////////////////////////////////////////////////////////////
7547/// Save list of functions
7548/// Also can be used by TGraph classes
7549
7550void TH1::SavePrimitiveFunctions(std::ostream &out, const char *varname, TList *lst)
7551{
7552 thread_local Int_t funcNumber = 0;
7553
7554 TObjLink *lnk = lst ? lst->FirstLink() : nullptr;
7555 while (lnk) {
7556 auto obj = lnk->GetObject();
7557 obj->SavePrimitive(out, TString::Format("nodraw #%d\n", ++funcNumber).Data());
7558 TString objvarname = obj->GetName();
7560 if (obj->InheritsFrom(TF1::Class())) {
7562 objvarname = gInterpreter->MapCppName(objvarname);
7563 out << " " << objvarname << "->SetParent(" << varname << ");\n";
7564 } else if (obj->InheritsFrom("TPaveStats")) {
7565 objvarname = "ptstats";
7566 withopt = kFALSE; // pave stats preserve own draw options
7567 out << " " << objvarname << "->SetParent(" << varname << ");\n";
7568 } else if (obj->InheritsFrom("TPolyMarker")) {
7569 objvarname = "pmarker";
7570 }
7571
7572 out << " " << varname << "->GetListOfFunctions()->Add(" << objvarname;
7573 if (withopt)
7574 out << ",\"" << TString(lnk->GetOption()).ReplaceSpecialCppChars() << "\"";
7575 out << ");\n";
7576
7577 lnk = lnk->Next();
7578 }
7579}
7580
7581////////////////////////////////////////////////////////////////////////////////
7622 }
7623}
7624
7625////////////////////////////////////////////////////////////////////////////////
7626/// For axis = 1,2 or 3 returns the mean value of the histogram along
7627/// X,Y or Z axis.
7628///
7629/// For axis = 11, 12, 13 returns the standard error of the mean value
7630/// of the histogram along X, Y or Z axis
7631///
7632/// Note that the mean value/StdDev is computed using the bins in the currently
7633/// defined range (see TAxis::SetRange). By default the range includes
7634/// all bins from 1 to nbins included, excluding underflows and overflows.
7635/// To force the underflows and overflows in the computation, one must
7636/// call the static function TH1::StatOverflows(kTRUE) before filling
7637/// the histogram.
7638///
7639/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7640/// are calculated. By default, if no range has been set, the returned mean is
7641/// the (unbinned) one calculated at fill time. If a range has been set, however,
7642/// the mean is calculated using the bins in range, as described above; THIS
7643/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7644/// the range. To ensure that the returned mean (and all other statistics) is
7645/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7646/// See TH1::GetStats.
7647///
7648/// Return mean value of this histogram along the X axis.
7649
7650Double_t TH1::GetMean(Int_t axis) const
7651{
7652 if (axis<1 || (axis>3 && axis<11) || axis>13) return 0;
7653 Double_t stats[kNstat];
7654 for (Int_t i=4;i<kNstat;i++) stats[i] = 0;
7655 GetStats(stats);
7656 if (stats[0] == 0) return 0;
7657 if (axis<4){
7658 Int_t ax[3] = {2,4,7};
7659 return stats[ax[axis-1]]/stats[0];
7660 } else {
7661 // mean error = StdDev / sqrt( Neff )
7662 Double_t stddev = GetStdDev(axis-10);
7664 return ( neff > 0 ? stddev/TMath::Sqrt(neff) : 0. );
7665 }
7666}
7667
7668////////////////////////////////////////////////////////////////////////////////
7669/// Return standard error of mean of this histogram along the X axis.
7670///
7671/// Note that the mean value/StdDev is computed using the bins in the currently
7672/// defined range (see TAxis::SetRange). By default the range includes
7673/// all bins from 1 to nbins included, excluding underflows and overflows.
7674/// To force the underflows and overflows in the computation, one must
7675/// call the static function TH1::StatOverflows(kTRUE) before filling
7676/// the histogram.
7677///
7678/// Also note, that although the definition of standard error doesn't include the
7679/// assumption of normality, many uses of this feature implicitly assume it.
7680///
7681/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7682/// are calculated. By default, if no range has been set, the returned value is
7683/// the (unbinned) one calculated at fill time. If a range has been set, however,
7684/// the value is calculated using the bins in range, as described above; THIS
7685/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7686/// the range. To ensure that the returned value (and all other statistics) is
7687/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7688/// See TH1::GetStats.
7689
7691{
7692 return GetMean(axis+10);
7693}
7694
7695////////////////////////////////////////////////////////////////////////////////
7696/// Returns the Standard Deviation (Sigma).
7697/// The Sigma estimate is computed as
7698/// \f[
7699/// \sqrt{\frac{1}{N}(\sum(x_i-x_{mean})^2)}
7700/// \f]
7701/// For axis = 1,2 or 3 returns the Sigma value of the histogram along
7702/// X, Y or Z axis
7703/// For axis = 11, 12 or 13 returns the error of StdDev estimation along
7704/// X, Y or Z axis for Normal distribution
7705///
7706/// Note that the mean value/sigma is computed using the bins in the currently
7707/// defined range (see TAxis::SetRange). By default the range includes
7708/// all bins from 1 to nbins included, excluding underflows and overflows.
7709/// To force the underflows and overflows in the computation, one must
7710/// call the static function TH1::StatOverflows(kTRUE) before filling
7711/// the histogram.
7712///
7713/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7714/// are calculated. By default, if no range has been set, the returned standard
7715/// deviation is the (unbinned) one calculated at fill time. If a range has been
7716/// set, however, the standard deviation is calculated using the bins in range,
7717/// as described above; THIS IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use
7718/// TAxis::SetRange(0, 0) to unset the range. To ensure that the returned standard
7719/// deviation (and all other statistics) is always that of the binned data stored
7720/// in the histogram, call TH1::ResetStats. See TH1::GetStats.
7721
7722Double_t TH1::GetStdDev(Int_t axis) const
7723{
7724 if (axis<1 || (axis>3 && axis<11) || axis>13) return 0;
7725
7726 Double_t x, stddev2, stats[kNstat];
7727 for (Int_t i=4;i<kNstat;i++) stats[i] = 0;
7728 GetStats(stats);
7729 if (stats[0] == 0) return 0;
7730 Int_t ax[3] = {2,4,7};
7731 Int_t axm = ax[axis%10 - 1];
7732 x = stats[axm]/stats[0];
7733 // for negative stddev (e.g. when having negative weights) - return stdev=0
7734 stddev2 = TMath::Max( stats[axm+1]/stats[0] -x*x, 0.0 );
7735 if (axis<10)
7736 return TMath::Sqrt(stddev2);
7737 else {
7738 // The right formula for StdDev error depends on 4th momentum (see Kendall-Stuart Vol 1 pag 243)
7739 // formula valid for only gaussian distribution ( 4-th momentum = 3 * sigma^4 )
7741 return ( neff > 0 ? TMath::Sqrt(stddev2/(2*neff) ) : 0. );
7742 }
7743}
7744
7745////////////////////////////////////////////////////////////////////////////////
7746/// Return error of standard deviation estimation for Normal distribution
7747///
7748/// Note that the mean value/StdDev is computed using the bins in the currently
7749/// defined range (see TAxis::SetRange). By default the range includes
7750/// all bins from 1 to nbins included, excluding underflows and overflows.
7751/// To force the underflows and overflows in the computation, one must
7752/// call the static function TH1::StatOverflows(kTRUE) before filling
7753/// the histogram.
7754///
7755/// Value returned is standard deviation of sample standard deviation.
7756/// Note that it is an approximated value which is valid only in the case that the
7757/// original data distribution is Normal. The correct one would require
7758/// the 4-th momentum value, which cannot be accurately estimated from a histogram since
7759/// the x-information for all entries is not kept.
7760///
7761/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7762/// are calculated. By default, if no range has been set, the returned value is
7763/// the (unbinned) one calculated at fill time. If a range has been set, however,
7764/// the value is calculated using the bins in range, as described above; THIS
7765/// IS TRUE EVEN IF THE RANGE INCLUDES ALL BINS--use TAxis::SetRange(0, 0) to unset
7766/// the range. To ensure that the returned value (and all other statistics) is
7767/// always that of the binned data stored in the histogram, call TH1::ResetStats.
7768/// See TH1::GetStats.
7769
7771{
7772 return GetStdDev(axis+10);
7773}
7774
7775////////////////////////////////////////////////////////////////////////////////
7776/// - For axis = 1, 2 or 3 returns skewness of the histogram along x, y or z axis.
7777/// - For axis = 11, 12 or 13 returns the approximate standard error of skewness
7778/// of the histogram along x, y or z axis
7779///
7780///Note, that since third and fourth moment are not calculated
7781///at the fill time, skewness and its standard error are computed bin by bin
7782///
7783/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7784/// are calculated. See TH1::GetMean and TH1::GetStdDev.
7785
7787{
7788
7789 if (axis > 0 && axis <= 3){
7790
7791 Double_t mean = GetMean(axis);
7792 Double_t stddev = GetStdDev(axis);
7794
7801 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7804 if (firstBinX == 1) firstBinX = 0;
7805 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7806 }
7808 if (firstBinY == 1) firstBinY = 0;
7809 if (lastBinY == fYaxis.GetNbins() ) lastBinY += 1;
7810 }
7812 if (firstBinZ == 1) firstBinZ = 0;
7813 if (lastBinZ == fZaxis.GetNbins() ) lastBinZ += 1;
7814 }
7815 }
7816
7817 Double_t x = 0;
7818 Double_t sum=0;
7819 Double_t np=0;
7820 for (Int_t binx = firstBinX; binx <= lastBinX; binx++) {
7821 for (Int_t biny = firstBinY; biny <= lastBinY; biny++) {
7822 for (Int_t binz = firstBinZ; binz <= lastBinZ; binz++) {
7823 if (axis==1 ) x = fXaxis.GetBinCenter(binx);
7824 else if (axis==2 ) x = fYaxis.GetBinCenter(biny);
7825 else if (axis==3 ) x = fZaxis.GetBinCenter(binz);
7827 np+=w;
7828 sum+=w*(x-mean)*(x-mean)*(x-mean);
7829 }
7830 }
7831 }
7832 sum/=np*stddev3;
7833 return sum;
7834 }
7835 else if (axis > 10 && axis <= 13) {
7836 //compute standard error of skewness
7837 // assume parent normal distribution use formula from Kendall-Stuart, Vol 1 pag 243, second edition
7839 return ( neff > 0 ? TMath::Sqrt(6./neff ) : 0. );
7840 }
7841 else {
7842 Error("GetSkewness", "illegal value of parameter");
7843 return 0;
7844 }
7845}
7846
7847////////////////////////////////////////////////////////////////////////////////
7848/// - For axis =1, 2 or 3 returns kurtosis of the histogram along x, y or z axis.
7849/// Kurtosis(gaussian(0, 1)) = 0.
7850/// - For axis =11, 12 or 13 returns the approximate standard error of kurtosis
7851/// of the histogram along x, y or z axis
7852////
7853/// Note, that since third and fourth moment are not calculated
7854/// at the fill time, kurtosis and its standard error are computed bin by bin
7855///
7856/// IMPORTANT NOTE: The returned value depends on how the histogram statistics
7857/// are calculated. See TH1::GetMean and TH1::GetStdDev.
7858
7860{
7861 if (axis > 0 && axis <= 3){
7862
7863 Double_t mean = GetMean(axis);
7864 Double_t stddev = GetStdDev(axis);
7866
7873 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7876 if (firstBinX == 1) firstBinX = 0;
7877 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7878 }
7880 if (firstBinY == 1) firstBinY = 0;
7881 if (lastBinY == fYaxis.GetNbins() ) lastBinY += 1;
7882 }
7884 if (firstBinZ == 1) firstBinZ = 0;
7885 if (lastBinZ == fZaxis.GetNbins() ) lastBinZ += 1;
7886 }
7887 }
7888
7889 Double_t x = 0;
7890 Double_t sum=0;
7891 Double_t np=0;
7892 for (Int_t binx = firstBinX; binx <= lastBinX; binx++) {
7893 for (Int_t biny = firstBinY; biny <= lastBinY; biny++) {
7894 for (Int_t binz = firstBinZ; binz <= lastBinZ; binz++) {
7895 if (axis==1 ) x = fXaxis.GetBinCenter(binx);
7896 else if (axis==2 ) x = fYaxis.GetBinCenter(biny);
7897 else if (axis==3 ) x = fZaxis.GetBinCenter(binz);
7899 np+=w;
7900 sum+=w*(x-mean)*(x-mean)*(x-mean)*(x-mean);
7901 }
7902 }
7903 }
7904 sum/=(np*stddev4);
7905 return sum-3;
7906
7907 } else if (axis > 10 && axis <= 13) {
7908 //compute standard error of skewness
7909 // assume parent normal distribution use formula from Kendall-Stuart, Vol 1 pag 243, second edition
7911 return ( neff > 0 ? TMath::Sqrt(24./neff ) : 0. );
7912 }
7913 else {
7914 Error("GetKurtosis", "illegal value of parameter");
7915 return 0;
7916 }
7917}
7918
7919////////////////////////////////////////////////////////////////////////////////
7920/// fill the array stats from the contents of this histogram
7921/// The array stats must be correctly dimensioned in the calling program.
7922///
7923/// ~~~ {.cpp}
7924/// stats[0] = sumw
7925/// stats[1] = sumw2
7926/// stats[2] = sumwx
7927/// stats[3] = sumwx2
7928/// ~~~
7929///
7930/// If no axis-subrange is specified (via TAxis::SetRange), the array stats
7931/// is simply a copy of the statistics quantities computed at filling time.
7932/// If a sub-range is specified, the function recomputes these quantities
7933/// from the bin contents in the current axis range.
7934///
7935/// IMPORTANT NOTE: This means that the returned statistics are context-dependent.
7936/// If TAxis::kAxisRange, the returned statistics are dependent on the binning;
7937/// otherwise, they are a copy of the histogram statistics computed at fill time,
7938/// which are unbinned by default (calling TH1::ResetStats forces them to use
7939/// binned statistics). You can reset TAxis::kAxisRange using TAxis::SetRange(0, 0).
7940///
7941/// Note that the mean value/StdDev is computed using the bins in the currently
7942/// defined range (see TAxis::SetRange). By default the range includes
7943/// all bins from 1 to nbins included, excluding underflows and overflows.
7944/// To force the underflows and overflows in the computation, one must
7945/// call the static function TH1::StatOverflows(kTRUE) before filling
7946/// the histogram.
7947
7948void TH1::GetStats(Double_t *stats) const
7949{
7950 if (fBuffer) ((TH1*)this)->BufferEmpty();
7951
7952 // Loop on bins (possibly including underflows/overflows)
7953 Int_t bin, binx;
7954 Double_t w,err;
7955 Double_t x;
7956 // identify the case of labels with extension of axis range
7957 // in this case the statistics in x does not make any sense
7958 Bool_t labelHist = ((const_cast<TAxis&>(fXaxis)).GetLabels() && fXaxis.CanExtend() );
7959 // fTsumw == 0 && fEntries > 0 is a special case when uses SetBinContent or calls ResetStats before
7960 if ( (fTsumw == 0 && fEntries > 0) || fXaxis.TestBit(TAxis::kAxisRange) ) {
7961 for (bin=0;bin<4;bin++) stats[bin] = 0;
7962
7965 // include underflow/overflow if TH1::StatOverflows(kTRUE) in case no range is set on the axis
7967 if (firstBinX == 1) firstBinX = 0;
7968 if (lastBinX == fXaxis.GetNbins() ) lastBinX += 1;
7969 }
7970 for (binx = firstBinX; binx <= lastBinX; binx++) {
7972 //w = TMath::Abs(RetrieveBinContent(binx));
7973 // not sure what to do here if w < 0
7975 err = TMath::Abs(GetBinError(binx));
7976 stats[0] += w;
7977 stats[1] += err*err;
7978 // statistics in x makes sense only for not labels histograms
7979 if (!labelHist) {
7980 stats[2] += w*x;
7981 stats[3] += w*x*x;
7982 }
7983 }
7984 // if (stats[0] < 0) {
7985 // // in case total is negative do something ??
7986 // stats[0] = 0;
7987 // }
7988 } else {
7989 stats[0] = fTsumw;
7990 stats[1] = fTsumw2;
7991 stats[2] = fTsumwx;
7992 stats[3] = fTsumwx2;
7993 }
7994}
7995
7996////////////////////////////////////////////////////////////////////////////////
7997/// Replace current statistics with the values in array stats
7998
7999void TH1::PutStats(Double_t *stats)
8000{
8001 fTsumw = stats[0];
8002 fTsumw2 = stats[1];
8003 fTsumwx = stats[2];
8004 fTsumwx2 = stats[3];
8005}
8006
8007////////////////////////////////////////////////////////////////////////////////
8008/// Reset the statistics including the number of entries
8009/// and replace with values calculated from bin content
8010///
8011/// The number of entries is set to the total bin content or (in case of weighted histogram)
8012/// to number of effective entries
8013///
8014/// \note By default, before calling this function, statistics are those
8015/// computed at fill time, which are unbinned. See TH1::GetStats.
8016
8017void TH1::ResetStats()
8018{
8019 Double_t stats[kNstat] = {0};
8020 fTsumw = 0;
8021 fEntries = 1; // to force re-calculation of the statistics in TH1::GetStats
8022 GetStats(stats);
8023 PutStats(stats);
8024 // histogram entries should include always underflows and overflows
8027 else {
8028 Double_t sumw2 = 0;
8029 Double_t * p_sumw2 = (fSumw2.fN > 0) ? &sumw2 : nullptr;
8031 // use effective entries for weighted histograms: (sum_w) ^2 / sum_w2
8033 }
8034}
8035
8036////////////////////////////////////////////////////////////////////////////////
8037/// Return the sum of all weights and optionally also the sum of weight squares
8038/// \param includeOverflow true to include under/overflows bins, false to exclude those.
8039/// \note Different from TH1::GetSumOfWeights, that always excludes those
8040
8042{
8043 if (fBuffer) const_cast<TH1*>(this)->BufferEmpty();
8044
8045 const Int_t start = (includeOverflow ? 0 : 1);
8046 const Int_t lastX = fXaxis.GetNbins() + (includeOverflow ? 1 : 0);
8047 const Int_t lastY = (fDimension > 1) ? (fYaxis.GetNbins() + (includeOverflow ? 1 : 0)) : start;
8048 const Int_t lastZ = (fDimension > 2) ? (fZaxis.GetNbins() + (includeOverflow ? 1 : 0)) : start;
8049 Double_t sum =0;
8050 Double_t sum2 = 0;
8051 for(auto binz = start; binz <= lastZ; binz++) {
8052 for(auto biny = start; biny <= lastY; biny++) {
8053 for(auto binx = start; binx <= lastX; binx++) {
8054 const auto bin = GetBin(binx, biny, binz);
8057 }
8058 }
8059 }
8060 if (sumWeightSquare) {
8061 if (fSumw2.fN > 0)
8063 else
8065 }
8066 return sum;
8067}
8068
8069////////////////////////////////////////////////////////////////////////////////
8070///Return integral of bin contents. Only bins in the bins range are considered.
8071///
8072/// By default the integral is computed as the sum of bin contents in the range.
8073/// if option "width" is specified, the integral is the sum of
8074/// the bin contents multiplied by the bin width in x.
8075
8077{
8079}
8080
8081////////////////////////////////////////////////////////////////////////////////
8082/// Return integral of bin contents in range [binx1,binx2].
8083///
8084/// By default the integral is computed as the sum of bin contents in the range.
8085/// if option "width" is specified, the integral is the sum of
8086/// the bin contents multiplied by the bin width in x.
8087
8089{
8090 double err = 0;
8091 return DoIntegral(binx1,binx2,0,-1,0,-1,err,option);
8092}
8093
8094////////////////////////////////////////////////////////////////////////////////
8095/// Return integral of bin contents in range [binx1,binx2] and its error.
8096///
8097/// By default the integral is computed as the sum of bin contents in the range.
8098/// if option "width" is specified, the integral is the sum of
8099/// the bin contents multiplied by the bin width in x.
8100/// the error is computed using error propagation from the bin errors assuming that
8101/// all the bins are uncorrelated
8102
8104{
8105 return DoIntegral(binx1,binx2,0,-1,0,-1,error,option,kTRUE);
8106}
8107
8108////////////////////////////////////////////////////////////////////////////////
8109/// Internal function compute integral and optionally the error between the limits
8110/// specified by the bin number values working for all histograms (1D, 2D and 3D)
8111
8113 Option_t *option, Bool_t doError) const
8114{
8115 if (fBuffer) ((TH1*)this)->BufferEmpty();
8116
8117 Int_t nx = GetNbinsX() + 2;
8118 if (binx1 < 0) binx1 = 0;
8119 if (binx2 >= nx || binx2 < binx1) binx2 = nx - 1;
8120
8121 if (GetDimension() > 1) {
8122 Int_t ny = GetNbinsY() + 2;
8123 if (biny1 < 0) biny1 = 0;
8124 if (biny2 >= ny || biny2 < biny1) biny2 = ny - 1;
8125 } else {
8126 biny1 = 0; biny2 = 0;
8127 }
8128
8129 if (GetDimension() > 2) {
8130 Int_t nz = GetNbinsZ() + 2;
8131 if (binz1 < 0) binz1 = 0;
8132 if (binz2 >= nz || binz2 < binz1) binz2 = nz - 1;
8133 } else {
8134 binz1 = 0; binz2 = 0;
8135 }
8136
8137 // - Loop on bins in specified range
8138 TString opt = option;
8139 opt.ToLower();
8141 if (opt.Contains("width")) width = kTRUE;
8142
8143
8144 Double_t dx = 1., dy = .1, dz =.1;
8145 Double_t integral = 0;
8146 Double_t igerr2 = 0;
8147 for (Int_t binx = binx1; binx <= binx2; ++binx) {
8148 if (width) dx = fXaxis.GetBinWidth(binx);
8149 for (Int_t biny = biny1; biny <= biny2; ++biny) {
8150 if (width) dy = fYaxis.GetBinWidth(biny);
8151 for (Int_t binz = binz1; binz <= binz2; ++binz) {
8153 Double_t dv = 0.0;
8154 if (width) {
8156 dv = dx * dy * dz;
8157 integral += RetrieveBinContent(bin) * dv;
8158 } else {
8159 integral += RetrieveBinContent(bin);
8160 }
8161 if (doError) {
8164 }
8165 }
8166 }
8167 }
8168
8169 if (doError) error = TMath::Sqrt(igerr2);
8170 return integral;
8171}
8172
8173////////////////////////////////////////////////////////////////////////////////
8174/// Statistical test of compatibility in shape between
8175/// this histogram and h2, using the Anderson-Darling 2 sample test.
8176///
8177/// The AD 2 sample test formula are derived from the paper
8178/// F.W Scholz, M.A. Stephens "k-Sample Anderson-Darling Test".
8179///
8180/// The test is implemented in root in the ROOT::Math::GoFTest class
8181/// It is the same formula ( (6) in the paper), and also shown in
8182/// [this preprint](http://arxiv.org/pdf/0804.0380v1.pdf)
8183///
8184/// Binned data are considered as un-binned data
8185/// with identical observation happening in the bin center.
8186///
8187/// \param[in] h2 Pointer to 1D histogram
8188/// \param[in] option is a character string to specify options
8189/// - "D" Put out a line of "Debug" printout
8190/// - "T" Return the normalized A-D test statistic
8191///
8192/// - Note1: Underflow and overflow are not considered in the test
8193/// - Note2: The test works only for un-weighted histogram (i.e. representing counts)
8194/// - Note3: The histograms are not required to have the same X axis
8195/// - Note4: The test works only for 1-dimensional histograms
8196
8198{
8199 Double_t advalue = 0;
8201
8202 TString opt = option;
8203 opt.ToUpper();
8204 if (opt.Contains("D") ) {
8205 printf(" AndersonDarlingTest Prob = %g, AD TestStatistic = %g\n",pvalue,advalue);
8206 }
8207 if (opt.Contains("T") ) return advalue;
8208
8209 return pvalue;
8210}
8211
8212////////////////////////////////////////////////////////////////////////////////
8213/// Same function as above but returning also the test statistic value
8214
8216{
8217 if (GetDimension() != 1 || h2->GetDimension() != 1) {
8218 Error("AndersonDarlingTest","Histograms must be 1-D");
8219 return -1;
8220 }
8221
8222 // empty the buffer. Probably we could add as an unbinned test
8223 if (fBuffer) ((TH1*)this)->BufferEmpty();
8224
8225 // use the BinData class
8228
8229 ROOT::Fit::FillData(data1, this, nullptr);
8230 ROOT::Fit::FillData(data2, h2, nullptr);
8231
8232 double pvalue;
8234
8235 return pvalue;
8236}
8237
8238////////////////////////////////////////////////////////////////////////////////
8239/// Statistical test of compatibility in shape between
8240/// this histogram and h2, using Kolmogorov test.
8241/// Note that the KolmogorovTest (KS) test should in theory be used only for unbinned data
8242/// and not for binned data as in the case of the histogram (see NOTE 3 below).
8243/// So, before using this method blindly, read the NOTE 3.
8244///
8245/// Default: Ignore under- and overflow bins in comparison
8246///
8247/// \param[in] h2 histogram
8248/// \param[in] option is a character string to specify options
8249/// - "U" include Underflows in test (also for 2-dim)
8250/// - "O" include Overflows (also valid for 2-dim)
8251/// - "N" include comparison of normalizations
8252/// - "D" Put out a line of "Debug" printout
8253/// - "M" Return the Maximum Kolmogorov distance instead of prob
8254/// - "X" Run the pseudo experiments post-processor with the following procedure:
8255/// make pseudoexperiments based on random values from the parent distribution,
8256/// compare the KS distance of the pseudoexperiment to the parent
8257/// distribution, and count all the KS values above the value
8258/// obtained from the original data to Monte Carlo distribution.
8259/// The number of pseudo-experiments nEXPT is by default 1000, and
8260/// it can be changed by specifying the option as "X=number",
8261/// for example "X=10000" for 10000 toys.
8262/// The function returns the probability.
8263/// (thanks to Ben Kilminster to submit this procedure). Note that
8264/// this option "X" is much slower.
8265///
8266/// The returned function value is the probability of test
8267/// (much less than one means NOT compatible)
8268///
8269/// Code adapted by Rene Brun from original HBOOK routine HDIFF
8270///
8271/// NOTE1
8272/// A good description of the Kolmogorov test can be seen at:
8273/// http://www.itl.nist.gov/div898/handbook/eda/section3/eda35g.htm
8274///
8275/// NOTE2
8276/// see also alternative function TH1::Chi2Test
8277/// The Kolmogorov test is assumed to give better results than Chi2Test
8278/// in case of histograms with low statistics.
8279///
8280/// NOTE3 (Jan Conrad, Fred James)
8281/// "The returned value PROB is calculated such that it will be
8282/// uniformly distributed between zero and one for compatible histograms,
8283/// provided the data are not binned (or the number of bins is very large
8284/// compared with the number of events). Users who have access to unbinned
8285/// data and wish exact confidence levels should therefore not put their data
8286/// into histograms, but should call directly TMath::KolmogorovTest. On
8287/// the other hand, since TH1 is a convenient way of collecting data and
8288/// saving space, this function has been provided. However, the values of
8289/// PROB for binned data will be shifted slightly higher than expected,
8290/// depending on the effects of the binning. For example, when comparing two
8291/// uniform distributions of 500 events in 100 bins, the values of PROB,
8292/// instead of being exactly uniformly distributed between zero and one, have
8293/// a mean value of about 0.56. We can apply a useful
8294/// rule: As long as the bin width is small compared with any significant
8295/// physical effect (for example the experimental resolution) then the binning
8296/// cannot have an important effect. Therefore, we believe that for all
8297/// practical purposes, the probability value PROB is calculated correctly
8298/// provided the user is aware that:
8299///
8300/// 1. The value of PROB should not be expected to have exactly the correct
8301/// distribution for binned data.
8302/// 2. The user is responsible for seeing to it that the bin widths are
8303/// small compared with any physical phenomena of interest.
8304/// 3. The effect of binning (if any) is always to make the value of PROB
8305/// slightly too big. That is, setting an acceptance criterion of (PROB>0.05
8306/// will assure that at most 5% of truly compatible histograms are rejected,
8307/// and usually somewhat less."
8308///
8309/// Note also that for GoF test of unbinned data ROOT provides also the class
8310/// ROOT::Math::GoFTest. The class has also method for doing one sample tests
8311/// (i.e. comparing the data with a given distribution).
8312
8314{
8315 TString opt = option;
8316 opt.ToUpper();
8317
8318 Double_t prob = 0;
8319 TH1 *h1 = (TH1*)this;
8320 if (h2 == nullptr) return 0;
8321 const TAxis *axis1 = h1->GetXaxis();
8322 const TAxis *axis2 = h2->GetXaxis();
8323 Int_t ncx1 = axis1->GetNbins();
8324 Int_t ncx2 = axis2->GetNbins();
8325
8326 // Check consistency of dimensions
8327 if (h1->GetDimension() != 1 || h2->GetDimension() != 1) {
8328 Error("KolmogorovTest","Histograms must be 1-D\n");
8329 return 0;
8330 }
8331
8332 // Check consistency in number of channels
8333 if (ncx1 != ncx2) {
8334 Error("KolmogorovTest","Histograms have different number of bins, %d and %d\n",ncx1,ncx2);
8335 return 0;
8336 }
8337
8338 // empty the buffer. Probably we could add as an unbinned test
8339 if (fBuffer) ((TH1*)this)->BufferEmpty();
8340
8341 // Check consistency in bin edges
8342 for(Int_t i = 1; i <= axis1->GetNbins() + 1; ++i) {
8343 if(!TMath::AreEqualRel(axis1->GetBinLowEdge(i), axis2->GetBinLowEdge(i), 1.E-15)) {
8344 Error("KolmogorovTest","Histograms are not consistent: they have different bin edges");
8345 return 0;
8346 }
8347 }
8348
8351 Double_t sum1 = 0, sum2 = 0;
8352 Double_t ew1, ew2, w1 = 0, w2 = 0;
8353 Int_t bin;
8354 Int_t ifirst = 1;
8355 Int_t ilast = ncx1;
8356 // integral of all bins (use underflow/overflow if option)
8357 if (opt.Contains("U")) ifirst = 0;
8358 if (opt.Contains("O")) ilast = ncx1 +1;
8359 for (bin = ifirst; bin <= ilast; bin++) {
8361 sum2 += h2->RetrieveBinContent(bin);
8362 ew1 = h1->GetBinError(bin);
8363 ew2 = h2->GetBinError(bin);
8364 w1 += ew1*ew1;
8365 w2 += ew2*ew2;
8366 }
8367 if (sum1 == 0) {
8368 Error("KolmogorovTest","Histogram1 %s integral is zero\n",h1->GetName());
8369 return 0;
8370 }
8371 if (sum2 == 0) {
8372 Error("KolmogorovTest","Histogram2 %s integral is zero\n",h2->GetName());
8373 return 0;
8374 }
8375
8376 // calculate the effective entries.
8377 // the case when errors are zero (w1 == 0 or w2 ==0) are equivalent to
8378 // compare to a function. In that case the rescaling is done only on sqrt(esum2) or sqrt(esum1)
8379 Double_t esum1 = 0, esum2 = 0;
8380 if (w1 > 0)
8381 esum1 = sum1 * sum1 / w1;
8382 else
8383 afunc1 = kTRUE; // use later for calculating z
8384
8385 if (w2 > 0)
8386 esum2 = sum2 * sum2 / w2;
8387 else
8388 afunc2 = kTRUE; // use later for calculating z
8389
8390 if (afunc2 && afunc1) {
8391 Error("KolmogorovTest","Errors are zero for both histograms\n");
8392 return 0;
8393 }
8394
8395
8396 Double_t s1 = 1/sum1;
8397 Double_t s2 = 1/sum2;
8398
8399 // Find largest difference for Kolmogorov Test
8400 Double_t dfmax =0, rsum1 = 0, rsum2 = 0;
8401
8402 for (bin=ifirst;bin<=ilast;bin++) {
8406 }
8407
8408 // Get Kolmogorov probability
8409 Double_t z, prb1=0, prb2=0, prb3=0;
8410
8411 // case h1 is exact (has zero errors)
8412 if (afunc1)
8413 z = dfmax*TMath::Sqrt(esum2);
8414 // case h2 has zero errors
8415 else if (afunc2)
8416 z = dfmax*TMath::Sqrt(esum1);
8417 else
8418 // for comparison between two data sets
8420
8422
8423 // option N to combine normalization makes sense if both afunc1 and afunc2 are false
8424 if (opt.Contains("N") && !(afunc1 || afunc2 ) ) {
8425 // Combine probabilities for shape and normalization,
8426 prb1 = prob;
8429 prb2 = TMath::Prob(chi2,1);
8430 // see Eadie et al., section 11.6.2
8431 if (prob > 0 && prb2 > 0) prob *= prb2*(1-TMath::Log(prob*prb2));
8432 else prob = 0;
8433 }
8434 // X option. Run Pseudo-experiments to determine NULL distribution of the
8435 // KS distance. We can find the probability from the number of pseudo-experiment that have a
8436 // KS distance larger than the one opbserved in the data.
8437 // We use the histogram with the largest statistics as a parent distribution for the NULL.
8438 // Note if one histogram has zero errors is considered as a function. In that case we use it
8439 // as parent distribution for the toys.
8440 //
8441 Int_t nEXPT = 1000;
8442 if (opt.Contains("X")) {
8443 // get number of pseudo-experiment of specified
8444 if (opt.Contains("X=")) {
8445 int numpos = opt.Index("X=") + 2; // 2 is length of X=
8446 int numlen = 0;
8447 int len = opt.Length();
8448 while( (numpos+numlen<len) && isdigit(opt[numpos+numlen]) )
8449 numlen++;
8450 TString snum = opt(numpos,numlen);
8451 int num = atoi(snum.Data());
8452 if (num <= 0)
8453 Warning("KolmogorovTest","invalid number of toys given: %d - use 1000",num);
8454 else
8455 nEXPT = num;
8456 }
8457
8459 TH1D hparent;
8460 // we cannot have afunc1 and func2 both True
8461 if (afunc1 || esum1 > esum2 ) h1->Copy(hparent);
8462 else h2->Copy(hparent);
8463
8464 // copy h1Expt from h1 and h2. It is just needed to get the correct binning
8465
8466
8467 if (hparent.GetMinimum() < 0.0) {
8468 // we need to create a new histogram
8469 // With negative bins we can't draw random samples in a meaningful way.
8470 Warning("KolmogorovTest", "Detected bins with negative weights, these have been ignored and output might be "
8471 "skewed. Reduce number of bins for histogram?");
8472 while (hparent.GetMinimum() < 0.0) {
8473 Int_t idx = hparent.GetMinimumBin();
8474 hparent.SetBinContent(idx, 0.0);
8475 }
8476 }
8477
8478 // make nEXPT experiments (this should be a parameter)
8479 prb3 = 0;
8480 TH1D h1Expt;
8481 h1->Copy(h1Expt);
8482 TH1D h2Expt;
8483 h1->Copy(h2Expt);
8484 // loop on pseudoexperients and generate the two histograms h1Expt and h2Expt according to the
8485 // parent distribution. In case the parent distribution is not an histogram but a function randomize only one
8486 // histogram
8487 for (Int_t i=0; i < nEXPT; i++) {
8488 if (!afunc1) {
8489 h1Expt.Reset();
8490 h1Expt.FillRandom(&hparent, (Int_t)esum1);
8491 }
8492 if (!afunc2) {
8493 h2Expt.Reset();
8494 h2Expt.FillRandom(&hparent, (Int_t)esum2);
8495 }
8496 // note we cannot have both afunc1 and afunc2 to be true
8497 if (afunc1)
8498 dSEXPT = hparent.KolmogorovTest(&h2Expt,"M");
8499 else if (afunc2)
8500 dSEXPT = hparent.KolmogorovTest(&h1Expt,"M");
8501 else
8502 dSEXPT = h1Expt.KolmogorovTest(&h2Expt,"M");
8503 // count number of cases toy KS distance (TS) is larger than oberved one
8504 if (dSEXPT>dfmax) prb3 += 1.0;
8505 }
8506 // compute p-value
8507 prb3 /= (Double_t)nEXPT;
8508 }
8509
8510
8511 // debug printout
8512 if (opt.Contains("D")) {
8513 printf(" Kolmo Prob h1 = %s, sum bin content =%g effective entries =%g\n",h1->GetName(),sum1,esum1);
8514 printf(" Kolmo Prob h2 = %s, sum bin content =%g effective entries =%g\n",h2->GetName(),sum2,esum2);
8515 printf(" Kolmo Prob = %g, Max Dist = %g\n",prob,dfmax);
8516 if (opt.Contains("N"))
8517 printf(" Kolmo Prob = %f for shape alone, =%f for normalisation alone\n",prb1,prb2);
8518 if (opt.Contains("X"))
8519 printf(" Kolmo Prob = %f with %d pseudo-experiments\n",prb3,nEXPT);
8520 }
8521 // This numerical error condition should never occur:
8522 if (TMath::Abs(rsum1-1) > 0.002) Warning("KolmogorovTest","Numerical problems with h1=%s\n",h1->GetName());
8523 if (TMath::Abs(rsum2-1) > 0.002) Warning("KolmogorovTest","Numerical problems with h2=%s\n",h2->GetName());
8524
8525 if(opt.Contains("M")) return dfmax;
8526 else if(opt.Contains("X")) return prb3;
8527 else return prob;
8528}
8529
8530////////////////////////////////////////////////////////////////////////////////
8531/// Replace bin contents by the contents of array content
8532
8533void TH1::SetContent(const Double_t *content)
8534{
8535 fEntries = fNcells;
8536 fTsumw = 0;
8537 for (Int_t i = 0; i < fNcells; ++i) UpdateBinContent(i, content[i]);
8538}
8539
8540////////////////////////////////////////////////////////////////////////////////
8541/// Return contour values into array levels if pointer levels is non zero.
8542///
8543/// The function returns the number of contour levels.
8544/// see GetContourLevel to return one contour only
8545
8547{
8549 if (levels) {
8550 if (nlevels == 0) {
8551 nlevels = 20;
8553 } else {
8555 }
8556 for (Int_t level=0; level<nlevels; level++) levels[level] = fContour.fArray[level];
8557 }
8558 return nlevels;
8559}
8560
8561////////////////////////////////////////////////////////////////////////////////
8562/// Return value of contour number level.
8563/// Use GetContour to return the array of all contour levels
8564
8566{
8567 return (level >= 0 && level < fContour.fN) ? fContour.fArray[level] : 0.0;
8568}
8569
8570////////////////////////////////////////////////////////////////////////////////
8571/// Return the value of contour number "level" in Pad coordinates.
8572/// ie: if the Pad is in log scale along Z it returns le log of the contour level
8573/// value. See GetContour to return the array of all contour levels
8574
8576{
8577 if (level <0 || level >= fContour.fN) return 0;
8578 Double_t zlevel = fContour.fArray[level];
8579
8580 // In case of user defined contours and Pad in log scale along Z,
8581 // fContour.fArray doesn't contain the log of the contour whereas it does
8582 // in case of equidistant contours.
8583 if (gPad && gPad->GetLogz() && TestBit(kUserContour)) {
8584 if (zlevel <= 0) return 0;
8586 }
8587 return zlevel;
8588}
8589
8590////////////////////////////////////////////////////////////////////////////////
8591/// Set the maximum number of entries to be kept in the buffer.
8592
8593void TH1::SetBuffer(Int_t bufsize, Option_t * /*option*/)
8594{
8595 if (fBuffer) {
8596 BufferEmpty();
8597 delete [] fBuffer;
8598 fBuffer = nullptr;
8599 }
8600 if (bufsize <= 0) {
8601 fBufferSize = 0;
8602 return;
8603 }
8604 if (bufsize < 100) bufsize = 100;
8605 fBufferSize = 1 + bufsize*(fDimension+1);
8607 memset(fBuffer, 0, sizeof(Double_t)*fBufferSize);
8608}
8609
8610////////////////////////////////////////////////////////////////////////////////
8611/// Set the number and values of contour levels.
8612///
8613/// By default the number of contour levels is set to 20. The contours values
8614/// in the array "levels" should be specified in increasing order.
8615///
8616/// if argument levels = 0 or missing, `nlevels` equidistant contours are computed
8617/// between `zmin` and `zmax - dz`, both included, with step
8618/// `dz = (zmax - zmin)/nlevels`. Note that contour lines are not centered, but
8619/// contour surfaces (when drawing with `COLZ`) will be, since contour color `i` covers
8620/// the region of values between contour line `i` and `i+1`.
8621
8623{
8624 Int_t level;
8626 if (nlevels <=0 ) {
8627 fContour.Set(0);
8628 return;
8629 }
8631
8632 // - Contour levels are specified
8633 if (levels) {
8635 for (level=0; level<nlevels; level++) fContour.fArray[level] = levels[level];
8636 } else {
8637 // - contour levels are computed automatically as equidistant contours
8638 Double_t zmin = GetMinimum();
8639 Double_t zmax = GetMaximum();
8640 if ((zmin == zmax) && (zmin != 0)) {
8641 zmax += 0.01*TMath::Abs(zmax);
8642 zmin -= 0.01*TMath::Abs(zmin);
8643 }
8644 Double_t dz = (zmax-zmin)/Double_t(nlevels);
8645 if (gPad && gPad->GetLogz()) {
8646 if (zmax <= 0) return;
8647 if (zmin <= 0) zmin = 0.001*zmax;
8648 zmin = TMath::Log10(zmin);
8649 zmax = TMath::Log10(zmax);
8650 dz = (zmax-zmin)/Double_t(nlevels);
8651 }
8652 for (level=0; level<nlevels; level++) {
8653 fContour.fArray[level] = zmin + dz*Double_t(level);
8654 }
8655 }
8656}
8657
8658////////////////////////////////////////////////////////////////////////////////
8659/// Set value for one contour level.
8660
8662{
8663 if (level < 0 || level >= fContour.fN) return;
8665 fContour.fArray[level] = value;
8666}
8667
8668////////////////////////////////////////////////////////////////////////////////
8669/// Return maximum value smaller than maxval of bins in the range,
8670/// unless the value has been overridden by TH1::SetMaximum,
8671/// in which case it returns that value. This happens, for example,
8672/// when the histogram is drawn and the y or z axis limits are changed
8673///
8674/// To get the maximum value of bins in the histogram regardless of
8675/// whether the value has been overridden (using TH1::SetMaximum), use
8676///
8677/// ~~~ {.cpp}
8678/// h->GetBinContent(h->GetMaximumBin())
8679/// ~~~
8680///
8681/// TH1::GetMaximumBin can be used to get the location of the maximum
8682/// value.
8683
8685{
8686 if (fMaximum != -1111) return fMaximum;
8687
8688 // empty the buffer
8689 if (fBuffer) ((TH1*)this)->BufferEmpty();
8690
8691 Int_t bin, binx, biny, binz;
8692 Int_t xfirst = fXaxis.GetFirst();
8693 Int_t xlast = fXaxis.GetLast();
8694 Int_t yfirst = fYaxis.GetFirst();
8695 Int_t ylast = fYaxis.GetLast();
8696 Int_t zfirst = fZaxis.GetFirst();
8697 Int_t zlast = fZaxis.GetLast();
8699 for (binz=zfirst;binz<=zlast;binz++) {
8700 for (biny=yfirst;biny<=ylast;biny++) {
8701 for (binx=xfirst;binx<=xlast;binx++) {
8702 bin = GetBin(binx,biny,binz);
8704 if (value > maximum && value < maxval) maximum = value;
8705 }
8706 }
8707 }
8708 return maximum;
8709}
8710
8711////////////////////////////////////////////////////////////////////////////////
8712/// Return location of bin with maximum value in the range.
8713///
8714/// TH1::GetMaximum can be used to get the maximum value.
8715
8717{
8720}
8721
8722////////////////////////////////////////////////////////////////////////////////
8723/// Return location of bin with maximum value in the range.
8724
8726{
8727 // empty the buffer
8728 if (fBuffer) ((TH1*)this)->BufferEmpty();
8729
8730 Int_t bin, binx, biny, binz;
8731 Int_t locm;
8732 Int_t xfirst = fXaxis.GetFirst();
8733 Int_t xlast = fXaxis.GetLast();
8734 Int_t yfirst = fYaxis.GetFirst();
8735 Int_t ylast = fYaxis.GetLast();
8736 Int_t zfirst = fZaxis.GetFirst();
8737 Int_t zlast = fZaxis.GetLast();
8739 locm = locmax = locmay = locmaz = 0;
8740 for (binz=zfirst;binz<=zlast;binz++) {
8741 for (biny=yfirst;biny<=ylast;biny++) {
8742 for (binx=xfirst;binx<=xlast;binx++) {
8743 bin = GetBin(binx,biny,binz);
8745 if (value > maximum) {
8746 maximum = value;
8747 locm = bin;
8748 locmax = binx;
8749 locmay = biny;
8750 locmaz = binz;
8751 }
8752 }
8753 }
8754 }
8755 return locm;
8756}
8757
8758////////////////////////////////////////////////////////////////////////////////
8759/// Return minimum value larger than minval of bins in the range,
8760/// unless the value has been overridden by TH1::SetMinimum,
8761/// in which case it returns that value. This happens, for example,
8762/// when the histogram is drawn and the y or z axis limits are changed
8763///
8764/// To get the minimum value of bins in the histogram regardless of
8765/// whether the value has been overridden (using TH1::SetMinimum), use
8766///
8767/// ~~~ {.cpp}
8768/// h->GetBinContent(h->GetMinimumBin())
8769/// ~~~
8770///
8771/// TH1::GetMinimumBin can be used to get the location of the
8772/// minimum value.
8773
8775{
8776 if (fMinimum != -1111) return fMinimum;
8777
8778 // empty the buffer
8779 if (fBuffer) ((TH1*)this)->BufferEmpty();
8780
8781 Int_t bin, binx, biny, binz;
8782 Int_t xfirst = fXaxis.GetFirst();
8783 Int_t xlast = fXaxis.GetLast();
8784 Int_t yfirst = fYaxis.GetFirst();
8785 Int_t ylast = fYaxis.GetLast();
8786 Int_t zfirst = fZaxis.GetFirst();
8787 Int_t zlast = fZaxis.GetLast();
8789 for (binz=zfirst;binz<=zlast;binz++) {
8790 for (biny=yfirst;biny<=ylast;biny++) {
8791 for (binx=xfirst;binx<=xlast;binx++) {
8792 bin = GetBin(binx,biny,binz);
8795 }
8796 }
8797 }
8798 return minimum;
8799}
8800
8801////////////////////////////////////////////////////////////////////////////////
8802/// Return location of bin with minimum value in the range.
8803
8805{
8808}
8809
8810////////////////////////////////////////////////////////////////////////////////
8811/// Return location of bin with minimum value in the range.
8812
8814{
8815 // empty the buffer
8816 if (fBuffer) ((TH1*)this)->BufferEmpty();
8817
8818 Int_t bin, binx, biny, binz;
8819 Int_t locm;
8820 Int_t xfirst = fXaxis.GetFirst();
8821 Int_t xlast = fXaxis.GetLast();
8822 Int_t yfirst = fYaxis.GetFirst();
8823 Int_t ylast = fYaxis.GetLast();
8824 Int_t zfirst = fZaxis.GetFirst();
8825 Int_t zlast = fZaxis.GetLast();
8827 locm = locmix = locmiy = locmiz = 0;
8828 for (binz=zfirst;binz<=zlast;binz++) {
8829 for (biny=yfirst;biny<=ylast;biny++) {
8830 for (binx=xfirst;binx<=xlast;binx++) {
8831 bin = GetBin(binx,biny,binz);
8833 if (value < minimum) {
8834 minimum = value;
8835 locm = bin;
8836 locmix = binx;
8837 locmiy = biny;
8838 locmiz = binz;
8839 }
8840 }
8841 }
8842 }
8843 return locm;
8844}
8845
8846///////////////////////////////////////////////////////////////////////////////
8847/// Retrieve the minimum and maximum values in the histogram
8848///
8849/// This will not return a cached value and will always search the
8850/// histogram for the min and max values. The user can condition whether
8851/// or not to call this with the GetMinimumStored() and GetMaximumStored()
8852/// methods. If the cache is empty, then the value will be -1111. Users
8853/// can then use the SetMinimum() or SetMaximum() methods to cache the results.
8854/// For example, the following recipe will make efficient use of this method
8855/// and the cached minimum and maximum values.
8856//
8857/// \code{.cpp}
8858/// Double_t currentMin = pHist->GetMinimumStored();
8859/// Double_t currentMax = pHist->GetMaximumStored();
8860/// if ((currentMin == -1111) || (currentMax == -1111)) {
8861/// pHist->GetMinimumAndMaximum(currentMin, currentMax);
8862/// pHist->SetMinimum(currentMin);
8863/// pHist->SetMaximum(currentMax);
8864/// }
8865/// \endcode
8866///
8867/// \param min reference to variable that will hold found minimum value
8868/// \param max reference to variable that will hold found maximum value
8869
8870void TH1::GetMinimumAndMaximum(Double_t& min, Double_t& max) const
8871{
8872 // empty the buffer
8873 if (fBuffer) ((TH1*)this)->BufferEmpty();
8874
8875 Int_t bin, binx, biny, binz;
8876 Int_t xfirst = fXaxis.GetFirst();
8877 Int_t xlast = fXaxis.GetLast();
8878 Int_t yfirst = fYaxis.GetFirst();
8879 Int_t ylast = fYaxis.GetLast();
8880 Int_t zfirst = fZaxis.GetFirst();
8881 Int_t zlast = fZaxis.GetLast();
8882 min=TMath::Infinity();
8883 max=-TMath::Infinity();
8885 for (binz=zfirst;binz<=zlast;binz++) {
8886 for (biny=yfirst;biny<=ylast;biny++) {
8887 for (binx=xfirst;binx<=xlast;binx++) {
8888 bin = GetBin(binx,biny,binz);
8890 if (value < min) min = value;
8891 if (value > max) max = value;
8892 }
8893 }
8894 }
8895}
8896
8897////////////////////////////////////////////////////////////////////////////////
8898/// Redefine x axis parameters.
8899///
8900/// The X axis parameters are modified.
8901/// The bins content array is resized
8902/// if errors (Sumw2) the errors array is resized
8903/// The previous bin contents are lost
8904/// To change only the axis limits, see TAxis::SetRange
8905
8907{
8908 if (GetDimension() != 1) {
8909 Error("SetBins","Operation only valid for 1-d histograms");
8910 return;
8911 }
8912 fXaxis.SetRange(0,0);
8914 fYaxis.Set(1,0,1);
8915 fZaxis.Set(1,0,1);
8916 fNcells = nx+2;
8918 if (fSumw2.fN) {
8920 }
8921}
8922
8923////////////////////////////////////////////////////////////////////////////////
8924/// Redefine x axis parameters with variable bin sizes.
8925///
8926/// The X axis parameters are modified.
8927/// The bins content array is resized
8928/// if errors (Sumw2) the errors array is resized
8929/// The previous bin contents are lost
8930/// To change only the axis limits, see TAxis::SetRange
8931/// xBins is supposed to be of length nx+1
8932
8933void TH1::SetBins(Int_t nx, const Double_t *xBins)
8934{
8935 if (GetDimension() != 1) {
8936 Error("SetBins","Operation only valid for 1-d histograms");
8937 return;
8938 }
8939 fXaxis.SetRange(0,0);
8940 fXaxis.Set(nx,xBins);
8941 fYaxis.Set(1,0,1);
8942 fZaxis.Set(1,0,1);
8943 fNcells = nx+2;
8945 if (fSumw2.fN) {
8947 }
8948}
8949
8950////////////////////////////////////////////////////////////////////////////////
8951/// Redefine x and y axis parameters.
8952///
8953/// The X and Y axis parameters are modified.
8954/// The bins content array is resized
8955/// if errors (Sumw2) the errors array is resized
8956/// The previous bin contents are lost
8957/// To change only the axis limits, see TAxis::SetRange
8958
8960{
8961 if (GetDimension() != 2) {
8962 Error("SetBins","Operation only valid for 2-D histograms");
8963 return;
8964 }
8965 fXaxis.SetRange(0,0);
8966 fYaxis.SetRange(0,0);
8969 fZaxis.Set(1,0,1);
8970 fNcells = (nx+2)*(ny+2);
8972 if (fSumw2.fN) {
8974 }
8975}
8976
8977////////////////////////////////////////////////////////////////////////////////
8978/// Redefine x and y axis parameters with variable bin sizes.
8979///
8980/// The X and Y axis parameters are modified.
8981/// The bins content array is resized
8982/// if errors (Sumw2) the errors array is resized
8983/// The previous bin contents are lost
8984/// To change only the axis limits, see TAxis::SetRange
8985/// xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1
8986
8987void TH1::SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t *yBins)
8988{
8989 if (GetDimension() != 2) {
8990 Error("SetBins","Operation only valid for 2-D histograms");
8991 return;
8992 }
8993 fXaxis.SetRange(0,0);
8994 fYaxis.SetRange(0,0);
8995 fXaxis.Set(nx,xBins);
8996 fYaxis.Set(ny,yBins);
8997 fZaxis.Set(1,0,1);
8998 fNcells = (nx+2)*(ny+2);
9000 if (fSumw2.fN) {
9002 }
9003}
9004
9005////////////////////////////////////////////////////////////////////////////////
9006/// Redefine x, y and z axis parameters.
9007///
9008/// The X, Y and Z axis parameters are modified.
9009/// The bins content array is resized
9010/// if errors (Sumw2) the errors array is resized
9011/// The previous bin contents are lost
9012/// To change only the axis limits, see TAxis::SetRange
9013
9015{
9016 if (GetDimension() != 3) {
9017 Error("SetBins","Operation only valid for 3-D histograms");
9018 return;
9019 }
9020 fXaxis.SetRange(0,0);
9021 fYaxis.SetRange(0,0);
9022 fZaxis.SetRange(0,0);
9025 fZaxis.Set(nz,zmin,zmax);
9026 fNcells = (nx+2)*(ny+2)*(nz+2);
9028 if (fSumw2.fN) {
9030 }
9031}
9032
9033////////////////////////////////////////////////////////////////////////////////
9034/// Redefine x, y and z axis parameters with variable bin sizes.
9035///
9036/// The X, Y and Z axis parameters are modified.
9037/// The bins content array is resized
9038/// if errors (Sumw2) the errors array is resized
9039/// The previous bin contents are lost
9040/// To change only the axis limits, see TAxis::SetRange
9041/// xBins is supposed to be of length nx+1, yBins is supposed to be of length ny+1,
9042/// zBins is supposed to be of length nz+1
9043
9044void TH1::SetBins(Int_t nx, const Double_t *xBins, Int_t ny, const Double_t *yBins, Int_t nz, const Double_t *zBins)
9045{
9046 if (GetDimension() != 3) {
9047 Error("SetBins","Operation only valid for 3-D histograms");
9048 return;
9049 }
9050 fXaxis.SetRange(0,0);
9051 fYaxis.SetRange(0,0);
9052 fZaxis.SetRange(0,0);
9053 fXaxis.Set(nx,xBins);
9054 fYaxis.Set(ny,yBins);
9055 fZaxis.Set(nz,zBins);
9056 fNcells = (nx+2)*(ny+2)*(nz+2);
9058 if (fSumw2.fN) {
9060 }
9061}
9062
9063////////////////////////////////////////////////////////////////////////////////
9064/// By default, when a histogram is created, it is added to the list
9065/// of histogram objects in the current directory in memory.
9066/// Remove reference to this histogram from current directory and add
9067/// reference to new directory dir. dir can be 0 in which case the
9068/// histogram does not belong to any directory.
9069///
9070/// Note that the directory is not a real property of the histogram and
9071/// it will not be copied when the histogram is copied or cloned.
9072/// If the user wants to have the copied (cloned) histogram in the same
9073/// directory, he needs to set again the directory using SetDirectory to the
9074/// copied histograms
9075
9077{
9078 if (fDirectory == dir) return;
9079 if (fDirectory) fDirectory->Remove(this);
9080 fDirectory = dir;
9081 if (fDirectory) {
9083 fDirectory->Append(this);
9084 }
9085}
9086
9087////////////////////////////////////////////////////////////////////////////////
9088/// Replace bin errors by values in array error.
9089
9090void TH1::SetError(const Double_t *error)
9091{
9092 for (Int_t i = 0; i < fNcells; ++i) SetBinError(i, error[i]);
9093}
9094
9095////////////////////////////////////////////////////////////////////////////////
9096/// Change the name of this histogram
9098
9099void TH1::SetName(const char *name)
9100{
9101 // Histograms are named objects in a THashList.
9102 // We must update the hashlist if we change the name
9103 // We protect this operation
9105 if (fDirectory) fDirectory->Remove(this);
9106 fName = name;
9107 if (fDirectory) fDirectory->Append(this);
9108}
9109
9110////////////////////////////////////////////////////////////////////////////////
9111/// Change the name and title of this histogram
9112
9113void TH1::SetNameTitle(const char *name, const char *title)
9114{
9115 // Histograms are named objects in a THashList.
9116 // We must update the hashlist if we change the name
9117 SetName(name);
9118 SetTitle(title);
9119}
9120
9121////////////////////////////////////////////////////////////////////////////////
9122/// Set statistics option on/off.
9123///
9124/// By default, the statistics box is drawn.
9125/// The paint options can be selected via gStyle->SetOptStat.
9126/// This function sets/resets the kNoStats bit in the histogram object.
9127/// It has priority over the Style option.
9128
9129void TH1::SetStats(Bool_t stats)
9130{
9132 if (!stats) {
9134 //remove the "stats" object from the list of functions
9135 if (fFunctions) {
9136 TObject *obj = fFunctions->FindObject("stats");
9137 if (obj) {
9138 fFunctions->Remove(obj);
9139 delete obj;
9140 }
9141 }
9142 }
9143}
9144
9145////////////////////////////////////////////////////////////////////////////////
9146/// Create structure to store sum of squares of weights.
9147///
9148/// if histogram is already filled, the sum of squares of weights
9149/// is filled with the existing bin contents
9150///
9151/// The error per bin will be computed as sqrt(sum of squares of weight)
9152/// for each bin.
9153///
9154/// This function is automatically called when the histogram is created
9155/// if the static function TH1::SetDefaultSumw2 has been called before.
9156/// If flag = false the structure containing the sum of the square of weights
9157/// is rest and it will be empty, but it is not deleted (i.e. GetSumw2()->fN = 0)
9158
9160{
9161 if (!flag) {
9162 // clear the array if existing - do nothing otherwise
9163 if (fSumw2.fN > 0 ) fSumw2.Set(0);
9164 return;
9165 }
9166
9167 if (fSumw2.fN == fNcells) {
9168 if (!fgDefaultSumw2 )
9169 Warning("Sumw2","Sum of squares of weights structure already created");
9170 return;
9171 }
9172
9174
9175 if (fEntries > 0)
9176 for (Int_t i = 0; i < fNcells; ++i)
9178}
9179
9180////////////////////////////////////////////////////////////////////////////////
9181/// Return pointer to function with name.
9182///
9183///
9184/// Functions such as TH1::Fit store the fitted function in the list of
9185/// functions of this histogram.
9186
9187TF1 *TH1::GetFunction(const char *name) const
9188{
9189 return (TF1*)fFunctions->FindObject(name);
9190}
9191
9192////////////////////////////////////////////////////////////////////////////////
9193/// Return value of error associated to bin number bin.
9194///
9195/// if the sum of squares of weights has been defined (via Sumw2),
9196/// this function returns the sqrt(sum of w2).
9197/// otherwise it returns the sqrt(contents) for this bin.
9198
9200{
9201 if (bin < 0) bin = 0;
9202 if (bin >= fNcells) bin = fNcells-1;
9203 if (fBuffer) ((TH1*)this)->BufferEmpty();
9204 if (fSumw2.fN) return TMath::Sqrt(fSumw2.fArray[bin]);
9205
9207}
9208
9209////////////////////////////////////////////////////////////////////////////////
9210/// Return lower error associated to bin number bin.
9211///
9212/// The error will depend on the statistic option used will return
9213/// the binContent - lower interval value
9214
9216{
9217 if (fBinStatErrOpt == kNormal) return GetBinError(bin);
9218 // in case of weighted histogram check if it is really weighted
9219 if (fSumw2.fN && fTsumw != fTsumw2) return GetBinError(bin);
9220
9221 if (bin < 0) bin = 0;
9222 if (bin >= fNcells) bin = fNcells-1;
9223 if (fBuffer) ((TH1*)this)->BufferEmpty();
9224
9225 Double_t alpha = 1.- 0.682689492;
9226 if (fBinStatErrOpt == kPoisson2) alpha = 0.05;
9227
9229 Int_t n = int(c);
9230 if (n < 0) {
9231 Warning("GetBinErrorLow","Histogram has negative bin content-force usage to normal errors");
9232 ((TH1*)this)->fBinStatErrOpt = kNormal;
9233 return GetBinError(bin);
9234 }
9235
9236 if (n == 0) return 0;
9237 return c - ROOT::Math::gamma_quantile( alpha/2, n, 1.);
9238}
9239
9240////////////////////////////////////////////////////////////////////////////////
9241/// Return upper error associated to bin number bin.
9242///
9243/// The error will depend on the statistic option used will return
9244/// the binContent - upper interval value
9245
9247{
9248 if (fBinStatErrOpt == kNormal) return GetBinError(bin);
9249 // in case of weighted histogram check if it is really weighted
9250 if (fSumw2.fN && fTsumw != fTsumw2) return GetBinError(bin);
9251 if (bin < 0) bin = 0;
9252 if (bin >= fNcells) bin = fNcells-1;
9253 if (fBuffer) ((TH1*)this)->BufferEmpty();
9254
9255 Double_t alpha = 1.- 0.682689492;
9256 if (fBinStatErrOpt == kPoisson2) alpha = 0.05;
9257
9259 Int_t n = int(c);
9260 if (n < 0) {
9261 Warning("GetBinErrorUp","Histogram has negative bin content-force usage to normal errors");
9262 ((TH1*)this)->fBinStatErrOpt = kNormal;
9263 return GetBinError(bin);
9264 }
9265
9266 // for N==0 return an upper limit at 0.68 or (1-alpha)/2 ?
9267 // decide to return always (1-alpha)/2 upper interval
9268 //if (n == 0) return ROOT::Math::gamma_quantile_c(alpha,n+1,1);
9269 return ROOT::Math::gamma_quantile_c( alpha/2, n+1, 1) - c;
9270}
9271
9272//L.M. These following getters are useless and should be probably deprecated
9273////////////////////////////////////////////////////////////////////////////////
9274/// Return bin center for 1D histogram.
9275/// Better to use h1.GetXaxis()->GetBinCenter(bin)
9276
9278{
9279 if (fDimension == 1) return fXaxis.GetBinCenter(bin);
9280 Error("GetBinCenter","Invalid method for a %d-d histogram - return a NaN",fDimension);
9281 return TMath::QuietNaN();
9282}
9283
9284////////////////////////////////////////////////////////////////////////////////
9285/// Return bin lower edge for 1D histogram.
9286/// Better to use h1.GetXaxis()->GetBinLowEdge(bin)
9287
9289{
9290 if (fDimension == 1) return fXaxis.GetBinLowEdge(bin);
9291 Error("GetBinLowEdge","Invalid method for a %d-d histogram - return a NaN",fDimension);
9292 return TMath::QuietNaN();
9293}
9294
9295////////////////////////////////////////////////////////////////////////////////
9296/// Return bin width for 1D histogram.
9297/// Better to use h1.GetXaxis()->GetBinWidth(bin)
9298
9300{
9301 if (fDimension == 1) return fXaxis.GetBinWidth(bin);
9302 Error("GetBinWidth","Invalid method for a %d-d histogram - return a NaN",fDimension);
9303 return TMath::QuietNaN();
9304}
9305
9306////////////////////////////////////////////////////////////////////////////////
9307/// Fill array with center of bins for 1D histogram
9308/// Better to use h1.GetXaxis()->GetCenter(center)
9309
9310void TH1::GetCenter(Double_t *center) const
9311{
9312 if (fDimension == 1) {
9313 fXaxis.GetCenter(center);
9314 return;
9315 }
9316 Error("GetCenter","Invalid method for a %d-d histogram ",fDimension);
9317}
9318
9319////////////////////////////////////////////////////////////////////////////////
9320/// Fill array with low edge of bins for 1D histogram
9321/// Better to use h1.GetXaxis()->GetLowEdge(edge)
9322
9323void TH1::GetLowEdge(Double_t *edge) const
9324{
9325 if (fDimension == 1) {
9327 return;
9328 }
9329 Error("GetLowEdge","Invalid method for a %d-d histogram ",fDimension);
9330}
9331
9332////////////////////////////////////////////////////////////////////////////////
9333/// Set the bin Error
9334/// Note that this resets the bin eror option to be of Normal Type and for the
9335/// non-empty bin the bin error is set by default to the square root of their content.
9336/// Note that in case the user sets after calling SetBinError explicitly a new bin content (e.g. using SetBinContent)
9337/// he needs then to provide also the corresponding bin error (using SetBinError) since the bin error
9338/// will not be recalculated after setting the content and a default error = 0 will be used for those bins.
9339///
9340/// See convention for numbering bins in TH1::GetBin
9341
9343{
9344 if (bin < 0 || bin>= fNcells) return;
9345 if (!fSumw2.fN) Sumw2();
9346 fSumw2.fArray[bin] = error * error;
9347 // reset the bin error option
9349}
9350
9351////////////////////////////////////////////////////////////////////////////////
9352/// Set bin content
9353/// see convention for numbering bins in TH1::GetBin
9354/// In case the bin number is greater than the number of bins and
9355/// the timedisplay option is set or CanExtendAllAxes(),
9356/// the number of bins is automatically doubled to accommodate the new bin
9357
9359{
9360 fEntries++;
9361 fTsumw = 0;
9362 if (bin < 0) return;
9363 if (bin >= fNcells-1) {
9365 while (bin >= fNcells-1) LabelsInflate();
9366 } else {
9368 return;
9369 }
9370 }
9372}
9373
9374////////////////////////////////////////////////////////////////////////////////
9375/// See convention for numbering bins in TH1::GetBin
9376
9378{
9379 if (binx < 0 || binx > fXaxis.GetNbins() + 1) return;
9380 if (biny < 0 || biny > fYaxis.GetNbins() + 1) return;
9381 SetBinError(GetBin(binx, biny), error);
9382}
9383
9384////////////////////////////////////////////////////////////////////////////////
9385/// See convention for numbering bins in TH1::GetBin
9386
9388{
9389 if (binx < 0 || binx > fXaxis.GetNbins() + 1) return;
9390 if (biny < 0 || biny > fYaxis.GetNbins() + 1) return;
9391 if (binz < 0 || binz > fZaxis.GetNbins() + 1) return;
9392 SetBinError(GetBin(binx, biny, binz), error);
9393}
9394
9395////////////////////////////////////////////////////////////////////////////////
9396/// This function calculates the background spectrum in this histogram.
9397/// The background is returned as a histogram.
9398///
9399/// \param[in] niter number of iterations (default value = 2)
9400/// Increasing niter make the result smoother and lower.
9401/// \param[in] option may contain one of the following options
9402/// - to set the direction parameter
9403/// "BackDecreasingWindow". By default the direction is BackIncreasingWindow
9404/// - filterOrder-order of clipping filter (default "BackOrder2")
9405/// possible values= "BackOrder4" "BackOrder6" "BackOrder8"
9406/// - "nosmoothing" - if selected, the background is not smoothed
9407/// By default the background is smoothed.
9408/// - smoothWindow - width of smoothing window, (default is "BackSmoothing3")
9409/// possible values= "BackSmoothing5" "BackSmoothing7" "BackSmoothing9"
9410/// "BackSmoothing11" "BackSmoothing13" "BackSmoothing15"
9411/// - "nocompton" - if selected the estimation of Compton edge
9412/// will be not be included (by default the compton estimation is set)
9413/// - "same" if this option is specified, the resulting background
9414/// histogram is superimposed on the picture in the current pad.
9415/// This option is given by default.
9416///
9417/// NOTE that the background is only evaluated in the current range of this histogram.
9418/// i.e., if this has a bin range (set via h->GetXaxis()->SetRange(binmin, binmax),
9419/// the returned histogram will be created with the same number of bins
9420/// as this input histogram, but only bins from binmin to binmax will be filled
9421/// with the estimated background.
9422
9424{
9425 return (TH1*)gROOT->ProcessLineFast(TString::Format("TSpectrum::StaticBackground((TH1*)0x%zx,%d,\"%s\")",
9426 (size_t)this, niter, option).Data());
9427}
9428
9429////////////////////////////////////////////////////////////////////////////////
9430/// Interface to TSpectrum::Search.
9431/// The function finds peaks in this histogram where the width is > sigma
9432/// and the peak maximum greater than threshold*maximum bin content of this.
9433/// For more details see TSpectrum::Search.
9434/// Note the difference in the default value for option compared to TSpectrum::Search
9435/// option="" by default (instead of "goff").
9436
9438{
9439 return (Int_t)gROOT->ProcessLineFast(TString::Format("TSpectrum::StaticSearch((TH1*)0x%zx,%g,\"%s\",%g)",
9440 (size_t)this, sigma, option, threshold).Data());
9441}
9442
9443////////////////////////////////////////////////////////////////////////////////
9444/// For a given transform (first parameter), fills the histogram (second parameter)
9445/// with the transform output data, specified in the third parameter
9446/// If the 2nd parameter h_output is empty, a new histogram (TH1D or TH2D) is created
9447/// and the user is responsible for deleting it.
9448///
9449/// Available options:
9450/// - "RE" - real part of the output
9451/// - "IM" - imaginary part of the output
9452/// - "MAG" - magnitude of the output
9453/// - "PH" - phase of the output
9454
9456{
9457 if (!fft || !fft->GetN() ) {
9458 ::Error("TransformHisto","Invalid FFT transform class");
9459 return nullptr;
9460 }
9461
9462 if (fft->GetNdim()>2){
9463 ::Error("TransformHisto","Only 1d and 2D transform are supported");
9464 return nullptr;
9465 }
9466 Int_t binx,biny;
9467 TString opt = option;
9468 opt.ToUpper();
9469 Int_t *n = fft->GetN();
9470 TH1 *hout=nullptr;
9471 if (h_output) {
9472 hout = h_output;
9473 }
9474 else {
9475 TString name = TString::Format("out_%s", opt.Data());
9476 if (fft->GetNdim()==1)
9477 hout = new TH1D(name, name,n[0], 0, n[0]);
9478 else if (fft->GetNdim()==2)
9479 hout = new TH2D(name, name, n[0], 0, n[0], n[1], 0, n[1]);
9480 }
9481 R__ASSERT(hout != nullptr);
9482 TString type=fft->GetType();
9483 Int_t ind[2];
9484 if (opt.Contains("RE")){
9485 if (type.Contains("2C") || type.Contains("2HC")) {
9486 Double_t re, im;
9487 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9488 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9489 ind[0] = binx-1; ind[1] = biny-1;
9490 fft->GetPointComplex(ind, re, im);
9491 hout->SetBinContent(binx, biny, re);
9492 }
9493 }
9494 } else {
9495 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9496 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9497 ind[0] = binx-1; ind[1] = biny-1;
9498 hout->SetBinContent(binx, biny, fft->GetPointReal(ind));
9499 }
9500 }
9501 }
9502 }
9503 if (opt.Contains("IM")) {
9504 if (type.Contains("2C") || type.Contains("2HC")) {
9505 Double_t re, im;
9506 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9507 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9508 ind[0] = binx-1; ind[1] = biny-1;
9509 fft->GetPointComplex(ind, re, im);
9510 hout->SetBinContent(binx, biny, im);
9511 }
9512 }
9513 } else {
9514 ::Error("TransformHisto","No complex numbers in the output");
9515 return nullptr;
9516 }
9517 }
9518 if (opt.Contains("MA")) {
9519 if (type.Contains("2C") || type.Contains("2HC")) {
9520 Double_t re, im;
9521 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9522 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9523 ind[0] = binx-1; ind[1] = biny-1;
9524 fft->GetPointComplex(ind, re, im);
9525 hout->SetBinContent(binx, biny, TMath::Sqrt(re*re + im*im));
9526 }
9527 }
9528 } else {
9529 for (binx = 1; binx<=hout->GetNbinsX(); binx++) {
9530 for (biny=1; biny<=hout->GetNbinsY(); biny++) {
9531 ind[0] = binx-1; ind[1] = biny-1;
9532 hout->SetBinContent(binx, biny, TMath::Abs(fft->GetPointReal(ind)));
9533 }
9534 }
9535 }
9536 }
9537 if (opt.Contains("PH")) {
9538 if (type.Contains("2C") || type.Contains("2HC")){
9539 Double_t re, im, ph;
9540 for (binx = 1; binx<=hout->GetNbinsX(); binx++){
9541 for (biny=1; biny<=hout->GetNbinsY(); biny++){
9542 ind[0] = binx-1; ind[1] = biny-1;
9543 fft->GetPointComplex(ind, re, im);
9544 if (TMath::Abs(re) > 1e-13){
9545 ph = TMath::ATan(im/re);
9546 //find the correct quadrant
9547 if (re<0 && im<0)
9548 ph -= TMath::Pi();
9549 if (re<0 && im>=0)
9550 ph += TMath::Pi();
9551 } else {
9552 if (TMath::Abs(im) < 1e-13)
9553 ph = 0;
9554 else if (im>0)
9555 ph = TMath::Pi()*0.5;
9556 else
9557 ph = -TMath::Pi()*0.5;
9558 }
9559 hout->SetBinContent(binx, biny, ph);
9560 }
9561 }
9562 } else {
9563 printf("Pure real output, no phase");
9564 return nullptr;
9565 }
9566 }
9567
9568 return hout;
9569}
9570
9571////////////////////////////////////////////////////////////////////////////////
9572/// Print value overload
9573
9574std::string cling::printValue(TH1 *val) {
9575 std::ostringstream strm;
9576 strm << cling::printValue((TObject*)val) << " NbinsX: " << val->GetNbinsX();
9577 return strm.str();
9578}
9579
9580//______________________________________________________________________________
9581// TH1C methods
9582// TH1C : histograms with one byte per channel. Maximum bin content = 127
9583//______________________________________________________________________________
9584
9585
9586////////////////////////////////////////////////////////////////////////////////
9587/// Constructor.
9588
9589TH1C::TH1C()
9590{
9591 fDimension = 1;
9592 SetBinsLength(3);
9593 if (fgDefaultSumw2) Sumw2();
9594}
9595
9596////////////////////////////////////////////////////////////////////////////////
9597/// Create a 1-Dim histogram with fix bins of type char (one byte per channel)
9598/// (see TH1::TH1 for explanation of parameters)
9599
9600TH1C::TH1C(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9601: TH1(name,title,nbins,xlow,xup)
9602{
9603 fDimension = 1;
9605
9606 if (xlow >= xup) SetBuffer(fgBufferSize);
9607 if (fgDefaultSumw2) Sumw2();
9608}
9609
9610////////////////////////////////////////////////////////////////////////////////
9611/// Create a 1-Dim histogram with variable bins of type char (one byte per channel)
9612/// (see TH1::TH1 for explanation of parameters)
9613
9614TH1C::TH1C(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9615: TH1(name,title,nbins,xbins)
9616{
9617 fDimension = 1;
9619 if (fgDefaultSumw2) Sumw2();
9620}
9621
9622////////////////////////////////////////////////////////////////////////////////
9623/// Create a 1-Dim histogram with variable bins of type char (one byte per channel)
9624/// (see TH1::TH1 for explanation of parameters)
9625
9626TH1C::TH1C(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9627: TH1(name,title,nbins,xbins)
9628{
9629 fDimension = 1;
9631 if (fgDefaultSumw2) Sumw2();
9632}
9633
9634////////////////////////////////////////////////////////////////////////////////
9635/// Destructor.
9636
9638{
9639}
9640
9641////////////////////////////////////////////////////////////////////////////////
9642/// Copy constructor.
9643/// The list of functions is not copied. (Use Clone() if needed)
9644
9645TH1C::TH1C(const TH1C &h1c) : TH1(), TArrayC()
9646{
9647 h1c.TH1C::Copy(*this);
9648}
9649
9650////////////////////////////////////////////////////////////////////////////////
9651/// Increment bin content by 1.
9652/// Passing an out-of-range bin leads to undefined behavior
9653
9655{
9656 if (fArray[bin] < 127) fArray[bin]++;
9657}
9658
9659////////////////////////////////////////////////////////////////////////////////
9660/// Increment bin content by w.
9661/// \warning The value of w is cast to `Int_t` before being added.
9662/// Passing an out-of-range bin leads to undefined behavior
9663
9665{
9666 Int_t newval = fArray[bin] + Int_t(w);
9667 if (newval > -128 && newval < 128) {fArray[bin] = Char_t(newval); return;}
9668 if (newval < -127) fArray[bin] = -127;
9669 if (newval > 127) fArray[bin] = 127;
9670}
9671
9672////////////////////////////////////////////////////////////////////////////////
9673/// Copy this to newth1
9674
9675void TH1C::Copy(TObject &newth1) const
9676{
9678}
9679
9680////////////////////////////////////////////////////////////////////////////////
9681/// Reset.
9682
9684{
9687}
9688
9689////////////////////////////////////////////////////////////////////////////////
9690/// Set total number of bins including under/overflow
9691/// Reallocate bin contents array
9692
9694{
9695 if (n < 0) n = fXaxis.GetNbins() + 2;
9696 fNcells = n;
9697 TArrayC::Set(n);
9698}
9699
9700////////////////////////////////////////////////////////////////////////////////
9701/// Operator =
9702
9703TH1C& TH1C::operator=(const TH1C &h1)
9704{
9705 if (this != &h1)
9706 h1.TH1C::Copy(*this);
9707 return *this;
9708}
9709
9710////////////////////////////////////////////////////////////////////////////////
9711/// Operator *
9712
9714{
9715 TH1C hnew = h1;
9716 hnew.Scale(c1);
9717 hnew.SetDirectory(nullptr);
9718 return hnew;
9719}
9720
9721////////////////////////////////////////////////////////////////////////////////
9722/// Operator +
9723
9724TH1C operator+(const TH1C &h1, const TH1C &h2)
9725{
9726 TH1C hnew = h1;
9727 hnew.Add(&h2,1);
9728 hnew.SetDirectory(nullptr);
9729 return hnew;
9730}
9731
9732////////////////////////////////////////////////////////////////////////////////
9733/// Operator -
9734
9735TH1C operator-(const TH1C &h1, const TH1C &h2)
9736{
9737 TH1C hnew = h1;
9738 hnew.Add(&h2,-1);
9739 hnew.SetDirectory(nullptr);
9740 return hnew;
9741}
9742
9743////////////////////////////////////////////////////////////////////////////////
9744/// Operator *
9745
9746TH1C operator*(const TH1C &h1, const TH1C &h2)
9747{
9748 TH1C hnew = h1;
9749 hnew.Multiply(&h2);
9750 hnew.SetDirectory(nullptr);
9751 return hnew;
9752}
9753
9754////////////////////////////////////////////////////////////////////////////////
9755/// Operator /
9756
9757TH1C operator/(const TH1C &h1, const TH1C &h2)
9758{
9759 TH1C hnew = h1;
9760 hnew.Divide(&h2);
9761 hnew.SetDirectory(nullptr);
9762 return hnew;
9763}
9764
9765//______________________________________________________________________________
9766// TH1S methods
9767// TH1S : histograms with one short per channel. Maximum bin content = 32767
9768//______________________________________________________________________________
9769
9770
9771////////////////////////////////////////////////////////////////////////////////
9772/// Constructor.
9773
9774TH1S::TH1S()
9775{
9776 fDimension = 1;
9777 SetBinsLength(3);
9778 if (fgDefaultSumw2) Sumw2();
9779}
9780
9781////////////////////////////////////////////////////////////////////////////////
9782/// Create a 1-Dim histogram with fix bins of type short
9783/// (see TH1::TH1 for explanation of parameters)
9784
9785TH1S::TH1S(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9786: TH1(name,title,nbins,xlow,xup)
9787{
9788 fDimension = 1;
9790
9791 if (xlow >= xup) SetBuffer(fgBufferSize);
9792 if (fgDefaultSumw2) Sumw2();
9793}
9794
9795////////////////////////////////////////////////////////////////////////////////
9796/// Create a 1-Dim histogram with variable bins of type short
9797/// (see TH1::TH1 for explanation of parameters)
9798
9799TH1S::TH1S(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9800: TH1(name,title,nbins,xbins)
9801{
9802 fDimension = 1;
9804 if (fgDefaultSumw2) Sumw2();
9805}
9806
9807////////////////////////////////////////////////////////////////////////////////
9808/// Create a 1-Dim histogram with variable bins of type short
9809/// (see TH1::TH1 for explanation of parameters)
9810
9811TH1S::TH1S(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9812: TH1(name,title,nbins,xbins)
9813{
9814 fDimension = 1;
9816 if (fgDefaultSumw2) Sumw2();
9817}
9818
9819////////////////////////////////////////////////////////////////////////////////
9820/// Destructor.
9821
9823{
9824}
9825
9826////////////////////////////////////////////////////////////////////////////////
9827/// Copy constructor.
9828/// The list of functions is not copied. (Use Clone() if needed)
9829
9830TH1S::TH1S(const TH1S &h1s) : TH1(), TArrayS()
9831{
9832 h1s.TH1S::Copy(*this);
9833}
9834
9835////////////////////////////////////////////////////////////////////////////////
9836/// Increment bin content by 1.
9837/// Passing an out-of-range bin leads to undefined behavior
9838
9840{
9841 if (fArray[bin] < 32767) fArray[bin]++;
9842}
9843
9844////////////////////////////////////////////////////////////////////////////////
9845/// Increment bin content by w.
9846/// \warning The value of w is cast to `Int_t` before being added.
9847/// Passing an out-of-range bin leads to undefined behavior
9848
9850{
9851 Int_t newval = fArray[bin] + Int_t(w);
9852 if (newval > -32768 && newval < 32768) {fArray[bin] = Short_t(newval); return;}
9853 if (newval < -32767) fArray[bin] = -32767;
9854 if (newval > 32767) fArray[bin] = 32767;
9855}
9856
9857////////////////////////////////////////////////////////////////////////////////
9858/// Copy this to newth1
9859
9860void TH1S::Copy(TObject &newth1) const
9861{
9863}
9864
9865////////////////////////////////////////////////////////////////////////////////
9866/// Reset.
9867
9869{
9872}
9873
9874////////////////////////////////////////////////////////////////////////////////
9875/// Set total number of bins including under/overflow
9876/// Reallocate bin contents array
9877
9879{
9880 if (n < 0) n = fXaxis.GetNbins() + 2;
9881 fNcells = n;
9882 TArrayS::Set(n);
9883}
9884
9885////////////////////////////////////////////////////////////////////////////////
9886/// Operator =
9887
9888TH1S& TH1S::operator=(const TH1S &h1)
9889{
9890 if (this != &h1)
9891 h1.TH1S::Copy(*this);
9892 return *this;
9893}
9894
9895////////////////////////////////////////////////////////////////////////////////
9896/// Operator *
9897
9899{
9900 TH1S hnew = h1;
9901 hnew.Scale(c1);
9902 hnew.SetDirectory(nullptr);
9903 return hnew;
9904}
9905
9906////////////////////////////////////////////////////////////////////////////////
9907/// Operator +
9908
9909TH1S operator+(const TH1S &h1, const TH1S &h2)
9910{
9911 TH1S hnew = h1;
9912 hnew.Add(&h2,1);
9913 hnew.SetDirectory(nullptr);
9914 return hnew;
9915}
9916
9917////////////////////////////////////////////////////////////////////////////////
9918/// Operator -
9919
9920TH1S operator-(const TH1S &h1, const TH1S &h2)
9921{
9922 TH1S hnew = h1;
9923 hnew.Add(&h2,-1);
9924 hnew.SetDirectory(nullptr);
9925 return hnew;
9926}
9927
9928////////////////////////////////////////////////////////////////////////////////
9929/// Operator *
9930
9931TH1S operator*(const TH1S &h1, const TH1S &h2)
9932{
9933 TH1S hnew = h1;
9934 hnew.Multiply(&h2);
9935 hnew.SetDirectory(nullptr);
9936 return hnew;
9937}
9938
9939////////////////////////////////////////////////////////////////////////////////
9940/// Operator /
9941
9942TH1S operator/(const TH1S &h1, const TH1S &h2)
9943{
9944 TH1S hnew = h1;
9945 hnew.Divide(&h2);
9946 hnew.SetDirectory(nullptr);
9947 return hnew;
9948}
9949
9950//______________________________________________________________________________
9951// TH1I methods
9952// TH1I : histograms with one int per channel. Maximum bin content = 2147483647
9953// 2147483647 = INT_MAX
9954//______________________________________________________________________________
9955
9956
9957////////////////////////////////////////////////////////////////////////////////
9958/// Constructor.
9959
9960TH1I::TH1I()
9961{
9962 fDimension = 1;
9963 SetBinsLength(3);
9964 if (fgDefaultSumw2) Sumw2();
9965}
9966
9967////////////////////////////////////////////////////////////////////////////////
9968/// Create a 1-Dim histogram with fix bins of type integer
9969/// (see TH1::TH1 for explanation of parameters)
9970
9971TH1I::TH1I(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
9972: TH1(name,title,nbins,xlow,xup)
9973{
9974 fDimension = 1;
9976
9977 if (xlow >= xup) SetBuffer(fgBufferSize);
9978 if (fgDefaultSumw2) Sumw2();
9979}
9980
9981////////////////////////////////////////////////////////////////////////////////
9982/// Create a 1-Dim histogram with variable bins of type integer
9983/// (see TH1::TH1 for explanation of parameters)
9984
9985TH1I::TH1I(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
9986: TH1(name,title,nbins,xbins)
9987{
9988 fDimension = 1;
9990 if (fgDefaultSumw2) Sumw2();
9991}
9992
9993////////////////////////////////////////////////////////////////////////////////
9994/// Create a 1-Dim histogram with variable bins of type integer
9995/// (see TH1::TH1 for explanation of parameters)
9996
9997TH1I::TH1I(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
9998: TH1(name,title,nbins,xbins)
9999{
10000 fDimension = 1;
10002 if (fgDefaultSumw2) Sumw2();
10003}
10004
10005////////////////////////////////////////////////////////////////////////////////
10006/// Destructor.
10007
10009{
10010}
10011
10012////////////////////////////////////////////////////////////////////////////////
10013/// Copy constructor.
10014/// The list of functions is not copied. (Use Clone() if needed)
10015
10016TH1I::TH1I(const TH1I &h1i) : TH1(), TArrayI()
10017{
10018 h1i.TH1I::Copy(*this);
10019}
10020
10021////////////////////////////////////////////////////////////////////////////////
10022/// Increment bin content by 1.
10023/// Passing an out-of-range bin leads to undefined behavior
10024
10026{
10027 if (fArray[bin] < INT_MAX) fArray[bin]++;
10028}
10029
10030////////////////////////////////////////////////////////////////////////////////
10031/// Increment bin content by w
10032/// \warning The value of w is cast to `Long64_t` before being added.
10033/// Passing an out-of-range bin leads to undefined behavior
10034
10036{
10038 if (newval > -INT_MAX && newval < INT_MAX) {fArray[bin] = Int_t(newval); return;}
10039 if (newval < -INT_MAX) fArray[bin] = -INT_MAX;
10040 if (newval > INT_MAX) fArray[bin] = INT_MAX;
10041}
10042
10043////////////////////////////////////////////////////////////////////////////////
10044/// Copy this to newth1
10045
10046void TH1I::Copy(TObject &newth1) const
10047{
10049}
10050
10051////////////////////////////////////////////////////////////////////////////////
10052/// Reset.
10053
10055{
10058}
10059
10060////////////////////////////////////////////////////////////////////////////////
10061/// Set total number of bins including under/overflow
10062/// Reallocate bin contents array
10063
10065{
10066 if (n < 0) n = fXaxis.GetNbins() + 2;
10067 fNcells = n;
10068 TArrayI::Set(n);
10069}
10070
10071////////////////////////////////////////////////////////////////////////////////
10072/// Operator =
10073
10074TH1I& TH1I::operator=(const TH1I &h1)
10075{
10076 if (this != &h1)
10077 h1.TH1I::Copy(*this);
10078 return *this;
10079}
10080
10081
10082////////////////////////////////////////////////////////////////////////////////
10083/// Operator *
10084
10086{
10087 TH1I hnew = h1;
10088 hnew.Scale(c1);
10089 hnew.SetDirectory(nullptr);
10090 return hnew;
10091}
10092
10093////////////////////////////////////////////////////////////////////////////////
10094/// Operator +
10095
10096TH1I operator+(const TH1I &h1, const TH1I &h2)
10097{
10098 TH1I hnew = h1;
10099 hnew.Add(&h2,1);
10100 hnew.SetDirectory(nullptr);
10101 return hnew;
10102}
10103
10104////////////////////////////////////////////////////////////////////////////////
10105/// Operator -
10106
10107TH1I operator-(const TH1I &h1, const TH1I &h2)
10108{
10109 TH1I hnew = h1;
10110 hnew.Add(&h2,-1);
10111 hnew.SetDirectory(nullptr);
10112 return hnew;
10113}
10114
10115////////////////////////////////////////////////////////////////////////////////
10116/// Operator *
10117
10118TH1I operator*(const TH1I &h1, const TH1I &h2)
10119{
10120 TH1I hnew = h1;
10121 hnew.Multiply(&h2);
10122 hnew.SetDirectory(nullptr);
10123 return hnew;
10124}
10125
10126////////////////////////////////////////////////////////////////////////////////
10127/// Operator /
10128
10129TH1I operator/(const TH1I &h1, const TH1I &h2)
10130{
10131 TH1I hnew = h1;
10132 hnew.Divide(&h2);
10133 hnew.SetDirectory(nullptr);
10134 return hnew;
10135}
10136
10137//______________________________________________________________________________
10138// TH1L methods
10139// TH1L : histograms with one long64 per channel. Maximum bin content = 9223372036854775807
10140// 9223372036854775807 = LLONG_MAX
10141//______________________________________________________________________________
10142
10143
10144////////////////////////////////////////////////////////////////////////////////
10145/// Constructor.
10146
10147TH1L::TH1L()
10148{
10149 fDimension = 1;
10150 SetBinsLength(3);
10151 if (fgDefaultSumw2) Sumw2();
10152}
10153
10154////////////////////////////////////////////////////////////////////////////////
10155/// Create a 1-Dim histogram with fix bins of type long64
10156/// (see TH1::TH1 for explanation of parameters)
10157
10158TH1L::TH1L(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10159: TH1(name,title,nbins,xlow,xup)
10160{
10161 fDimension = 1;
10163
10164 if (xlow >= xup) SetBuffer(fgBufferSize);
10165 if (fgDefaultSumw2) Sumw2();
10166}
10167
10168////////////////////////////////////////////////////////////////////////////////
10169/// Create a 1-Dim histogram with variable bins of type long64
10170/// (see TH1::TH1 for explanation of parameters)
10171
10172TH1L::TH1L(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10173: TH1(name,title,nbins,xbins)
10174{
10175 fDimension = 1;
10177 if (fgDefaultSumw2) Sumw2();
10178}
10179
10180////////////////////////////////////////////////////////////////////////////////
10181/// Create a 1-Dim histogram with variable bins of type long64
10182/// (see TH1::TH1 for explanation of parameters)
10183
10184TH1L::TH1L(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10185: TH1(name,title,nbins,xbins)
10186{
10187 fDimension = 1;
10189 if (fgDefaultSumw2) Sumw2();
10190}
10191
10192////////////////////////////////////////////////////////////////////////////////
10193/// Destructor.
10194
10196{
10197}
10198
10199////////////////////////////////////////////////////////////////////////////////
10200/// Copy constructor.
10201/// The list of functions is not copied. (Use Clone() if needed)
10202
10203TH1L::TH1L(const TH1L &h1l) : TH1(), TArrayL64()
10204{
10205 h1l.TH1L::Copy(*this);
10206}
10207
10208////////////////////////////////////////////////////////////////////////////////
10209/// Increment bin content by 1.
10210/// Passing an out-of-range bin leads to undefined behavior
10211
10213{
10214 if (fArray[bin] < LLONG_MAX) fArray[bin]++;
10215}
10216
10217////////////////////////////////////////////////////////////////////////////////
10218/// Increment bin content by w.
10219/// \warning The value of w is cast to `Long64_t` before being added.
10220/// Passing an out-of-range bin leads to undefined behavior
10221
10223{
10225 if (newval > -LLONG_MAX && newval < LLONG_MAX) {fArray[bin] = newval; return;}
10226 if (newval < -LLONG_MAX) fArray[bin] = -LLONG_MAX;
10228}
10229
10230////////////////////////////////////////////////////////////////////////////////
10231/// Copy this to newth1
10232
10233void TH1L::Copy(TObject &newth1) const
10234{
10236}
10237
10238////////////////////////////////////////////////////////////////////////////////
10239/// Reset.
10240
10242{
10245}
10246
10247////////////////////////////////////////////////////////////////////////////////
10248/// Set total number of bins including under/overflow
10249/// Reallocate bin contents array
10250
10252{
10253 if (n < 0) n = fXaxis.GetNbins() + 2;
10254 fNcells = n;
10256}
10257
10258////////////////////////////////////////////////////////////////////////////////
10259/// Operator =
10260
10261TH1L& TH1L::operator=(const TH1L &h1)
10262{
10263 if (this != &h1)
10264 h1.TH1L::Copy(*this);
10265 return *this;
10266}
10267
10268
10269////////////////////////////////////////////////////////////////////////////////
10270/// Operator *
10271
10273{
10274 TH1L hnew = h1;
10275 hnew.Scale(c1);
10276 hnew.SetDirectory(nullptr);
10277 return hnew;
10278}
10279
10280////////////////////////////////////////////////////////////////////////////////
10281/// Operator +
10282
10283TH1L operator+(const TH1L &h1, const TH1L &h2)
10284{
10285 TH1L hnew = h1;
10286 hnew.Add(&h2,1);
10287 hnew.SetDirectory(nullptr);
10288 return hnew;
10289}
10290
10291////////////////////////////////////////////////////////////////////////////////
10292/// Operator -
10293
10294TH1L operator-(const TH1L &h1, const TH1L &h2)
10295{
10296 TH1L hnew = h1;
10297 hnew.Add(&h2,-1);
10298 hnew.SetDirectory(nullptr);
10299 return hnew;
10300}
10301
10302////////////////////////////////////////////////////////////////////////////////
10303/// Operator *
10304
10305TH1L operator*(const TH1L &h1, const TH1L &h2)
10306{
10307 TH1L hnew = h1;
10308 hnew.Multiply(&h2);
10309 hnew.SetDirectory(nullptr);
10310 return hnew;
10311}
10312
10313////////////////////////////////////////////////////////////////////////////////
10314/// Operator /
10315
10316TH1L operator/(const TH1L &h1, const TH1L &h2)
10317{
10318 TH1L hnew = h1;
10319 hnew.Divide(&h2);
10320 hnew.SetDirectory(nullptr);
10321 return hnew;
10322}
10323
10324//______________________________________________________________________________
10325// TH1F methods
10326// TH1F : histograms with one float per channel. Maximum precision 7 digits, maximum integer bin content = +/-16777216
10327//______________________________________________________________________________
10328
10329
10330////////////////////////////////////////////////////////////////////////////////
10331/// Constructor.
10332
10333TH1F::TH1F()
10334{
10335 fDimension = 1;
10336 SetBinsLength(3);
10337 if (fgDefaultSumw2) Sumw2();
10338}
10339
10340////////////////////////////////////////////////////////////////////////////////
10341/// Create a 1-Dim histogram with fix bins of type float
10342/// (see TH1::TH1 for explanation of parameters)
10343
10344TH1F::TH1F(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10345: TH1(name,title,nbins,xlow,xup)
10346{
10347 fDimension = 1;
10349
10350 if (xlow >= xup) SetBuffer(fgBufferSize);
10351 if (fgDefaultSumw2) Sumw2();
10352}
10353
10354////////////////////////////////////////////////////////////////////////////////
10355/// Create a 1-Dim histogram with variable bins of type float
10356/// (see TH1::TH1 for explanation of parameters)
10357
10358TH1F::TH1F(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10359: TH1(name,title,nbins,xbins)
10360{
10361 fDimension = 1;
10363 if (fgDefaultSumw2) Sumw2();
10364}
10365
10366////////////////////////////////////////////////////////////////////////////////
10367/// Create a 1-Dim histogram with variable bins of type float
10368/// (see TH1::TH1 for explanation of parameters)
10369
10370TH1F::TH1F(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10371: TH1(name,title,nbins,xbins)
10372{
10373 fDimension = 1;
10375 if (fgDefaultSumw2) Sumw2();
10376}
10377
10378////////////////////////////////////////////////////////////////////////////////
10379/// Create a histogram from a TVectorF
10380/// by default the histogram name is "TVectorF" and title = ""
10381
10382TH1F::TH1F(const TVectorF &v)
10383: TH1("TVectorF","",v.GetNrows(),0,v.GetNrows())
10384{
10386 fDimension = 1;
10387 Int_t ivlow = v.GetLwb();
10388 for (Int_t i=0;i<fNcells-2;i++) {
10389 SetBinContent(i+1,v(i+ivlow));
10390 }
10392 if (fgDefaultSumw2) Sumw2();
10393}
10394
10395////////////////////////////////////////////////////////////////////////////////
10396/// Copy Constructor.
10397/// The list of functions is not copied. (Use Clone() if needed)
10398
10399TH1F::TH1F(const TH1F &h1f) : TH1(), TArrayF()
10400{
10401 h1f.TH1F::Copy(*this);
10402}
10403
10404////////////////////////////////////////////////////////////////////////////////
10405/// Destructor.
10406
10408{
10409}
10410
10411////////////////////////////////////////////////////////////////////////////////
10412/// Copy this to newth1.
10413
10414void TH1F::Copy(TObject &newth1) const
10415{
10417}
10418
10419////////////////////////////////////////////////////////////////////////////////
10420/// Reset.
10421
10423{
10426}
10427
10428////////////////////////////////////////////////////////////////////////////////
10429/// Set total number of bins including under/overflow
10430/// Reallocate bin contents array
10431
10433{
10434 if (n < 0) n = fXaxis.GetNbins() + 2;
10435 fNcells = n;
10436 TArrayF::Set(n);
10437}
10438
10439////////////////////////////////////////////////////////////////////////////////
10440/// Operator =
10441
10443{
10444 if (this != &h1f)
10445 h1f.TH1F::Copy(*this);
10446 return *this;
10447}
10448
10449////////////////////////////////////////////////////////////////////////////////
10450/// Operator *
10451
10453{
10454 TH1F hnew = h1;
10455 hnew.Scale(c1);
10456 hnew.SetDirectory(nullptr);
10457 return hnew;
10458}
10459
10460////////////////////////////////////////////////////////////////////////////////
10461/// Operator +
10462
10463TH1F operator+(const TH1F &h1, const TH1F &h2)
10464{
10465 TH1F hnew = h1;
10466 hnew.Add(&h2,1);
10467 hnew.SetDirectory(nullptr);
10468 return hnew;
10469}
10470
10471////////////////////////////////////////////////////////////////////////////////
10472/// Operator -
10473
10474TH1F operator-(const TH1F &h1, const TH1F &h2)
10475{
10476 TH1F hnew = h1;
10477 hnew.Add(&h2,-1);
10478 hnew.SetDirectory(nullptr);
10479 return hnew;
10480}
10481
10482////////////////////////////////////////////////////////////////////////////////
10483/// Operator *
10484
10485TH1F operator*(const TH1F &h1, const TH1F &h2)
10486{
10487 TH1F hnew = h1;
10488 hnew.Multiply(&h2);
10489 hnew.SetDirectory(nullptr);
10490 return hnew;
10491}
10492
10493////////////////////////////////////////////////////////////////////////////////
10494/// Operator /
10495
10496TH1F operator/(const TH1F &h1, const TH1F &h2)
10497{
10498 TH1F hnew = h1;
10499 hnew.Divide(&h2);
10500 hnew.SetDirectory(nullptr);
10501 return hnew;
10502}
10503
10504//______________________________________________________________________________
10505// TH1D methods
10506// TH1D : histograms with one double per channel. Maximum precision 14 digits, maximum integer bin content = +/-9007199254740992
10507//______________________________________________________________________________
10508
10509
10510////////////////////////////////////////////////////////////////////////////////
10511/// Constructor.
10512
10513TH1D::TH1D()
10514{
10515 fDimension = 1;
10516 SetBinsLength(3);
10517 if (fgDefaultSumw2) Sumw2();
10518}
10519
10520////////////////////////////////////////////////////////////////////////////////
10521/// Create a 1-Dim histogram with fix bins of type double
10522/// (see TH1::TH1 for explanation of parameters)
10523
10524TH1D::TH1D(const char *name,const char *title,Int_t nbins,Double_t xlow,Double_t xup)
10525: TH1(name,title,nbins,xlow,xup)
10526{
10527 fDimension = 1;
10529
10530 if (xlow >= xup) SetBuffer(fgBufferSize);
10531 if (fgDefaultSumw2) Sumw2();
10532}
10533
10534////////////////////////////////////////////////////////////////////////////////
10535/// Create a 1-Dim histogram with variable bins of type double
10536/// (see TH1::TH1 for explanation of parameters)
10537
10538TH1D::TH1D(const char *name,const char *title,Int_t nbins,const Float_t *xbins)
10539: TH1(name,title,nbins,xbins)
10540{
10541 fDimension = 1;
10543 if (fgDefaultSumw2) Sumw2();
10544}
10545
10546////////////////////////////////////////////////////////////////////////////////
10547/// Create a 1-Dim histogram with variable bins of type double
10548/// (see TH1::TH1 for explanation of parameters)
10549
10550TH1D::TH1D(const char *name,const char *title,Int_t nbins,const Double_t *xbins)
10551: TH1(name,title,nbins,xbins)
10552{
10553 fDimension = 1;
10555 if (fgDefaultSumw2) Sumw2();
10556}
10557
10558////////////////////////////////////////////////////////////////////////////////
10559/// Create a histogram from a TVectorD
10560/// by default the histogram name is "TVectorD" and title = ""
10561
10562TH1D::TH1D(const TVectorD &v)
10563: TH1("TVectorD","",v.GetNrows(),0,v.GetNrows())
10564{
10566 fDimension = 1;
10567 Int_t ivlow = v.GetLwb();
10568 for (Int_t i=0;i<fNcells-2;i++) {
10569 SetBinContent(i+1,v(i+ivlow));
10570 }
10572 if (fgDefaultSumw2) Sumw2();
10573}
10574
10575////////////////////////////////////////////////////////////////////////////////
10576/// Destructor.
10577
10579{
10580}
10581
10582////////////////////////////////////////////////////////////////////////////////
10583/// Constructor.
10584
10585TH1D::TH1D(const TH1D &h1d) : TH1(), TArrayD()
10586{
10587 // intentially call virtual method to warn if TProfile is copying
10588 h1d.Copy(*this);
10589}
10590
10591////////////////////////////////////////////////////////////////////////////////
10592/// Copy this to newth1
10593
10594void TH1D::Copy(TObject &newth1) const
10595{
10597}
10598
10599////////////////////////////////////////////////////////////////////////////////
10600/// Reset.
10601
10603{
10606}
10607
10608////////////////////////////////////////////////////////////////////////////////
10609/// Set total number of bins including under/overflow
10610/// Reallocate bin contents array
10611
10613{
10614 if (n < 0) n = fXaxis.GetNbins() + 2;
10615 fNcells = n;
10616 TArrayD::Set(n);
10617}
10618
10619////////////////////////////////////////////////////////////////////////////////
10620/// Operator =
10621
10623{
10624 // intentially call virtual method to warn if TProfile is copying
10625 if (this != &h1d)
10626 h1d.Copy(*this);
10627 return *this;
10628}
10629
10630////////////////////////////////////////////////////////////////////////////////
10631/// Operator *
10632
10634{
10635 TH1D hnew = h1;
10636 hnew.Scale(c1);
10637 hnew.SetDirectory(nullptr);
10638 return hnew;
10639}
10640
10641////////////////////////////////////////////////////////////////////////////////
10642/// Operator +
10643
10644TH1D operator+(const TH1D &h1, const TH1D &h2)
10645{
10646 TH1D hnew = h1;
10647 hnew.Add(&h2,1);
10648 hnew.SetDirectory(nullptr);
10649 return hnew;
10650}
10651
10652////////////////////////////////////////////////////////////////////////////////
10653/// Operator -
10654
10655TH1D operator-(const TH1D &h1, const TH1D &h2)
10656{
10657 TH1D hnew = h1;
10658 hnew.Add(&h2,-1);
10659 hnew.SetDirectory(nullptr);
10660 return hnew;
10661}
10662
10663////////////////////////////////////////////////////////////////////////////////
10664/// Operator *
10665
10666TH1D operator*(const TH1D &h1, const TH1D &h2)
10667{
10668 TH1D hnew = h1;
10669 hnew.Multiply(&h2);
10670 hnew.SetDirectory(nullptr);
10671 return hnew;
10672}
10673
10674////////////////////////////////////////////////////////////////////////////////
10675/// Operator /
10676
10677TH1D operator/(const TH1D &h1, const TH1D &h2)
10678{
10679 TH1D hnew = h1;
10680 hnew.Divide(&h2);
10681 hnew.SetDirectory(nullptr);
10682 return hnew;
10683}
10684
10685////////////////////////////////////////////////////////////////////////////////
10686///return pointer to histogram with name
10687///hid if id >=0
10688///h_id if id <0
10689
10690TH1 *R__H(Int_t hid)
10691{
10692 TString hname;
10693 if(hid >= 0) hname.Form("h%d",hid);
10694 else hname.Form("h_%d",hid);
10695 return (TH1*)gDirectory->Get(hname);
10696}
10697
10698////////////////////////////////////////////////////////////////////////////////
10699///return pointer to histogram with name hname
10700
10701TH1 *R__H(const char * hname)
10702{
10703 return (TH1*)gDirectory->Get(hname);
10704}
10705
10706
10707/// \fn void TH1::SetBarOffset(Float_t offset)
10708/// Set the bar offset as fraction of the bin width for drawing mode "B".
10709/// This shifts bars to the right on the x axis, and helps to draw bars next to each other.
10710/// \see THistPainter, SetBarWidth()
10711
10712/// \fn void TH1::SetBarWidth(Float_t width)
10713/// Set the width of bars as fraction of the bin width for drawing mode "B".
10714/// This allows for making bars narrower than the bin width. With SetBarOffset(), this helps to draw multiple bars next to each other.
10715/// \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:148
static bool IsEquidistantBinning(const TAxis &axis)
Test if the binning is equidistant.
Definition TH1.cxx:5960
void H1LeastSquareLinearFit(Int_t ndata, Double_t &a0, Double_t &a1, Int_t &ifail)
Least square linear fit without weights.
Definition TH1.cxx:4906
void H1InitGaus()
Compute Initial values of parameters for a gaussian.
Definition TH1.cxx:4741
void H1InitExpo()
Compute Initial values of parameters for an exponential.
Definition TH1.cxx:4797
TH1C operator+(const TH1C &h1, const TH1C &h2)
Operator +.
Definition TH1.cxx:9722
TH1C operator-(const TH1C &h1, const TH1C &h2)
Operator -.
Definition TH1.cxx:9733
TH1C operator/(const TH1C &h1, const TH1C &h2)
Operator /.
Definition TH1.cxx:9755
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:4952
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:5943
static Bool_t AlmostInteger(Double_t a, Double_t epsilon=0.00000001)
Test if a double is almost an integer.
Definition TH1.cxx:5951
TF1 * gF1
Definition TH1.cxx:604
TH1 * R__H(Int_t hid)
return pointer to histogram with name hid if id >=0 h_id if id <0
Definition TH1.cxx:10688
TH1C operator*(Double_t c1, const TH1C &h1)
Operator *.
Definition TH1.cxx:9711
void H1LeastSquareFit(Int_t n, Int_t m, Double_t *a)
Least squares lpolynomial fitting without weights.
Definition TH1.cxx:4847
void H1InitPolynom()
Compute Initial values of parameters for a polynom.
Definition TH1.cxx:4817
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:783
R__EXTERN TVirtualMutex * gROOTMutex
Definition TROOT.h:63
#define gROOT
Definition TROOT.h:426
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:32
void Copy(TAttFill &attfill) const
Copy this fill attributes to a new TAttFill.
Definition TAttFill.cxx:203
virtual Style_t GetFillStyle() const
Return the fill area style.
Definition TAttFill.h:33
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:240
virtual void Streamer(TBuffer &)
virtual Color_t GetLineColor() const
Return the line color.
Definition TAttLine.h:36
virtual void SetLineStyle(Style_t lstyle)
Set the line style.
Definition TAttLine.h:46
virtual Width_t GetLineWidth() const
Return the line width.
Definition TAttLine.h:38
virtual Style_t GetLineStyle() const
Return the line style.
Definition TAttLine.h:37
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:289
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:34
virtual void SetMarkerColor(Color_t mcolor=1)
Set the marker color.
Definition TAttMarker.h:41
virtual Color_t GetMarkerColor() const
Return the marker color.
Definition TAttMarker.h:33
virtual Size_t GetMarkerSize() const
Return the marker size.
Definition TAttMarker.h:35
virtual void SetMarkerStyle(Style_t mstyle=1)
Set the marker style.
Definition TAttMarker.h:43
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:48
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:5048
ROOT::NewFunc_t GetNew() const
Return the wrapper around new ThisClass().
Definition TClass.cxx:7612
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.
TDirectory::TContext keeps track and restore the current directory.
Definition TDirectory.h:89
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:9635
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:9691
TH1C & operator=(const TH1C &h1)
Operator =.
Definition TH1.cxx:9701
TH1C()
Constructor.
Definition TH1.cxx:9587
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:9673
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:9652
void Reset(Option_t *option="") override
Reset.
Definition TH1.cxx:9681
1-D histogram with a double per channel (see TH1 documentation)
Definition TH1.h:926
~TH1D() override
Destructor.
Definition TH1.cxx:10576
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10610
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10592
TH1D()
Constructor.
Definition TH1.cxx:10511
TH1D & operator=(const TH1D &h1)
Operator =.
Definition TH1.cxx:10620
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:10440
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10412
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10430
~TH1F() override
Destructor.
Definition TH1.cxx:10405
TH1F()
Constructor.
Definition TH1.cxx:10331
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:10062
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:10023
~TH1I() override
Destructor.
Definition TH1.cxx:10006
TH1I()
Constructor.
Definition TH1.cxx:9958
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10044
TH1I & operator=(const TH1I &h1)
Operator =.
Definition TH1.cxx:10072
1-D histogram with a long64 per channel (see TH1 documentation)
Definition TH1.h:837
TH1L & operator=(const TH1L &h1)
Operator =.
Definition TH1.cxx:10259
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:10210
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:10249
~TH1L() override
Destructor.
Definition TH1.cxx:10193
TH1L()
Constructor.
Definition TH1.cxx:10145
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:10231
1-D histogram with a short per channel (see TH1 documentation)
Definition TH1.h:755
TH1S & operator=(const TH1S &h1)
Operator =.
Definition TH1.cxx:9886
void Copy(TObject &hnew) const override
Copy this to newth1.
Definition TH1.cxx:9858
TH1S()
Constructor.
Definition TH1.cxx:9772
void SetBinsLength(Int_t n=-1) override
Set total number of bins including under/overflow Reallocate bin contents array.
Definition TH1.cxx:9876
~TH1S() override
Destructor.
Definition TH1.cxx:9820
void AddBinContent(Int_t bin) override
Increment bin content by 1.
Definition TH1.cxx:9837
TH1 is the base class of all histogram classes in ROOT.
Definition TH1.h:109
~TH1() override
Histogram default destructor.
Definition TH1.cxx:650
virtual void SetError(const Double_t *error)
Replace bin errors by values in array error.
Definition TH1.cxx:9088
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:9074
virtual void FitPanel()
Display a panel with all histogram fit options.
Definition TH1.cxx:4340
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:1358
virtual Double_t GetEffectiveEntries() const
Number of effective entries of the histogram.
Definition TH1.cxx:4503
char * GetObjectInfo(Int_t px, Int_t py) const override
Redefines TObject::GetObjectInfo.
Definition TH1.cxx:4557
virtual void Smooth(Int_t ntimes=1, Option_t *option="")
Smooth bin contents of this histogram.
Definition TH1.cxx:7004
virtual Double_t GetBinCenter(Int_t bin) const
Return bin center for 1D histogram.
Definition TH1.cxx:9275
virtual void Rebuild(Option_t *option="")
Using the current bin info, recompute the arrays for contents and errors.
Definition TH1.cxx:7212
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:3852
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:2856
virtual Bool_t Multiply(TF1 *f1, Double_t c1=1)
Performs the operation:
Definition TH1.cxx:6131
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:7946
virtual void Normalize(Option_t *option="")
Normalize a histogram to its integral or to its maximum.
Definition TH1.cxx:6293
void Copy(TObject &hnew) const override
Copy this histogram structure to newth1.
Definition TH1.cxx:2705
void SetTitle(const char *title) override
Change/set the title.
Definition TH1.cxx:6836
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:7050
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:8039
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
@ kNstat
Size of statistics data (up to TProfile3D)
Definition TH1.h:422
static TClass * Class()
static Int_t GetDefaultBufferSize()
Static function return the default buffer size for automatic histograms the parameter fgBufferSize ma...
Definition TH1.cxx:4461
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:8110
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:7720
TH1()
Histogram default constructor.
Definition TH1.cxx:622
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:9453
void UseCurrentStyle() override
Copy current attributes from/to current style.
Definition TH1.cxx:7582
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:5464
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:2084
static bool CheckBinLimits(const TAxis *a1, const TAxis *a2)
Check bin limits.
Definition TH1.cxx:1556
virtual Double_t GetBinError(Int_t bin) const
Return value of error associated to bin number bin.
Definition TH1.cxx:9197
static Int_t FitOptionsMake(Option_t *option, Foption_t &Foption)
Decode string choptin and fill fitOption structure.
Definition TH1.cxx:4732
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:7648
virtual Double_t GetSkewness(Int_t axis=1) const
Definition TH1.cxx:7784
virtual void ClearUnderflowAndOverflow()
Remove all the content from the underflow and overflow bins, without changing the number of entries A...
Definition TH1.cxx:2540
virtual void FillRandom(TF1 *f1, Int_t ntimes=5000, TRandom *rng=nullptr)
Definition TH1.cxx:3577
virtual Double_t GetContourLevelPad(Int_t level) const
Return the value of contour number "level" in Pad coordinates.
Definition TH1.cxx:8573
virtual TH1 * DrawNormalized(Option_t *option="", Double_t norm=1) const
Draw a normalized copy of this histogram.
Definition TH1.cxx:3193
@ 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:7058
static void AddDirectory(Bool_t add=kTRUE)
Sets the flag controlling the automatic add of histograms in memory.
Definition TH1.cxx:1309
@ 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:8659
virtual Bool_t CanExtendAllAxes() const
Returns true if all axes are extendable.
Definition TH1.cxx:6751
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:7228
void SetNameTitle(const char *name, const char *title) override
Change the name and title of this histogram.
Definition TH1.cxx:9111
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:5054
TH1 * GetCumulative(Bool_t forward=kTRUE, const char *suffix="_cumulative") const
Return a pointer to a histogram containing the cumulative content.
Definition TH1.cxx:2650
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:1323
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:9435
static Bool_t RecomputeAxisLimits(TAxis &destAxis, const TAxis &anAxis)
Finds new limits for the axis for the Merge function.
Definition TH1.cxx:5990
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:7997
TVirtualHistPainter * GetPainter(Option_t *option="")
Return pointer to painter.
Definition TH1.cxx:4566
TObject * FindObject(const char *name) const override
Search object named name in the list of functions.
Definition TH1.cxx:3912
void Print(Option_t *option="") const override
Print some global quantities for this histogram.
Definition TH1.cxx:7134
static Bool_t GetDefaultSumw2()
Return kTRUE if TH1::Sumw2 must be called when creating new histograms.
Definition TH1.cxx:4470
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:3789
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:3954
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:5041
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:8682
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:3333
virtual void LabelsInflate(Option_t *axis="X")
Double the number of bins for axis.
Definition TH1.cxx:5397
virtual TH1 * ShowBackground(Int_t niter=20, Option_t *option="same")
This function calculates the background spectrum in this histogram.
Definition TH1.cxx:9421
static Bool_t SameLimitsAndNBins(const TAxis &axis1, const TAxis &axis2)
Same limits and bins.
Definition TH1.cxx:5980
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:836
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:7367
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:8101
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:9340
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:3393
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:9213
void Browse(TBrowser *b) override
Browse the Histogram object.
Definition TH1.cxx:772
virtual void SetContent(const Double_t *content)
Replace bin contents by the contents of array content.
Definition TH1.cxx:8531
void Draw(Option_t *option="") override
Draw this histogram with options.
Definition TH1.cxx:3097
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:7494
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:5296
void SavePrimitive(std::ostream &out, Option_t *option="") override
Save primitive as a C++ statement(s) on output stream out.
Definition TH1.cxx:7389
static bool CheckBinLabels(const TAxis *a1, const TAxis *a2)
Check that axis have same labels.
Definition TH1.cxx:1583
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:5197
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:6818
virtual void SetBuffer(Int_t bufsize, Option_t *option="")
Set the maximum number of entries to be kept in the buffer.
Definition TH1.cxx:8591
Bool_t IsBinOverflow(Int_t bin, Int_t axis=0) const
Return true if the bin is overflow.
Definition TH1.cxx:5264
UInt_t GetAxisLabelStatus() const
Internal function used in TH1::Fill to see which axis is full alphanumeric, i.e.
Definition TH1.cxx:6790
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:8074
static void SetDefaultBufferSize(Int_t bufsize=1000)
Static function to set the default buffer size for automatic histograms.
Definition TH1.cxx:6808
@ 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
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:9356
virtual void DirectoryAutoAdd(TDirectory *)
Callback to perform the automatic addition of the histogram to the given directory.
Definition TH1.cxx:2834
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:9321
virtual Double_t GetBinLowEdge(Int_t bin) const
Return bin lower edge for 1D histogram.
Definition TH1.cxx:9286
void Build()
Creates histogram basic data structure.
Definition TH1.cxx:781
virtual Double_t GetEntries() const
Return the current number of entries.
Definition TH1.cxx:4478
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:9185
virtual TH1 * Rebin(Int_t ngroup=2, const char *newname="", const Double_t *xbins=nullptr)
Rebin this histogram.
Definition TH1.cxx:6390
virtual Int_t BufferFill(Double_t x, Double_t w)
accumulate arguments in buffer.
Definition TH1.cxx:1521
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:5168
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:6764
TList * GetListOfFunctions() const
Definition TH1.h:488
void SetName(const char *name) override
Change the name of this histogram.
Definition TH1.cxx:9097
virtual TH1 * DrawCopy(Option_t *option="", const char *name_postfix="_copy") const
Copy this histogram and Draw in the current pad.
Definition TH1.cxx:3162
virtual Double_t GetRandom(TRandom *rng=nullptr, Option_t *option="") const
Return a random number distributed according the histogram bin contents.
Definition TH1.cxx:5091
Bool_t IsEmpty() const
Check if a histogram is empty (this is a protected method used mainly by TH1Merger )
Definition TH1.cxx:5246
virtual Double_t GetMeanError(Int_t axis=1) const
Return standard error of mean of this histogram along the X axis.
Definition TH1.cxx:7688
void Paint(Option_t *option="") override
Control routine to paint any kind of histograms.
Definition TH1.cxx:6321
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:8195
virtual void ResetStats()
Reset the statistics including the number of entries and replace with values calculated from bin cont...
Definition TH1.cxx:8015
virtual void SetBinErrorOption(EBinErrorOpt type)
Definition TH1.h:629
virtual void DrawPanel()
Display a panel with all histogram drawing options.
Definition TH1.cxx:3224
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:2518
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:2025
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:3522
virtual void GetMinimumAndMaximum(Double_t &min, Double_t &max) const
Retrieve the minimum and maximum values in the histogram.
Definition TH1.cxx:8868
virtual Int_t GetMaximumBin() const
Return location of bin with maximum value in the range.
Definition TH1.cxx:8714
static Int_t AutoP2GetBins(Int_t n)
Auxiliary function to get the next power of 2 integer value larger then n.
Definition TH1.cxx:1336
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:4522
void ExecuteEvent(Int_t event, Int_t px, Int_t py) override
Execute action corresponding to one event.
Definition TH1.cxx:3289
virtual Double_t * GetIntegral()
Return a pointer to the array of bins integral.
Definition TH1.cxx:2620
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:3496
static bool CheckEqualAxes(const TAxis *a1, const TAxis *a2)
Check that the axis are the same.
Definition TH1.cxx:1626
@ 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:5143
virtual Int_t GetContour(Double_t *levels=nullptr)
Return contour values into array levels if pointer levels is non zero.
Definition TH1.cxx:8544
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:6619
virtual Double_t GetBinWidth(Int_t bin) const
Return bin width for 1D histogram.
Definition TH1.cxx:9297
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:4395
virtual Double_t GetContourLevel(Int_t level) const
Return value of contour number level.
Definition TH1.cxx:8563
virtual void SetContour(Int_t nlevels, const Double_t *levels=nullptr)
Set the number and values of contour levels.
Definition TH1.cxx:8620
virtual void SetHighlight(Bool_t set=kTRUE)
Set highlight (enable/disable) mode for the histogram by default highlight mode is disable.
Definition TH1.cxx:4537
virtual Double_t GetBinErrorUp(Int_t bin) const
Return upper error associated to bin number bin.
Definition TH1.cxx:9244
virtual void Scale(Double_t c1=1, Option_t *option="")
Multiply this histogram by a constant c1.
Definition TH1.cxx:6719
virtual Int_t GetMinimumBin() const
Return location of bin with minimum value in the range.
Definition TH1.cxx:8802
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:2565
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:3727
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:7306
virtual Int_t GetQuantiles(Int_t n, Double_t *xp, const Double_t *p=nullptr)
Compute Quantiles for this histogram.
Definition TH1.cxx:4670
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:2786
virtual Double_t GetStdDevError(Int_t axis=1) const
Return error of standard deviation estimation for Normal distribution.
Definition TH1.cxx:7768
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:2873
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:8772
int LoggedInconsistency(const char *name, const TH1 *h1, const TH1 *h2, bool useMerge=false) const
Definition TH1.cxx:893
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:1655
static Int_t CheckConsistency(const TH1 *h1, const TH1 *h2)
Check histogram compatibility.
Definition TH1.cxx:1694
void RecursiveRemove(TObject *obj) override
Recursively remove object from the list of functions.
Definition TH1.cxx:6691
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:8311
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:6893
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:9308
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:8904
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:3760
virtual void Sumw2(Bool_t flag=kTRUE)
Create structure to store sum of squares of weights.
Definition TH1.cxx:9157
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:6575
static bool CheckAxisLimits(const TAxis *a1, const TAxis *a2)
Check that the axis limits of the histograms are the same.
Definition TH1.cxx:1612
static Bool_t AddDirectoryStatus()
Check whether TH1-derived classes should register themselves to the current gDirectory.
Definition TH1.cxx:764
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:7548
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:5327
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:3241
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:1429
virtual void SetStats(Bool_t stats=kTRUE)
Set statistics option on/off.
Definition TH1.cxx:9127
virtual Double_t GetKurtosis(Int_t axis=1) const
Definition TH1.cxx:7857
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:459
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:477
virtual const char * ClassName() const
Returns name of class to which the object belongs.
Definition TObject.cxx:224
virtual void UseCurrentStyle()
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyl...
Definition TObject.cxx:906
virtual void Warning(const char *method, const char *msgfmt,...) const
Issue warning message.
Definition TObject.cxx:1081
virtual void AppendPad(Option_t *option="")
Append graphics object to current pad.
Definition TObject.cxx:201
virtual void SaveAs(const char *filename="", Option_t *option="") const
Save this object in the file specified by filename.
Definition TObject.cxx:705
void SetBit(UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.
Definition TObject.cxx:885
virtual Bool_t InheritsFrom(const char *classname) const
Returns kTRUE if object inherits from class "classname".
Definition TObject.cxx:546
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1095
virtual void SetUniqueID(UInt_t uid)
Set the unique object id.
Definition TObject.cxx:896
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:842
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:793
void ResetBit(UInt_t f)
Definition TObject.h:203
@ kCanDelete
if object in a list can be deleted
Definition TObject.h:71
@ kInvalidObject
if object ctor succeeded but object should not be used
Definition TObject.h:81
@ kMustCleanup
if object destructor must call RecursiveRemove()
Definition TObject.h:73
virtual void Info(const char *method, const char *msgfmt,...) const
Issue info message.
Definition TObject.cxx:1069
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:409
bool ObjectAutoRegistrationEnabled()
Test whether objects in this thread auto-register themselves, e.g.
Definition TROOT.cxx:768
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, bool useIntegral=false)
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