 |
ROOT
Reference Guide |
|
| |
ROOT
Reference Guide |
|
TFoam is the main class of the multi-dimensional general purpose Monte Carlo event generator (integrator) FOAM.
FOAM is the simplified version of the multi-dimensional general purpose Monte Carlo event generator (integrator) FOAM. It creates hyper-rectangular "foam of cells", which is more dense around its peaks. See the following 2-dim. example of the map of 1000 cells for doubly peaked distribution:
FOAM is now fully integrated with the ROOT package. The important bonus of the ROOT use is persistency of the FOAM objects!
For more sophisticated problems full version of FOAM may be more appropriate: See full version of FOAM
| Name | default | Description |
|---|---|---|
| kDim | 0 | Dimension of the integration space. Must be redefined! |
| nCells | 1000 | No of allocated number of cells, |
| nSampl | 200 | No. of MC events in the cell MC exploration |
| nBin | 8 | No. of bins in edge-histogram in cell exploration |
| OptRej | 1 | OptRej = 0, weighted; OptRej=1, wt=1 MC events |
| OptDrive | 2 | Maximum weight reduction, =1 for variance reduction |
| EvPerBin | 25 | Maximum number of the effective wt=1 events/bin, |
| EvPerBin=0 deactivates this option | ||
| Chat | 1 | =0,1,2 is the `‘chat level’' in the standard output |
| MaxWtRej | 1.1 | Maximum weight used to get w=1 MC events |
The above can be redefined before calling Initialize() method, for instance FoamObject->SetkDim(15) sets dimension of the distribution to 15. Only kDim HAS TO BE redefined, the other parameters may be left at their defaults. nCell may be increased up to about million cells for wildly peaked distributions. Increasing nSampl sometimes helps, but it may cost CPU time. MaxWtRej may need to be increased for wild a distribution, while using OptRej=0.
Past versions of FOAM: August 2003, v.1.00; September 2003 v.1.01 Adopted starting from FOAM-2.06 by P. Sawicki
Users of FOAM are kindly requested to cite the following work: S. Jadach, Computer Physics Communications 152 (2003) 55.
Public Types | |
| enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
| enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
| enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
| enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Public Member Functions | |
| TFoam () | |
| Default constructor for streamer, user should not use it. | |
| TFoam (const Char_t *) | |
| User constructor, to be employed by the user. | |
| TFoam (const TFoam &) | |
| Copy Constructor NOT IMPLEMENTED (NEVER USED) | |
| ~TFoam () override | |
| Default destructor. | |
| 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. | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. | |
| virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action. | |
| virtual void | Carver (Int_t &, Double_t &, Double_t &) |
| Internal method used by Initialize. | |
| virtual Int_t | CellFill (Int_t, TFoamCell *) |
| Internal method used by Initialize. | |
| virtual void | CheckAll (Int_t) |
| User utility, miscellaneous and debug. | |
| ULong_t | CheckedHash () |
| Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. | |
| virtual void | Clear (Option_t *="") |
| virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility. | |
| virtual Int_t | Compare (const TObject *obj) const |
| Compare abstract method. | |
| virtual void | Copy (TObject &object) const |
| Copy this to obj. | |
| virtual void | Delete (Option_t *option="") |
| Delete this object. | |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object. | |
| virtual Int_t | Divide (TFoamCell *) |
| Internal method used by Initialize. | |
| 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 Double_t | Eval (Double_t *) |
| Internal method. | |
| 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 | Explore (TFoamCell *Cell) |
| Internal method used by Initialize. | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. | |
| virtual void | Finalize (Double_t &, Double_t &) |
| May be called optionally by the user after the MC run. | |
| virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. | |
| virtual void | GenerCel2 (TFoamCell *&) |
| Internal method. | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. | |
| virtual void | GetIntegMC (Double_t &, Double_t &) |
| User method. | |
| virtual void | GetIntNorm (Double_t &, Double_t &) |
| User method. | |
| virtual void | GetMCvect (Double_t *) |
| User may get generated MC point/vector with help of this method. | |
| virtual Double_t | GetMCwt () |
| User may get weight MC weight using this method. | |
| virtual void | GetMCwt (Double_t &) |
| User may get weight MC weight using this method. | |
| virtual const char * | GetName () const |
| Returns name of object. | |
| virtual Long_t | GetnCalls () const |
| virtual Long_t | GetnEffev () 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 |
| virtual Double_t | GetPrimary () const |
| virtual void | GetPrimary (Double_t &prime) |
| virtual TRandom * | GetPseRan () const |
| virtual TFoamIntegrand * | GetRho () |
| virtual const char * | GetTitle () const |
| Returns title of object. | |
| virtual Int_t | GetTotDim () const |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. | |
| virtual const char * | GetVersion () const |
| virtual void | GetWtParams (Double_t, Double_t &, Double_t &, Double_t &) |
| May be called optionally after the MC run. | |
| virtual void | Grow () |
| Internal method used by Initialize. | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. | |
| virtual ULong_t | Hash () const |
| 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 | InitCells () |
| Internal method used by Initialize. | |
| virtual void | Initialize () |
| Basic initialization of FOAM invoked by the user. | |
| virtual void | Initialize (TRandom *, TFoamIntegrand *) |
| virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas. | |
| 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). | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
| R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
| virtual Bool_t | IsSortable () const |
| R__ALWAYS_INLINE Bool_t | IsZombie () const |
| virtual void | LinkCells (void) |
| virtual void | ls (Option_t *option="") const |
| The ls function lists the contents of a class on stdout. | |
| virtual void | MakeActiveList () |
| Internal method used by Initialize. | |
| virtual void | MakeAlpha () |
| Internal method used by Initialize. | |
| virtual void | MakeEvent () |
| User method. | |
| void | MayNotUse (const char *method) const |
| Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). | |
| virtual Double_t | MCgenerate (Double_t *MCvect) |
| User method which generates MC event and returns MC weight. | |
| 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 Long_t | PeekMax () |
| Internal method used by Initialize. | |
| virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list. | |
| virtual void | Print (Option_t *option="") const |
| This method must be overridden when a class wants to print itself. | |
| virtual void | PrintCells () |
| Prints geometry of ALL cells of the FOAM. | |
| virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory. | |
| virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list. | |
| void | ResetBit (UInt_t f) |
| virtual void | ResetPseRan (TRandom *PseRan) |
| User may optionally reset random number generator using this method. | |
| virtual void | ResetRho (TFoamIntegrand *Rho) |
| User may optionally reset the distribution using this method. | |
| virtual void | RootPlot2dim (Char_t *) |
| Debugging tool which plots 2-dimensional cells as rectangles in C++ format readable for root. | |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename. | |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out". | |
| void | SetBit (UInt_t f) |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. | |
| virtual void | SetChat (Int_t Chat) |
| virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object. | |
| virtual void | SetEvPerBin (Int_t EvPerBin) |
| virtual void | SetInhiDiv (Int_t, Int_t) |
| This can be called before Initialize, after setting kDim It defines which variables are excluded in the process of the cell division. | |
| virtual void | SetkDim (Int_t kDim) |
| virtual void | SetMaxWtRej (Double_t MaxWtRej) |
| virtual void | SetnBin (Int_t nBin) |
| virtual void | SetnCells (Long_t nCells) |
| virtual void | SetnSampl (Long_t nSampl) |
| virtual void | SetOptDrive (Int_t OptDrive) |
| virtual void | SetOptRej (Int_t OptRej) |
| virtual void | SetPseRan (TRandom *PseRan) |
| virtual void | SetRho (TFoamIntegrand *Rho) |
| User may use this method to set the distribution object. | |
| virtual void | SetRhoInt (Double_t(*fun)(Int_t, Double_t *)) |
| User may use this method to set the distribution object as a global function pointer (and not as an interpreted function). | |
| virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id. | |
| virtual void | SetXdivPRD (Int_t, Int_t, Double_t[]) |
| This should be called before Initialize, after setting kDim It predefines values of the cell division for certain variable iDim. | |
| void | Streamer (TBuffer &) override |
| Stream an object of class TObject. | |
| void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. | |
| R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
| Int_t | TestBits (UInt_t f) const |
| virtual void | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
| virtual void | Varedu (Double_t[5], Int_t &, Double_t &, Double_t &) |
| Internal method used by Initialize. | |
| 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 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 )) } |
Protected Member Functions | |
| virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
| Interface to ErrorHandler (protected). | |
| void | MakeZombie () |
Static Protected Member Functions | |
| 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 | |
| Double_t * | fAlpha |
| [fDim] Internal parameters of the hyper-rectangle | |
| TFoamCell ** | fCells = nullptr |
| [fNCells] Array of ALL cells | |
| std::vector< Long_t > | fCellsAct |
| Index of active cells, constructed at the end of foam build-up. | |
| Int_t | fChat |
| Chat=0,1,2 chat level in output, Chat=1 normal level. | |
| TString | fDate |
| Release date of FOAM. | |
| Int_t | fDim |
| Dimension of the integration/simulation space. | |
| Int_t | fEvPerBin |
| Maximum number of effective (wt=1) events per bin. | |
| TObjArray * | fHistDbg |
| Histograms of wt, for debug. | |
| TObjArray * | fHistEdg |
| Histograms of wt, one for each cell edge. | |
| TH1D * | fHistWt |
| Histogram of the MC wt. | |
| Int_t * | fInhiDiv |
| ! [fDim] Flags for inhibiting cell division | |
| Int_t | fLastCe |
| Index of the last cell. | |
| Int_t * | fMaskDiv |
| ! [fDim] Dynamic Mask for cell division | |
| Double_t | fMaxWtRej |
| Maximum weight in rejection for getting wt=1 events. | |
| Double_t | fMCerror |
| and its error | |
| TFoamMaxwt * | fMCMonit |
| Monitor of the MC weight for measuring MC efficiency. | |
| Double_t | fMCresult |
| True Integral R from MC series. | |
| Double_t * | fMCvect |
| [fDim] Generated MC vector for the outside user | |
| Double_t | fMCwt |
| MC weight. | |
| TMethodCall * | fMethodCall |
| ! ROOT's pointer to user-defined global distribution function | |
| TString | fName |
| Name of a given instance of the FOAM class. | |
| Int_t | fNBin |
| No. of bins in the edge histogram for cell MC exploration. | |
| Long_t | fNCalls |
| Total number of the function calls. | |
| Int_t | fNCells |
| Maximum number of cells. | |
| Long_t | fNEffev |
| Total number of effective events (wt=1) in the foam buildup. | |
| Double_t | fNevGen |
| Total number of the generated MC events. | |
| Int_t | fNoAct |
| Number of active cells. | |
| Int_t | fNSampl |
| No. of MC events, when dividing (exploring) cell. | |
| Int_t | fOptDrive |
| Optimization switch =1,2 for variance or maximum weight optimization. | |
| Int_t | fOptPRD |
| Option switch for predefined division, for quick check. | |
| Int_t | fOptRej |
| Switch =0 for weighted events; =1 for unweighted events in MC. | |
| Double_t * | fPrimAcu |
| [fNoAct] Array of cumulative probability of all active cells | |
| Double_t | fPrime |
Primary integral R' (R=R'<wt>) | |
| TRandom * | fPseRan |
| Pointer to user-defined generator of pseudorandom numbers. | |
| TFoamIntegrand * | fRho |
| ! Pointer to the user-defined integrand function/distribution | |
| Int_t | fRNmax |
| Maximum No. of the rand. numb. requested at once. | |
| Double_t * | fRvec |
| [fRNmax] random number vector from r.n. generator fDim+1 maximum elements | |
| Double_t | fSumOve |
| Total Sum of overweighted events. | |
| Double_t | fSumWt |
| Double_t | fSumWt2 |
| Total sum of wt and wt^2. | |
| TString | fVersion |
| Actual version of the FOAM like (1.01m) | |
| Double_t | fWtMax |
| Double_t | fWtMin |
| Maximum/Minimum MC weight. | |
| TFoamVect ** | fXdivPRD |
| ! Lists of division values encoded in one vector per direction | |
Private Member Functions | |
| TFoamCell * | getCell (std::size_t i) const |
| Double_t | Sqr (Double_t x) const |
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 <TFoam.h>
| Enumerator | |
|---|---|
| kOnlyPrepStep | Used to request that the class specific implementation of This is just for example by TBufferMerger to request that the TTree inside the file calls |
|
inherited |
|
inherited |
| Enumerator | |
|---|---|
| kCanDelete | if object in a list can be deleted |
| kMustCleanup | if object destructor must call RecursiveRemove() |
| kIsReferenced | |
| 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 |
| TFoam::TFoam | ( | ) |
|
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.
Definition at line 1149 of file TObject.cxx.
|
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.
|
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.
|
virtualinherited |
Browse object. May be overridden for another default action.
Reimplemented in TASImage, TRecorder, TEfficiency, TGraph2D, TChain, TTree, TDirectory, TFolder, TMacro, TRemoteObject, TROOT, TStyle, TSystemDirectory, TSystemFile, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookBranch, THbookFile, THbookKey, TF1, TGraph, TH1, THnBase, ROOT::Internal::THnBaseBrowsable, THStack, TMultiDimFit, TMultiGraph, TPrincipal, TDirectoryFile, TKey, TKeyMapFile, TMapFile, TSPlot, TDatabasePDG, TGenerator, TParticleClassPDG, TApplicationRemote, RooPlot, TBranch, TVirtualBranchBrowsable, TCollectionPropertyBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, TLeaf, TNtuple, TNtupleD, TTreePerfStats, and ROOT::Experimental::XRooFit::xRooNode.
Definition at line 218 of file TObject.cxx.
Internal method used by Initialize.
Determines the best edge-candidate and the position of the division plane for the future cell division, in the case of the optimization of the maximum weight. It exploits results of the cell MC exploration run stored in fHistEdg.
|
virtual |
|
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.
|
virtualinherited |
Returns name of class to which the object belongs.
Definition at line 227 of file TObject.cxx.
Reimplemented in TMVA::ResultsClassification, TMVA::ResultsMulticlass, TMVA::ResultsRegression, TMVA::ResultsClassification, TMVA::ResultsMulticlass, TMVA::ResultsRegression, TMrbSubevent_Caen, TNotifyLinkBase, TRefTable, ROOT::TSchemaRule, TGTextEdit, TGTextView, TGView, TGHtml, TStreamerInfo, TMatrixT< Element >, TMatrixT< AReal >, TMatrixT< Double_t >, TMatrixTSparse< Element >, TMatrixTSparse< Double_t >, TMatrixTSym< Element >, TMatrixTSym< Double_t >, TVectorT< Element >, TVectorT< Double_t >, TVirtualStreamerInfo, TMVA::MinuitWrapper, RooLinkedList, TUsrHitBuffer, TFumili, TListOfEnums, TListOfEnumsWithLock, TDirectory, TFolder, TNamed, TProcessID, TTask, TBits, TBtree, TClonesArray, THashList, THashTable, TList, TMap, TObjArray, TOrdCollection, TRefArray, TDictAttributeMap, TListOfDataMembers, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TGeoRotation, TGeoCombiTrans, TGeoGenTrans, TGeoHMatrix, TCanvas, TPad, TLegend, TPaveText, TGTextEntry, TBackCompFitter, TFormula, TGraph2D, TMultiDimFit, TPrincipal, ROOT::v5::TFormula, TFitter, TLinearFitter, TBranchRef, TEventList, JetEvent, TVirtualPad, TCollection, TVirtualFitter, TMatrixTBase< Element >, TMatrixTBase< AReal >, and TMatrixTBase< Double_t >.
Make a clone of an object using the Streamer facility.
If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.
If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.
Reimplemented in TMVA::MinuitWrapper, RooCatType, TImage, RooStudyPackage, RooLinkedList, RooStats::ModelConfig, TNamed, TCollection, TClass, TFunction, TFunctionTemplate, TMethod, TMethodCall, TASImage, TH1, TStreamerInfo, TMinuit, RooAbsStudy, RooDataHist, RooDataSet, RooWorkspace, TChainIndex, TTreeIndex, TF1, RooAbsArg, RooAbsBinning, RooAbsCollection, RooCmdArg, RooFitResult, RooTemplateProxy< T >, RooTemplateProxy< const RooHistFunc >, RooTemplateProxy< RooAbsCategory >, RooTemplateProxy< RooAbsPdf >, RooTemplateProxy< RooAbsReal >, RooTemplateProxy< RooAbsRealLValue >, RooTemplateProxy< RooMultiCategory >, RooTemplateProxy< RooRealVar >, and RooStats::HypoTestResult.
Definition at line 243 of file TObject.cxx.
Compare abstract method.
Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.
Reimplemented in TEnvRec, TFileInfo, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TUrl, TCollection, TGeoBranchArray, TGeoOverlap, TStructNode, TStructNodeProperty, TGFSFrameElement, TGLBFrameElement, RooAbsArg, and RooDouble.
Definition at line 258 of file TObject.cxx.
|
virtualinherited |
Copy this to obj.
Reimplemented in TDirectory, TFolder, TSystemDirectory, TSystemFile, TGTextEdit, TGTextView, TDirectoryFile, TFile, TArc, TArrow, TAxis, TBox, TColor, TCrown, TEllipse, TF1, TFormula, TF12, TF2, TF3, ROOT::v5::TFormula, TFrame, THelix, TAxis3D, TH1, TH1C, TH1S, TH1I, TH1L, TH1F, TH1D, TH2, TH2C, TH2S, TH2I, TH2L, TH2F, TH2D, TH3, TH3C, TH3S, TH3I, TH3L, TH3F, TH3D, TProfile, TProfile2D, TProfile3D, TLine, TMarker, TNamed, TH2Poly, TLegend, TLegendEntry, TF1Convolution, TF1NormSum, TF1AbsComposition, TPaletteAxis, TPave, TPaveLabel, TPaveClass, TPolyLine, TPolyLine3D, TPolyMarker3D, TPolyMarker, TPieSlice, TStyle, TLatex, TMathText, TText, TWbox, and TXTRU.
Definition at line 159 of file TObject.cxx.
|
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 TDirectory, TDirectoryFile, TFile, TSystemDirectory, TSystemFile, TTreeViewer, TGItemContext, TCanvas, TGFrame, TGTextEdit, TAxis, RooLinkedList, TExMap, TObjectTable, TProtoClass, TKeySQL, TKeyXML, TQCommand, TBtree, TClonesArray, THashList, THashTable, TList, TMap, TObjArray, TOrdCollection, TRefArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TThread, TKey, TMVA::Results, TTree, and TCollection.
Definition at line 268 of file TObject.cxx.
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 TGeoTessellated, TStyle, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoTorus, TGeoTube, TGeoTubeSeg, TGeoVolume, TGeoXtru, TGeoOverlap, TGeoTrack, TGeoVGShape, TASImage, TColorWheel, TPad, TBox, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEllipse, TGraphPolargram, TLine, TMarker, TPave, TPie, TPolyLine, TText, TGraphEdge, TGraphNode, TAxis3D, TBRIK, TMarker3DBox, TNode, TPCON, TPolyLine3D, TPolyMarker3D, TSPHE, TTUBE, TTUBS, TXTRU, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGLViewer, TAxis, TEfficiency, TF1, TF2, TF3, TGraph, TGraph2D, TH1, THStack, TMultiGraph, TPolyMarker, TScatter, TScatter2D, TSpline, THistPainter, TPaletteAxis, TGenerator, TParticle, TPrimary, TFileDrawMap, TTreePerfStats, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TSpider, TGeoShape, TPoints3DABC, TVirtualHistPainter, TPieSlice, and TGLScenePad.
Definition at line 284 of file TObject.cxx.
Internal method used by Initialize.
It divides cell iCell into two daughter cells. The iCell is retained and tagged as inactive, daughter cells are appended at the end of the buffer. New vertex is added to list of vertices. List of active cells is updated, iCell removed, two daughters added and their properties set with help of MC sampling (TFoam_Explore) Returns Code RC=-1 of buffer limit is reached, fLastCe=fnBuf.
|
protectedvirtualinherited |
Interface to ErrorHandler (protected).
Reimplemented in TTreeViewer, and TThread.
Definition at line 1059 of file TObject.cxx.
|
virtualinherited |
Default Draw method for all objects.
Reimplemented in TClassTree, ROOT::RGeoPainter, TGListTree, TGPicture, TMultiDimFit, TRatioPlot, TGraph, TGraphTime, THStack, TMultiGraph, TChain, TTree, TFITSHDU, TEfficiency, RooStats::HypoTestInverterPlot, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TGeoParallelWorld, TDirectory, TCollection, TBrowser, TClass, TGeoBatemanSol, TGeoNode, TGeoPhysicalNode, TGeoPolygon, TGeoShape, TGeoVolume, TGeoOverlap, TGeoPainter, TGeoTrack, TGeoVGShape, TASImage, TButton, TCanvas, TColorWheel, TPad, TArrow, TBox, TDiamond, TEllipse, TFrame, TLegend, TMarker, TPave, TPaveLabel, TPavesText, TPaveText, TPolyLine, TWbox, TGraphStruct, TEveGeoNode, TEveGeoTopNode, TGeometry, THelix, TNode, TNodeDiv, TPolyLine3D, TPolyMarker3D, TStructViewer, TStructViewerGUI, TF1, TF2, TF3, TH1, TPolyMarker, TSpline, TFile, TMatrixTBase< Element >, TMatrixTBase< AReal >, TMatrixTBase< Double_t >, TVectorT< Element >, TVectorT< Double_t >, TMultiLayerPerceptron, TGenerator, RooAbsData, TTreePerfStats, TParallelCoordVar, TGItemContext, TVirtualPad, TPie, TGraph2D, TGraphPolar, TGraphPolargram, TParallelCoord, TParallelCoordRange, TSpider, RooPlot, and RooStats::SamplingDistPlot.
Definition at line 293 of file TObject.cxx.
|
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 TSystemDirectory, TSystemFile, and TGFrame.
Definition at line 308 of file TObject.cxx.
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
If pad was not selected - gPad will be used.
Reimplemented in TSystemDirectory, TSystemFile, TGFrame, TAxis, and TCanvas.
Definition at line 319 of file TObject.cxx.
|
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:
Reimplemented in TSystemFile, TCollection, TClass, TGFrame, and TGPack.
Definition at line 367 of file TObject.cxx.
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.
|
virtualinherited |
Execute method on this object with the given parameter string, e.g.
"3.14,1,\"text\"".
Reimplemented in TMethodCall, TCling, TInterpreter, ROOT::R::TRInterface, and TContextMenu.
Definition at line 378 of file TObject.cxx.
|
virtualinherited |
Execute method on this object with parameters stored in the TObjArray.
The TObjArray should contain an argv vector like:
Reimplemented in TCling, TMethodCall, TInterpreter, ROOT::R::TRInterface, and TContextMenu.
Definition at line 398 of file TObject.cxx.
Execute action corresponding to an event at (px,py).
This method must be overridden if an object can react to graphics events.
Reimplemented in TParallelCoord, TParallelCoordRange, TParallelCoordVar, TGeoManager, TGeoNode, TGeoShape, TGeoVolume, TGeoOverlap, TGeoTrack, TASImage, TASPaletteEditor::LimitLine, TButton, TCanvas, TGroupButton, TPad, TSliderBox, TBox, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEllipse, TFrame, TGraphPolargram, TLine, TLink, TMarker, TPave, TPolyLine, TText, TWbox, TGraphEdge, TGraphNode, TAxis3D, TMarker3DBox, TNode, TPolyLine3D, TPolyMarker3D, TView3D, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGLViewer, TAxis, TEfficiency, TF1, TF2, TF3, TGraph, TGraph2D, TH1, TPolyMarker, TScatter, TScatter2D, TSpline, THistPainter, TPaletteAxis, TGenerator, TParticle, TPrimary, TTreePerfStats, TSpider, TView, TVirtualHistPainter, TPie, and TGLScenePad.
Definition at line 415 of file TObject.cxx.
|
virtual |
Internal method used by Initialize.
It explores newly defined cell with help of special short MC sampling. As a result, estimates of true and drive volume is defined/determined Average and dispersion of the weight distribution will is found along each edge and the best edge (minimum dispersion, best maximum weight) is memorized for future use.
The optimal division point for eventual future cell division is determined/recorded. Recorded are also minimum and maximum weight etc. The volume estimate in all (inactive) parent cells is updated. Note that links to parents and initial volume = 1/2 parent has to be already defined prior to calling this routine.
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.
Must be redefined in derived classes.
This function is typically used with TCollections, but can also be used to find an object by name inside this object.
Reimplemented in TListOfEnums, TMap, TDirectory, TFolder, TROOT, TListOfTypes, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.
Definition at line 425 of file TObject.cxx.
Must be redefined in derived classes.
This function is typically used with TCollections, but can also be used to find an object inside this object.
Reimplemented in TMap, TDirectory, TFolder, TROOT, TListOfTypes, TBtree, TCollection, THashList, THashTable, TList, TObjArray, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TViewPubDataMembers, TViewPubFunctions, TPad, TGeometry, THbookFile, TGraph, TGraph2D, TH1, RooAbsCollection, and RooLinkedList.
Definition at line 435 of file TObject.cxx.
|
virtual |
|
private |
|
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.
|
staticinherited |
Return destructor only flag.
Definition at line 1196 of file TObject.cxx.
|
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 TSystemFile, TGeoVolume, TASImage, TGMainFrame, TKey, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TMethodBrowsable, and TBranchElement.
Definition at line 472 of file TObject.cxx.
User method.
It returns NORMALIZATION integral to be combined with the average weights and content of the histograms in order to get proper absolute normalization of the integrand and distributions. It can be called after initialization, before or during the MC run.
| IntNorm | variable where the integral will be stored |
| ErrInt | variable where the absolute error of the integral will be stored if internal rejection is active, otherwise set to 0. |
|
virtual |
|
virtual |
|
virtual |
|
virtualinherited |
Returns name of object.
This default method returns the class name. Classes that give objects a name should override this method.
Reimplemented in TSQLClassColumnInfo, TSQLClassInfo, TSQLColumnData, TEnvRec, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TQCommand, TQConnection, TQSlot, TCollection, TPair, TRealData, TGeoDecayChannel, TGeoShape, TVirtualGeoTrack, TGeoVGShape, TPad, TGaxis, TPave, TEveGeoNode, TPolyMarker3D, TGLEmbeddedViewer, TGLPShapeObj, TGLSAViewer, TStructNode, TGMenuEntry, TGMenuTitle, TGPicture, TGWindow, TIconBoxThumb, TArchiveMember, TMapFile, TXMLAttr, TStatistic, TParticle, TPrimary, RooAbsCollection, RooCatType, RooLinkedList, TMVA::DataSetInfo, TMVA::FitterBase, TMVA::MethodBase, TMVA::OptionBase, TMVA::PDF, TMVA::Reader, TMVA::VariableTransformBase, TTreePerfStats, TTVRecord, TTVSession, and TVirtualPad.
Definition at line 462 of file TObject.cxx.
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 TGeoNode, TGeoVolume, TGeoTrack, TASImage, TColorWheel, TAxis3D, TNode, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TF1, TF2, TGraph, TH1, THistPainter, TPaletteAxis, TFileDrawMap, TParallelCoordVar, and TVirtualHistPainter.
Definition at line 491 of file TObject.cxx.
|
staticinherited |
Get status of object stat flag.
Definition at line 1181 of file TObject.cxx.
Reimplemented in TGeoVolume, TArrow, TGaxis, TLegendEntry, TPave, TPolyLine, TAxis3D, THelix, TNode, TPolyLine3D, TPolyMarker3D, TH1, TPolyMarker, TFile, TMapFile, TPSocket, TSocket, TUDPSocket, TSelector, and TPoints3DABC.
|
inlinevirtual |
|
virtualinherited |
Returns title of object.
This default method returns the class title (i.e. description). Classes that give objects a title should override this method.
Reimplemented in TNamed, TQCommand, TPair, TClassMenuItem, TBaseClass, TASImage, TPad, TGaxis, TPaveLabel, TEveGeoNode, TEvePointSet, TGTextButton, TGGroupFrame, TGLabel, TGTextLBEntry, TGLVEntry, TGTextEntry, TRootIconList, TAxis, TKey, TMapFile, TParticle, TPrimary, Axis2, TParallelCoordSelect, and TVirtualPad.
Definition at line 507 of file TObject.cxx.
|
virtualinherited |
Return the unique object id.
Definition at line 480 of file TObject.cxx.
|
virtual |
Execute action in response of a timer timing out.
This method must be overridden if an object has to react to timers.
Reimplemented in TGWindow, TGuiBldDragManager, TGraphTime, TGLEventHandler, TGCommandPlugin, TGDNDManager, TGFileContainer, TGPopupMenu, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGHtml, and TTreeViewer.
Definition at line 516 of file TObject.cxx.
|
virtualinherited |
Return hash value for this object.
Note: If this routine is overloaded in a derived class, this derived class should also add
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
Reimplemented in TEnvRec, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TCollection, TPair, TASImagePlugin, TASPluginGS, TPad, TImagePlugin, TPave, TGObject, TGPicture, TIconBoxThumb, TStatistic, and RooLinkedList.
Definition at line 539 of file TObject.cxx.
|
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)
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.
Returns kTRUE if object inherits from class "classname".
Reimplemented in TClass.
Definition at line 549 of file TObject.cxx.
Returns kTRUE if object inherits from TClass cl.
Reimplemented in TClass.
Definition at line 557 of file TObject.cxx.
|
virtual |
|
virtual |
|
virtual |
This method starts the process of the cell build-up. User must invoke Initialize with two arguments or Initialize without arguments. This is done BEFORE generating first MC event and AFTER allocating FOAM object and resetting (optionally) its internal parameters/switches. The overall operational scheme of the FOAM is the following:
InitCells initializes memory storage for cells and begins exploration process from the root cell. The empty cells are allocated/filled using CellFill. The procedure Grow which loops over cells, picks up the cell with the biggest `‘driver integral’', see Computer Physics Communications 152 152 (2003) 55 for explanations, with the help of PeekMax procedure. The chosen cell is split using Divide. Subsequently, the procedure Explore called by the Divide (and by InitCells for the root cell) does the most important job in the FOAM object build-up: it performs a small MC run for each newly allocated daughter cell. Explore calculates how profitable the future split of the cell will be and defines the optimal cell division geometry with the help of Carver or Varedu procedures, for maximum weight or variance optimization respectively. All essential results of the exploration are written into the explored cell object. At the very end of the foam build-up, Finally, MakeActiveList is invoked to create a list of pointers to all active cells, for the purpose of the quick access during the MC generation. The procedure Explore employs MakeAlpha to generate random coordinates inside a given cell with the uniform distribution. The above sequence of the procedure calls is depicted in the following figure:
|
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 TSystemFile, TInspectorObject, TGFrame, and ROOT::Experimental::XRooFit::xRooNode.
Definition at line 570 of file TObject.cxx.
|
inlineoverridevirtual |
|
inlineinherited |
IsDestructed.
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 TObjString, TQCommand, TPair, and TGObject.
Definition at line 589 of file TObject.cxx.
|
virtualinherited |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Reimplemented in TDirectory, TFolder, TRemoteObject, TROOT, TSystemDirectory, TTask, TCollection, TPair, TBrowserObject, TBaseClass, TClass, TGeoManager, TGeoNode, TGeoNodeMatrix, TGeoVolume, TGeoOverlap, TGeoTrack, TCanvas, TPad, TAxis3D, TGeometry, TNode, TRootIconList, THbookFile, THbookKey, THnBase, ROOT::Internal::THnBaseBrowsable, TMultiDimFit, TPrincipal, TKey, TMapFile, TSPlot, TDatabasePDG, TParticleClassPDG, TApplicationRemote, ROOT::Experimental::XRooFit::xRooNode, TBranch, TVirtualBranchBrowsable, TBranchClones, TBranchElement, TBranchObject, TBranchSTL, and TTree.
Definition at line 579 of file TObject.cxx.
|
inlineinherited |
Reimplemented in TFileInfo, TNamed, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TUri, TUrl, TCollection, TGeoBranchArray, TGeoOverlap, TPave, TStructNode, TStructNodeProperty, TGFSFrameElement, TGLBFrameElement, RooAbsArg, and RooDouble.
|
inlineinherited |
|
virtualinherited |
The ls function lists the contents of a class on stdout.
Ls output is typically much less verbose then Dump().
Reimplemented in THbookFile, ROOT::Experimental::XRooFit::xRooBrowser, TParameter< AParamType >, TParameter< Long64_t >, TFree, TVirtualStreamerInfo, TQSlot, TClass, TStatistic, TApplication, TColor, TDirectory, TFolder, TNamed, TQCommand, TQUndoManager, TQConnection, TROOT, TQConnectionList, TCollection, TFunction, ROOT::TSchemaRule, ROOT::Detail::TSchemaRuleSet, TStreamerElement, TStreamerBase, TStreamerSTL, TGeoNode, TAnnotation, TCanvas, TClassTree, TPad, TBox, TEllipse, TImage, TLine, TMarker, TPave, TPolyLine, TText, TPolyLine3D, TPolyMarker3D, TGLayoutHints, TGFrameElement, THStack, TPolyMarker, TDirectoryFile, TFile, TKey, TMapFile, TStreamerInfo, TChain, TChainElement, TFriendElement, TVirtualPad, TTask, TNode, and TGeometry.
Definition at line 598 of file TObject.cxx.
|
virtual |
|
virtual |
|
virtual |
User method.
It generates randomly point/vector according to user-defined distribution. Prior initialization with help of Initialize() is mandatory. Generated MC point/vector is available using GetMCvect and the MC weight with GetMCwt. MC point is generated with wt=1 or with variable weight, see OptRej switch.
|
inherited |
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).
Definition at line 1160 of file TObject.cxx.
|
virtualinherited |
This method must be overridden to handle object notification (the base implementation is no-op).
Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.
For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.
Reimplemented in TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TFileHandler, TSignalHandler, TStdExceptionHandler, TProcessEventTimer, TTimer, TIdleTimer, TSingleShotCleaner, TCollection, TRefTable, TBrowserTimer, TInterruptHandler, TTermInputHandler, TThreadTimer, TGLRedrawTimer, TViewTimer, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TViewUpdateTimer, TPopupDelayTimer, TRepeatTimer, TSBRepeatTimer, TGTextEditHist, TInsCharCom, TDelCharCom, TBreakLineCom, TInsTextCom, TDelTextCom, TBlinkTimer, TTipDelayTimer, TGuiBldDragManagerRepeatTimer, TARInterruptHandler, TASLogHandler, TASInterruptHandler, TASSigPipeHandler, TASInputHandler, TSocketHandler, TTimeOutTimer, TBranchElement, TBranchRef, TLeafObject, TSelector, TTree, TSelectorDraw, TSelectorEntries, TTreeFormula, TTreeFormulaManager, TTreeReader, h1analysis, h1analysisTreeReader, and TSysEvtHandler.
Definition at line 618 of file TObject.cxx.
|
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.
|
inherited |
Operator delete for sized deallocation.
Definition at line 1234 of file TObject.cxx.
|
inherited |
Operator delete.
Definition at line 1212 of file TObject.cxx.
|
inherited |
Only called by placement new when throwing an exception.
Definition at line 1266 of file TObject.cxx.
|
inherited |
Operator delete [] for sized deallocation.
Definition at line 1245 of file TObject.cxx.
|
inherited |
Operator delete [].
Definition at line 1223 of file TObject.cxx.
|
inherited |
Only called by placement new[] when throwing an exception.
Definition at line 1274 of file TObject.cxx.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
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 TPie, TSQLFile, TXMLFile, ROOT::RGeoPainter, TGaxis, TGraph, TGraphTime, THStack, TMultiGraph, TScatter, TScatter2D, TTreePerfStats, ROOT::Experimental::RTreeMapPainter, TEfficiency, TRatioPlot, TGeoBoolNode, TGeoUnion, TGeoIntersection, TGeoSubtraction, TMarker3DBox, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2DPainter, TSpectrum2Painter, TFileDrawMap, TDirectory, TExec, TMacro, TStyle, TBits, TCollection, TGeoNode, TGeoPhysicalNode, TGeoShape, TGeoVolume, TGeoOverlap, TGeoPainter, TGeoTrack, TGeoVGShape, TASImage, TASPaletteEditor::PaintPalette, TASPaletteEditor::LimitLine, TAnnotation, TButton, TCanvas, TClassTree, TColorWheel, TPad, TArrow, TBox, TCrown, TDiamond, TEllipse, TFrame, TLatex, TLegend, TLine, TMarker, TMathText, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPolyLine, TText, TWbox, TGraphEdge, TGraphNode, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoTopNode, TEveGeoShape, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TAxis3D, TNode, TNodeDiv, TPolyLine3D, TPolyMarker3D, TShape, TF1, TF2, TF3, TGraph2D, TH1, TPolyMarker, TSpline, THistPainter, TPaletteAxis, TFile, TGenerator, TParticle, TPrimary, TParallelCoordVar, TVirtualPad, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TParallelCoordRange, TSpider, TGraphPolargram, and TParallelCoord.
Definition at line 631 of file TObject.cxx.
|
virtual |
|
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 TPad, TFrame, and TVirtualPad.
Definition at line 640 of file TObject.cxx.
|
virtualinherited |
This method must be overridden when a class wants to print itself.
Reimplemented in RooCmdArg, TPad, TVirtualPad, RooLinkedList, TObjString, TParameter< AParamType >, TParameter< Long64_t >, TRootBrowserHistoryCursor, TRolke, TSQLFile, TXMLFile, TGTextEdit, TStreamerInfoActions::TActionSequence, TStatistic, TMVA::TNeuron, TBranchSTL, TGraph, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, THStack, TMultiGraph, TScatter, TScatter2D, TBenchmark, TMatrixTBase< Element >, TMatrixTBase< AReal >, TMatrixTBase< Double_t >, TGeoDecayChannel, TPluginHandler, TPluginManager, TQSlot, TDecompBase, TDecompBK, TDecompChol, TDecompLU, TDecompQRH, TDecompSparse, TDecompSVD, TQpDataDens, TQpDataSparse, TDatabasePDG, TParticleClassPDG, TParticlePDG, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoPoint, ROOT::Experimental::XRooFit::xRooNLLVar::xRooHypoSpace, ROOT::Experimental::XRooFit::xRooNode, TPrincipal, TFoamCell, TFoamVect, TMVA::PDEFoamCell, TMVA::PDEFoamVect, TMVA::Event, TMVA::OptionBase, TMVA::Option< T >, TCling, TColor, TDirectory, TEnv, TFileCollection, TInetAddress, TMacro, TMessageHandler, TNamed, TStopwatch, TUri, TUrl, TBits, TClassTable, TCollection, THashTable, TObjectTable, TFunction, TGDMLMatrix, TGeoBranchArray, TGeoElement, TGeoIsotope, TGeoElementRN, TGeoBatemanSol, TGeoElementTable, TGeoMatrix, TGeoOpticalSurface, TGeoSkinSurface, TGeoBorderSurface, TGeoPhysicalNode, TGeoRegion, TGeoTessellated, TGeoVolume, TGeoVoxelFinder, TGeoOverlap, TGeoTrack, TAnnotation, TBox, TEllipse, TLegend, TLegendEntry, TLine, TMarker, TPave, TPaveText, TPolyLine, TText, TEveTrans, ROOT::Experimental::REveTrans, THelix, TPolyLine3D, TPolyMarker3D, TXTRU, TGFont, TGFontPool, TGFrame, TGCompositeFrame, TGGC, TGGCPool, TGLayoutHints, TGFrameElement, TGMimeTypes, TGPicture, TGPicturePool, TGWindow, THbookTree, TF1, TFitResult, TFormula, TH1, THnBase, TPolyMarker, ROOT::v5::TFormula, TSpectrum, TSpectrum2, TSpectrum3, TFile, TFileCacheRead, TFileCacheWrite, TKey, TMapFile, TMemFile, TZIPFile, TZIPMember, TSQLStructure, TVectorT< Element >, TVectorT< Double_t >, TLorentzVector, TQuaternion, TVector2, TVector3, TQpVar, TAttParticle, TParticle, TPrimary, TApplicationRemote, TSQLColumnInfo, TSQLTableInfo, RooStats::ModelConfig, TBranch, TBranchClones, TBranchElement, TBranchObject, TBranchRef, TChain, TEventList, TTree, TTreeCache, TTreeCacheUnzip, TTreeIndex, TTreePerfStats, TParallelCoordVar, TMultiDimFit, TParallelCoordRange, TFileInfo, TFileInfoMeta, Roo1DTable, RooAbsArg, RooAbsBinning, RooAbsCollection, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooCurve, RooEllipse, RooCatType, RooFitResult, RooGenFitStudy, RooHist, RooMsgService, RooNumGenConfig, RooNumIntConfig, RooPlot, RooSharedProperties, and RooWorkspace.
Definition at line 661 of file TObject.cxx.
|
virtual |
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 TKeyXML, TBuffer, TKey, and TKeySQL.
Definition at line 673 of file TObject.cxx.
|
virtualinherited |
Recursively remove this object from a list.
Typically implemented by classes that can contain multiple references to a same object.
Reimplemented in THistPainter, TCling, TDirectory, TFolder, TProcessID, TROOT, TCollection, THashList, TList, TObjArray, TBrowser, TObjectSpy, TObjectRefSpy, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, ROOT::Internal::TCheckHashRecursiveRemoveConsistency, TViewPubDataMembers, TViewPubFunctions, TDialogCanvas, TInspectCanvas, TPad, TLegend, TGeometry, TNode, ROOT::RBrowserDataCleanup, TFitEditor, TGedEditor, TH1Editor, TH2Editor, TGFileBrowser, TRootBrowser, TRootBrowserLite, TRootContextMenu, TRootBrowserHistory, TEfficiency, TGraph, TGraph2D, TH1, THStack, TMultiGraph, TFileMerger, RooAbsCollection, RooAbsData, RooLinkedList, RooMCStudy, RooWorkspace, TChain, TFriendElement, TTree, TTreePlayer, and TVirtualPad.
Definition at line 684 of file TObject.cxx.
|
virtual |
User may optionally reset random number generator using this method.
Usually it is done when FOAM object is restored from the disk. IMPORTANT: this method deletes existing random number generator registered in the FOAM object. In particular such an object is created by the streamer during the disk-read operation.
|
virtual |
User may optionally reset the distribution using this method.
Usually it is done when FOAM object is restored from the disk. IMPORTANT: this method deletes existing distribution object registered in the FOAM object. In particular such an object is created by the streamer diring the disk-read operation. This method is used only in very special cases, because the distribution in most cases should be "owned" by the FOAM object and should not be replaced by another one after initialization.
|
virtual |
Save this object in the file specified by filename.
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 TSpline, TFolder, TGeoVolume, TClassTree, TPad, TPaveClass, TGObject, TSpline3, TSpline5, ROOT::Experimental::XRooFit::xRooNode, TTreePerfStats, TVirtualPad, TGraph, and TH1.
Definition at line 708 of file TObject.cxx.
|
virtualinherited |
Save a primitive as a C++ statement(s) on output stream "out".
Reimplemented in TGeoTessellated, TGraphEdge, TGraphNode, TGeoIdentity, TStyle, TCurlyArc, TCurlyLine, TGedMarkerSelect, TGedPatternSelect, TGColorSelect, TGFont, TGVerticalLayout, TGHorizontalLayout, TGRowLayout, TGColumnLayout, TGMatrixLayout, TGTileLayout, TGListLayout, TGListDetailsLayout, TGTextLBEntry, TGNumberEntryField, TGNumberEntry, TGTableLayoutHints, TGTableLayout, TGTextEdit, TGTextView, TGXYLayoutHints, TGXYLayout, TRootContainer, TGHtml, TEfficiency, TExec, TMacro, TGeoArb8, TGeoTrap, TGeoGtra, TGeoBBox, TGeoBoolNode, TGeoUnion, TGeoIntersection, TGeoSubtraction, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoElementRN, TGeoDecayChannel, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoMaterial, TGeoMixture, TGeoTranslation, TGeoRotation, TGeoCombiTrans, TGeoHMatrix, TGeoMedium, TGeoPara, TGeoParaboloid, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternTrapZ, TGeoPatternCylR, TGeoPatternCylPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternSphPhi, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoTorus, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoCtub, TGeoVolume, TGeoXtru, TASImage, TAnnotation, TButton, TCanvas, TGroupButton, TPad, TPaveClass, TSlider, TSliderBox, TArc, TArrow, TBox, TCrown, TCutG, TDiamond, TEllipse, TFrame, TGaxis, TGraphPolar, TGraphPolargram, TLatex, TLegend, TLine, TMarker, TMathText, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPolyLine, TText, TWbox, TGraphStruct, TAxis3D, THelix, TMarker3DBox, TPolyLine3D, TPolyMarker3D, TGHorizontal3DLine, TGVertical3DLine, TGButton, TGTextButton, TGPictureButton, TGCheckButton, TGRadioButton, TGButtonGroup, TGVButtonGroup, TGHButtonGroup, TGContainer, TGCanvas, TGComboBox, TGLineStyleComboBox, TGLineWidthComboBox, TGDockableFrame, TGDoubleVSlider, TGDoubleHSlider, TGFrame, TGCompositeFrame, TGVerticalFrame, TGHorizontalFrame, TGMainFrame, TGTransientFrame, TGGroupFrame, TGFSComboBox, TGFileContainer, TGGC, TGIcon, TGLabel, TGLayoutHints, TGListBox, TGListTree, TGListView, TGLVContainer, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGPopupMenu, TGMenuTitle, TGMenuBar, TGProgressBar, TGHProgressBar, TGVProgressBar, TGHScrollBar, TGVScrollBar, TGShapedFrame, TGShutterItem, TGShutter, TGVSlider, TGHSlider, TGSplitFrame, TGVSplitter, TGHSplitter, TGVFileSplitter, TGStatusBar, TGTabLayout, TGTab, TGTextEntry, TGToolBar, TGTripleVSlider, TGTripleHSlider, TRootEmbeddedCanvas, TF1, TF12, TF2, TF3, TGraph, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraphAsymmErrors, TGraphBentErrors, TGraphErrors, TGraphMultiErrors, TH1, TH2Poly, THStack, TMultiGraph, TPolyMarker, TProfile, TProfile2D, TProfile3D, TScatter, TScatter2D, TSpline3, TSpline5, TPaletteAxis, TChain, TTreePerfStats, TParallelCoord, TParallelCoordVar, TPie, and TPieSlice.
Definition at line 858 of file TObject.cxx.
|
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.
|
staticprotectedinherited |
Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
Definition at line 845 of file TObject.cxx.
|
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.
Set or unset the user status bits as specified in f.
Definition at line 888 of file TObject.cxx.
|
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 TSystemDirectory, TSystemFile, TPad, TGFrame, TAxis, TBrowser, TPaveStats, TGedFrame, TRootBrowserLite, and RooPlot.
Definition at line 871 of file TObject.cxx.
|
staticinherited |
Set destructor only flag.
Definition at line 1204 of file TObject.cxx.
This can be called before Initialize, after setting kDim It defines which variables are excluded in the process of the cell division.
For example 'FoamX->SetInhiDiv(1, 1);' inhibits division of y-variable. The resulting map of cells in 2-dim. case will look as follows:
|
staticinherited |
Turn on/off tracking of objects in the TObjectTable.
Definition at line 1188 of file TObject.cxx.
|
virtual |
|
virtualinherited |
Set the unique object id.
Definition at line 899 of file TObject.cxx.
This should be called before Initialize, after setting kDim It predefines values of the cell division for certain variable iDim.
For example setting 3 predefined division lines using:
results in the following 2-dim. pattern of the cells:
|
overridevirtual |
|
inline |
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.
|
inlineinherited |
|
virtualinherited |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
Reimplemented in TCanvas, TPad, TFrame, TPaveStats, TPaveText, TAxis3D, TGraph, TH1, and TTree.
Definition at line 909 of file TObject.cxx.
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.
|
virtualinherited |
Write this object to the current directory.
For more see the const version of this method.
Reimplemented in TSQLFile, TXMLFile, TDirectory, TBuffer, ROOT::TBufferMergerFile, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.
Definition at line 989 of file TObject.cxx.
|
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:
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 TSQLFile, TXMLFile, TDirectory, TBuffer, TDirectoryFile, TFile, TParallelMergingFile, TCollection, TMap, and TTree.
Definition at line 964 of file TObject.cxx.
|
protected |
|
privateinherited |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprivateinherited |
if true keep track of objects in TObjectTable
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
privateinherited |
|
protected |
|
protected |
