Logo ROOT   6.21/01
Reference Guide
THnT< T > Class Template Reference

template<typename T>
class THnT< T >

Templated implementation of the abstract base THn.

All functionality and the interfaces to be used are in THn!

THn does not know how to store any bin content itself. Instead, this is delegated to the derived, templated class: the template parameter decides what the format for the bin content is. The actual storage is delegated to TNDArrayT<T>.

Typedefs exist for template parematers with ROOT's generic types:

Templated name Typedef Bin content type
THnT<Char_t> THnC Char_t
THnT<Short_t> THnS Short_t
THnT<Int_t> THnI Int_t
THnT<Long_t> THnL Long_t
THnT<Float_t> THnF Float_t
THnT<Double_t> THnD Double_t

We recommend to use THnC wherever possible, and to map its value space of 256 possible values to e.g. float values outside the class. This saves an enourmous amount of memory. Only if more than 256 values need to be distinguished should e.g. THnS or even THnF be chosen.

Implementation detail: the derived, templated class is kept extremely small on purpose. That way the (templated thus inlined) uses of this class will only create a small amount of machine code, in contrast to e.g. STL.

Definition at line 228 of file THn.h.

Public Member Functions

 THnT ()
 
 THnT (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax)
 
const TNDArrayGetArray () const
 
TNDArrayGetArray ()
 
- Public Member Functions inherited from THn
virtual ~THn ()
 Destruct a THn. More...
 
void AddBinContent (const Int_t *idx, Double_t v=1.)
 
void AddBinContent (Long64_t bin, Double_t v=1.)
 
void AddBinError2 (Long64_t bin, Double_t e2)
 
ROOT::Internal::THnBaseBinIterCreateIter (Bool_t respectAxisRange) const
 Create an iterator over all bins. Public interface is THnIter. More...
 
void FillBin (Long64_t bin, Double_t w)
 
Long64_t GetBin (const Int_t *idx) const
 
Long64_t GetBin (const Double_t *x) const
 
Long64_t GetBin (const char *name[]) const
 
Long64_t GetBin (const Int_t *idx, Bool_t=kTRUE)
 
Long64_t GetBin (const Double_t *x, Bool_t=kTRUE)
 
Long64_t GetBin (const char *name[], Bool_t=kTRUE)
 
Double_t GetBinContent (const Int_t *idx) const
 
Double_t GetBinContent (Long64_t bin, Int_t *idx=0) const
 
Double_t GetBinError2 (Long64_t linidx) const
 
Long64_t GetNbins () const
 
TH1DProjection (Int_t xDim, Option_t *option="") const
 
TH2DProjection (Int_t yDim, Int_t xDim, Option_t *option="") const
 
TH3DProjection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
 
THnProjection (Int_t ndim, const Int_t *dim, Option_t *option="") const
 
THnRebin (Int_t group) const
 
THnRebin (const Int_t *group) const
 
void Reset (Option_t *option="")
 Reset the contents of a THn. More...
 
void SetBinContent (const Int_t *idx, Double_t v)
 
void SetBinContent (Long64_t bin, Double_t v)
 
void SetBinError2 (Long64_t bin, Double_t e2)
 
void Sumw2 ()
 Enable calculation of errors. More...
 
- Public Member Functions inherited from THnBase
virtual ~THnBase ()
 Destruct a THnBase. More...
 
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. More...
 
void Add (const TH1 *hist, Double_t c=1.)
 Fill the THnBase with the bins of hist that have content or error != 0. More...
 
void AddBinContent (const Int_t *x, Double_t v=1.)
 
void Browse (TBrowser *b)
 Browse a THnSparse: create an entry (ROOT::THnSparseBrowsable) for each dimension. More...
 
void CalculateErrors (Bool_t calc=kTRUE)
 Calculate errors (or not if "calc" == kFALSE) More...
 
Double_t ComputeIntegral ()
 Calculate the integral of the histogram. More...
 
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. More...
 
void Divide (const THnBase *h1, const THnBase *h2, Double_t c1=1., Double_t c2=1., Option_t *option="")
 Replace contents of this histogram by multiplication of h1 by h2 this = (c1*h1)/(c2*h2) Note that if h1 or h2 have Sumw2 set, Sumw2 is automatically called for this if not already set. More...
 
Long64_t Fill (const Double_t *x, Double_t w=1.)
 
Long64_t Fill (const char *name[], Double_t w=1.)
 
TFitResultPtr Fit (TF1 *f1, Option_t *option="", Option_t *goption="")
 Fit a THnSparse with function f. More...
 
TAxisGetAxis (Int_t dim) const
 
Double_t GetBinContent (const Int_t *idx) const
 
Double_t GetBinError (const Int_t *idx) const
 
Double_t GetBinError (Long64_t linidx) const
 
Bool_t GetCalculateErrors () const
 
Double_t GetEntries () const
 
TObjArrayGetListOfAxes ()
 
const TObjArrayGetListOfAxes () const
 
TListGetListOfFunctions ()
 
Int_t GetNdimensions () const
 
void GetRandom (Double_t *rand, Bool_t subBinRandom=kTRUE)
 Generate an n-dimensional random tuple based on the histogrammed distribution. More...
 
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
 
Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
Bool_t IsInRange (Int_t *coord) const
 Check whether bin coord is in range, as defined by TAxis::SetRange(). More...
 
Long64_t Merge (TCollection *list)
 Merge this with a list of THnBase's. More...
 
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. More...
 
void Multiply (TF1 *f, Double_t c=1.)
 Performs the operation: this = this*c*f1 if errors are defined, errors are also recalculated. More...
 
void Print (Option_t *option="") const
 Print a THnBase. More...
 
void PrintBin (Int_t *coord, Option_t *options) const
 
void PrintBin (Long64_t idx, Option_t *options) const
 Print bin with linex index "idx". More...
 
void PrintEntries (Long64_t from=0, Long64_t howmany=-1, Option_t *options=0) const
 Print "howmany" entries starting at "from". More...
 
TH1DProjection (Int_t xDim, Option_t *option="") const
 Project all bins into a 1-dimensional histogram, keeping only axis "xDim". More...
 
TH2DProjection (Int_t yDim, Int_t xDim, Option_t *option="") const
 Project all bins into a 2-dimensional histogram, keeping only axes "xDim" and "yDim". More...
 
TH3DProjection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const
 Project all bins into a 3-dimensional histogram, keeping only axes "xDim", "yDim", and "zDim". More...
 
THnBaseProjectionND (Int_t ndim, const Int_t *dim, Option_t *option="") const
 
void RebinnedAdd (const THnBase *h, Double_t c=1.)
 Add contents of h scaled by c to this histogram: this = this + c * h Note that if h has Sumw2 set, Sumw2 is automatically called for this if not already set. More...
 
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. More...
 
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. More...
 
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)
 Change (i.e. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Attributes

TNDArrayT< T > fArray
 
- Protected Attributes inherited from THn
Int_tfCoordBuf
 
TNDArrayT< Double_tfSumw2
 
- Protected Attributes inherited from THnBase
TObjArray fAxes
 
TObjArray fBrowsables
 
Double_t fEntries
 browser-helpers for each axis More...
 
Double_tfIntegral
 
enum THnBase:: { ... }  fIntegralStatus
 array with bin weight sums More...
 
Int_t fNdimensions
 
Double_t fTsumw
 
Double_t fTsumw2
 
TArrayD fTsumwx
 
TArrayD fTsumwx2
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from THn
static THnCreateHn (const char *name, const char *title, const TH1 *h1)
 
static THnCreateHn (const char *name, const char *title, const THnBase *hn)
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from THnBase
enum  { kNoInt, kValidInt, kInvalidInt }
 array with bin weight sums More...
 
- Protected Member Functions inherited from THn
 THn ()
 
 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. More...
 
void AllocCoordBuf () const
 Create the coordinate buffer. More...
 
void InitStorage (Int_t *nbins, Int_t chunkSize)
 Initialize the storage of a histogram created via Init() More...
 
- Protected Member Functions inherited from THnBase
 THnBase ()
 
 THnBase (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax)
 Construct a THnBase with "dim" dimensions, "nbins" holds the number of bins for each dimension; "xmin" and "xmax" the minimal and maximal value for each dimension. More...
 
void AddInternal (const THnBase *h, Double_t c, Bool_t rebinned)
 Add() implementation for both rebinned histograms and those with identical binning. More...
 
Bool_t CheckConsistency (const THnBase *h, const char *tag) const
 Consistency check on (some of) the parameters of two histograms (for operations). More...
 
THnBaseCloneEmpty (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
 Create a new THnBase object that is of the same type as *this, but with dimensions and bins given by axes. More...
 
TH1CreateHist (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis) const
 Create an empty histogram with name and title with a given set of axes. More...
 
void FillBinBase (Double_t w)
 Increment the statistics due to filled weight "w",. More...
 
void Init (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis, Int_t chunkSize=1024 *16)
 Initialize axes and name. More...
 
Bool_t PrintBin (Long64_t idx, Int_t *coord, Option_t *options) const
 Print one bin. More...
 
TObjectProjectionAny (Int_t ndim, const Int_t *dim, Bool_t wantNDim, Option_t *option="") const
 Project all bins into a ndim-dimensional THn / THnSparse (whatever *this is) or if (ndim < 4 and !wantNDim) a TH1/2/3 histogram, keeping only axes in dim (specifying ndim dimensions). More...
 
THnBaseRebinBase (Int_t group) const
 Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase. More...
 
THnBaseRebinBase (const Int_t *group) const
 Combine the content of "group" neighboring bins for each dimension into a new bin and return the resulting THnBase. More...
 
virtual void Reserve (Long64_t)
 
void ResetBase (Option_t *option="")
 Clear the histogram. More...
 
virtual void SetFilledBins (Long64_t)
 
void UpdateXStat (const Double_t *x, Double_t w=1.)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 
- Static Protected Member Functions inherited from THnBase
static THnBaseCreateHnAny (const char *name, const char *title, const TH1 *h1, Bool_t sparse, Int_t chunkSize=1024 *16)
 Create a THn / THnSparse object from a histogram deriving from TH1. More...
 
static THnBaseCreateHnAny (const char *name, const char *title, const THnBase *hn, Bool_t sparse, Int_t chunkSize=1024 *16)
 Create a THnSparse (if "sparse") or THn from "hn", possibly converting THn <-> THnSparse. More...
 

#include <THn.h>

Inheritance diagram for THnT< T >:
[legend]

Constructor & Destructor Documentation

◆ THnT() [1/2]

template<typename T >
THnT< T >::THnT ( )
inline

Definition at line 230 of file THn.h.

◆ THnT() [2/2]

template<typename T >
THnT< T >::THnT ( const char *  name,
const char *  title,
Int_t  dim,
const Int_t nbins,
const Double_t xmin,
const Double_t xmax 
)
inline

Definition at line 232 of file THn.h.

Member Function Documentation

◆ GetArray() [1/2]

template<typename T >
const TNDArray& THnT< T >::GetArray ( ) const
inlinevirtual

Implements THn.

Definition at line 238 of file THn.h.

◆ GetArray() [2/2]

template<typename T >
TNDArray& THnT< T >::GetArray ( )
inlinevirtual

Implements THn.

Definition at line 239 of file THn.h.

Member Data Documentation

◆ fArray

template<typename T >
TNDArrayT<T> THnT< T >::fArray
protected

Definition at line 242 of file THn.h.


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