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

Multidimensional histogram.

Use a THn if you really, really have to store more than three dimensions, and if a large fraction of all bins are filled. Better alternatives are

The major problem of THn is the memory use caused by n-dimensional histogramming: a THnD with 8 dimensions and 100 bins per dimension needs more than 2.5GB of RAM!

To construct a THn object you must use one of its templated, derived classes:

THnD (typedef for THnT<Double_t>): bin content held by a Double_t,
THnF (typedef for THnT<Float_t>): bin content held by a Float_t,
THnL (typedef for THnT<Long64_t>): bin content held by a Long64_t,
THnI (typedef for THnT<Int_t>): bin content held by an Int_t,
THnS (typedef for THnT<Short_t>): bin content held by a Short_t,
THnC (typedef for THnT<Char_t>): bin content held by a Char_t,

They take name and title, the number of dimensions, and for each dimension the number of bins, the minimal, and the maximal value on the dimension's axis. A TH2F h("h","h",10, 0., 10., 20, -5., 5.) would correspond to

Int_t bins[2] = {10, 20};
Double_t xmin[2] = {0., -5.};
Double_t xmax[2] = {10., 5.};
THnF hn("hn", "hn", 2, bins, xmin, xmax);

Filling

A THn is filled just like a regular histogram, using THn::Fill(x, weight), where x is a n-dimensional Double_t value. To take errors into account, Sumw2() must be called before filling the histogram. Storage is allocated when the first bin content is stored.

Projections

The dimensionality of a THn can be reduced by projecting it to 1, 2, 3, or n dimensions, which can be represented by a TH1, TH2, TH3, or a THn. See the Projection() members. To only project parts of the histogram, call

hn->GetAxis(12)->SetRange(from_bin, to_bin);

Conversion from other histogram classes

The static factory function THn::CreateHn() can be used to create a THn from a TH1, TH2, TH3, THnSparse and (for copying) even from a THn. The created THn will have compatble storage type, i.e. calling CreateHn() on a TH2F will create a THnF.

Definition at line 30 of file THn.h.

Public Member Functions

 ~THn () override
 Destruct a THn.
 
void AddBinContent (const Int_t *idx, Double_t v=1.)
 Forwards to THnBase::SetBinContent().
 
void AddBinContent (Long64_t bin, Double_t v=1.) override
 
void AddBinError2 (Long64_t bin, Double_t e2) override
 
ROOT::Internal::THnBaseBinIterCreateIter (Bool_t respectAxisRange) const override
 Create an iterator over all bins. Public interface is THnIter.
 
void FillBin (Long64_t bin, Double_t w) override
 Increment the bin content of "bin" by "w", return the bin index.
 
virtual const TNDArrayGetArray () const =0
 
virtual TNDArrayGetArray ()=0
 
Long64_t GetBin (const char *name[]) const override
 
Long64_t GetBin (const char *name[], Bool_t=kTRUE) override
 
Long64_t GetBin (const Double_t *x) const override
 
Long64_t GetBin (const Double_t *x, Bool_t=kTRUE) override
 
Long64_t GetBin (const Int_t *idx) const override
 
Long64_t GetBin (const Int_t *idx, Bool_t=kTRUE) override
 
Double_t GetBinContent (const Int_t *idx) const
 Forwards to THnBase::GetBinContent() overload.
 
Double_t GetBinContent (Long64_t bin, Int_t *idx=nullptr) const override
 Get the content of bin, and set its index if idx is != 0.
 
Double_t GetBinError2 (Long64_t linidx) const override
 
Long64_t GetNbins () const override
 
TClassIsA () const override
 
THnProjection (Int_t ndim, const Int_t *dim, Option_t *option="") const
 
TH3DProjection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
 Forwards to THnBase::Projection().
 
TH1DProjection (Int_t xDim, Option_t *option="") const
 Forwards to THnBase::Projection().
 
TH2DProjection (Int_t yDim, Int_t xDim, Option_t *option="") const
 Forwards to THnBase::Projection().
 
THnRebin (const Int_t *group) const
 
THnRebin (Int_t group) const
 
void Reset (Option_t *option="") override
 Reset the contents of a THn.
 
void SetBinContent (const Int_t *idx, Double_t v)
 Forwards to THnBase::SetBinContent().
 
void SetBinContent (Long64_t bin, Double_t v) override
 
void SetBinError2 (Long64_t bin, Double_t e2) override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void Sumw2 () override
 Enable calculation of errors.
 
- Public Member Functions inherited from THnBase
 ~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.)
 
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.
 
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.
 
TFitResultPtr Fit (TF1 *f1, Option_t *option="", Option_t *goption="")
 Fit a THnSparse with function f.
 
TAxisGetAxis (Int_t dim) const
 
std::vector< Double_tGetBinCenter (const std::vector< Int_t > &idx) const
 THnBase::GetBinCenter.
 
Double_t GetBinContent (const Int_t *idx) const
 
Double_t GetBinError (const Int_t *idx) const
 
Double_t GetBinError (Long64_t linidx) const
 
Bool_t GetCalculateErrors () const
 
Double_t GetEntries () const
 
TObjArrayGetListOfAxes ()
 
const TObjArrayGetListOfAxes () const
 
TListGetListOfFunctions ()
 
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.
 
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)
 
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)
 
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)
 
- 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 ()
 Temporary buffer.
 
static THnCreateHn (const char *name, const char *title, const TH1 *h1)
 
static THnCreateHn (const char *name, const char *title, const THnBase *hn)
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from THnBase
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 Member Functions

 THn ()=default
 
 THn (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax)
 Construct a THn.
 
 THn (const char *name, const char *title, Int_t dim, const Int_t *nbins, const std::vector< std::vector< double > > &xbins)
 
void AllocCoordBuf () const
 Create the coordinate buffer.
 
void InitStorage (Int_t *nbins, Int_t chunkSize) override
 Initialize the storage of a histogram created via Init()
 
- Protected Member Functions inherited from THnBase
 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.
 
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 ()
 

Protected Attributes

std::vector< Int_tfCoordBuf
 
TNDArrayT< Double_tfSumw2
 
- Protected Attributes inherited from THnBase
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
 

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 ))
}
 
- Protected Types inherited from THnBase
enum  { kNoInt , kValidInt , kInvalidInt }
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Static Protected Member Functions inherited from THnBase
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.
 

#include <THn.h>

Inheritance diagram for THn:
[legend]

Constructor & Destructor Documentation

◆ THn() [1/3]

THn::THn ( )
protecteddefault

◆ THn() [2/3]

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

Construct a THn.

Definition at line 182 of file THn.cxx.

◆ THn() [3/3]

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

Definition at line 190 of file THn.cxx.

◆ ~THn()

THn::~THn ( )
override

Destruct a THn.

Definition at line 199 of file THn.cxx.

Member Function Documentation

◆ AddBinContent() [1/2]

void THn::AddBinContent ( const Int_t idx,
Double_t  v = 1. 
)
inline

Forwards to THnBase::SetBinContent().

Non-virtual, CINT-compatible replacement of a using declaration.

Definition at line 109 of file THn.h.

◆ AddBinContent() [2/2]

void THn::AddBinContent ( Long64_t  bin,
Double_t  v = 1. 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 112 of file THn.h.

◆ AddBinError2()

void THn::AddBinError2 ( Long64_t  bin,
Double_t  e2 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 115 of file THn.h.

◆ AllocCoordBuf()

void THn::AllocCoordBuf ( ) const
protected

Create the coordinate buffer.

Outlined to hide allocation from inlined functions.

Definition at line 232 of file THn.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

static constexpr Version_t THn::Class_Version ( )
inlinestaticconstexpr

Temporary buffer.

Returns
Version of this class

Definition at line 183 of file THn.h.

◆ CreateHn() [1/2]

static THn * THn::CreateHn ( const char *  name,
const char *  title,
const TH1 h1 
)
inlinestatic

Definition at line 46 of file THn.h.

◆ CreateHn() [2/2]

static THn * THn::CreateHn ( const char *  name,
const char *  title,
const THnBase hn 
)
inlinestatic

Definition at line 49 of file THn.h.

◆ CreateIter()

ROOT::Internal::THnBaseBinIter * THn::CreateIter ( Bool_t  respectAxisRange) const
overridevirtual

Create an iterator over all bins. Public interface is THnIter.

Implements THnBase.

Definition at line 207 of file THn.cxx.

◆ DeclFileName()

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

Definition at line 183 of file THn.h.

◆ FillBin()

void THn::FillBin ( Long64_t  bin,
Double_t  w 
)
inlineoverridevirtual

Increment the bin content of "bin" by "w", return the bin index.

Implements THnBase.

Definition at line 87 of file THn.h.

◆ GetArray() [1/2]

virtual const TNDArray & THn::GetArray ( ) const
pure virtual

Implemented in THnT< T >.

◆ GetArray() [2/2]

virtual TNDArray & THn::GetArray ( )
pure virtual

Implemented in THnT< T >.

◆ GetBin() [1/6]

Long64_t THn::GetBin ( const char *  name[]) const
inlineoverridevirtual

Implements THnBase.

Definition at line 67 of file THn.h.

◆ GetBin() [2/6]

Long64_t THn::GetBin ( const char *  name[],
Bool_t  = kTRUE 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 82 of file THn.h.

◆ GetBin() [3/6]

Long64_t THn::GetBin ( const Double_t x) const
inlineoverridevirtual

Implements THnBase.

Definition at line 59 of file THn.h.

◆ GetBin() [4/6]

Long64_t THn::GetBin ( const Double_t x,
Bool_t  = kTRUE 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 79 of file THn.h.

◆ GetBin() [5/6]

Long64_t THn::GetBin ( const Int_t idx) const
inlineoverridevirtual

Implements THnBase.

Definition at line 56 of file THn.h.

◆ GetBin() [6/6]

Long64_t THn::GetBin ( const Int_t idx,
Bool_t  = kTRUE 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 76 of file THn.h.

◆ GetBinContent() [1/2]

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

Forwards to THnBase::GetBinContent() overload.

Non-virtual, CINT-compatible replacement of a using declaration.

Definition at line 120 of file THn.h.

◆ GetBinContent() [2/2]

Double_t THn::GetBinContent ( Long64_t  bin,
Int_t idx = nullptr 
) const
inlineoverridevirtual

Get the content of bin, and set its index if idx is != 0.

Implements THnBase.

Definition at line 124 of file THn.h.

◆ GetBinError2()

Double_t THn::GetBinError2 ( Long64_t  linidx) const
inlineoverridevirtual

Implements THnBase.

Definition at line 136 of file THn.h.

◆ GetNbins()

Long64_t THn::GetNbins ( ) const
inlineoverridevirtual

Implements THnBase.

Definition at line 54 of file THn.h.

◆ InitStorage()

void THn::InitStorage ( Int_t nbins,
Int_t  chunkSize 
)
overrideprotectedvirtual

Initialize the storage of a histogram created via Init()

Implements THnBase.

Definition at line 240 of file THn.cxx.

◆ IsA()

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

Reimplemented from TObject.

Reimplemented in THnT< T >.

Definition at line 183 of file THn.h.

◆ Projection() [1/4]

THn * THn::Projection ( Int_t  ndim,
const Int_t dim,
Option_t option = "" 
) const
inline

Definition at line 165 of file THn.h.

◆ Projection() [2/4]

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

Forwards to THnBase::Projection().

Non-virtual, as a CINT-compatible replacement of a using declaration.

Definition at line 160 of file THn.h.

◆ Projection() [3/4]

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

Forwards to THnBase::Projection().

Non-virtual, as a CINT-compatible replacement of a using declaration.

Definition at line 147 of file THn.h.

◆ Projection() [4/4]

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

Forwards to THnBase::Projection().

Non-virtual, as a CINT-compatible replacement of a using declaration.

Definition at line 153 of file THn.h.

◆ Rebin() [1/2]

THn * THn::Rebin ( const Int_t group) const
inline

Definition at line 173 of file THn.h.

◆ Rebin() [2/2]

THn * THn::Rebin ( Int_t  group) const
inline

Definition at line 170 of file THn.h.

◆ Reset()

void THn::Reset ( Option_t option = "")
overridevirtual

Reset the contents of a THn.

Implements THnBase.

Definition at line 250 of file THn.cxx.

◆ SetBinContent() [1/2]

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

Forwards to THnBase::SetBinContent().

Non-virtual, CINT-compatible replacement of a using declaration.

Definition at line 97 of file THn.h.

◆ SetBinContent() [2/2]

void THn::SetBinContent ( Long64_t  bin,
Double_t  v 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 100 of file THn.h.

◆ SetBinError2()

void THn::SetBinError2 ( Long64_t  bin,
Double_t  e2 
)
inlineoverridevirtual

Implements THnBase.

Definition at line 103 of file THn.h.

◆ Streamer()

void THn::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in THnT< T >.

◆ StreamerNVirtual()

void THn::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 183 of file THn.h.

◆ Sumw2()

void THn::Sumw2 ( )
overridevirtual

Enable calculation of errors.

Implements THnBase.

Definition at line 216 of file THn.cxx.

Member Data Documentation

◆ fCoordBuf

std::vector<Int_t> THn::fCoordBuf
mutableprotected

Definition at line 181 of file THn.h.

◆ fSumw2

TNDArrayT<Double_t> THn::fSumw2
protected

Definition at line 180 of file THn.h.

Libraries for THn:

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