Efficient multidimensional histogram.

Use a THnSparse instead of TH1 / TH2 / TH3 / array for histogramming when only a small fraction of bins is filled. A 10-dimensional histogram with 10 bins per dimension has 10^10 bins; in a naive implementation this will not fit in memory. THnSparse only allocates memory for the bins that have non-zero bin content instead, drastically reducing both the memory usage and the access time.

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

THnSparseD (typedef for THnSparseT<ArrayD>): bin content held by a Double_t,
THnSparseF (typedef for THnSparseT<ArrayF>): bin content held by a Float_t,
THnSparseL (typedef for THnSparseT<ArrayL64>): bin content held by a Long64_t,
THnSparseI (typedef for THnSparseT<ArrayI>): bin content held by an Int_t,
THnSparseS (typedef for THnSparseT<ArrayS>): bin content held by a Short_t,
THnSparseC (typedef for THnSparseT<ArrayC>): 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 TH2 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.};
THnSparseD hs("hs", "hs", 2, bins, xmin, xmax);

Filling

A THnSparse is filled just like a regular histogram, using THnSparse::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.

Bins are allocated as needed; the status of the allocation can be observed by GetSparseFractionBins(), GetSparseFractionMem().

Fast Bin Content Access

When iterating over a THnSparse one should only look at filled bins to save processing time. The number of filled bins is returned by THnSparse::GetNbins(); the bin content for each (linear) bin number can be retrieved by THnSparse::GetBinContent(linidx, (Int_t*)coord). After the call, coord will contain the bin coordinate of each axis for the bin with linear index linidx. A possible call would be

std::cout << hs.GetBinContent(0, coord); std::cout <<" is the content of bin [x = " << coord[0] " << " | y = " << coord[1] << "]" << std::endl; @subsection autotoc_md566 Efficiency TH1 and TH2 are generally faster than THnSparse for one and two dimensional distributions. THnSparse becomes competitive for a sparsely filled TH3 with large numbers of bins per dimension. The tutorial sparsehist.C shows the turning point. On a AMD64 with 8GB memory, THnSparse "wins" starting with a TH3 with 30 bins per dimension. Using a THnSparse for a one-dimensional histogram is only reasonable if it has a huge number of bins.

Projections

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

THnSparse::GetAxis(12)->SetRange(from_bin, to_bin);

Internal Representation

An entry for a filled bin consists of its n-dimensional coordinates and its bin content. The coordinates are compacted to use as few bits as possible; e.g. a histogram with 10 bins in x and 20 bins in y will only use 4 bits for the x representation and 5 bits for the y representation. This is handled by the internal class THnSparseCompactBinCoord. Bin data (content and coordinates) are allocated in chunks of size fChunkSize; this parameter can be set when constructing a THnSparse. Each chunk is represented by an object of class THnSparseArrayChunk.

Translation from an n-dimensional bin coordinate to the linear index within the chunks is done by GetBin(). It creates a hash from the compacted bin coordinates (the hash of a bin coordinate is the compacted coordinate itself if it takes less than 8 bytes, the size of a Long64_t. This hash is used to lookup the linear index in the TExMap member fBins; the coordinates of the entry fBins points to is compared to the coordinates passed to GetBin(). If they do not match, these two coordinates have the same hash - which is extremely unlikely but (for the case where the compact bin coordinates are larger than 4 bytes) possible. In this case, fBinsContinued contains a chain of linear indexes with the same hash. Iterating through this chain and comparing each bin coordinates with the one passed to GetBin() will retrieve the matching bin.

Definition at line 37 of file THnSparse.h.

Public Member Functions
	THnSparse ()
	Construct an empty THnSparse.

	THnSparse (const char name, const char title, const std::vector< TAxis > &axes, Int_t chunksize=1024 *16)
	Construct a THnSparse with chunksize as the size of the chunks.

	THnSparse (const char name, const char title, Int_t dim, const Int_t nbins, const Double_t xmin=nullptr, const Double_t xmax=nullptr, Int_t chunksize=1024 16)
	Construct a THnSparse with "dim" dimensions, with chunksize as the size of the chunks.

	~THnSparse () override
	Destruct a THnSparse.

void	AddBinContent (const Int_t *idx, Double_t v=1.)
	Forwards to THnBase::AddBinContent().

void	AddBinContent (Long64_t bin, Double_t v=1.) override
	Add "v" to the content of bin with index "bin".

void	AddBinError2 (Long64_t bin, Double_t e2) override
	Add "e" to error of bin with index "bin", enable errors if needed.

ROOT::Internal::THnBaseBinIter *	CreateIter (Bool_t respectAxisRange) const override
	Create an iterator over all filled bins of a THnSparse.

Long64_t	GetBin (const char *name[]) const override

Long64_t	GetBin (const char *name[], Bool_t allocate=kTRUE) override
	Get the bin index for the n dimensional tuple addressed by "name", allocate one if it doesn't exist yet and "allocate" is true.

Long64_t	GetBin (const Double_t *x) const override

Long64_t	GetBin (const Double_t *x, Bool_t allocate=kTRUE) override
	Get the bin index for the n dimensional tuple x, allocate one if it doesn't exist yet and "allocate" is true.

Long64_t	GetBin (const Int_t *idx) const override

Long64_t	GetBin (const Int_t *idx, Bool_t allocate=kTRUE) override
	Get the bin index for the n dimensional coordinates coord, allocate one if it doesn't exist yet and "allocate" is true.

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
	Return the content of the filled bin number "idx".

Double_t	GetBinError2 (Long64_t linidx) const override
	Get square of the error of bin addressed by linidx as \(\sum weight^{2}\) If errors are not enabled (via Sumw2() or CalculateErrors()) return contents.

Int_t	GetChunkSize () const

Long64_t	GetNbins () const override

Int_t	GetNChunks () const

Double_t	GetSparseFractionBins () const
	Return the amount of filled bins over all bins.

Double_t	GetSparseFractionMem () const
	Return the amount of used memory over memory that would be used by a non-sparse n-dimensional histogram.

TClass *	IsA () const override

THnSparse *	Projection (Int_t ndim, const Int_t dim, Option_t option="") const

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

TH1D *	Projection (Int_t xDim, Option_t *option="") const
	Forwards to THnBase::Projection().

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

THnSparse *	Rebin (const Int_t *group) const

THnSparse *	Rebin (Int_t group) const

void	Reset (Option_t *option="") override
	Clear the histogram.

void	SetBinContent (const Int_t *idx, Double_t v)
	Forwards to THnBase::SetBinContent().

void	SetBinContent (Long64_t bin, Double_t v) override
	Set content of bin with index "bin" to "v".

void	SetBinError2 (Long64_t bin, Double_t e2) override
	Set error of bin with index "bin" to "e", enable errors if needed.

void	SetFilledBins (Long64_t nbins) 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 = (c1h1)/(c2h2) 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.

TAxis *	GetAxis (Int_t dim) const

std::vector< Double_t >	GetBinCenter (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

TObjArray *	GetListOfAxes ()

const TObjArray *	GetListOfAxes () const

TList *	GetListOfFunctions ()

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.

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 = thiscf1 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".

TH3D *	Projection (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".

TH1D *	Projection (Int_t xDim, Option_t *option="") const
	Project all bins into a 1-dimensional histogram, keeping only axis "xDim".

TH2D *	Projection (Int_t yDim, Int_t xDim, Option_t *option="") const
	Project all bins into a 2-dimensional histogram, keeping only axes "xDim" and "yDim".

THnBase *	ProjectionND (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	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 ("").

TObject *	Clone (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.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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)

TObject &	operator= (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 TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static THnSparse *	CreateSparse (const char name, const char title, const TH1 h1, Int_t chunkSize=1024 16)

static THnSparse *	CreateSparse (const char name, const char title, const THnBase hn, Int_t chunkSize=1024 16)

static const char *	DeclFileName ()

Static Public Member Functions inherited from THnBase
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

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
THnSparseArrayChunk *	AddChunk ()
	Create a new chunk of bin content.

void	FillBin (Long64_t bin, Double_t w) override
	Increment the bin content of "bin" by "w", return the bin index.

void	FillExMap ()
	We have been streamed; set up fBins.

virtual TArray *	GenerateArray () const =0

Long64_t	GetBinIndexForCurrentBin (Bool_t allocate)
	Return the index for fCurrentBinIndex.

THnSparseArrayChunk *	GetChunk (Int_t idx) const

THnSparseCompactBinCoord *	GetCompactCoord () const
	Return THnSparseCompactBinCoord object.

void	InitStorage (Int_t *nbins, Int_t chunkSize) override
	Initialize the storage of a histogram created via Init()

void	Reserve (Long64_t nbins) override
	Initialize storage for nbins.

Protected Member Functions inherited from THnBase
	THnBase ()

	THnBase (const char name, const char title, const std::vector< TAxis > &axes)

	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).

THnBase *	CloneEmpty (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.

TH1 *	CreateHist (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.

THnBase &	operator= (const THnBase &other)

THnBase &	operator= (THnBase &&other)

Bool_t	PrintBin (Long64_t idx, Int_t coord, Option_t options) const
	Print one bin.

TObject *	ProjectionAny (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).

THnBase *	RebinBase (const Int_t *group) const
	Combine the content of "group" neighboring bins for each dimension into a new bin and return the resulting THnBase.

THnBase *	RebinBase (Int_t group) const
	Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase.

void	ResetBase (Option_t *option="")
	Clear the histogram.

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 ()

Private Member Functions
	THnSparse (const THnSparse &)=delete

THnSparse &	operator= (const THnSparse &)=delete

Private Attributes
TObjArray	fBinContent
	Array of THnSparseArrayChunk.

TExMap	fBins
	! Filled bins

TExMap	fBinsContinued
	! Filled bins for non-unique hashes, containing pairs of (bin index 0, bin index 1)

Int_t	fChunkSize
	Number of entries for each chunk.

THnSparseCompactBinCoord *	fCompactCoord
	! Compact coordinate

Long64_t	fFilledBins
	Number of filled bins.

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 THnBase *	CreateHnAny (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 THnBase *	CreateHnAny (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 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_t >	fIntegral
	! 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 weightXX for each dimension.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <THnSparse.h>

Inheritance diagram for THnSparse:

[legend]

Constructor & Destructor Documentation

◆ THnSparse() [1/4]

THnSparse::THnSparse ( const THnSparse & )

privatedelete

◆ THnSparse() [2/4]

THnSparse::THnSparse ( )

Construct an empty THnSparse.

Definition at line 589 of file THnSparse.cxx.

◆ THnSparse() [3/4]

THnSparse::THnSparse	(	const char *	name,
		const char *	title,
		Int_t	dim,
		const Int_t *	nbins,
		const Double_t *	xmin = `nullptr`,
		const Double_t *	xmax = `nullptr`,
		Int_t	chunksize = `1024 * 16`
	)

Construct a THnSparse with "dim" dimensions, with chunksize as the size of the chunks.

"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 603 of file THnSparse.cxx.

◆ THnSparse() [4/4]

THnSparse::THnSparse	(	const char *	name,
		const char *	title,
		const std::vector< TAxis > &	axes,
		Int_t	chunksize = `1024 * 16`
	)

Construct a THnSparse with chunksize as the size of the chunks.

"axes" is a vector of TAxis, its size sets the number of dimensions. This method is convenient for passing the Axes on the fly: auto h0= new THnSparseI{"h0", "", {{100, -50., 50.}, {50, -1000., 1000.}}};

Definition at line 619 of file THnSparse.cxx.

◆ ~THnSparse()

THnSparse::~THnSparse ( )

override

Destruct a THnSparse.

Definition at line 637 of file THnSparse.cxx.

Member Function Documentation

◆ AddBinContent() [1/2]

void THnSparse::AddBinContent	(	const Int_t *	idx,
		Double_t	v = `1.`
	)

inline

Forwards to THnBase::AddBinContent().

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

Definition at line 118 of file THnSparse.h.

◆ AddBinContent() [2/2]

void THnSparse::AddBinContent	(	Long64_t	bin,
		Double_t	v = `1.`
	)

overridevirtual

Add "v" to the content of bin with index "bin".

Implements THnBase.

Definition at line 644 of file THnSparse.cxx.

◆ AddBinError2()

void THnSparse::AddBinError2	(	Long64_t	bin,
		Double_t	e2
	)

overridevirtual

Add "e" to error of bin with index "bin", enable errors if needed.

Implements THnBase.

Definition at line 952 of file THnSparse.cxx.

◆ AddChunk()

THnSparseArrayChunk * THnSparse::AddChunk ( )

protected

Create a new chunk of bin content.

Definition at line 655 of file THnSparse.cxx.

◆ Class()

static TClass * THnSparse::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * THnSparse::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t THnSparse::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 174 of file THnSparse.h.

◆ CreateIter()

ROOT::Internal::THnBaseBinIter * THnSparse::CreateIter ( Bool_t respectAxisRange ) const

overridevirtual

Create an iterator over all filled bins of a THnSparse.

Use THnIter instead.

Implements THnBase.

Definition at line 917 of file THnSparse.cxx.

◆ CreateSparse() [1/2]

static THnSparse * THnSparse::CreateSparse	(	const char *	name,
		const char *	title,
		const TH1 *	h1,
		Int_t	chunkSize = `1024 * 16`
	)

inlinestatic

Definition at line 82 of file THnSparse.h.

◆ CreateSparse() [2/2]

static THnSparse * THnSparse::CreateSparse	(	const char *	name,
		const char *	title,
		const THnBase *	hn,
		Int_t	chunkSize = `1024 * 16`
	)

inlinestatic

Definition at line 87 of file THnSparse.h.

◆ DeclFileName()

static const char * THnSparse::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 174 of file THnSparse.h.

◆ FillBin()

void THnSparse::FillBin	(	Long64_t	bin,
		Double_t	w
	)

inlineoverrideprotectedvirtual

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

Implements THnBase.

Definition at line 63 of file THnSparse.h.

◆ FillExMap()

void THnSparse::FillExMap ( )

protected

We have been streamed; set up fBins.

Definition at line 676 of file THnSparse.cxx.

◆ GenerateArray()

virtual TArray * THnSparse::GenerateArray ( ) const

protectedpure virtual

Implemented in THnSparseT< CONT >.

◆ GetBin() [1/6]

Long64_t THnSparse::GetBin ( const char * name[] ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 103 of file THnSparse.h.

◆ GetBin() [2/6]

Long64_t THnSparse::GetBin	(	const char *	name[],
		Bool_t	allocate = `kTRUE`
	)

overridevirtual

Get the bin index for the n dimensional tuple addressed by "name", allocate one if it doesn't exist yet and "allocate" is true.

Implements THnBase.

Definition at line 739 of file THnSparse.cxx.

◆ GetBin() [3/6]

Long64_t THnSparse::GetBin ( const Double_t * x ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 102 of file THnSparse.h.

◆ GetBin() [4/6]

Long64_t THnSparse::GetBin	(	const Double_t *	x,
		Bool_t	allocate = `kTRUE`
	)

overridevirtual

Get the bin index for the n dimensional tuple x, allocate one if it doesn't exist yet and "allocate" is true.

Implements THnBase.

Definition at line 723 of file THnSparse.cxx.

◆ GetBin() [5/6]

Long64_t THnSparse::GetBin ( const Int_t * idx ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 101 of file THnSparse.h.

◆ GetBin() [6/6]

Long64_t THnSparse::GetBin	(	const Int_t *	idx,
		Bool_t	allocate = `kTRUE`
	)

overridevirtual

Get the bin index for the n dimensional coordinates coord, allocate one if it doesn't exist yet and "allocate" is true.

Implements THnBase.

Definition at line 754 of file THnSparse.cxx.

◆ GetBinContent() [1/2]

Double_t THnSparse::GetBinContent ( const Int_t * idx ) const

inline

Forwards to THnBase::GetBinContent() overload.

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

Definition at line 126 of file THnSparse.h.

◆ GetBinContent() [2/2]

Double_t THnSparse::GetBinContent	(	Long64_t	idx,
		Int_t *	coord = `nullptr`
	)		const

overridevirtual

Return the content of the filled bin number "idx".

If coord is non-null, it will contain the bin's coordinates for each axis that correspond to the bin.

Implements THnBase.

Definition at line 765 of file THnSparse.cxx.

◆ GetBinError2()

Double_t THnSparse::GetBinError2 ( Long64_t linidx ) const

overridevirtual

Get square of the error of bin addressed by linidx as \(\sum weight^{2}\) If errors are not enabled (via Sumw2() or CalculateErrors()) return contents.

Implements THnBase.

Definition at line 792 of file THnSparse.cxx.

◆ GetBinIndexForCurrentBin()

Long64_t THnSparse::GetBinIndexForCurrentBin ( Bool_t allocate )

protected

Return the index for fCurrentBinIndex.

If it doesn't exist then return -1, or allocate a new bin if allocate is set

Definition at line 810 of file THnSparse.cxx.

◆ GetChunk()

THnSparseArrayChunk * THnSparse::GetChunk ( Int_t idx ) const

inlineprotected

Definition at line 52 of file THnSparse.h.

◆ GetChunkSize()

Int_t THnSparse::GetChunkSize ( ) const

inline

Definition at line 93 of file THnSparse.h.

◆ GetCompactCoord()

THnSparseCompactBinCoord * THnSparse::GetCompactCoord ( ) const

protected

Return THnSparseCompactBinCoord object.

Definition at line 859 of file THnSparse.cxx.

◆ GetNbins()

Long64_t THnSparse::GetNbins ( ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 98 of file THnSparse.h.

◆ GetNChunks()

Int_t THnSparse::GetNChunks ( ) const

inline

Definition at line 94 of file THnSparse.h.

◆ GetSparseFractionBins()

Double_t THnSparse::GetSparseFractionBins ( ) const

Return the amount of filled bins over all bins.

Definition at line 875 of file THnSparse.cxx.

◆ GetSparseFractionMem()

Double_t THnSparse::GetSparseFractionMem ( ) const

Return the amount of used memory over memory that would be used by a non-sparse n-dimensional histogram.

The value is approximate.

Definition at line 886 of file THnSparse.cxx.

◆ InitStorage()

void THnSparse::InitStorage	(	Int_t *	nbins,
		Int_t	chunkSize
	)

overrideprotectedvirtual

Initialize the storage of a histogram created via Init()

Implements THnBase.

Definition at line 667 of file THnSparse.cxx.

◆ IsA()

TClass * THnSparse::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from THnBase.

Reimplemented in THnSparseT< CONT >.

Definition at line 174 of file THnSparse.h.

◆ operator=()

THnSparse & THnSparse::operator= ( const THnSparse & )

privatedelete

◆ Projection() [1/4]

THnSparse * THnSparse::Projection	(	Int_t	ndim,
		const Int_t *	dim,
		Option_t *	option = `""`
	)		const

inline

Definition at line 159 of file THnSparse.h.

◆ Projection() [2/4]

TH3D * THnSparse::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 154 of file THnSparse.h.

◆ Projection() [3/4]

TH1D * THnSparse::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 139 of file THnSparse.h.

◆ Projection() [4/4]

TH2D * THnSparse::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 146 of file THnSparse.h.

◆ Rebin() [1/2]

THnSparse * THnSparse::Rebin ( const Int_t * group ) const

inline

Definition at line 167 of file THnSparse.h.

◆ Rebin() [2/2]

THnSparse * THnSparse::Rebin ( Int_t group ) const

inline

Definition at line 164 of file THnSparse.h.

◆ Reserve()

void THnSparse::Reserve ( Long64_t nbins )

overrideprotectedvirtual

Initialize storage for nbins.

Reimplemented from THnBase.

Definition at line 710 of file THnSparse.cxx.

◆ Reset()

void THnSparse::Reset ( Option_t * option = "" )

overridevirtual

Clear the histogram.

Implements THnBase.

Definition at line 983 of file THnSparse.cxx.

◆ SetBinContent() [1/2]

void THnSparse::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 110 of file THnSparse.h.

◆ SetBinContent() [2/2]

void THnSparse::SetBinContent	(	Long64_t	bin,
		Double_t	v
	)

overridevirtual

Set content of bin with index "bin" to "v".

Implements THnBase.

Definition at line 925 of file THnSparse.cxx.

◆ SetBinError2()

void THnSparse::SetBinError2	(	Long64_t	bin,
		Double_t	e2
	)

overridevirtual

Set error of bin with index "bin" to "e", enable errors if needed.

Implements THnBase.

Definition at line 935 of file THnSparse.cxx.

◆ SetFilledBins()

void THnSparse::SetFilledBins ( Long64_t nbins )

inlineoverridevirtual

Reimplemented from THnBase.

Definition at line 99 of file THnSparse.h.

◆ Streamer()

void THnSparse::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from THnBase.

Reimplemented in THnSparseT< CONT >.

◆ StreamerNVirtual()

void THnSparse::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 174 of file THnSparse.h.

◆ Sumw2()

void THnSparse::Sumw2 ( )

overridevirtual

Enable calculation of errors.

Implements THnBase.

Definition at line 969 of file THnSparse.cxx.

Member Data Documentation

◆ fBinContent

TObjArray THnSparse::fBinContent

private

Array of THnSparseArrayChunk.

Definition at line 41 of file THnSparse.h.

◆ fBins

TExMap THnSparse::fBins

private

! Filled bins

Definition at line 42 of file THnSparse.h.

◆ fBinsContinued

TExMap THnSparse::fBinsContinued

private

! Filled bins for non-unique hashes, containing pairs of (bin index 0, bin index 1)

Definition at line 43 of file THnSparse.h.

◆ fChunkSize

Int_t THnSparse::fChunkSize

private

Number of entries for each chunk.

Definition at line 39 of file THnSparse.h.

◆ fCompactCoord

THnSparseCompactBinCoord* THnSparse::fCompactCoord

private

! Compact coordinate

Definition at line 44 of file THnSparse.h.

◆ fFilledBins

Long64_t THnSparse::fFilledBins

private

Number of filled bins.

Definition at line 40 of file THnSparse.h.

Libraries for THnSparse:

[legend]

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

hist/hist/inc/THnSparse.h
hist/hist/src/THnSparse.cxx

Filling

Fast Bin Content Access

Projections

Internal Representation

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ THnSparse() [1/4]

◆ THnSparse() [2/4]

◆ THnSparse() [3/4]

◆ THnSparse() [4/4]

◆ ~THnSparse()

Member Function Documentation

◆ AddBinContent() [1/2]

◆ AddBinContent() [2/2]

◆ AddBinError2()

◆ AddChunk()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CreateIter()

◆ CreateSparse() [1/2]

◆ CreateSparse() [2/2]

◆ DeclFileName()

◆ FillBin()

◆ FillExMap()

◆ GenerateArray()

◆ GetBin() [1/6]

◆ GetBin() [2/6]

◆ GetBin() [3/6]

◆ GetBin() [4/6]

◆ GetBin() [5/6]

◆ GetBin() [6/6]

◆ GetBinContent() [1/2]

◆ GetBinContent() [2/2]

◆ GetBinError2()

◆ GetBinIndexForCurrentBin()

◆ GetChunk()

◆ GetChunkSize()

◆ GetCompactCoord()

◆ GetNbins()

◆ GetNChunks()

◆ GetSparseFractionBins()

◆ GetSparseFractionMem()

◆ InitStorage()

◆ IsA()

◆ operator=()

◆ Projection() [1/4]

◆ Projection() [2/4]

◆ Projection() [3/4]

◆ Projection() [4/4]

◆ Rebin() [1/2]

◆ Rebin() [2/2]

◆ Reserve()

◆ Reset()

◆ SetBinContent() [1/2]

◆ SetBinContent() [2/2]

◆ SetBinError2()

◆ SetFilledBins()

◆ Streamer()

◆ StreamerNVirtual()

◆ Sumw2()

Member Data Documentation

◆ fBinContent

◆ fBins

◆ fBinsContinued

◆ fChunkSize

◆ fCompactCoord

◆ fFilledBins