 |
ROOT 6.12/07 Reference Guide |
| |
ROOT 6.12/07 Reference Guide |
Templated implementation of the abstract base THnSparse.
All functionality and the interfaces to be used are in THnSparse!
THnSparse 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. In fact it even defines the array itself; possible implementations probably derive from TArray.
Typedefs exist for template parematers with ROOT's generic types:
| Templated name | Typedef | Bin content type |
|---|---|---|
| THnSparseT<TArrayC> | THnSparseC | Char_t |
| THnSparseT<TArrayS> | THnSparseS | Short_t |
| THnSparseT<TArrayI> | THnSparseI | Int_t |
| THnSparseT<TArrayL> | THnSparseL | Long_t |
| THnSparseT<TArrayF> | THnSparseF | Float_t |
| THnSparseT<TArrayD> | THnSparseD | Double_t |
We recommend to use THnSparseC 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. THnSparseS or even THnSparseF 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 203 of file THnSparse.h.
Public Member Functions | |
| THnSparseT () | |
| THnSparseT (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin=0, const Double_t *xmax=0, Int_t chunksize=1024 *16) | |
| TArray * | GenerateArray () const |
 Public Member Functions inherited from THnSparse | |
| virtual | ~THnSparse () |
| Destruct a THnSparse. More... | |
| void | AddBinContent (const Int_t *idx, Double_t v=1.) |
| void | AddBinContent (Long64_t bin, Double_t v=1.) |
| Add "v" to the content of bin with index "bin". More... | |
| void | AddBinError2 (Long64_t bin, Double_t e2) |
| Add "e" to error of bin with index "bin", enable errors if needed. More... | |
| ROOT::Internal::THnBaseBinIter * | CreateIter (Bool_t respectAxisRange) const |
| Create an iterator over all filled bins of a THnSparse. More... | |
| 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 allocate=kTRUE) |
| Get the bin index for the n dimensional coordinates coord, allocate one if it doesn't exist yet and "allocate" is true. More... | |
| Long64_t | GetBin (const Double_t *x, Bool_t allocate=kTRUE) |
| Get the bin index for the n dimensional tuple x, allocate one if it doesn't exist yet and "allocate" is true. More... | |
| Long64_t | GetBin (const char *name[], Bool_t allocate=kTRUE) |
| Get the bin index for the n dimensional tuple addressed by "name", allocate one if it doesn't exist yet and "allocate" is true. More... | |
| Double_t | GetBinContent (const Int_t *idx) const |
| Double_t | GetBinContent (Long64_t bin, Int_t *idx=0) const |
| Return the content of the filled bin number "idx". More... | |
| Double_t | GetBinError2 (Long64_t linidx) const |
| Get square of the error of bin addressed by linidx as \(\sum weight^{2}\) If errors are not enabled (via Sumw2() or CalculateErrors()) return contents. More... | |
| Int_t | GetChunkSize () const |
| Long64_t | GetNbins () const |
| Int_t | GetNChunks () const |
| Double_t | GetSparseFractionBins () const |
| Return the amount of filled bins over all bins. More... | |
| Double_t | GetSparseFractionMem () const |
| Return the amount of used memory over memory that would be used by a non-sparse n-dimensional histogram. 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 |
| THnSparse * | Projection (Int_t ndim, const Int_t *dim, Option_t *option="") const |
| THnSparse * | Rebin (Int_t group) const |
| THnSparse * | Rebin (const Int_t *group) const |
| void | Reset (Option_t *option="") |
| Clear the histogram. More... | |
| void | SetBinContent (const Int_t *idx, Double_t v) |
| void | SetBinContent (Long64_t bin, Double_t v) |
| Set content of bin with index "bin" to "v". More... | |
| void | SetBinError2 (Long64_t bin, Double_t e2) |
| Set error of bin with index "bin" to "e", enable errors if needed. More... | |
| void | SetFilledBins (Long64_t nbins) |
| 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) |
| 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... | |
| TAxis * | GetAxis (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 |
| TObjArray * | GetListOfAxes () |
| const TObjArray * | GetListOfAxes () const |
| TList * | GetListOfFunctions () |
| Int_t | GetNdimensions () const |
| void | GetRandom (Double_t *rand, Bool_t subBinRandom=kTRUE) |
| Generate an n-dimensional random tuple based on the histogrammed distribution. 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... | |
| 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 |
| 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 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 | ls (Option_t *option="") const |
| List TNamed name and title. More... | |
| TNamed & | operator= (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 () |
| Checked and record whether for 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 TObject * | DrawClone (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 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 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_t * | GetOption () 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... | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *vp) |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, void *vp) |
| TObject & | operator= (const TObject &rhs) |
| TObject assignment operator. 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... | |
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 THnSparse | |
| static THnSparse * | CreateSparse (const char *name, const char *title, const TH1 *h1, Int_t chunkSize=1024 *16) |
| static THnSparse * | CreateSparse (const char *name, const char *title, const THnBase *hn, Int_t chunkSize=1024 *16) |
| Static 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 THnSparse | |
| THnSparse () | |
| Construct an empty THnSparse. More... | |
| THnSparse (const char *name, const char *title, Int_t dim, const Int_t *nbins, const Double_t *xmin, const Double_t *xmax, Int_t chunksize) | |
| Construct a THnSparse with "dim" dimensions, with chunksize as the size of the chunks. More... | |
| THnSparseArrayChunk * | AddChunk () |
| Create a new chunk of bin content. More... | |
| void | FillBin (Long64_t bin, Double_t w) |
| void | FillExMap () |
| We have been streamed; set up fBins. More... | |
| Long64_t | GetBinIndexForCurrentBin (Bool_t allocate) |
| Return the index for fCurrentBinIndex. More... | |
| THnSparseArrayChunk * | GetChunk (Int_t idx) const |
| THnSparseCompactBinCoord * | GetCompactCoord () const |
| Return THnSparseCompactBinCoord object. More... | |
| void | InitStorage (Int_t *nbins, Int_t chunkSize) |
| Initialize the storage of a histogram created via Init() More... | |
| void | Reserve (Long64_t nbins) |
| Initialize storage for nbins. 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... | |
| 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... | |
| 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... | |
| 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... | |
| Bool_t | PrintBin (Long64_t idx, Int_t *coord, Option_t *options) const |
| Print one bin. 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... | |
| 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... | |
| 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 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... | |
| Protected Attributes inherited from THnBase | |
| TObjArray | fAxes |
| TObjArray | fBrowsables |
| Double_t | fEntries |
| browser-helpers for each axis More... | |
| Double_t * | fIntegral |
| 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 |
#include <THnSparse.h>
|
inline |
Definition at line 205 of file THnSparse.h.
|
inline |
Definition at line 206 of file THnSparse.h.
|
inlinevirtual |
Implements THnSparse.
Definition at line 211 of file THnSparse.h.
ROOT 6.12/07 - Reference Guide Generated on Sat Sep 29 2018 23:44:06 (GVA Time) using Doxygen 1.8.13.