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

THnSparse if a fraction of all bins are filled
TTree

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 Types
enum	{ kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }
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)) }

Public Member Functions
	~THn () override
	Destruct a THn.
void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
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	AddBinContent (Long64_t bin, Double_t v=1.) override
void	AddBinError2 (Long64_t bin, Double_t e2) override
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
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).
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.
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.
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	Copy (TObject &named) const override
	Copy this to obj.
ROOT::Internal::THnBaseBinIter *	CreateIter (Bool_t respectAxisRange) const override
	Create an iterator over all bins. Public interface is THnIter.
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.
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.
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.
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.
void	FillBin (Long64_t bin, Double_t w) override
	Increment the bin content of "bin" by "w", return the bin index.
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
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.
TFitResultPtr	Fit (TF1 f1, Option_t option="", Option_t *goption="")
	Fit a THnSparse with function f.
virtual const TNDArray &	GetArray () const =0
virtual TNDArray &	GetArray ()=0
TAxis *	GetAxis (Int_t dim) const
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
std::vector< Double_t >	GetBinCenter (const std::vector< Int_t > &idx) const
	THnBase::GetBinCenter.
Double_t	GetBinContent (const Int_t *idx) const
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	GetBinError (const Int_t *idx) const
Double_t	GetBinError (Long64_t linidx) const
Double_t	GetBinError2 (Long64_t linidx) const override
Bool_t	GetCalculateErrors () const
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
Double_t	GetEntries () const
virtual const char *	GetIconName () const
	Returns mime type name of object.
TObjArray *	GetListOfAxes ()
const TObjArray *	GetListOfAxes () const
TList *	GetListOfFunctions ()
const char *	GetName () const override
	Returns name of object.
Long64_t	GetNbins () const override
Int_t	GetNdimensions () const
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
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
const char *	GetTitle () const override
	Returns title of object.
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
Double_t	GetWeightSum () const
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
ULong_t	Hash () const override
	Return hash value for this object.
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.
Double_t	Integral (Bool_t respectAxisRange) const
	Compute integral (sum of counts) of histogram in all dimensions.
void	InvertBit (UInt_t f)
TClass *	IsA () const override
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).
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().
Bool_t	IsOnHeap () const
Bool_t	IsSortable () const override
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List TNamed name and title.
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).
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.
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 *, size_t)
	Operator delete for sized deallocation.
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 *, size_t)
	Operator delete [] for sized deallocation.
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)
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.
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".
THn *	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
	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
	Project histogram onto the axes specified in dim.
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
THn *	Rebin (const Int_t *group) const
THn *	Rebin (Int_t group) 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	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.
void	Reset (Option_t *option="") override
	Reset the contents of a THn.
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	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	SetBinContent (Long64_t bin, Double_t v) override
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	SetBinError2 (Long64_t bin, Double_t e2) override
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.
void	SetEntries (Double_t entries)
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).
void	SetTitle (const char *title) override
	Change (i.e.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
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)
void	Sumw2 () override
	Enable calculation of errors.
virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.
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 THn *	CreateHn (const char name, const char title, const TH1 *h1)
static THn *	CreateHn (const char name, const char title, const THnBase *hn)
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	{ kOnlyPrepStep = (1ULL << (3)) }
enum	{ kNoInt , kValidInt , kInvalidInt }

Protected Member Functions
	THn ()=default
	THn (const char name, const char title, const std::vector< TAxis > &axes)
	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	AddInternal (const THnBase *h, Double_t c, Bool_t rebinned)
	Add() implementation for both rebinned histograms and those with identical binning.
void	AllocCoordBuf () const
	Create the coordinate buffer.
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.
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).
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.
void	InitStorage (Int_t *nbins, Int_t chunkSize) override
	Initialize the storage of a histogram created via Init().
void	MakeZombie ()
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.
virtual void	Reserve (Long64_t)
void	ResetBase (Option_t *option="")
	Clear the histogram.
void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".
virtual void	SetFilledBins (Long64_t)
void	SetTitleImpl (const char *title, bool overrideAxesTitle)
void	UpdateXStat (const Double_t *x, Double_t w=1.)

Static Protected Member Functions
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.
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".
static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Int_t flag=0)
	Save array in the output stream "out" as vector.

Protected Attributes
TObjArray	fAxes
	Axes of the histogram.
TObjArray	fBrowsables
	! Browser-helpers for each axis
std::vector< Int_t >	fCoordBuf
	! Temporary buffer
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
TString	fName
Int_t	fNdimensions
	Number of dimensions.
TNDArrayT< Double_t >	fSumw2
TString	fTitle
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.

Static Private Member Functions
static void	AddToTObjectTable (TObject *)
	Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes
UInt_t	fBits
	bit field status word
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
static Longptr_t	fgDtorOnly = 0
	object for which to call dtor only (i.e. no delete)
static Bool_t	fgObjectStat = kTRUE
	if true keep track of objects in TObjectTable

#include <THn.h>

Inheritance diagram for THn:

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator

kOnlyPrepStep

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kSingleKey	write collection with single key
kOverwrite	overwrite existing object with same name
kWriteDelete	write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum

inherited

Enumerator
kIsOnHeap	object is on heap
kNotDeleted	object has not been deleted
kZombie	object ctor failed
kInconsistent	class overload Hash but does call RecursiveRemove in destructor
kBitMask

Definition at line 89 of file TObject.h.

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
kNoInt
kValidInt
kInvalidInt

Definition at line 56 of file THnBase.h.

◆ EDeprecatedStatusBits

enum TObject::EDeprecatedStatusBits

inherited

Enumerator
kObjInCanvas	for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits

inherited

Enumerator
kCanDelete	if object in a list can be deleted
kMustCleanup	if object destructor must call RecursiveRemove()
kIsReferenced	if object is referenced by a TRef or TRefArray
kHasUUID	if object has a TUUID (its fUniqueID=UUIDNumber)
kCannotPick	if object in a pad cannot be picked
kNoContextMenu	if object does not want context menu
kInvalidObject	if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ THn() [1/4]

THn::THn ( )

protecteddefault

◆ THn() [2/4]

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 181 of file THn.cxx.

◆ THn() [3/4]

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

protected

Definition at line 189 of file THn.cxx.

◆ THn() [4/4]

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 198 of file THn.cxx.

◆ ~THn()

THn::~THn ( )

override

Destruct a THn.

Definition at line 207 of file THn.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method ) const

inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning: This interface is a legacy function that is no longer recommended to be used by new development code.

Note: The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ Add() [1/2]

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

inherited

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

Definition at line 479 of file THnBase.cxx.

◆ Add() [2/2]

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

inherited

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 889 of file THnBase.cxx.

◆ AddBinContent() [1/2]

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

inline

Definition at line 196 of file THnBase.h.

◆ AddBinContent() [2/2]

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

inlineoverridevirtual

Implements THnBase.

Definition at line 104 of file THn.h.

◆ AddBinError2()

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

inlineoverridevirtual

Implements THnBase.

Definition at line 107 of file THn.h.

◆ AddInternal()

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

protectedinherited

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

See THnBase::Add().

Definition at line 813 of file THnBase.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op )

staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AllocCoordBuf()

void THn::AllocCoordBuf ( ) const

protected

Create the coordinate buffer.

Outlined to hide allocation from inlined functions.

Definition at line 240 of file THn.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "" )

virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

void THnBase::Browse ( TBrowser * b )

overridevirtualinherited

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

Reimplemented from TObject.

Definition at line 1598 of file THnBase.cxx.

◆ CalculateErrors()

void THnBase::CalculateErrors ( Bool_t calc = kTRUE )

inlineinherited

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

Definition at line 149 of file THnBase.h.

◆ CheckConsistency()

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

protectedinherited

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

Definition at line 1180 of file THnBase.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )

inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * THn::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

const char * THn::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

constexpr Version_t THn::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 155 of file THn.h.

◆ ClassName()

const char * TObject::ClassName ( ) const

virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TNamed::Clear ( Option_t * option = "" )

overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "" ) const

overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ CloneEmpty()

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

protectedinherited

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 191 of file THnBase.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj ) const

overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ ComputeIntegral()

Double_t THnBase::ComputeIntegral ( )

inherited

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 1381 of file THnBase.cxx.

◆ Copy()

void TNamed::Copy ( TObject & named ) const

overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TPieSlice, TProfile2D, TProfile3D, TProfile, TStyle, TSystemDirectory, TSystemFile, TText, and TXTRU.

Definition at line 93 of file TNamed.cxx.

◆ CreateHist()

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

protectedinherited

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 264 of file THnBase.cxx.

◆ CreateHn() [1/2]

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

inlinestatic

Definition at line 46 of file THn.h.

◆ CreateHn() [2/2]

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

inlinestatic

Definition at line 49 of file THn.h.

◆ CreateHnAny() [1/2]

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

staticprotectedinherited

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

Definition at line 335 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 )

staticprotectedinherited

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

Definition at line 415 of file THnBase.cxx.

◆ 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 215 of file THn.cxx.

◆ DeclFileName()

const char * THn::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 155 of file THn.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "" )

virtualinherited

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented in RooLinkedList, TAxis, TBtree, TCanvas, TClonesArray, TCollection, TDirectory, TDirectoryFile, TExMap, TFile, TGFrame, TGItemContext, TGTextEdit, THashList, THashTable, TKey, TKeySQL, TKeyXML, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMap, TMVA::Results, TObjArray, TObjectTable, TOrdCollection, TProtoClass, TQCommand, TRefArray, TSystemDirectory, TSystemFile, TThread, TTree, TTreeViewer, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 268 of file TObject.cxx.

◆ DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive	(	Int_t	px,
		Int_t	py )

virtualinherited

Computes distance from point (px,py) to the object.

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

◆ Divide() [1/2]

void THnBase::Divide ( const THnBase * h )

inherited

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 1041 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 = "" )

inherited

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 1098 of file THnBase.cxx.

◆ DoError()

void TObject::DoError	(	int	level,
		const char *	location,
		const char *	fmt,
		va_list	va ) const

protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

void TObject::Draw ( Option_t * option = "" )

virtualinherited

Default Draw method for all objects.

Reimplemented in RooAbsData, RooPlot, RooStats::HypoTestInverterPlot, RooStats::SamplingDistPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, ROOT::RGeoPainter, TArrow, TASImage, TBox, TBrowser, TButton, TCanvas, TChain, TClass, TClassTree, TCollection, TColorWheel, TDiamond, TDirectory, TEfficiency, TEllipse, TEveGeoNode, TEveGeoTopNode, TF1, TF2, TF3, TFile, TFITSHDU, TFrame, TGenerator, TGeoBatemanSol, TGeometry, TGeoNode, TGeoOverlap, TGeoPainter, TGeoParallelWorld, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoTrack, TGeoVGShape, TGeoVolume, TGItemContext, TGListTree, TGPicture, TGraph2D, TGraph, TGraphPolar, TGraphPolargram, TGraphStruct, TGraphTime, TH1, THelix, THStack, TLegend, TMarker, TMatrixTBase< Element >, TMatrixTBase< Double_t >, TMatrixTBase< Float_t >, TMultiDimFit, TMultiGraph, TMultiLayerPerceptron, TNode, TNodeDiv, TPad, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TPave, TPaveLabel, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TRatioPlot, TSpider, TSpline, TStructViewer, TStructViewerGUI, TTree, TTreePerfStats, TVectorT< Element >, TVectorT< Double_t >, TVectorT< Float_t >, TVirtualPad, and TWbox.

Definition at line 293 of file TObject.cxx.

◆ DrawClass()

void TObject::DrawClass ( ) const

virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "" ) const

virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note: For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const

virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle                   0           Arrow opening angle (degrees)
fArrowSize               0.2         Arrow Size
fOption.*fData
fX1                      0.1         X of 1st point
fY1                      0.15        Y of 1st point
fX2                      0.67        X of 2nd point
fY2                      0.83        Y of 2nd point
fUniqueID                0           object unique identifier
fBits                    50331648    bit field status word
fLineColor               1           line color
fLineStyle               1           line style
fLineWidth               1           line width
fFillColor               19          fill area color
fFillStyle               1001        fill area style

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute	(	const char *	method,
		const char *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute	(	TMethod *	method,
		TObjArray *	params,
		Int_t *	error = nullptr )

virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters

TObjString

Collectable string class.

Definition TObjString.h:28

n

const Int_t n

Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TObject::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

◆ Fatal()

void TObject::Fatal	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ Fill() [1/3]

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

inlineinherited

Definition at line 160 of file THnBase.h.

◆ Fill() [2/3]

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

inlineinherited

Definition at line 154 of file THnBase.h.

◆ Fill() [3/3]

template<typename... MoreTypes>

Long64_t THnBase::Fill	(	Double_t	firstval,
		MoreTypes...	morevals )

inlineinherited

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 172 of file THnBase.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.

◆ FillBinBase()

void THnBase::FillBinBase ( Double_t w )

inlineprotectedinherited

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

Definition at line 93 of file THnBase.h.

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

inherited

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 517 of file THnBase.cxx.

◆ GetArray() [1/2]

virtual const TNDArray & THn::GetArray ( ) const

pure virtual

Implemented in THnT< T >, THnT< Char_t >, THnT< double >, THnT< Double_t >, THnT< Float_t >, THnT< Int_t >, THnT< Long64_t >, and THnT< Short_t >.

◆ GetArray() [2/2]

virtual TNDArray & THn::GetArray ( )

pure virtual

Implemented in THnT< T >, THnT< Char_t >, THnT< double >, THnT< Double_t >, THnT< Float_t >, THnT< Int_t >, THnT< Long64_t >, and THnT< Short_t >.

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

inherited

THnBase::GetBinCenter.

Parameters

idx	an 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 546 of file THnBase.cxx.

◆ GetBinContent() [1/2]

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

inline

Definition at line 202 of file THnBase.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 112 of file THn.h.

◆ GetBinError() [1/2]

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

inlineinherited

Definition at line 192 of file THnBase.h.

◆ GetBinError() [2/2]

Double_t THnBase::GetBinError ( Long64_t linidx ) const

inlineinherited

Definition at line 193 of file THnBase.h.

◆ GetBinError2()

Double_t THn::GetBinError2 ( Long64_t linidx ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 124 of file THn.h.

◆ GetCalculateErrors()

Bool_t THnBase::GetCalculateErrors ( ) const

inlineinherited

Definition at line 146 of file THnBase.h.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const

virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )

staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEntries()

Double_t THnBase::GetEntries ( ) const

inlineinherited

Definition at line 143 of file THnBase.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const

virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetListOfAxes() [1/2]

TObjArray * THnBase::GetListOfAxes ( )

inlineinherited

Definition at line 133 of file THnBase.h.

◆ GetListOfAxes() [2/2]

const TObjArray * THnBase::GetListOfAxes ( ) const

inlineinherited

Definition at line 134 of file THnBase.h.

◆ GetListOfFunctions()

TList * THnBase::GetListOfFunctions ( )

inlineinherited

Definition at line 138 of file THnBase.h.

◆ GetName()

const char * TNamed::GetName ( ) const

inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNbins()

Long64_t THn::GetNbins ( ) const

inlineoverridevirtual

Implements THnBase.

Definition at line 54 of file THn.h.

◆ GetNdimensions()

Int_t THnBase::GetNdimensions ( ) const

inlineinherited

Definition at line 145 of file THnBase.h.

◆ GetObjectInfo()

char * TObject::GetObjectInfo	(	Int_t	px,
		Int_t	py ) const

virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )

staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const

inlinevirtualinherited

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

◆ GetRandom()

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

inherited

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const

virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetWeightSum()

Double_t THnBase::GetWeightSum ( ) const

inlineinherited

Definition at line 144 of file THnBase.h.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer )

virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const

inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides

TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

TNamed::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TNamed.h:51

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:1098

TObject::TObject

TObject()

TObject constructor.

Definition TObject.h:259

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const

inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Info()

void TObject::Info	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname ) const

virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl ) const

virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Init()

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

protectedinherited

Initialize axes and name.

Definition at line 207 of file THnBase.cxx.

◆ 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 248 of file THn.cxx.

◆ Inspect()

void TObject::Inspect ( ) const

virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ Integral()

Double_t THnBase::Integral ( Bool_t respectAxisRange ) const

inherited

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

Parameters

respectAxisRange if false, count all bins including under/overflows, if true, restrict sum to the user-set axis range

Note: See also Projection(0)::Integral() as alternative; this function is different from ComputeIntegral, that is a normalized cumulative sum

Definition at line 1361 of file THnBase.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f )

inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * THn::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in THnT< T >, THnT< Char_t >, THnT< double >, THnT< Double_t >, THnT< Float_t >, THnT< Int_t >, THnT< Long64_t >, and THnT< Short_t >.

Definition at line 155 of file THn.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const

inlineinherited

IsDestructed.

Note: This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).

Returns: true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj ) const

virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

Bool_t THnBase::IsFolder ( ) const

inlineoverridevirtualinherited

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

Reimplemented from TObject.

Definition at line 301 of file THnBase.h.

◆ IsInRange()

Bool_t THnBase::IsInRange ( Int_t * coord ) const

inherited

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

Definition at line 604 of file THnBase.cxx.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const

inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const

inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TNamed::ls ( Option_t * option = "" ) const

overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

◆ MakeZombie()

◆ Obsolete()

void TObject::Obsolete	(	const char *	method,
		const char *	asOfVers,
		const char *	removedFromVers ) const

inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete	(	void *	ptr,
		size_t	size )

inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr )

inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[]	(	void *	ptr,
		size_t	size )

inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr )

inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[]	(	void *	ptr,
		void *	vp )

inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new	(	size_t	sz,
		void *	vp )

inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz )

inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

void * TObject::operator new[]	(	size_t	sz,
		void *	vp )

inlineinherited

Definition at line 192 of file TObject.h.

◆ Paint()

void TObject::Paint ( Option_t * option = "" )

virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )

virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

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

overridevirtualinherited

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 1551 of file THnBase.cxx.

◆ PrintBin() [1/3]

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

inlineinherited

Definition at line 295 of file THnBase.h.

◆ PrintBin() [2/3]

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

protectedinherited

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 1456 of file THnBase.cxx.

◆ PrintBin() [3/3]

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

inherited

Print bin with linex index "idx".

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

Definition at line 1442 of file THnBase.cxx.

◆ PrintEntries()

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

inherited

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 1500 of file THnBase.cxx.

◆ Projection() [1/4]

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

inline

Definition at line 137 of file THn.h.

◆ Projection() [2/4]

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 257 of file THnBase.h.

◆ Projection() [3/4]

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 231 of file THnBase.h.

◆ Projection() [4/4]

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 244 of file THnBase.h.

◆ ProjectionAny()

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

protectedinherited

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 630 of file THnBase.cxx.

◆ ProjectionND()

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

inlineinherited

Project histogram onto the axes specified in dim.

Parameters

ndim	Size of the dim array.
dim	Indices of the axes to project on.
option	- "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.

Returns: A new THnBase derived class, such as THN or THNSparse.

Definition at line 270 of file THnBase.h.

◆ Read()

Int_t TObject::Read ( const char * name )

virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ Rebin() [1/2]

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

inline

Definition at line 145 of file THn.h.

◆ Rebin() [2/2]

THn * THn::Rebin ( Int_t group ) const

inline

Definition at line 142 of file THn.h.

◆ RebinBase() [1/2]

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

protectedinherited

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 1264 of file THnBase.cxx.

◆ RebinBase() [2/2]

THnBase * THnBase::RebinBase ( Int_t group ) const

protectedinherited

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 1248 of file THnBase.cxx.

◆ RebinnedAdd()

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

inherited

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 905 of file THnBase.cxx.

◆ RecursiveRemove()

void TObject::RecursiveRemove ( TObject * obj )

virtualinherited

Recursively remove this object from a list.

Typically implemented by classes that can contain multiple references to a same object.

Reimplemented in RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, ROOT::RBrowserDataCleanup, RooWorkspace, TBrowser, TChain, TCling, TCollection, TDialogCanvas, TDirectory, TEfficiency, TFileMerger, TFitEditor, TFolder, TFriendElement, TGedEditor, TGeometry, TGFileBrowser, TGraph2D, TGraph, TH1, TH1Editor, TH2Editor, THashList, THistPainter, THStack, TInspectCanvas, TLegend, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TMultiGraph, TNode, TObjArray, TObjectRefSpy, TObjectSpy, TPad, TProcessID, TROOT, TRootBrowser, TRootBrowserHistory, TRootBrowserLite, TRootContextMenu, TTree, TTreePlayer, TViewPubDataMembers, TViewPubFunctions, and TVirtualPad.

Definition at line 684 of file TObject.cxx.

◆ Reserve()

virtual void THnBase::Reserve ( Long64_t )

inlineprotectedvirtualinherited

Reimplemented in THnSparse.

Definition at line 108 of file THnBase.h.

◆ Reset()

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

overridevirtual

Reset the contents of a THn.

Implements THnBase.

Definition at line 258 of file THn.cxx.

◆ ResetBase()

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

protectedinherited

Clear the histogram.

Definition at line 1343 of file THnBase.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs	(	const char *	filename = "",
		Option_t *	option = "" ) const

virtualinherited

Save this object in the file specified by filename.

if "filename" contains ".root" the object is saved in filename as root binary file.
if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = "" )

virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor	(	std::ostream &	out,
		TClass *	cl,
		const char *	variable_name,
		const char *	constructor_agrs = "",
		Bool_t	empty_line = kTRUE )

staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw	(	std::ostream &	out,
		const char *	variable_name,
		Option_t *	option = nullptr )

staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle	(	std::ostream &	out,
		const char *	variable_name )

protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector	(	std::ostream &	out,
		const char *	prefix,
		Int_t	len,
		Double_t *	arr,
		Int_t	flag = 0 )

staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ Scale()

void THnBase::Scale ( Double_t c )

inherited

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 789 of file THnBase.cxx.

◆ SetBinContent() [1/2]

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

inline

Definition at line 212 of file THnBase.h.

◆ SetBinContent() [2/2]

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

inlineoverridevirtual

Implements THnBase.

Definition at line 96 of file THn.h.

◆ SetBinEdges()

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

inherited

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

Definition at line 1198 of file THnBase.cxx.

◆ SetBinError() [1/2]

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

inlineinherited

Definition at line 194 of file THnBase.h.

◆ SetBinError() [2/2]

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

inlineinherited

Definition at line 195 of file THnBase.h.

◆ SetBinError2()

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

inlineoverridevirtual

Implements THnBase.

Definition at line 99 of file THn.h.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f )

inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit	(	UInt_t	f,
		Bool_t	set )

inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "" )

virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj )

staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEntries()

void THnBase::SetEntries ( Double_t entries )

inlineinherited

Definition at line 197 of file THnBase.h.

◆ SetFilledBins()

virtual void THnBase::SetFilledBins ( Long64_t )

inlineprotectedvirtualinherited

Reimplemented in THnSparse.

Definition at line 109 of file THnBase.h.

◆ SetName()

void TNamed::SetName ( const char * name )

virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle	(	const char *	name,
		const char *	title )

virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat )

staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetTitle()

void THnBase::SetTitle ( const char * title )

overridevirtualinherited

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 1237 of file THnBase.cxx.

◆ SetTitleImpl()

void THnBase::SetTitleImpl	(	const char *	title,
		bool	overrideAxesTitle )

protectedinherited

Definition at line 1205 of file THnBase.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid )

virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const

virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void THn::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in THnT< T >, THnT< Char_t >, THnT< double >, THnT< Double_t >, THnT< Float_t >, THnT< Int_t >, THnT< Long64_t >, and THnT< Short_t >.

◆ StreamerNVirtual()

void THn::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 155 of file THn.h.

◆ Sumw2()

void THn::Sumw2 ( )

overridevirtual

Enable calculation of errors.

Implements THnBase.

Definition at line 224 of file THn.cxx.

◆ SysError()

void TObject::SysError	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f ) const

inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f ) const

inlineinherited

Definition at line 205 of file TObject.h.

◆ UpdateXStat()

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

inlineprotectedinherited

Definition at line 81 of file THnBase.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )

virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning	(	const char *	location,
		const char *	fmt,
			... ) const

virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 )

virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write	(	const char *	name = nullptr,
		Int_t	option = 0,
		Int_t	bufsize = 0 ) const

virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
The TBuffer object is filled via the class::Streamer function.
If the file is compressed (default) a second buffer is created to hold the compressed buffer.
Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

◆ fAxes

TObjArray THnBase::fAxes

protectedinherited

Axes of the histogram.

Definition at line 48 of file THnBase.h.

◆ fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBrowsables

TObjArray THnBase::fBrowsables

protectedinherited

! Browser-helpers for each axis

Definition at line 49 of file THnBase.h.

◆ fCoordBuf

std::vector<Int_t> THn::fCoordBuf

mutableprotected

! Temporary buffer

Definition at line 153 of file THn.h.

◆ fEntries

Double_t THnBase::fEntries

protectedinherited

Number of entries, spread over chunks.

Definition at line 50 of file THnBase.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0

staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fIntegral

std::vector<Double_t> THnBase::fIntegral

protectedinherited

! vector with bin weight sums

Definition at line 55 of file THnBase.h.

◆ []

enum { ... } THnBase::fIntegralStatus

! status of integral

◆ fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNdimensions

Int_t THnBase::fNdimensions

protectedinherited

Number of dimensions.

Definition at line 47 of file THnBase.h.

◆ fSumw2

TNDArrayT<Double_t> THn::fSumw2

protected

Definition at line 152 of file THn.h.

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

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

hist/hist/inc/THn.h
hist/hist/src/THn.cxx

Filling

Projections

Conversion from other histogram classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ EDeprecatedStatusBits

◆ EStatusBits

Constructor & Destructor Documentation

◆ THn() [1/4]

◆ THn() [2/4]

◆ THn() [3/4]

◆ THn() [4/4]

◆ ~THn()

Member Function Documentation

◆ AbstractMethod()

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddBinContent() [1/2]

◆ AddBinContent() [2/2]

◆ AddBinError2()

◆ AddInternal()

◆ AddToTObjectTable()

◆ AllocCoordBuf()

◆ AppendPad()

◆ Browse()

◆ CalculateErrors()

◆ CheckConsistency()

◆ CheckedHash()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClassName()

◆ Clear()

◆ Clone()

◆ CloneEmpty()

◆ Compare()

◆ ComputeIntegral()

◆ Copy()

◆ CreateHist()

◆ CreateHn() [1/2]

◆ CreateHn() [2/2]

◆ CreateHnAny() [1/2]

◆ CreateHnAny() [2/2]

◆ CreateIter()

◆ DeclFileName()

◆ Delete()

◆ DistancetoPrimitive()

◆ Divide() [1/2]

◆ Divide() [2/2]

◆ DoError()

◆ Draw()

◆ DrawClass()

◆ DrawClone()

◆ Dump()

◆ Error()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteEvent()

◆ Fatal()

◆ Fill() [1/3]

◆ Fill() [2/3]

◆ Fill() [3/3]

◆ FillBin()

◆ FillBinBase()

◆ FillBuffer()

◆ FindObject() [1/2]

◆ FindObject() [2/2]