Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
THnBase Class Referenceabstract

Multidimensional histogram base.

Defines common functionality and interfaces for THn, THnSparse.

Definition at line 43 of file THnBase.h.

Public Member Functions

 ~THnBase () override
 Destruct a THnBase.
 
void Add (const TH1 *hist, Double_t c=1.)
 Fill the THnBase with the bins of hist that have content or error != 0.
 
void Add (const THnBase *h, Double_t c=1.)
 Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
 
void AddBinContent (const Int_t *x, Double_t v=1.)
 
virtual void AddBinContent (Long64_t bin, Double_t v=1.)=0
 
virtual void AddBinError2 (Long64_t bin, Double_t e2)=0
 
void Browse (TBrowser *b) override
 Browse a THnSparse: create an entry (ROOT::THnSparseBrowsable) for each dimension.
 
void CalculateErrors (Bool_t calc=kTRUE)
 Calculate errors (or not if "calc" == kFALSE)
 
Double_t ComputeIntegral ()
 Compute integral (normalized cumulative sum of bins) w/o under/overflows The result is stored in fIntegral and used by the GetRandom functions.
 
virtual ROOT::Internal::THnBaseBinIterCreateIter (Bool_t respectAxisRange) const =0
 
void Divide (const THnBase *h)
 Divide this histogram by h this = this/(h) Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
 
void Divide (const THnBase *h1, const THnBase *h2, Double_t c1=1., Double_t c2=1., Option_t *option="")
 Replace contents of this histogram by multiplication of h1 by h2 this = (c1*h1)/(c2*h2) Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this if not already set.
 
Long64_t Fill (const char *name[], Double_t w=1.)
 
Long64_t Fill (const Double_t *x, Double_t w=1.)
 
template<typename... MoreTypes>
Long64_t Fill (Double_t firstval, MoreTypes... morevals)
 Fill with the provided variadic arguments.
 
virtual void FillBin (Long64_t bin, Double_t w)=0
 
TFitResultPtr Fit (TF1 *f1, Option_t *option="", Option_t *goption="")
 Fit a THnSparse with function f.
 
TAxisGetAxis (Int_t dim) const
 
virtual Long64_t GetBin (const char *name[]) const =0
 
virtual Long64_t GetBin (const char *name[], Bool_t=kTRUE)=0
 
virtual Long64_t GetBin (const Double_t *x) const =0
 
virtual Long64_t GetBin (const Double_t *x, Bool_t=kTRUE)=0
 
virtual Long64_t GetBin (const Int_t *idx) const =0
 
virtual Long64_t GetBin (const Int_t *idx, Bool_t=kTRUE)=0
 
std::vector< Double_tGetBinCenter (const std::vector< Int_t > &idx) const
 THnBase::GetBinCenter.
 
Double_t GetBinContent (const Int_t *idx) const
 
virtual Double_t GetBinContent (Long64_t bin, Int_t *idx=nullptr) const =0
 
Double_t GetBinError (const Int_t *idx) const
 
Double_t GetBinError (Long64_t linidx) const
 
virtual Double_t GetBinError2 (Long64_t linidx) const =0
 
Bool_t GetCalculateErrors () const
 
Double_t GetEntries () const
 
TObjArrayGetListOfAxes ()
 
const TObjArrayGetListOfAxes () const
 
TListGetListOfFunctions ()
 
virtual Long64_t GetNbins () const =0
 
Int_t GetNdimensions () const
 
void GetRandom (Double_t *rand, Bool_t subBinRandom=kTRUE)
 Generate an n-dimensional random tuple based on the histogrammed distribution.
 
Double_t GetSumw () const
 
Double_t GetSumw2 () const
 
Double_t GetSumwx (Int_t dim) const
 
Double_t GetSumwx2 (Int_t dim) const
 
Double_t GetWeightSum () const
 
Double_t Integral (Bool_t respectAxisRange) const
 Compute integral (sum of counts) of histogram in all dimensions.
 
TClassIsA () const override
 
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
Bool_t IsInRange (Int_t *coord) const
 Check whether bin coord is in range, as defined by TAxis::SetRange().
 
Long64_t Merge (TCollection *list)
 Merge this with a list of THnBase's.
 
void Multiply (const THnBase *h)
 Multiply this histogram by histogram h this = this * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
 
void Multiply (TF1 *f, Double_t c=1.)
 Performs the operation: this = this*c*f1 if errors are defined, errors are also recalculated.
 
void Print (Option_t *option="") const override
 Print a THnBase.
 
void PrintBin (Int_t *coord, Option_t *options) const
 
void PrintBin (Long64_t idx, Option_t *options) const
 Print bin with linex index "idx".
 
void PrintEntries (Long64_t from=0, Long64_t howmany=-1, Option_t *options=nullptr) const
 Print "howmany" entries starting at "from".
 
TH3DProjection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
 Project all bins into a 3-dimensional histogram, keeping only axes "xDim", "yDim", and "zDim".
 
TH1DProjection (Int_t xDim, Option_t *option="") const
 Project all bins into a 1-dimensional histogram, keeping only axis "xDim".
 
TH2DProjection (Int_t yDim, Int_t xDim, Option_t *option="") const
 Project all bins into a 2-dimensional histogram, keeping only axes "xDim" and "yDim".
 
THnBaseProjectionND (Int_t ndim, const Int_t *dim, Option_t *option="") const
 
void RebinnedAdd (const THnBase *h, Double_t c=1.)
 Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.
 
virtual void Reset (Option_t *option="")=0
 
void Scale (Double_t c)
 Scale contents and errors of this histogram by c: this = this * c It does not modify the histogram's number of entries.
 
void SetBinContent (const Int_t *idx, Double_t v)
 
virtual void SetBinContent (Long64_t bin, Double_t v)=0
 
void SetBinEdges (Int_t idim, const Double_t *bins)
 Set the axis # of bins and bin limits on dimension idim.
 
void SetBinError (const Int_t *idx, Double_t e)
 
void SetBinError (Long64_t bin, Double_t e)
 
virtual void SetBinError2 (Long64_t bin, Double_t e2)=0
 
void SetEntries (Double_t entries)
 
void SetTitle (const char *title) override
 Change (i.e.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void Sumw2 ()=0
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Types

enum  { kNoInt , kValidInt , kInvalidInt }
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

Protected Member Functions

 THnBase ()
 
 THnBase (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax)
 Construct a THnBase with "dim" dimensions, "nbins" holds the number of bins for each dimension; "xmin" and "xmax" the minimal and maximal value for each dimension.
 
 THnBase (const char *name, const char *title, Int_t dim, const Int_t *nbins, const std::vector< std::vector< double > > &xbins)
 
 THnBase (const THnBase &other)
 
 THnBase (THnBase &&other)
 
void AddInternal (const THnBase *h, Double_t c, Bool_t rebinned)
 Add() implementation for both rebinned histograms and those with identical binning.
 
Bool_t CheckConsistency (const THnBase *h, const char *tag) const
 Consistency check on (some of) the parameters of two histograms (for operations).
 
THnBaseCloneEmpty (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
 Create a new THnBase object that is of the same type as *this, but with dimensions and bins given by axes.
 
TH1CreateHist (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
 Create an empty histogram with name and title with a given set of axes.
 
void FillBinBase (Double_t w)
 Increment the statistics due to filled weight "w",.
 
void Init (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis, Int_t chunkSize=1024 *16)
 Initialize axes and name.
 
virtual void InitStorage (Int_t *nbins, Int_t chunkSize)=0
 
THnBaseoperator= (const THnBase &other)
 
THnBaseoperator= (THnBase &&other)
 
Bool_t PrintBin (Long64_t idx, Int_t *coord, Option_t *options) const
 Print one bin.
 
TObjectProjectionAny (Int_t ndim, const Int_t *dim, Bool_t wantNDim, Option_t *option="") const
 Project all bins into a ndim-dimensional THn / THnSparse (whatever *this is) or if (ndim < 4 and !wantNDim) a TH1/2/3 histogram, keeping only axes in dim (specifying ndim dimensions).
 
THnBaseRebinBase (const Int_t *group) const
 Combine the content of "group" neighboring bins for each dimension into a new bin and return the resulting THnBase.
 
THnBaseRebinBase (Int_t group) const
 Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase.
 
virtual void Reserve (Long64_t)
 
void ResetBase (Option_t *option="")
 Clear the histogram.
 
virtual void SetFilledBins (Long64_t)
 
void UpdateXStat (const Double_t *x, Double_t w=1.)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

Static Protected Member Functions

static THnBaseCreateHnAny (const char *name, const char *title, const TH1 *h1, Bool_t sparse, Int_t chunkSize=1024 *16)
 Create a THn / THnSparse object from a histogram deriving from TH1.
 
static THnBaseCreateHnAny (const char *name, const char *title, const THnBase *hn, Bool_t sparse, Int_t chunkSize=1024 *16)
 Create a THnSparse (if "sparse") or THn from "hn", possibly converting THn <-> THnSparse.
 

Protected Attributes

TObjArray fAxes
 Axes of the histogram.
 
TObjArray fBrowsables
 ! Browser-helpers for each axis
 
Double_t fEntries
 Number of entries, spread over chunks.
 
std::vector< Double_tfIntegral
 ! vector with bin weight sums
 
enum THnBase:: { ... }  fIntegralStatus
 ! status of integral
 
Int_t fNdimensions
 Number of dimensions.
 
Double_t fTsumw
 Total sum of weights.
 
Double_t fTsumw2
 Total sum of weights squared; -1 if no errors are calculated.
 
TArrayD fTsumwx
 Total sum of weight*X for each dimension.
 
TArrayD fTsumwx2
 Total sum of weight*X*X for each dimension.
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Friends

class THnIter
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

#include <THnBase.h>

Inheritance diagram for THnBase:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
kNoInt 
kValidInt 
kInvalidInt 

Definition at line 54 of file THnBase.h.

Constructor & Destructor Documentation

◆ THnBase() [1/5]

THnBase::THnBase ( )
inlineprotected

Definition at line 61 of file THnBase.h.

◆ THnBase() [2/5]

THnBase::THnBase ( const char *  name,
const char *  title,
Int_t  dim,
const Int_t nbins,
const Double_t xmin,
const Double_t xmax 
)
protected

Construct a THnBase with "dim" dimensions, "nbins" holds the number of bins for each dimension; "xmin" and "xmax" the minimal and maximal value for each dimension.

The arrays "xmin" and "xmax" can be NULL; in that case SetBinEdges() must be called for each dimension.

Definition at line 52 of file THnBase.cxx.

◆ THnBase() [3/5]

THnBase::THnBase ( const char *  name,
const char *  title,
Int_t  dim,
const Int_t nbins,
const std::vector< std::vector< double > > &  xbins 
)
protected

Definition at line 67 of file THnBase.cxx.

◆ THnBase() [4/5]

THnBase::THnBase ( const THnBase other)
protected

Definition at line 88 of file THnBase.cxx.

◆ THnBase() [5/5]

THnBase::THnBase ( THnBase &&  other)
protected

Definition at line 128 of file THnBase.cxx.

◆ ~THnBase()

THnBase::~THnBase ( )
override

Destruct a THnBase.

Definition at line 167 of file THnBase.cxx.

Member Function Documentation

◆ Add() [1/2]

void THnBase::Add ( const TH1 hist,
Double_t  c = 1. 
)

Fill the THnBase with the bins of hist that have content or error != 0.

Definition at line 467 of file THnBase.cxx.

◆ Add() [2/2]

void THnBase::Add ( const THnBase h,
Double_t  c = 1. 
)

Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.

Definition at line 871 of file THnBase.cxx.

◆ AddBinContent() [1/2]

void THnBase::AddBinContent ( const Int_t x,
Double_t  v = 1. 
)
inline

Definition at line 191 of file THnBase.h.

◆ AddBinContent() [2/2]

virtual void THnBase::AddBinContent ( Long64_t  bin,
Double_t  v = 1. 
)
pure virtual

Implemented in THn, and THnSparse.

◆ AddBinError2()

virtual void THnBase::AddBinError2 ( Long64_t  bin,
Double_t  e2 
)
pure virtual

Implemented in THn, and THnSparse.

◆ AddInternal()

void THnBase::AddInternal ( const THnBase h,
Double_t  c,
Bool_t  rebinned 
)
protected

Add() implementation for both rebinned histograms and those with identical binning.

See THnBase::Add().

Definition at line 798 of file THnBase.cxx.

◆ Browse()

void THnBase::Browse ( TBrowser b)
overridevirtual

Browse a THnSparse: create an entry (ROOT::THnSparseBrowsable) for each dimension.

Reimplemented from TObject.

Definition at line 1582 of file THnBase.cxx.

◆ CalculateErrors()

void THnBase::CalculateErrors ( Bool_t  calc = kTRUE)
inline

Calculate errors (or not if "calc" == kFALSE)

Definition at line 144 of file THnBase.h.

◆ CheckConsistency()

Bool_t THnBase::CheckConsistency ( const THnBase h,
const char *  tag 
) const
protected

Consistency check on (some of) the parameters of two histograms (for operations).

Definition at line 1162 of file THnBase.cxx.

◆ Class()

static TClass * THnBase::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * THnBase::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t THnBase::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 292 of file THnBase.h.

◆ CloneEmpty()

THnBase * THnBase::CloneEmpty ( const char *  name,
const char *  title,
const TObjArray axes,
Bool_t  keepTargetAxis 
) const
protected

Create a new THnBase object that is of the same type as *this, but with dimensions and bins given by axes.

If keepTargetAxis is true, the axes will keep their original xmin / xmax, else they will be restricted to the range selected (first / last).

Definition at line 179 of file THnBase.cxx.

◆ ComputeIntegral()

Double_t THnBase::ComputeIntegral ( )

Compute integral (normalized cumulative sum of bins) w/o under/overflows The result is stored in fIntegral and used by the GetRandom functions.

This function is automatically called by GetRandom when the fIntegral array does not exist or when the number of entries in the histogram has changed since the previous call to GetRandom. The resulting integral is normalized to 1.

Returns
1 if success, 0 if integral is zero

Definition at line 1365 of file THnBase.cxx.

◆ CreateHist()

TH1 * THnBase::CreateHist ( const char *  name,
const char *  title,
const TObjArray axes,
Bool_t  keepTargetAxis 
) const
protected

Create an empty histogram with name and title with a given set of axes.

Create a TH1D/TH2D/TH3D, depending on the number of elements in axes.

Definition at line 252 of file THnBase.cxx.

◆ CreateHnAny() [1/2]

THnBase * THnBase::CreateHnAny ( const char *  name,
const char *  title,
const TH1 h1,
Bool_t  sparse,
Int_t  chunkSize = 1024 * 16 
)
staticprotected

Create a THn / THnSparse object from a histogram deriving from TH1.

Definition at line 323 of file THnBase.cxx.

◆ CreateHnAny() [2/2]

THnBase * THnBase::CreateHnAny ( const char *  name,
const char *  title,
const THnBase hn,
Bool_t  sparse,
Int_t  chunkSize = 1024 * 16 
)
staticprotected

Create a THnSparse (if "sparse") or THn from "hn", possibly converting THn <-> THnSparse.

Definition at line 403 of file THnBase.cxx.

◆ CreateIter()

virtual ROOT::Internal::THnBaseBinIter * THnBase::CreateIter ( Bool_t  respectAxisRange) const
pure virtual

Implemented in THn, and THnSparse.

◆ DeclFileName()

static const char * THnBase::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 292 of file THnBase.h.

◆ Divide() [1/2]

void THnBase::Divide ( const THnBase h)

Divide this histogram by h this = this/(h) Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.

The resulting errors are calculated assuming uncorrelated content.

Definition at line 1023 of file THnBase.cxx.

◆ Divide() [2/2]

void THnBase::Divide ( const THnBase h1,
const THnBase h2,
Double_t  c1 = 1.,
Double_t  c2 = 1.,
Option_t option = "" 
)

Replace contents of this histogram by multiplication of h1 by h2 this = (c1*h1)/(c2*h2) Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this if not already set.

The resulting errors are calculated assuming uncorrelated content. However, if option ="B" is specified, Binomial errors are computed. In this case c1 and c2 do not make real sense and they are ignored.

Definition at line 1080 of file THnBase.cxx.

◆ Fill() [1/3]

Long64_t THnBase::Fill ( const char *  name[],
Double_t  w = 1. 
)
inline

Definition at line 155 of file THnBase.h.

◆ Fill() [2/3]

Long64_t THnBase::Fill ( const Double_t x,
Double_t  w = 1. 
)
inline

Definition at line 149 of file THnBase.h.

◆ Fill() [3/3]

template<typename... MoreTypes>
Long64_t THnBase::Fill ( Double_t  firstval,
MoreTypes...  morevals 
)
inline

Fill with the provided variadic arguments.

The number of arguments must be equal to the number of histogram dimensions or, for weighted fills, to the number of dimensions + 1; in the latter case, the last function argument is used as weight. A separate firstval argument is needed so the compiler does not pick this overload instead of the non-templated Fill overloads

Definition at line 167 of file THnBase.h.

◆ FillBin()

virtual void THnBase::FillBin ( Long64_t  bin,
Double_t  w 
)
pure virtual

Implemented in THn, and THnSparse.

◆ FillBinBase()

void THnBase::FillBinBase ( Double_t  w)
inlineprotected

Increment the statistics due to filled weight "w",.

Definition at line 89 of file THnBase.h.

◆ Fit()

TFitResultPtr THnBase::Fit ( TF1 f,
Option_t option = "",
Option_t goption = "" 
)

Fit a THnSparse with function f.

since the data is sparse by default a likelihood fit is performed merging all the regions with empty bins for better performance efficiency

Since the THnSparse is not drawn no graphics options are passed Here is the list of possible options

          = "I"  Use integral of function in bin instead of value at bin center
          = "X"  Use chi2 method (default is log-likelihood method)
          = "U"  Use a User specified fitting algorithm (via SetFCN)
          = "Q"  Quiet mode (minimum printing)
          = "V"  Verbose mode (default is between Q and V)
          = "E"  Perform better Errors estimation using Minos technique
          = "B"  Use this option when you want to fix one or more parameters
                 and the fitting function is like "gaus", "expo", "poln", "landau".
          = "M"  More. Improve fit results
          = "R"  Use the Range specified in the function range 

Definition at line 505 of file THnBase.cxx.

◆ GetAxis()

TAxis * THnBase::GetAxis ( Int_t  dim) const
inline

Definition at line 130 of file THnBase.h.

◆ GetBin() [1/6]

virtual Long64_t THnBase::GetBin ( const char *  name[]) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetBin() [2/6]

virtual Long64_t THnBase::GetBin ( const char *  name[],
Bool_t  = kTRUE 
)
pure virtual

Implemented in THnSparse, and THn.

◆ GetBin() [3/6]

virtual Long64_t THnBase::GetBin ( const Double_t x) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetBin() [4/6]

virtual Long64_t THnBase::GetBin ( const Double_t x,
Bool_t  = kTRUE 
)
pure virtual

Implemented in THnSparse, and THn.

◆ GetBin() [5/6]

virtual Long64_t THnBase::GetBin ( const Int_t idx) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetBin() [6/6]

virtual Long64_t THnBase::GetBin ( const Int_t idx,
Bool_t  = kTRUE 
)
pure virtual

Implemented in THnSparse, and THn.

◆ GetBinCenter()

std::vector< Double_t > THnBase::GetBinCenter ( const std::vector< Int_t > &  idx) const

THnBase::GetBinCenter.

Parameters
idxan array of bin index in each dimension.
Returns
vector of bin centers in each dimension; empty in case of error.
Note
Throws error if size is different from nDimensions.
See also
GetAxis(dim)::GetBinCenter(idx) as an alternative

Definition at line 534 of file THnBase.cxx.

◆ GetBinContent() [1/2]

Double_t THnBase::GetBinContent ( const Int_t idx) const
inline

Definition at line 197 of file THnBase.h.

◆ GetBinContent() [2/2]

virtual Double_t THnBase::GetBinContent ( Long64_t  bin,
Int_t idx = nullptr 
) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetBinError() [1/2]

Double_t THnBase::GetBinError ( const Int_t idx) const
inline

Definition at line 187 of file THnBase.h.

◆ GetBinError() [2/2]

Double_t THnBase::GetBinError ( Long64_t  linidx) const
inline

Definition at line 188 of file THnBase.h.

◆ GetBinError2()

virtual Double_t THnBase::GetBinError2 ( Long64_t  linidx) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetCalculateErrors()

Bool_t THnBase::GetCalculateErrors ( ) const
inline

Definition at line 141 of file THnBase.h.

◆ GetEntries()

Double_t THnBase::GetEntries ( ) const
inline

Definition at line 138 of file THnBase.h.

◆ GetListOfAxes() [1/2]

TObjArray * THnBase::GetListOfAxes ( )
inline

Definition at line 128 of file THnBase.h.

◆ GetListOfAxes() [2/2]

const TObjArray * THnBase::GetListOfAxes ( ) const
inline

Definition at line 129 of file THnBase.h.

◆ GetListOfFunctions()

TList * THnBase::GetListOfFunctions ( )
inline

Definition at line 133 of file THnBase.h.

◆ GetNbins()

virtual Long64_t THnBase::GetNbins ( ) const
pure virtual

Implemented in THn, and THnSparse.

◆ GetNdimensions()

Int_t THnBase::GetNdimensions ( ) const
inline

Definition at line 140 of file THnBase.h.

◆ GetRandom()

void THnBase::GetRandom ( Double_t rand,
Bool_t  subBinRandom = kTRUE 
)

Generate an n-dimensional random tuple based on the histogrammed distribution.

If subBinRandom, the returned tuple will be additionally randomly distributed within the randomized bin, using a flat distribution.

Definition at line 557 of file THnBase.cxx.

◆ GetSumw()

Double_t THnBase::GetSumw ( ) const
inline

Definition at line 213 of file THnBase.h.

◆ GetSumw2()

Double_t THnBase::GetSumw2 ( ) const
inline

Definition at line 214 of file THnBase.h.

◆ GetSumwx()

Double_t THnBase::GetSumwx ( Int_t  dim) const
inline

Definition at line 215 of file THnBase.h.

◆ GetSumwx2()

Double_t THnBase::GetSumwx2 ( Int_t  dim) const
inline

Definition at line 216 of file THnBase.h.

◆ GetWeightSum()

Double_t THnBase::GetWeightSum ( ) const
inline

Definition at line 139 of file THnBase.h.

◆ Init()

void THnBase::Init ( const char *  name,
const char *  title,
const TObjArray axes,
Bool_t  keepTargetAxis,
Int_t  chunkSize = 1024 * 16 
)
protected

Initialize axes and name.

Definition at line 195 of file THnBase.cxx.

◆ InitStorage()

virtual void THnBase::InitStorage ( Int_t nbins,
Int_t  chunkSize 
)
protectedpure virtual

Implemented in THn, and THnSparse.

◆ Integral()

Double_t THnBase::Integral ( Bool_t  respectAxisRange) const

Compute integral (sum of counts) of histogram in all dimensions.

Parameters
respectAxisRangeif false, count all bins including under/overflows, if true, restrict sum to the user-set axis range
See also
Projection(0)Integral() as alternative
Note
this function is different from ComputeIntegral, that is a normalized cumulative sum

Definition at line 1345 of file THnBase.cxx.

◆ IsA()

TClass * THnBase::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Reimplemented in THnT< T >, THnSparse, and THnSparseT< CONT >.

Definition at line 292 of file THnBase.h.

◆ IsFolder()

Bool_t THnBase::IsFolder ( ) const
inlineoverridevirtual

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented from TObject.

Definition at line 288 of file THnBase.h.

◆ IsInRange()

Bool_t THnBase::IsInRange ( Int_t coord) const

Check whether bin coord is in range, as defined by TAxis::SetRange().

Definition at line 592 of file THnBase.cxx.

◆ Merge()

Long64_t THnBase::Merge ( TCollection list)

Merge this with a list of THnBase's.

All THnBase's provided in the list must have the same bin layout!

Definition at line 897 of file THnBase.cxx.

◆ Multiply() [1/2]

void THnBase::Multiply ( const THnBase h)

Multiply this histogram by histogram h this = this * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.

Definition at line 932 of file THnBase.cxx.

◆ Multiply() [2/2]

void THnBase::Multiply ( TF1 f,
Double_t  c = 1. 
)

Performs the operation: this = this*c*f1 if errors are defined, errors are also recalculated.

Only bins inside the function range are recomputed. IMPORTANT NOTE: If you intend to use the errors of this histogram later you should call Sumw2 before making this operation. This is particularly important if you fit the histogram after calling Multiply()

Definition at line 980 of file THnBase.cxx.

◆ operator=() [1/2]

THnBase & THnBase::operator= ( const THnBase other)
protected

Definition at line 101 of file THnBase.cxx.

◆ operator=() [2/2]

THnBase & THnBase::operator= ( THnBase &&  other)
protected

Definition at line 139 of file THnBase.cxx.

◆ Print()

void THnBase::Print ( Option_t options = "") const
overridevirtual

Print a THnBase.

If "option" contains:

  • 'a': print axis details
  • 'm': print memory usage
  • 's': print statistics
  • 'c': print its content, too (this can generate a LOT of output!) Other options are forwarded to PrintEntries().

Reimplemented from TObject.

Definition at line 1535 of file THnBase.cxx.

◆ PrintBin() [1/3]

void THnBase::PrintBin ( Int_t coord,
Option_t options 
) const
inline

Definition at line 282 of file THnBase.h.

◆ PrintBin() [2/3]

Bool_t THnBase::PrintBin ( Long64_t  idx,
Int_t bin,
Option_t options 
) const
protected

Print one bin.

If "idx" is != -1 use that to determine the bin, otherwise (if "idx" == -1) use the coordinate in "bin". If "options" contains:

  • '0': only print bins with an error or content != 0 Return whether the bin was printed (depends on options)

Definition at line 1440 of file THnBase.cxx.

◆ PrintBin() [3/3]

void THnBase::PrintBin ( Long64_t  idx,
Option_t options 
) const

Print bin with linex index "idx".

For valid options see PrintBin(Long64_t idx, Int_t* bin, Option_t* options).

Definition at line 1426 of file THnBase.cxx.

◆ PrintEntries()

void THnBase::PrintEntries ( Long64_t  from = 0,
Long64_t  howmany = -1,
Option_t options = nullptr 
) const

Print "howmany" entries starting at "from".

If "howmany" is -1, print all. If "options" contains:

  • 'x': print in the order of axis bins, i.e. (0,0,...,0), (0,0,...,1),...
  • '0': only print bins with content != 0

Definition at line 1484 of file THnBase.cxx.

◆ Projection() [1/3]

TH3D * THnBase::Projection ( Int_t  xDim,
Int_t  yDim,
Int_t  zDim,
Option_t option = "" 
) const
inline

Project all bins into a 3-dimensional histogram, keeping only axes "xDim", "yDim", and "zDim".

If "option" contains:

  • "E" errors will be calculated.
  • "A" ranges of the taget axes will be ignored.
  • "O" original axis range of the taget axes will be kept, but only bins inside the selected range will be filled.

Definition at line 252 of file THnBase.h.

◆ Projection() [2/3]

TH1D * THnBase::Projection ( Int_t  xDim,
Option_t option = "" 
) const
inline

Project all bins into a 1-dimensional histogram, keeping only axis "xDim".

If "option" contains:

  • "E" errors will be calculated.
  • "A" ranges of the taget axes will be ignored.
  • "O" original axis range of the taget axes will be kept, but only bins inside the selected range will be filled.

Definition at line 226 of file THnBase.h.

◆ Projection() [3/3]

TH2D * THnBase::Projection ( Int_t  yDim,
Int_t  xDim,
Option_t option = "" 
) const
inline

Project all bins into a 2-dimensional histogram, keeping only axes "xDim" and "yDim".

WARNING: just like TH3::Project3D("yx") and TTree::Draw("y:x"), Projection(y,x) uses the first argument to define the y-axis and the second for the x-axis!

If "option" contains "E" errors will be calculated. "A" ranges of the taget axes will be ignored.

Definition at line 239 of file THnBase.h.

◆ ProjectionAny()

TObject * THnBase::ProjectionAny ( Int_t  ndim,
const Int_t dim,
Bool_t  wantNDim,
Option_t option = "" 
) const
protected

Project all bins into a ndim-dimensional THn / THnSparse (whatever *this is) or if (ndim < 4 and !wantNDim) a TH1/2/3 histogram, keeping only axes in dim (specifying ndim dimensions).

If "option" contains:

  • "E" errors will be calculated.
  • "A" ranges of the target axes will be ignored.
  • "O" original axis range of the target axes will be kept, but only bins inside the selected range will be filled.

Definition at line 618 of file THnBase.cxx.

◆ ProjectionND()

THnBase * THnBase::ProjectionND ( Int_t  ndim,
const Int_t dim,
Option_t option = "" 
) const
inline

Definition at line 257 of file THnBase.h.

◆ RebinBase() [1/2]

THnBase * THnBase::RebinBase ( const Int_t group) const
protected

Combine the content of "group" neighboring bins for each dimension into a new bin and return the resulting THnBase.

For group={2,1,1} and a 3 dimensional histogram, pairs of x-bins will be grouped.

Definition at line 1248 of file THnBase.cxx.

◆ RebinBase() [2/2]

THnBase * THnBase::RebinBase ( Int_t  group) const
protected

Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase.

For group=2 and a 3 dimensional histogram, all "blocks" of 2*2*2 bins will be put into a bin.

Definition at line 1232 of file THnBase.cxx.

◆ RebinnedAdd()

void THnBase::RebinnedAdd ( const THnBase h,
Double_t  c = 1. 
)

Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set.

In contrast to Add(), RebinnedAdd() does not require consistent binning of this and h; instead, each bin's center is used to determine the target bin.

Definition at line 887 of file THnBase.cxx.

◆ Reserve()

virtual void THnBase::Reserve ( Long64_t  )
inlineprotectedvirtual

Reimplemented in THnSparse.

Definition at line 104 of file THnBase.h.

◆ Reset()

virtual void THnBase::Reset ( Option_t option = "")
pure virtual

Implemented in THn, and THnSparse.

◆ ResetBase()

void THnBase::ResetBase ( Option_t option = "")
protected

Clear the histogram.

Definition at line 1327 of file THnBase.cxx.

◆ Scale()

void THnBase::Scale ( Double_t  c)

Scale contents and errors of this histogram by c: this = this * c It does not modify the histogram's number of entries.

Definition at line 774 of file THnBase.cxx.

◆ SetBinContent() [1/2]

void THnBase::SetBinContent ( const Int_t idx,
Double_t  v 
)
inline

Definition at line 207 of file THnBase.h.

◆ SetBinContent() [2/2]

virtual void THnBase::SetBinContent ( Long64_t  bin,
Double_t  v 
)
pure virtual

Implemented in THn, and THnSparse.

◆ SetBinEdges()

void THnBase::SetBinEdges ( Int_t  idim,
const Double_t bins 
)

Set the axis # of bins and bin limits on dimension idim.

Definition at line 1180 of file THnBase.cxx.

◆ SetBinError() [1/2]

void THnBase::SetBinError ( const Int_t idx,
Double_t  e 
)
inline

Definition at line 189 of file THnBase.h.

◆ SetBinError() [2/2]

void THnBase::SetBinError ( Long64_t  bin,
Double_t  e 
)
inline

Definition at line 190 of file THnBase.h.

◆ SetBinError2()

virtual void THnBase::SetBinError2 ( Long64_t  bin,
Double_t  e2 
)
pure virtual

Implemented in THn, and THnSparse.

◆ SetEntries()

void THnBase::SetEntries ( Double_t  entries)
inline

Definition at line 192 of file THnBase.h.

◆ SetFilledBins()

virtual void THnBase::SetFilledBins ( Long64_t  )
inlineprotectedvirtual

Reimplemented in THnSparse.

Definition at line 105 of file THnBase.h.

◆ SetTitle()

void THnBase::SetTitle ( const char *  title)
overridevirtual

Change (i.e.

set) the title.

If title is in the form "stringt;string0;string1;string2 ..." the histogram title is set to stringt, the title of axis0 to string0, of axis1 to string1, of axis2 to string2, etc, just like it is done for TH1/TH2/TH3. To insert the character ";" in one of the titles, one should use "#;" or "#semicolon".

Reimplemented from TNamed.

Definition at line 1196 of file THnBase.cxx.

◆ Streamer()

void THnBase::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in THnT< T >, THnSparse, and THnSparseT< CONT >.

◆ StreamerNVirtual()

void THnBase::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 292 of file THnBase.h.

◆ Sumw2()

virtual void THnBase::Sumw2 ( )
pure virtual

Implemented in THn, and THnSparse.

◆ UpdateXStat()

void THnBase::UpdateXStat ( const Double_t x,
Double_t  w = 1. 
)
inlineprotected

Definition at line 77 of file THnBase.h.

Friends And Related Symbol Documentation

◆ THnIter

friend class THnIter
friend

Definition at line 294 of file THnBase.h.

Member Data Documentation

◆ fAxes

TObjArray THnBase::fAxes
protected

Axes of the histogram.

Definition at line 46 of file THnBase.h.

◆ fBrowsables

TObjArray THnBase::fBrowsables
protected

! Browser-helpers for each axis

Definition at line 47 of file THnBase.h.

◆ fEntries

Double_t THnBase::fEntries
protected

Number of entries, spread over chunks.

Definition at line 48 of file THnBase.h.

◆ fIntegral

std::vector<Double_t> THnBase::fIntegral
protected

! vector with bin weight sums

Definition at line 53 of file THnBase.h.

◆ []

enum { ... } THnBase::fIntegralStatus

! status of integral

◆ fNdimensions

Int_t THnBase::fNdimensions
protected

Number of dimensions.

Definition at line 45 of file THnBase.h.

◆ fTsumw

Double_t THnBase::fTsumw
protected

Total sum of weights.

Definition at line 49 of file THnBase.h.

◆ fTsumw2

Double_t THnBase::fTsumw2
protected

Total sum of weights squared; -1 if no errors are calculated.

Definition at line 50 of file THnBase.h.

◆ fTsumwx

TArrayD THnBase::fTsumwx
protected

Total sum of weight*X for each dimension.

Definition at line 51 of file THnBase.h.

◆ fTsumwx2

TArrayD THnBase::fTsumwx2
protected

Total sum of weight*X*X for each dimension.

Definition at line 52 of file THnBase.h.

Libraries for THnBase:

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