![]() |
ROOT
6.06/09
Reference Guide
|
Multidimensional histogram.
Use a THn if you really, really have to store more than three dimensions, and if a large fraction of all bins are filled. Better alternatives are
The major problem of THn is the memory use caused by n-dimensional histogramming: a THnD with 8 dimensions and 100 bins per dimension needs more than 2.5GB of RAM!
To construct a THn object you must use one of its templated, derived classes:
THnD (typedef for THnT<Double_t>): bin content held by a Double_t, THnF (typedef for THnT<Float_t>): bin content held by a Float_t, THnL (typedef for THnT<Long_t>): bin content held by a Long_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, min, max);
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.
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);
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.
Public Member Functions | |
| virtual | ~THn () |
| Destruct a THn. More... | |
| ROOT::Internal::THnBaseBinIter * | CreateIter (Bool_t respectAxisRange) const |
| Create an iterator over all bins. Public interface is THnIter. More... | |
| Long64_t | GetNbins () const |
| 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) |
| 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 | 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) |
| 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 |
| virtual const TNDArray & | GetArray () const =0 |
| virtual TNDArray & | GetArray ()=0 |
| void | Sumw2 () |
| Enable calculation of errors. More... | |
| TH1D * | Projection (Int_t xDim, Option_t *option="") const |
| TH2D * | Projection (Int_t yDim, Int_t xDim, Option_t *option="") const |
| TH3D * | Projection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const |
| THn * | Projection (Int_t ndim, const Int_t *dim, Option_t *option="") const |
| THn * | Rebin (Int_t group) const |
| THn * | Rebin (const Int_t *group) const |
| void | Reset (Option_t *option="") |
| Reset the contents of a THn. More... | |
Public Member Functions inherited from THnBase | |
| virtual | ~THnBase () |
| Destruct a THnBase. More... | |
| TObjArray * | GetListOfAxes () |
| const TObjArray * | GetListOfAxes () const |
| TAxis * | GetAxis (Int_t dim) const |
| TFitResultPtr | Fit (TF1 *f1, Option_t *option="", Option_t *goption="") |
| Fit a THnSparse with function f. More... | |
| TList * | GetListOfFunctions () |
| Double_t | GetEntries () const |
| Double_t | GetWeightSum () const |
| Int_t | GetNdimensions () const |
| Bool_t | GetCalculateErrors () const |
| void | CalculateErrors (Bool_t calc=kTRUE) |
| Long64_t | Fill (const Double_t *x, Double_t w=1.) |
| Long64_t | Fill (const char *name[], Double_t w=1.) |
| void | SetBinEdges (Int_t idim, const Double_t *bins) |
| Set the axis # of bins and bin limits on dimension idim. More... | |
| Bool_t | IsInRange (Int_t *coord) const |
| Check whether bin coord is in range, as defined by TAxis::SetRange(). More... | |
| Double_t | GetBinError (const Int_t *idx) const |
| Double_t | GetBinError (Long64_t linidx) const |
| void | SetBinError (const Int_t *idx, Double_t e) |
| void | SetBinError (Long64_t bin, Double_t e) |
| void | AddBinContent (const Int_t *x, Double_t v=1.) |
| void | SetEntries (Double_t entries) |
| void | SetTitle (const char *title) |
| Change (i.e. More... | |
| Double_t | GetBinContent (const Int_t *idx) const |
| void | SetBinContent (const Int_t *idx, Double_t v) |
| Double_t | GetSumw () const |
| Double_t | GetSumw2 () const |
| Double_t | GetSumwx (Int_t dim) const |
| Double_t | GetSumwx2 (Int_t dim) const |
| TH1D * | Projection (Int_t xDim, Option_t *option="") const |
| TH2D * | Projection (Int_t yDim, Int_t xDim, Option_t *option="") const |
| TH3D * | Projection (Int_t xDim, Int_t yDim, Int_t zDim, Option_t *option="") const |
| THnBase * | ProjectionND (Int_t ndim, const Int_t *dim, Option_t *option="") const |
| Long64_t | Merge (TCollection *list) |
| Merge this with a list of THnBase's. 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 | 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 | 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 | 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... | |
| 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... | |
| Double_t | ComputeIntegral () |
| Calculate the integral of the histogram. More... | |
| void | GetRandom (Double_t *rand, Bool_t subBinRandom=kTRUE) |
| Generate an n-dimensional random tuple based on the histogrammed distribution. More... | |
| void | Print (Option_t *option="") const |
| Print a THnBase. More... | |
| void | PrintEntries (Long64_t from=0, Long64_t howmany=-1, Option_t *options=0) const |
| Print "howmany" entries starting at "from". 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 | Browse (TBrowser *b) |
| Browse a THnSparse: create an entry (ROOT::THnSparseBrowsable) for each dimension. More... | |
| Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
| ClassDef (THnBase, 1) | |
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 & | operator= (const TNamed &rhs) |
| TNamed assignment operator. More... | |
| virtual | ~TNamed () |
| virtual void | Clear (Option_t *option="") |
| Set name and title to empty strings (""). More... | |
| virtual TObject * | Clone (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 | SetName (const char *name) |
| Change (i.e. More... | |
| virtual void | SetNameTitle (const char *name, const char *title) |
| Change (i.e. set) all the TNamed parameters (name and title). More... | |
| virtual void | ls (Option_t *option="") const |
| List TNamed 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 (const TObject &object) | |
| TObject copy ctor. More... | |
| TObject & | operator= (const TObject &rhs) |
| TObject assignment operator. More... | |
| virtual | ~TObject () |
| TObject destructor. More... | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. 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 TObject * | DrawClone (Option_t *option="") const |
| Draw a clone of this object in the current pad. More... | |
| virtual void | Dump () const |
| Dump contents of object on stdout. 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 TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. More... | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. More... | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. More... | |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. More... | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. More... | |
| virtual Option_t * | GetOption () const |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). More... | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. 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... | |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). More... | |
| Bool_t | IsOnHeap () const |
| Bool_t | IsZombie () const |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification. 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... | |
| 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... | |
| 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 | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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... | |
| void * | operator new (size_t sz) |
| void * | operator new[] (size_t sz) |
| void * | operator new (size_t sz, void *vp) |
| void * | operator new[] (size_t sz, void *vp) |
| void | operator delete (void *ptr) |
| Operator delete. More... | |
| void | operator delete[] (void *ptr) |
| Operator delete []. 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) |
| void | ResetBit (UInt_t f) |
| Bool_t | TestBit (UInt_t f) const |
| Int_t | TestBits (UInt_t f) const |
| void | InvertBit (UInt_t f) |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. More... | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. More... | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. More... | |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. More... | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. 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... | |
| 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... | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. More... | |
Static Public Member Functions | |
| 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 Public Member Functions inherited from TObject | |
| static Long_t | GetDtorOnly () |
| Return destructor only flag. More... | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. More... | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. More... | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. More... | |
Protected Member Functions | |
| void | FillBin (Long64_t bin, Double_t w) |
| 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... | |
| 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... | |
| ClassDef (THn, 1) | |
| Temporary buffer. 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 | UpdateXStat (const Double_t *x, Double_t w=1.) |
| void | FillBinBase (Double_t w) |
| void | Init (const char *name, const char *title, const TObjArray *axes, Bool_t keepTargetAxis, Int_t chunkSize=1024 *16) |
| Initialize axes and name. More... | |
| 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. More... | |
| virtual void | Reserve (Long64_t) |
| virtual void | SetFilledBins (Long64_t) |
| Bool_t | CheckConsistency (const THnBase *h, const char *tag) const |
| Consistency check on (some of) the parameters of two histograms (for operations). More... | |
| 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. More... | |
| 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). More... | |
| Bool_t | PrintBin (Long64_t idx, Int_t *coord, Option_t *options) const |
| Print one bin. More... | |
| void | AddInternal (const THnBase *h, Double_t c, Bool_t rebinned) |
| Add() implementation for both rebinned histograms and those with identical binning. More... | |
| THnBase * | RebinBase (Int_t group) const |
| Combine the content of "group" neighboring bins into a new bin and return the resulting THnBase. More... | |
| 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. More... | |
| void | ResetBase (Option_t *option="") |
| Clear the histogram. More... | |
Protected Member Functions inherited from TObject | |
| void | MakeZombie () |
| virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
| Interface to ErrorHandler (protected). More... | |
Protected Attributes | |
| TNDArrayT< Double_t > | fSumw2 |
| Int_t * | fCoordBuf |
Protected Attributes inherited from THnBase | |
| Int_t | fNdimensions |
| TObjArray | fAxes |
| TObjArray | fBrowsables |
| Double_t | fEntries |
| browser-helpers for each axis More... | |
| Double_t | fTsumw |
| Double_t | fTsumw2 |
| TArrayD | fTsumwx |
| TArrayD | fTsumwx2 |
| Double_t * | fIntegral |
| enum THnBase:: { ... } | fIntegralStatus |
| array with bin weight sums More... | |
Protected Attributes inherited from TNamed | |
| TString | fName |
| TString | fTitle |
Private Member Functions | |
| THn (const THn &) | |
| THn & | operator= (const THn &) |
Additional Inherited Members | |
Public Types inherited from TObject | |
| enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
| enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
| enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
Protected Types inherited from THnBase | |
| enum | { kNoInt, kValidInt, kInvalidInt } |
| array with bin weight sums More... | |
Static Protected Member Functions inherited from THnBase | |
| static THnBase * | CreateHnAny (const char *name, const char *title, const TH1 *h1, Bool_t sparse, Int_t chunkSize=1024 *16) |
| Create a THn / THnSparse object from a histogram deriving from TH1. More... | |
| 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. More... | |
#include <THn.h>
Inheritance diagram for THn:
Collaboration diagram for THn:
|
private |
|
protected |
|
protected |
Temporary buffer.
|
virtual |
|
pure virtual |
Implemented in THnT< T >.
Referenced by AddBinContent(), CreateIter(), FillBin(), GetBin(), GetBinContent(), GetNbins(), InitStorage(), Reset(), SetBinContent(), and Sumw2().
|
inlinevirtual |
Definition at line 135 of file THn.h.
Referenced by GetBinError2().
|
inlinevirtual |
|
virtual |
Enable calculation of errors.
Implements THnBase.
Definition at line 213 of file THn.cxx.
Referenced by SetBinError2().
|
mutableprotected |
Definition at line 201 of file THn.h.
Referenced by AllocCoordBuf(), GetBin(), InitStorage(), and ~THn().
Definition at line 200 of file THn.h.
Referenced by AddBinError2(), FillBin(), GetBinError2(), InitStorage(), Reset(), SetBinError2(), and Sumw2().