Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
TTreeSQL Class Reference

A TTree object is a list of TBranch.

To Create a TTree object one must:

  • Create the TTree header via the TTree constructor
  • Call the TBranch constructor for every branch.

To Fill this object, use member function Fill with no parameters. The Fill function loops on all defined TBranch.

TTreeSQL is the TTree implementation interfacing with an SQL database

Definition at line 42 of file TTreeSQL.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  { kSplitCollectionOfPointers = 100 }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  ESetBranchAddressStatus {
  kMissingBranch = -5 , kInternalError = -4 , kMissingCompiledCollectionProxy = -3 , kMismatch = -2 ,
  kClassMismatch = -1 , kMatch = 0 , kMatchConversion = 1 , kMatchConversionCollection = 2 ,
  kMakeClass = 3 , kVoidPtr = 4 , kNoCheck = 5 , kNeedEnableDecomposedObj = (1ULL << (29)) ,
  kNeedDisableDecomposedObj = (1ULL << (30)) , kDecomposedObjMask = kNeedEnableDecomposedObj | kNeedDisableDecomposedObj
}
enum  EStatusBits { kForceRead = (1ULL << (11)) , kCircular = (1ULL << (12)) , kOnlyFlushAtCluster = (1ULL << (14)) , kEntriesReshuffled = (1ULL << (19)) }

Public Member Functions

 TTreeSQL (TSQLServer *server, TString DB, const TString &table)
 Constructor with an explicit TSQLServer.
 ~TTreeSQL () override
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
void AddAllocationCount (UInt_t count)
virtual Int_t AddBranchToCache (const char *bname, bool subbranches=false)
 Add branch with name bname to the Tree cache.
virtual Int_t AddBranchToCache (TBranch *branch, bool subbranches=false)
 Add branch b to the Tree cache.
void AddClone (TTree *)
 Add a cloned tree to our list of trees to be notified whenever we change our branch addresses or when we are deleted.
virtual TFriendElementAddFriend (const char *treename, const char *filename="")
 Add a TFriendElement to the list of friends.
virtual TFriendElementAddFriend (const char *treename, TFile *file)
 Add a TFriendElement to the list of friends.
virtual TFriendElementAddFriend (TTree *tree, const char *alias="", bool warn=false)
 Add a TFriendElement to the list of friends.
virtual void AddTotBytes (Int_t tot)
virtual void AddZipBytes (Int_t zip)
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
virtual Long64_t AutoSave (Option_t *option="")
 AutoSave tree header every fAutoSave bytes.
TBranchBranch (const char *name, char *address, const char *leaflist, Int_t bufsize=32000)
template<class T>
TBranchBranch (const char *name, const char *classname, T **addobj, Int_t bufsize=32000, Int_t splitlevel=99)
template<class T>
TBranchBranch (const char *name, const char *classname, T *obj, Int_t bufsize=32000, Int_t splitlevel=99)
TBranchBranch (const char *name, int address, const char *leaflist, Int_t bufsize=32000)
TBranchBranch (const char *name, Longptr_t address, const char *leaflist, Int_t bufsize=32000)
template<typename T, std::size_t N>
TBranchBranch (const char *name, std::array< T, N > *obj, Int_t bufsize=32000, Int_t splitlevel=99)
template<class T>
TBranchBranch (const char *name, T **addobj, Int_t bufsize=32000, Int_t splitlevel=99)
 Add a new branch, and infer the data type from the array addobj being passed.
template<class T>
TBranchBranch (const char *name, T *obj, Int_t bufsize=32000, Int_t splitlevel=99)
 Add a new branch, and infer the data type from the type of obj being passed.
Int_t Branch (const char *folder, Int_t bufsize=32000, Int_t splitlevel=99) override
 Not implemented yet.
TBranchBranch (const char *name, const char *classname, void *addobj, Int_t bufsize=32000, Int_t splitlevel=99) override
 Not implemented yet.
TBranchBranch (const char *name, void *address, const char *leaflist, Int_t bufsize) override
 Create a branch.
Int_t Branch (TCollection *list, Int_t bufsize=32000, Int_t splitlevel=99, const char *name="") override
 Not implemented yet.
Int_t Branch (TList *list, Int_t bufsize=32000, Int_t splitlevel=99) override
 Not implemented yet.
TBranchBranchOld (const char *name, const char *classname, void *addobj, Int_t bufsize=32000, Int_t splitlevel=1) override
 Not implemented yet.
virtual TBranchBranchRef ()
 Build the optional branch supporting the TRefTable.
TBranchBronch (const char *name, const char *classname, void *addobj, Int_t bufsize=32000, Int_t splitlevel=99) override
 Not implemented yet.
void Browse (TBrowser *) override
 Browse content of the TTree.
Int_t BuildIndex (const char *majorname, bool long64major)
 Build index with only a major formula.
virtual Int_t BuildIndex (const char *majorname, const char *minorname="0", bool long64major=false, bool long64minor=false)
 Build a Tree Index (default is TTreeIndex).
TStreamerInfoBuildStreamerInfo (TClass *cl, void *pointer=nullptr, bool canOptimize=true)
 Build StreamerInfo for class cl.
virtual TFileChangeFile (TFile *file)
 Called by TTree::Fill() when file has reached its maximum fgMaxTreeSize.
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
virtual TTreeCloneTree (Long64_t nentries=-1, Option_t *option="")
 Create a clone of this tree and copy nentries.
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
void Copy (TAttFill &attfill) const
void Copy (TAttLine &attline) const
void Copy (TAttMarker &attmarker) const
void Copy (TObject &named) const override
 Copy this to obj.
virtual void CopyAddresses (TTree *, bool undo=false)
 Set branch addresses of passed tree equal to ours.
virtual Long64_t CopyEntries (TTree *tree, Long64_t nentries=-1, Option_t *option="", bool needCopyAddresses=false)
 Copy nentries from given tree to this tree.
virtual TTreeCopyTree (const char *selection, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Copy a tree with selection.
Int_t Debug () const
void Delete (Option_t *option="") override
 Delete this tree from memory or/and disk.
virtual void DirectoryAutoAdd (TDirectory *)
 Called by TKey and TObject::Clone to automatically add us to a directory when we are read from a file.
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
virtual Long64_t Draw (const char *varexp, const char *selection, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Draw expression varexp for entries and objects that pass a (optional) selection.
virtual Long64_t Draw (const char *varexp, const TCut &selection, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Draw expression varexp for specified entries.
void Draw (Option_t *opt) override
 Default Draw method for all objects.
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
virtual void DropBaskets ()
 Remove some baskets from memory.
virtual Int_t DropBranchFromCache (const char *bname, bool subbranches=false)
 Remove the branch with name 'bname' from the Tree cache.
virtual Int_t DropBranchFromCache (TBranch *branch, bool subbranches=false)
 Remove the branch b from the Tree cache.
virtual void DropBuffers (Int_t nbytes)
 Drop branch buffers to accommodate nbytes below MaxVirtualsize.
virtual void Dump () const
 Dump contents of object on stdout.
bool EnableCache ()
 Enable the TTreeCache unless explicitly disabled for this TTree by a prior call to SetCacheSize(0).
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
Int_t Fill () override
 Copy the information from the user object to the TTree.
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual TBranchFindBranch (const char *name)
 Return the branch that correspond to the path 'branchname', which can include the name of the tree or the omitted name of the parent branches.
virtual TLeafFindLeaf (const char *name)
 Find first leaf containing searchname.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
virtual Int_t Fit (const char *funcname, const char *varexp, const char *selection="", Option_t *option="", Option_t *goption="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Fit a projected item(s) from a tree.
virtual Int_t FlushBaskets (bool create_cluster=true) const
 Write to disk all the basket that have not yet been individually written and create an event cluster boundary (by default).
virtual const char * GetAlias (const char *aliasName) const
 Returns the expanded value of the alias. Search in the friends if any.
UInt_t GetAllocationCount () const
virtual Long64_t GetAutoFlush () const
virtual Long64_t GetAutoSave () const
virtual TBranchGetBranch (const char *name)
 Return pointer to the branch with the given name in this tree or its friends.
virtual TBranchRefGetBranchRef () const
virtual bool GetBranchStatus (const char *branchname) const
 Return status of branch with name branchname.
virtual Long64_t GetCacheSize () const
virtual Long64_t GetChainEntryNumber (Long64_t entry) const
virtual Long64_t GetChainOffset () const
virtual TClusterIterator GetClusterIterator (Long64_t firstentry)
 Return an iterator over the cluster of baskets starting at firstentry.
virtual bool GetClusterPrefetch () const
TFileGetCurrentFile () const
 Return pointer to the current file.
Long64_t GetDebugMax () const
Long64_t GetDebugMin () const
Int_t GetDefaultEntryOffsetLen () const
TDirectoryGetDirectory () const
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
Long64_t GetEntries () const override
 Get the number of rows in the database.
Long64_t GetEntries (const char *sel) override
 Return the number of entries matching the selection.
Long64_t GetEntriesFast () const override
 Return the number of entries as of the last check.
virtual Long64_t GetEntriesFriend () const
 Returns a number corresponding to:
Int_t GetEntry (Long64_t entry=0, Int_t getall=0) override
 Load the data for the entry from the database.
virtual TEntryListGetEntryList ()
 Returns the entry list assigned to this tree.
virtual Long64_t GetEntryNumber (Long64_t entry) const
 Return entry number corresponding to entry.
virtual Long64_t GetEntryNumberWithBestIndex (Long64_t major, Long64_t minor=0) const
 Return entry number corresponding to major and minor number.
virtual Long64_t GetEntryNumberWithIndex (Long64_t major, Long64_t minor=0) const
 Return entry number corresponding to major and minor number.
virtual Int_t GetEntryWithIndex (Long64_t major, Long64_t minor=0)
 Read entry corresponding to major and minor number.
virtual Long64_t GetEstimate () const
Int_t GetEvent (Long64_t entry, Int_t getall=0)
TEventListGetEventList () const
virtual Int_t GetFileNumber () const
virtual Color_t GetFillColor () const
 Return the fill area color.
virtual Style_t GetFillStyle () const
 Return the fill area style.
virtual TTreeGetFriend (const char *) const
 Return a pointer to the TTree friend whose name or alias is friendname.
virtual const char * GetFriendAlias (TTree *) const
 If the 'tree' is a friend, this method returns its alias name.
TH1GetHistogram ()
virtual const char * GetIconName () const
 Returns mime type name of object.
virtual bool GetImplicitMT ()
virtual Int_tGetIndex ()
virtual Double_tGetIndexValues ()
ROOT::TIOFeatures GetIOFeatures () const
 Returns the current set of IO settings.
virtual TIteratorGetIteratorOnAllLeaves (bool dir=kIterForward)
 Creates a new iterator that will go through all the leaves on the tree itself and its friend.
virtual TLeafGetLeaf (const char *branchname, const char *leafname)
 Return pointer to the 1st Leaf named name in any Branch of this Tree or any branch in the list of friend trees.
virtual TLeafGetLeaf (const char *name)
 Return pointer to first leaf named "name" in any branch of this tree or its friend trees.
virtual Color_t GetLineColor () const
 Return the line color.
virtual Style_t GetLineStyle () const
 Return the line style.
virtual Width_t GetLineWidth () const
 Return the line width.
virtual TListGetListOfAliases () const
virtual TObjArrayGetListOfBranches ()
virtual TListGetListOfClones ()
virtual TListGetListOfFriends () const
virtual TObjArrayGetListOfLeaves ()
Int_t GetMakeClass () const
virtual Color_t GetMarkerColor () const
 Return the marker color.
virtual Size_t GetMarkerSize () const
 Return the marker size.
virtual Style_t GetMarkerStyle () const
 Return the marker style.
virtual Long64_t GetMaxEntryLoop () const
virtual Double_t GetMaximum (const char *columname)
 Return maximum of column with name columname.
virtual Long64_t GetMaxVirtualSize () const
virtual Double_t GetMinimum (const char *columname)
 Return minimum of column with name columname.
const char * GetName () const override
 Returns name of object.
virtual Int_t GetNbranches ()
TObjectGetNotify () const
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
virtual Option_tGetOption () const
virtual Int_t GetPacketSize () const
virtual TVirtualPerfStatsGetPerfStats () const
TVirtualTreePlayerGetPlayer ()
 Load the TTreePlayer (if not already done).
TTreeCacheGetReadCache (TFile *file) const
 Find and return the TTreeCache registered with the file and which may contain branches for us.
TTreeCacheGetReadCache (TFile *file, bool create)
 Find and return the TTreeCache registered with the file and which may contain branches for us.
virtual Long64_t GetReadEntry () const
virtual Long64_t GetReadEvent () const
virtual Int_t GetScanField () const
TTreeFormulaGetSelect ()
virtual Long64_t GetSelectedRows ()
TString GetTableName ()
Float_t GetTargetMemoryRatio () const
virtual Int_t GetTimerInterval () const
const char * GetTitle () const override
 Returns title of object.
virtual Long64_t GetTotBytes () const
TBufferGetTransientBuffer (Int_t size)
 Returns the transient buffer currently used by this TTree for reading/writing baskets.
virtual TTreeGetTree () const
virtual TVirtualIndexGetTreeIndex () const
virtual Int_t GetTreeNumber () const
virtual UInt_t GetUniqueID () const
 Return the unique object id.
virtual Int_t GetUpdate () const
virtual TListGetUserInfo ()
 Return a pointer to the list containing user objects associated to this tree.
virtual Double_tGetV1 ()
virtual Double_tGetV2 ()
virtual Double_tGetV3 ()
virtual Double_tGetV4 ()
virtual Double_tGetVal (Int_t i)
TTreeFormulaGetVar (Int_t i)
TTreeFormulaGetVar1 ()
TTreeFormulaGetVar2 ()
TTreeFormulaGetVar3 ()
TTreeFormulaGetVar4 ()
virtual Double_tGetW ()
virtual Double_t GetWeight () const
virtual Long64_t GetZipBytes () const
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
ULong_t Hash () const override
 Return hash value for this object.
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void IncrementTotalBuffers (Int_t nbytes)
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 bool InPlaceClone (TDirectory *newdirectory, const char *options="")
 Copy the content to a new new file, update this TTree with the new location information and attach this TTree to the new directory.
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
TClassIsA () const override
Bool_t IsDestructed () const
 IsDestructed.
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
bool IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t IsOnHeap () const
Bool_t IsSortable () const override
virtual Bool_t IsTransparent () const
Bool_t IsZombie () const
virtual Int_t LoadBaskets (Long64_t maxmemory=2000000000)
 Read in memory all baskets from all branches up to the limit of maxmemory bytes.
Long64_t LoadTree (Long64_t entry) override
 Setup the tree to the load the specified entry.
virtual Long64_t LoadTreeFriend (Long64_t entry, TTree *T)
 Load entry on behalf of our master tree, we may use an index.
void ls (Option_t *option="") const override
 List TNamed name and title.
virtual Int_t MakeClass (const char *classname=nullptr, Option_t *option="")
 Generate a skeleton analysis class for this tree.
virtual Int_t MakeCode (const char *filename=nullptr)
 Generate a skeleton function for this tree.
virtual Int_t MakeProxy (const char *classname, const char *macrofilename=nullptr, const char *cutfilename=nullptr, const char *option=nullptr, Int_t maxUnrolling=3)
 Generate a skeleton analysis class for this Tree using TBranchProxy.
virtual Int_t MakeSelector (const char *selector=nullptr, Option_t *option="")
 Generate skeleton selector class for this tree.
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).
bool MemoryFull (Int_t nbytes)
 Check if adding nbytes to memory we are still below MaxVirtualsize.
virtual Long64_t Merge (TCollection *list, Option_t *option="")
 Merge the trees in the TList into this tree.
virtual Long64_t Merge (TCollection *list, TFileMergeInfo *info)
 Merge the trees in the TList into this tree.
virtual void Modify ()
virtual void Modify ()
virtual void Modify ()
virtual void ModifyOn (TVirtualPad &pad)
virtual void ModifyOn (TVirtualPad &pad)
virtual void ModifyOn (TVirtualPad &pad)
bool Notify () override
 Function called when loading a new class library.
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 OptimizeBaskets (ULong64_t maxMemory=10000000, Float_t minComp=1.1, Option_t *option="")
 This function may be called after having filled some entries in a Tree.
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
virtual Long64_t PrepEntry (Long64_t entry)
 Make sure the server and result set are setup for the requested entry.
TPrincipalPrincipal (const char *varexp="", const char *selection="", Option_t *option="np", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Interface to the Principal Components Analysis class.
void Print (Option_t *option="") const override
 Print a summary of the tree contents.
virtual void PrintCacheStats (Option_t *option="") const
 Print statistics about the TreeCache for this tree.
virtual Long64_t Process (const char *filename, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Process this tree executing the TSelector code in the specified filename.
virtual Long64_t Process (TSelector *selector, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Process this tree executing the code in the specified selector.
virtual Long64_t Project (const char *hname, const char *varexp, const char *selection="", Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Make a projection of a tree using selections.
virtual TSQLResultQuery (const char *varexp="", const char *selection="", Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Loop over entries and return a TSQLResult object containing entries following selection.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
virtual Long64_t ReadFile (const char *filename, const char *branchDescriptor="", char delimiter=' ')
 Create or simply read branches from filename.
virtual Long64_t ReadStream (std::istream &inputStream, const char *branchDescriptor="", char delimiter=' ')
 Create or simply read branches from an input stream.
void RecursiveRemove (TObject *obj) override
 Make sure that obj (which is being deleted or will soon be) is no longer referenced by this TTree.
void Refresh () override
 Refresh contents of this Tree and its branches from the current Tree status in the database One can call this function in case the Tree on its file is being updated by another process.
virtual void RegisterExternalFriend (TFriendElement *)
 Record a TFriendElement that we need to warn when the chain switches to a new file (typically this is because this chain is a friend of another TChain).
virtual void RemoveExternalFriend (TFriendElement *)
 Removes external friend.
virtual void RemoveFriend (TTree *)
 Remove a friend from the list of friends.
virtual void Reset (Option_t *option="")
 Reset baskets, buffers and entries count in all branches and leaves.
virtual void ResetAfterMerge (TFileMergeInfo *)
 Resets the state of this TTree after a merge (keep the customization but forget the data).
virtual void ResetAttFill (Option_t *option="")
virtual void ResetAttLine (Option_t *option="")
virtual void ResetAttMarker (Option_t *toption="")
void ResetBit (UInt_t f)
virtual void ResetBranchAddress (TBranch *)
 Tell a branch to set its address to zero.
virtual void ResetBranchAddresses ()
 Tell all of our branches to drop their current objects and allocate new ones.
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
virtual void SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
virtual Long64_t Scan (const char *varexp="", const char *selection="", Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Loop over tree entries and print entries passing selection.
virtual bool SetAlias (const char *aliasName, const char *aliasFormula)
 Set a tree variable alias.
virtual void SetAutoFlush (Long64_t autof=-30000000)
 This function may be called at the start of a program to change the default value for fAutoFlush.
virtual void SetAutoSave (Long64_t autos=-300000000)
 In case of a program crash, it will be possible to recover the data in the tree up to the last AutoSave point.
virtual void SetBasketSize (const char *bname, Int_t buffsize=16000)
 Set a branch's basket size.
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
template<class T>
Int_t SetBranchAddress (const char *bname, T **add, TBranch **ptr=nullptr)
template<class T>
Int_t SetBranchAddress (const char *bname, T *add, TBranch **ptr=nullptr)
virtual Int_t SetBranchAddress (const char *bname, void *add, TBranch **ptr, TClass *realClass, EDataType datatype, bool isptr)
 Verify the validity of the type of addr before calling SetBranchAddress.
virtual Int_t SetBranchAddress (const char *bname, void *add, TBranch **ptr=nullptr)
 Change branch address, dealing with clone trees properly.
virtual Int_t SetBranchAddress (const char *bname, void *add, TClass *realClass, EDataType datatype, bool isptr)
 Verify the validity of the type of addr before calling SetBranchAddress.
virtual void SetBranchStatus (const char *bname, bool status=true, UInt_t *found=nullptr)
 Set branch status to Process or DoNotProcess.
virtual Int_t SetCacheEntryRange (Long64_t first, Long64_t last)
 interface to TTreeCache to set the cache entry range
virtual void SetCacheLearnEntries (Int_t n=10)
 Interface to TTreeCache to set the number of entries for the learning phase.
virtual Int_t SetCacheSize (Long64_t cachesize=-1)
 Set maximum size of the file cache (TTreeCache) in bytes.
virtual void SetChainOffset (Long64_t offset=0)
virtual void SetCircular (Long64_t maxEntries)
 Enable/Disable circularity for this tree.
virtual void SetClusterPrefetch (bool enabled)
 Enables (or disables) the early decompression of the baskets of the current cluster (whose compressed data is already in memory if used in conjunction with the TTreeCache).
virtual void SetDebug (Int_t level=1, Long64_t min=0, Long64_t max=9999999)
 Set the debug level and the debug range.
virtual void SetDefaultEntryOffsetLen (Int_t newdefault, bool updateExisting=false)
 Update the default value for the branch's fEntryOffsetLen.
virtual void SetDirectory (TDirectory *dir)
 Change the tree's directory.
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
virtual Long64_t SetEntries (Long64_t n=-1)
 Change number of entries in the tree.
virtual void SetEntryList (TEntryList *list, Option_t *opt="")
 Set an EntryList.
virtual void SetEstimate (Long64_t nentries=1000000)
 Set number of entries to estimate variable limits.
virtual void SetEventList (TEventList *list)
 This function transfroms the given TEventList into a TEntryList The new TEntryList is owned by the TTree and gets deleted when the tree is deleted.
virtual void SetFileNumber (Int_t number=0)
 Set fFileNumber to number.
virtual void SetFillAttributes ()
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color.
void SetFillColor (TColorNumber)
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style.
virtual void SetImplicitMT (bool enabled)
ROOT::TIOFeatures SetIOFeatures (const ROOT::TIOFeatures &)
 Provide the end-user with the ability to enable/disable various experimental IO features for this TTree.
virtual void SetLineAttributes ()
virtual void SetLineColor (Color_t lcolor)
 Set the line color.
void SetLineColor (TColorNumber lcolor)
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
virtual void SetLineStyle (Style_t lstyle)
 Set the line style.
virtual void SetLineWidth (Width_t lwidth)
 Set the line width.
virtual void SetMakeClass (Int_t make)
 Set all the branches in this TTree to be in decomposed object mode (also known as MakeClass mode).
virtual void SetMarkerAttributes ()
virtual void SetMarkerColor (Color_t mcolor=1)
 Set the marker color.
void SetMarkerColor (TColorNumber lcolor)
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
virtual void SetMarkerSize (Size_t msize=1)
 Set the marker size.
virtual void SetMarkerStyle (Style_t mstyle=1)
 Set the marker style.
virtual void SetMaxEntryLoop (Long64_t maxev=kMaxEntries)
virtual void SetMaxVirtualSize (Long64_t size=0)
void SetName (const char *name) override
 Change the name of this tree.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
virtual void SetNotify (TObject *obj)
 Sets the address of the object to be notified when the tree is loaded.
virtual void SetObject (const char *name, const char *title)
 Change the name and title of this tree.
virtual void SetParallelUnzip (bool opt=true, Float_t RelSize=-1)
 Enable or disable parallel unzipping of Tree buffers.
virtual void SetPerfStats (TVirtualPerfStats *perf)
 Set perf stats.
virtual void SetScanField (Int_t n=50)
 Sets the default maximum number of lines to be shown before <CR> when calling Scan().
void SetTargetMemoryRatio (Float_t ratio)
virtual void SetTimerInterval (Int_t msec=333)
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual void SetTreeIndex (TVirtualIndex *index)
 The current TreeIndex is replaced by the new index.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
virtual void SetUpdate (Int_t freq=0)
virtual void SetWeight (Double_t w=1, Option_t *option="")
 Set tree weight.
virtual void Show (Long64_t entry=-1, Int_t lenmax=20)
 Print values of all active leaves for entry.
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
virtual void StartViewer ()
 Start the TTreeViewer on this tree.
virtual Int_t StopCacheLearningPhase ()
 Stop the cache learning phase.
void Streamer (TBuffer &) override
 Stream a class object.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
virtual Int_t UnbinnedFit (const char *funcname, const char *varexp, const char *selection="", Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
 Unbinned fit of one or more variable(s) from a tree.
void UseCurrentStyle () override
 Replace current attributes by current style.
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const override
 Write this object to the current directory.
Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) override
 Write this object to the current directory.

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()
static Int_t GetBranchStyle ()
 Static function returning the current branch style.
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static Width_t GetMarkerLineWidth (Style_t style)
static Style_t GetMarkerStyleBase (Style_t style)
static Long64_t GetMaxTreeSize ()
 Static function which returns the tree file size limit in bytes.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static TTreeMergeTrees (TList *list, Option_t *option="")
 Static function merging the trees in the TList into a new tree.
static void SetBranchStyle (Int_t style=1)
 Set the current branch style.
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetMaxTreeSize (Long64_t maxsize=100000000000LL)
 Set the maximum size in bytes of a Tree file (static function).
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.

Static Public Attributes

static constexpr Long64_t kMaxEntries = TVirtualTreePlayer::kMaxEntries
 Used as the max value for any TTree range operation.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }
enum  ELockStatusBits {
  kFindBranch = (1ULL << (0)) , kFindLeaf = (1ULL << (1)) , kGetAlias = (1ULL << (2)) , kGetBranch = (1ULL << (3)) ,
  kGetEntry = (1ULL << (4)) , kGetEntryWithIndex = (1ULL << (5)) , kGetFriend = (1ULL << (6)) , kGetFriendAlias = (1ULL << (7)) ,
  kGetLeaf = (1ULL << (8)) , kLoadTree = (1ULL << (9)) , kPrint = (1ULL << (10)) , kRemoveFriend = (1ULL << (11)) ,
  kSetBranchStatus = (1ULL << (12)) , kResetBranchAddresses = (1ULL << (13))
}

Protected Member Functions

TBranchBranchImp (const char *branchname, const char *classname, TClass *ptrClass, void *addobj, Int_t bufsize, Int_t splitlevel) override
 Not implemented yet.
TBranchBranchImp (const char *branchname, TClass *ptrClass, void *addobj, Int_t bufsize, Int_t splitlevel) override
 Not implemented yet.
virtual TBranchBranchImpArr (const char *branchname, EDataType datatype, std::size_t N, void *addobj, Int_t bufsize, Int_t splitlevel)
virtual TBranchBranchImpRef (const char *branchname, const char *classname, TClass *ptrClass, void *addobj, Int_t bufsize, Int_t splitlevel)
 Same as TTree::Branch but automatic detection of the class name.
virtual TBranchBranchImpRef (const char *branchname, TClass *ptrClass, EDataType datatype, void *addobj, Int_t bufsize, Int_t splitlevel)
 Same as TTree::Branch but automatic detection of the class name.
virtual TBranchBronchExec (const char *name, const char *classname, void *addobj, bool isptrptr, Int_t bufsize, Int_t splitlevel)
 Helper function implementing TTree::Bronch and TTree::Branch(const char *name, T &obj);.
void CheckBasket (TBranch *tb)
 Check if the basket is properly setup.
bool CheckBranch (TBranch *tb)
 Check if the table has a column corresponding the branch and that the resultset are properly setup.
virtual Int_t CheckBranchAddressType (TBranch *branch, TClass *ptrClass, EDataType datatype, bool ptr)
 Check whether or not the address described by the last 3 parameters matches the content of the branch.
bool CheckTable (const TString &table) const
 Check the table exist in the database.
TString ConvertTypeName (const TString &typeName)
 Convert from ROOT typename to SQL typename.
TBasketCreateBasket (TBranch *br) override
 Create a TBasketSQL.
virtual void CreateBranch (const TString &branchName, const TString &typeName)
 Create the column(s) in the database that correspond to the branch/.
void CreateBranches ()
 determine leaf description string
bool CreateTable (const TString &table)
 Create the database table corresponding to this TTree.
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
TBranchGetBranchFromFriends (const char *branchName)
 Returns a pointer to the branch with the given name, if it can be found in the list of friends of this tree.
TBranchGetBranchFromSelf (const char *branchName)
 Returns a pointer to the branch with the given name, if it can be found in this tree.
Long64_t GetCacheAutoSize (bool withDefault=false)
 Used for automatic sizing of the cache.
std::vector< Int_t > * GetColumnIndice (TBranch *branch)
 Return a vector of columns index corresponding to the current SQL table and the branch given as argument Returns 0 if no columns indices is found Otherwise returns a pointer to a vector to be deleted by the caller.
virtual TLeafGetLeafImpl (const char *branchname, const char *leafname)
 Return pointer to the 1st Leaf named name in any Branch of this Tree or any branch in the list of friend trees.
char GetNewlineValue (std::istream &inputStream)
 Determine which newline this file is using.
void ImportClusterRanges (TTree *fromtree)
 Appends the cluster range information stored in 'fromtree' to this tree, including the value of fAutoFlush.
void Init ()
 Initialization routine.
virtual void KeepCircular ()
 Keep a maximum of fMaxEntries in memory.
void MakeZombie ()
void MoveReadCache (TFile *src, TDirectory *dir)
 Move a cache from a file to the current file in dir.
void ResetQuery ()
 Reset the internal query.
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
virtual Int_t SetBranchAddress (const char *bname, void *add, TBranch **ptr, TClass *realClass, EDataType datatype, bool isptr, bool suppressMissingBranchError)
Int_t SetBranchAddressImp (TBranch *branch, void *addr, TBranch **ptr)
 Change branch address, dealing with clone trees properly.
Int_t SetCacheSizeAux (bool autocache=true, Long64_t cacheSize=0)
 Set the maximum size of the file cache (TTreeCache) in bytes and create it if possible.

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

TListfAliases
 List of aliases for expressions based on the tree branches.
std::atomic< UInt_tfAllocationCount {0}
 memory churn.
Long64_t fAutoFlush
 Auto-flush tree when fAutoFlush entries written or -fAutoFlush (compressed) bytes produced.
Long64_t fAutoSave
 Autosave tree when fAutoSave entries written or -fAutoSave (compressed) bytes produced.
bool fBranchChecked
TObjArray fBranches
 List of Branches.
TBranchReffBranchRef
 Branch supporting the TRefTable (if any).
bool fCacheDoAutoInit
 ! true if cache auto creation or resize check is needed
bool fCacheDoClusterPrefetch
 ! true if cache is prefetching whole clusters
Long64_t fCacheSize
 ! Maximum size of file buffers
bool fCacheUserSet
 ! true if the cache setting was explicitly given by user
Long64_t fChainOffset
 ! Offset of 1st entry of this Tree in a TChain
TListfClones
 ! List of cloned trees which share our addresses
Long64_tfClusterRangeEnd
 [fNClusterRange] Last entry of a cluster range.
Long64_tfClusterSize
 [fNClusterRange] Number of entries in each cluster for a given range.
Int_t fCurrentEntry
TString fDB
Int_t fDebug
 ! Debug level
Long64_t fDebugMax
 ! Last entry number to debug
Long64_t fDebugMin
 ! First entry number to debug
Int_t fDefaultEntryOffsetLen
 Initial Length of fEntryOffset table in the basket buffers.
TDirectoryfDirectory
 ! Pointer to directory holding this tree
Long64_t fEntries
 Number of entries.
TEntryListfEntryList
 ! Pointer to event selection list (if one)
Long64_t fEstimate
 Number of entries to estimate histogram limits.
TEventListfEventList
 ! Pointer to event selection list (if one)
TListfExternalFriends
 ! List of TFriendsElement pointing to us and need to be notified of LoadTree. Content not owned.
Int_t fFileNumber
 !
Color_t fFillColor
 Fill area color.
Style_t fFillStyle
 Fill area style.
Long64_t fFlushedBytes
 Number of auto-flushed bytes.
UInt_t fFriendLockStatus
 ! Record which method is locking the friend recursion
TListfFriends
 pointer to list of friend elements
bool fIMTEnabled
 ! true if implicit multi-threading is enabled for this tree
TArrayI fIndex
 Index of sorted values.
TArrayD fIndexValues
 Sorted index values.
TString fInsertQuery
TIOFeatures fIOFeatures {0}
 IO features to define for newly-written baskets and branches.
TObjArray fLeaves
 Direct pointers to individual branch leaves.
Color_t fLineColor
 Line color.
Style_t fLineStyle
 Line style.
Width_t fLineWidth
 Line width.
Int_t fMakeClass
 ! not zero when processing code generated by MakeClass
Color_t fMarkerColor
 Marker color.
Size_t fMarkerSize
 Marker size.
Style_t fMarkerStyle
 Marker style.
Int_t fMaxClusterRange
 ! Memory allocated for the cluster range.
Long64_t fMaxEntries
 Maximum number of entries in case of circular buffers.
Long64_t fMaxEntryLoop
 Maximum number of entries to process.
Long64_t fMaxVirtualSize
 Maximum total size of buffers kept in memory.
TString fName
Int_t fNClusterRange
 Number of Cluster range in addition to the one defined by 'AutoFlush'.
UInt_t fNEntriesSinceSorting
 ! Number of entries processed since the last re-sorting of branches
Int_t fNfill
 ! Local for EntryLoop
TObjectfNotify
 Object to be notified when loading a Tree.
Int_t fPacketSize
 ! Number of entries in one packet for parallel root
TVirtualPerfStatsfPerfStats
 ! pointer to the current perf stats object
TVirtualTreePlayerfPlayer
 ! Pointer to current Tree player
TString fQuery
Long64_t fReadEntry
 ! Number of the entry being processed
TSQLResultfResult
TSQLRowfRow
Long64_t fSavedBytes
 Number of autosaved bytes.
Int_t fScanField
 Number of runs before prompting in Scan.
std::vector< TBranch * > fSeqBranches
 ! Branches to be processed sequentially when IMT is on
TSQLServerfServer
std::vector< std::pair< Long64_t, TBranch * > > fSortedBranches
 ! Branches to be processed in parallel when IMT is on, sorted by average task time
TString fTable
TSQLTableInfofTableInfo
Float_t fTargetMemoryRatio {1.1f}
 !
Int_t fTimerInterval
 Timer interval in milliseconds.
TString fTitle
std::atomic< Long64_tfTotalBuffers
 ! Total number of bytes in branch buffers
Long64_t fTotBytes
 Total number of bytes in all branches before compression.
TBufferfTransientBuffer
 ! Pointer to the current transient buffer.
TVirtualIndexfTreeIndex
 Pointer to the tree Index (if any).
Int_t fUpdate
 Update frequency for EntryLoop.
TListfUserInfo
 pointer to a list of user objects associated to this Tree
Double_t fWeight
 Tree weight (see TTree::SetWeight).
Long64_t fZipBytes
 Total number of bytes in all branches after compression.

Static Protected Attributes

static Int_t fgBranchStyle = 1
 Old/New branch style.
static Long64_t fgMaxTreeSize = 100000000000LL
 Maximum size of a file containing a Tree.

Private Types

using TIOFeatures = ROOT::TIOFeatures

Private Member Functions

Int_t FlushBasketsImpl () const
 Internal implementation of the FlushBaskets algorithm.
Long64_t GetMedianClusterSize ()
 Estimate the median cluster size for the TTree.
void InitializeBranchLists (bool checkLeafCount)
 Divides the top-level branches into two vectors: (i) branches to be processed sequentially and (ii) branches to be processed in parallel.
void MarkEventCluster ()
 Mark the previous event as being at the end of the event cluster.
void RegisterBranchFullName (std::pair< std::string, TBranch * > &&kv)
Int_t SetBranchAddressImp (const char *bname, void *add, TBranch **ptr, TClass *realClass, EDataType datatype, bool isptr)
void SortBranchesByTime ()
 Sorts top-level branches by the last average task time recorded per branch.

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
bool fIMTFlush {false}
 ! True if we are doing a multithreaded flush.
std::atomic< Long64_tfIMTTotBytes
 ! Total bytes for the IMT flush baskets
std::atomic< Long64_tfIMTZipBytes
 ! Zip bytes for the IMT flush baskets.
std::unordered_map< std::string, TBranch * > fNamesToBranches
 ! maps names to their branches, useful when retrieving branches by name
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 <TTreeSQL.h>

Inheritance diagram for TTreeSQL:
TTree TNamed TAttLine TAttFill TAttMarker TObject

Member Typedef Documentation

◆ TIOFeatures

using TTree::TIOFeatures = ROOT::TIOFeatures
privateinherited

Definition at line 91 of file TTree.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

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

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

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSplitCollectionOfPointers 

Definition at line 309 of file TTree.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ ELockStatusBits

enum TTree::ELockStatusBits
protectedinherited
Enumerator
kFindBranch 
kFindLeaf 
kGetAlias 
kGetBranch 
kGetEntry 
kGetEntryWithIndex 
kGetFriend 
kGetFriendAlias 
kGetLeaf 
kLoadTree 
kPrint 
kRemoveFriend 
kSetBranchStatus 
kResetBranchAddresses 

Definition at line 244 of file TTree.h.

◆ ESetBranchAddressStatus

Enumerator
kMissingBranch 
kInternalError 
kMissingCompiledCollectionProxy 
kMismatch 
kClassMismatch 
kMatch 
kMatchConversion 
kMatchConversionCollection 
kMakeClass 
kVoidPtr 
kNoCheck 
kNeedEnableDecomposedObj 
kNeedDisableDecomposedObj 
kDecomposedObjMask 

Definition at line 276 of file TTree.h.

◆ EStatusBits

enum TTree::EStatusBits
inherited
Enumerator
kForceRead 
kCircular 
kOnlyFlushAtCluster 

If set, the branch's buffers will grow until an event cluster boundary is hit, guaranteeing a basket per cluster.

This mode does not provide any guarantee on the memory bounds in the case of extremely large events.

kEntriesReshuffled 

If set, signals that this TTree is the output of the processing of another TTree, and the entries are reshuffled w.r.t.

to the original TTree. As a safety measure, a TTree with this bit set cannot add friends nor can be added as a friend. If you know what you are doing, you can manually unset this bit with ResetBit(EStatusBits::kEntriesReshuffled).

Definition at line 294 of file TTree.h.

Constructor & Destructor Documentation

◆ TTreeSQL()

TTreeSQL::TTreeSQL ( TSQLServer * server,
TString DB,
const TString & table )

Constructor with an explicit TSQLServer.

Definition at line 51 of file TTreeSQL.cxx.

◆ ~TTreeSQL()

TTreeSQL::~TTreeSQL ( )
override

Definition at line 816 of file TTreeSQL.cxx.

Member Function Documentation

◆ AbstractMethod()

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

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

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

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddAllocationCount()

void TTree::AddAllocationCount ( UInt_t count)
inlineinherited

Definition at line 381 of file TTree.h.

◆ AddBranchToCache() [1/2]

Int_t TTree::AddBranchToCache ( const char * bname,
bool subbranches = false )
virtualinherited

Add branch with name bname to the Tree cache.

If bname="*" all branches are added to the cache. if subbranches is true all the branches of the subbranches are also put to the cache.

Returns:

  • 0 branch added or already included
  • -1 on error

Definition at line 1086 of file TTree.cxx.

◆ AddBranchToCache() [2/2]

Int_t TTree::AddBranchToCache ( TBranch * b,
bool subbranches = false )
virtualinherited

Add branch b to the Tree cache.

if subbranches is true all the branches of the subbranches are also put to the cache.

Returns:

  • 0 branch added or already included
  • -1 on error

Definition at line 1125 of file TTree.cxx.

◆ AddClone()

void TTree::AddClone ( TTree * clone)
inherited

Add a cloned tree to our list of trees to be notified whenever we change our branch addresses or when we are deleted.

Definition at line 1246 of file TTree.cxx.

◆ AddFriend() [1/3]

TFriendElement * TTree::AddFriend ( const char * treename,
const char * filename = "" )
virtualinherited

Add a TFriendElement to the list of friends.

This function:

  • opens a file if filename is specified
  • reads a Tree with name treename from the file (current directory)
  • adds the Tree to the list of friends see other AddFriend functions

A TFriendElement TF describes a TTree object TF in a file. When a TFriendElement TF is added to the list of friends of an existing TTree T, any variable from TF can be referenced in a query to T.

A tree keeps a list of friends. In the context of a tree (or a chain), friendship means unrestricted access to the friends data. In this way it is much like adding another branch to the tree without taking the risk of damaging it. To add a friend to the list, you can use the TTree::AddFriend method. The tree in the diagram below has two friends (friend_tree1 and friend_tree2) and now has access to the variables a,b,c,i,j,k,l and m.

The AddFriend method has two parameters, the first is the tree name and the second is the name of the ROOT file where the friend tree is saved. AddFriend automatically opens the friend file. If no file name is given, the tree called ft1 is assumed to be in the same file as the original tree.

tree.AddFriend("ft1","friendfile1.root"); If the friend tree has the same name as the original tree, you can give it an alias in the context of the friendship:

tree.AddFriend("tree1 = tree","friendfile1.root"); Once the tree has friends, we can use TTree::Draw as if the friend's variables were in the original tree. To specify which tree to use in the Draw method, use the syntax:

<treeName>.<branchname>.<varname>

If the variablename is enough to uniquely identify the variable, you can leave out the tree and/or branch name. For example, these commands generate a 3-d scatter plot of variable "var" in the TTree tree versus variable v1 in TTree ft1 versus variable v2 in TTree ft2.

tree.AddFriend("ft1","friendfile1.root");
tree.AddFriend("ft2","friendfile2.root");
tree.Draw("var:ft1.v1:ft2.v2");

The picture illustrates the access of the tree and its friends with a Draw command. When AddFriend is called, the ROOT file is automatically opened and the friend tree (ft1) is read into memory. The new friend (ft1) is added to the list of friends of tree. The number of entries in the friend must be equal or greater to the number of entries of the original tree. If the friend tree has fewer entries a warning is given and the missing entries are not included in the histogram. To retrieve the list of friends from a tree use TTree::GetListOfFriends. When the tree is written to file (TTree::Write), the friends list is saved with it. And when the tree is retrieved, the trees on the friends list are also retrieved and the friendship restored. When a tree is deleted, the elements of the friend list are also deleted. It is possible to declare a friend tree that has the same internal structure (same branches and leaves) as the original tree, and compare the same values by specifying the tree.

tree.Draw("var:ft1.var:ft2.var")

Reimplemented in TChain.

Definition at line 1359 of file TTree.cxx.

◆ AddFriend() [2/3]

TFriendElement * TTree::AddFriend ( const char * treename,
TFile * file )
virtualinherited

Add a TFriendElement to the list of friends.

The TFile is managed by the user (e.g. the user must delete the file). For complete description see AddFriend(const char *, const char *). This function:

  • reads a Tree with name treename from the file
  • adds the Tree to the list of friends

Reimplemented in TChain.

Definition at line 1393 of file TTree.cxx.

◆ AddFriend() [3/3]

TFriendElement * TTree::AddFriend ( TTree * tree,
const char * alias = "",
bool warn = false )
virtualinherited

Add a TFriendElement to the list of friends.

The TTree is managed by the user (e.g., the user must delete the file). For a complete description see AddFriend(const char *, const char *).

Reimplemented in TChain.

Definition at line 1424 of file TTree.cxx.

◆ AddTotBytes()

virtual void TTree::AddTotBytes ( Int_t tot)
inlinevirtualinherited

Definition at line 375 of file TTree.h.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

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

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AddZipBytes()

virtual void TTree::AddZipBytes ( Int_t zip)
inlinevirtualinherited

Definition at line 376 of file TTree.h.

◆ AppendPad()

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

Append graphics object to current pad.

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

Definition at line 204 of file TObject.cxx.

◆ AutoSave()

Long64_t TTree::AutoSave ( Option_t * option = "")
virtualinherited

AutoSave tree header every fAutoSave bytes.

When large Trees are produced, it is safe to activate the AutoSave procedure. Some branches may have buffers holding many entries. If fAutoSave is negative, AutoSave is automatically called by TTree::Fill when the number of bytes generated since the previous AutoSave is greater than -fAutoSave bytes. If fAutoSave is positive, AutoSave is automatically called by TTree::Fill every N entries. This function may also be invoked by the user. Each AutoSave generates a new key on the file. Once the key with the tree header has been written, the previous cycle (if any) is deleted.

Note that calling TTree::AutoSave too frequently (or similarly calling TTree::SetAutoSave with a small value) is an expensive operation. You should make tests for your own application to find a compromise between speed and the quantity of information you may loose in case of a job crash.

In case your program crashes before closing the file holding this tree, the file will be automatically recovered when you will connect the file in UPDATE mode. The Tree will be recovered at the status corresponding to the last AutoSave.

if option contains "SaveSelf", gDirectory->SaveSelf() is called. This allows another process to analyze the Tree while the Tree is being filled.

if option contains "FlushBaskets", TTree::FlushBaskets is called and all the current basket are closed-out and written to disk individually.

By default the previous header is deleted after having written the new header. if option contains "Overwrite", the previous Tree header is deleted before written the new header. This option is slightly faster, but the default option is safer in case of a problem (disk quota exceeded) when writing the new header.

The function returns the number of bytes written to the file. if the number of bytes is null, an error has occurred while writing the header to the file.

How to write a Tree in one process and view it from another process

The following two scripts illustrate how to do this. The script treew.C is executed by process1, treer.C by process2

script treew.C:

void treew() {
TFile f("test.root","recreate");
TNtuple *ntuple = new TNtuple("ntuple","Demo","px:py:pz:random:i");
Float_t px, py, pz;
for ( Int_t i=0; i<10000000; i++) {
gRandom->Rannor(px,py);
pz = px*px + py*py;
Float_t random = gRandom->Rndm(1);
ntuple->Fill(px,py,pz,random,i);
if (i%1000 == 1) ntuple->AutoSave("SaveSelf");
}
}
#define f(i)
Definition RSha256.hxx:104
int Int_t
Signed integer 4 bytes (int).
Definition RtypesCore.h:59
float Float_t
Float 4 bytes (float).
Definition RtypesCore.h:71
externTRandom * gRandom
Definition TRandom.h:62
A file, usually with extension .root, that stores data and code in the form of serialized objects in ...
Definition TFile.h:130
A simple TTree restricted to a list of float variables only.
Definition TNtuple.h:28

script treer.C:

void treer() {
TFile f("test.root");
TTree *ntuple = (TTree*)f.Get("ntuple");
Int_t first = 0;
while(1) {
if (first == 0) ntuple->Draw("px>>hpx", "","",10000000,first);
else ntuple->Draw("px>>+hpx","","",10000000,first);
first = (Int_t)ntuple->GetEntries();
c1.Update();
gSystem->Sleep(1000); //sleep 1 second
ntuple->Refresh();
}
}
externTSystem * gSystem
Definition TSystem.h:582
The Canvas class.
Definition TCanvas.h:23
TTree()
Default constructor and I/O constructor.
Definition TTree.cxx:764
return c1
Definition legend1.C:41

Definition at line 1527 of file TTree.cxx.

◆ Branch() [1/13]

TBranch * TTree::Branch ( const char * name,
char * address,
const char * leaflist,
Int_t bufsize = 32000 )
inlineinherited

Definition at line 423 of file TTree.h.

◆ Branch() [2/13]

template<class T>
TBranch * TTree::Branch ( const char * name,
const char * classname,
T ** addobj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
inlineinherited

Definition at line 444 of file TTree.h.

◆ Branch() [3/13]

template<class T>
TBranch * TTree::Branch ( const char * name,
const char * classname,
T * obj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
inlineinherited

Definition at line 439 of file TTree.h.

◆ Branch() [4/13]

TBranch * TTree::Branch ( const char * name,
int address,
const char * leaflist,
Int_t bufsize = 32000 )
inlineinherited

Definition at line 433 of file TTree.h.

◆ Branch() [5/13]

TBranch * TTree::Branch ( const char * name,
Longptr_t address,
const char * leaflist,
Int_t bufsize = 32000 )
inlineinherited

Definition at line 428 of file TTree.h.

◆ Branch() [6/13]

template<typename T, std::size_t N>
TBranch * TTree::Branch ( const char * name,
std::array< T, N > * obj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
inlineinherited

Definition at line 449 of file TTree.h.

◆ Branch() [7/13]

template<class T>
TBranch * TTree::Branch ( const char * name,
T ** addobj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
inlineinherited

Add a new branch, and infer the data type from the array addobj being passed.

Note
This and the previous overload should cover most cases for creating a branch. Try to use these two whenever possible, unless e.g. type conversions are needed.
Parameters
[in]nameName of the branch to be created.
[in]addobjArray of the objects to be added. When calling Fill(), the current value of the type/object will be saved.
[in]bufsizehe buffer size in bytes for this branch. When the buffer is full, it is compressed and written to disc. The default value of 32000 bytes and should be ok for most simple types. Larger buffers (e.g. 256000) if your Tree is not split and each entry is large (Megabytes). A small value for bufsize is beneficial if entries in the Tree are accessed randomly and the Tree is in split mode.
[in]splitlevelIf T is a class or struct and splitlevel > 0, the members of the object are serialised as separate branches.
Returns
Pointer to the TBranch that was created. The branch is owned by the tree.

Definition at line 414 of file TTree.h.

◆ Branch() [8/13]

template<class T>
TBranch * TTree::Branch ( const char * name,
T * obj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
inlineinherited

Add a new branch, and infer the data type from the type of obj being passed.

Note
This and the next overload should cover most cases for creating a branch. Try to use these two whenever possible, unless e.g. type conversions are needed.
Parameters
[in]nameName of the branch to be created.
[in]objAddress of the object to be added. Make sure to pass a pointer to the actual type/class that should be stored in the tree (no pointers to base classes). When calling Fill(), the current value of the type/object will be saved.
[in]bufsizeThe buffer size in bytes for this branch. When the buffer is full, it is compressed and written to disc. The default value of 32000 bytes and should be ok for most simple types. Larger buffers (e.g. 256000) if your Tree is not split and each entry is large (Megabytes). A small value for bufsize is beneficial if entries in the Tree are accessed randomly and the Tree is in split mode.
[in]splitlevelIf T is a class or struct and splitlevel > 0, the members of the object are serialised as separate branches.
Returns
Pointer to the TBranch that was created. The branch is owned by the tree.

Definition at line 397 of file TTree.h.

◆ Branch() [9/13]

Int_t TTreeSQL::Branch ( const char * folder,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 114 of file TTreeSQL.cxx.

◆ Branch() [10/13]

TBranch * TTreeSQL::Branch ( const char * name,
const char * classname,
void * addobj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 144 of file TTreeSQL.cxx.

◆ Branch() [11/13]

TBranch * TTreeSQL::Branch ( const char * name,
void * address,
const char * leaflist,
Int_t bufsize )
overridevirtual

Create a branch.

Reimplemented from TTree.

Definition at line 154 of file TTreeSQL.cxx.

◆ Branch() [12/13]

Int_t TTreeSQL::Branch ( TCollection * list,
Int_t bufsize = 32000,
Int_t splitlevel = 99,
const char * name = "" )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 95 of file TTreeSQL.cxx.

◆ Branch() [13/13]

Int_t TTreeSQL::Branch ( TList * list,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 105 of file TTreeSQL.cxx.

◆ BranchImp() [1/2]

TBranch * TTreeSQL::BranchImp ( const char * branchname,
const char * classname,
TClass * ptrClass,
void * addobj,
Int_t bufsize,
Int_t splitlevel )
overrideprotectedvirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 75 of file TTreeSQL.cxx.

◆ BranchImp() [2/2]

TBranch * TTreeSQL::BranchImp ( const char * branchname,
TClass * ptrClass,
void * addobj,
Int_t bufsize,
Int_t splitlevel )
overrideprotectedvirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 86 of file TTreeSQL.cxx.

◆ BranchImpArr()

TBranch * TTree::BranchImpArr ( const char * branchname,
EDataType datatype,
std::size_t N,
void * addobj,
Int_t bufsize,
Int_t splitlevel )
protectedvirtualinherited

Definition at line 1758 of file TTree.cxx.

◆ BranchImpRef() [1/2]

TBranch * TTree::BranchImpRef ( const char * branchname,
const char * classname,
TClass * ptrClass,
void * addobj,
Int_t bufsize,
Int_t splitlevel )
protectedvirtualinherited

Same as TTree::Branch but automatic detection of the class name.

See also
TTree::Branch

Definition at line 1662 of file TTree.cxx.

◆ BranchImpRef() [2/2]

TBranch * TTree::BranchImpRef ( const char * branchname,
TClass * ptrClass,
EDataType datatype,
void * addobj,
Int_t bufsize,
Int_t splitlevel )
protectedvirtualinherited

Same as TTree::Branch but automatic detection of the class name.

See also
TTree::Branch

Definition at line 1722 of file TTree.cxx.

◆ BranchOld()

TBranch * TTreeSQL::BranchOld ( const char * name,
const char * classname,
void * addobj,
Int_t bufsize = 32000,
Int_t splitlevel = 1 )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 134 of file TTreeSQL.cxx.

◆ BranchRef()

TBranch * TTree::BranchRef ( )
virtualinherited

Build the optional branch supporting the TRefTable.

This branch will keep all the information to find the branches containing referenced objects.

At each Tree::Fill, the branch numbers containing the referenced objects are saved to the TBranchRef basket. When the Tree header is saved (via TTree::Write), the branch is saved keeping the information with the pointers to the branches having referenced objects.

Definition at line 2358 of file TTree.cxx.

◆ Bronch()

TBranch * TTreeSQL::Bronch ( const char * name,
const char * classname,
void * addobj,
Int_t bufsize = 32000,
Int_t splitlevel = 99 )
overridevirtual

Not implemented yet.

Reimplemented from TTree.

Definition at line 124 of file TTreeSQL.cxx.

◆ BronchExec()

TBranch * TTree::BronchExec ( const char * name,
const char * classname,
void * addobj,
bool isptrptr,
Int_t bufsize,
Int_t splitlevel )
protectedvirtualinherited

Helper function implementing TTree::Bronch and TTree::Branch(const char *name, T &obj);.

Definition at line 2442 of file TTree.cxx.

◆ Browse()

void TTree::Browse ( TBrowser * b)
overridevirtualinherited

Browse content of the TTree.

Reimplemented from TObject.

Definition at line 2639 of file TTree.cxx.

◆ BuildIndex() [1/2]

Int_t TTree::BuildIndex ( const char * majorname,
bool long64major )
inlineinherited

Build index with only a major formula.

Minor formula will be set to "0" ie skip.

See also
TTree::BuildIndex(const char *, const char *, bool, bool)

Definition at line 467 of file TTree.h.

◆ BuildIndex() [2/2]

Int_t TTree::BuildIndex ( const char * majorname,
const char * minorname = "0",
bool long64major = false,
bool long64minor = false )
virtualinherited

Build a Tree Index (default is TTreeIndex).

See a description of the parameters and functionality in TTreeIndex::TTreeIndex().

The return value is the number of entries in the Index (< 0 indicates failure).

A TTreeIndex object pointed by fTreeIndex is created. This object will be automatically deleted by the TTree destructor. If an index is already existing, this is replaced by the new one without being deleted. This behaviour prevents the deletion of a previously external index assigned to the TTree via the TTree::SetTreeIndex() method.

See also
TTree::SetTreeIndex()

Definition at line 2667 of file TTree.cxx.

◆ BuildStreamerInfo()

TStreamerInfo * TTree::BuildStreamerInfo ( TClass * cl,
void * pointer = nullptr,
bool canOptimize = true )
inherited

Build StreamerInfo for class cl.

pointer is an optional argument that may contain a pointer to an object of cl.

Definition at line 2682 of file TTree.cxx.

◆ ChangeFile()

TFile * TTree::ChangeFile ( TFile * file)
virtualinherited

Called by TTree::Fill() when file has reached its maximum fgMaxTreeSize.

Create a new file. If the original file is named "myfile.root", subsequent files are named "myfile_1.root", "myfile_2.root", etc.

Returns a pointer to the new file.

Currently, the automatic change of file is restricted to the case where the tree is in the top level directory. The file should not contain sub-directories.

Before switching to a new file, the tree header is written to the current file, then the current file is closed.

To process the multiple files created by ChangeFile, one must use a TChain.

The new file name has a suffix "_N" where N is equal to fFileNumber+1. By default a Root session starts with fFileNumber=0. One can set fFileNumber to a different value via TTree::SetFileNumber. In case a file named "_N" already exists, the function will try a file named "__N", then "___N", etc.

fgMaxTreeSize can be set via the static function TTree::SetMaxTreeSize. The default value of fgMaxTreeSize is 100 Gigabytes.

If the current file contains other objects like TH1 and TTree, these objects are automatically moved to the new file.

Warning
Be careful when writing the final Tree header to the file! Don't do:
TFile *file = new TFile("myfile.root","recreate");
TTree *T = new TTree("T","title");
T->Fill(); // Loop
file->Write();
file->Close();
Int_t Write(const char *name=nullptr, Int_t opt=0, Int_t bufsize=0) override
Write memory objects to this file.
Definition TFile.cxx:2488
void Close(Option_t *option="") override
Close a file.
Definition TFile.cxx:981
but do the following:
TFile *file = new TFile("myfile.root","recreate");
TTree *T = new TTree("T","title");
T->Fill(); // Loop
file = T->GetCurrentFile(); // To get the pointer to the current file
file->Write();
file->Close();
Note
This method is never called if the input file is a TMemFile or derivate.

Definition at line 2779 of file TTree.cxx.

◆ CheckBasket()

void TTreeSQL::CheckBasket ( TBranch * tb)
protected

Check if the basket is properly setup.

Definition at line 186 of file TTreeSQL.cxx.

◆ CheckBranch()

bool TTreeSQL::CheckBranch ( TBranch * tb)
protected

Check if the table has a column corresponding the branch and that the resultset are properly setup.

Definition at line 214 of file TTreeSQL.cxx.

◆ CheckBranchAddressType()

Int_t TTree::CheckBranchAddressType ( TBranch * branch,
TClass * ptrClass,
EDataType datatype,
bool isptr )
protectedvirtualinherited

Check whether or not the address described by the last 3 parameters matches the content of the branch.

If a Data Model Evolution conversion is involved, reset the fInfo of the branch. The return values are:

  • kMissingBranch (-5) : Missing branch
  • kInternalError (-4) : Internal error (could not find the type corresponding to a data type number)
  • kMissingCompiledCollectionProxy (-3) : Missing compiled collection proxy for a compiled collection
  • kMismatch (-2) : Non-Class Pointer type given does not match the type expected by the branch
  • kClassMismatch (-1) : Class Pointer type given does not match the type expected by the branch
  • kMatch (0) : perfect match
  • kMatchConversion (1) : match with (I/O) conversion
  • kMatchConversionCollection (2) : match with (I/O) conversion of the content of a collection
  • kMakeClass (3) : MakeClass mode so we can not check.
  • kVoidPtr (4) : void* passed so no check was made.
  • kNoCheck (5) : Underlying TBranch not yet available so no check was made. In addition this can be multiplexed with the two bits:
  • kNeedEnableDecomposedObj : in order for the address (type) to be 'usable' the branch needs to be in Decomposed Object (aka MakeClass) mode.
  • kNeedDisableDecomposedObj : in order for the address (type) to be 'usable' the branch needs to not be in Decomposed Object (aka MakeClass) mode. This bits can be masked out by using kDecomposedObjMask

Definition at line 2901 of file TTree.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

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

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

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

Definition at line 332 of file TObject.h.

◆ CheckTable()

bool TTreeSQL::CheckTable ( const TString & table) const
protected

Check the table exist in the database.

Definition at line 262 of file TTreeSQL.cxx.

◆ Class()

TClass * TTreeSQL::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

const char * TTreeSQL::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TTreeSQL::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 94 of file TTreeSQL.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

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

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

Reimplemented from TObject.

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

Definition at line 63 of file TNamed.cxx.

◆ Clone()

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

Make a clone of an object using the Streamer facility.

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

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ CloneTree()

TTree * TTree::CloneTree ( Long64_t nentries = -1,
Option_t * option = "" )
virtualinherited

Create a clone of this tree and copy nentries.

By default copy all entries. The compression level of the cloned tree is set to the destination file's compression level.

NOTE: Only active branches are copied. See TTree::SetBranchStatus for more information and usage regarding the (de)activation of branches. More examples are provided in the tutorials listed below.

NOTE: If the TTree is a TChain, the structure of the first TTree is used for the copy.

IMPORTANT: The cloned tree stays connected with this tree until this tree is deleted. In particular, any changes in branch addresses in this tree are forwarded to the clone trees, unless a branch in a clone tree has had its address changed, in which case that change stays in effect. When this tree is deleted, all the addresses of the cloned tree are reset to their default values.

If 'option' contains the word 'fast' and nentries is -1, the cloning will be done without unzipping or unstreaming the baskets (i.e., a direct copy of the raw bytes on disk).

When 'fast' is specified, 'option' can also contain a sorting order for the baskets in the output file.

There are currently 3 supported sorting order:

  • SortBasketsByOffset (the default)
  • SortBasketsByBranch
  • SortBasketsByEntry

When using SortBasketsByOffset the baskets are written in the output file in the same order as in the original file (i.e. the baskets are sorted by their offset in the original file; Usually this also means that the baskets are sorted by the index/number of the last entry they contain)

When using SortBasketsByBranch all the baskets of each individual branches are stored contiguously. This tends to optimize reading speed when reading a small number (1->5) of branches, since all their baskets will be clustered together instead of being spread across the file. However it might decrease the performance when reading more branches (or the full entry).

When using SortBasketsByEntry the baskets with the lowest starting entry are written first. (i.e. the baskets are sorted by the index/number of the first entry they contain). This means that on the file the baskets will be in the order in which they will be needed when reading the whole tree sequentially.

For examples of CloneTree, see tutorials:

  • copytree.C: A macro to copy a subset of a TTree to a new TTree. The input file has been generated by the program in $ROOTSYS/test/Event with: Event 1000 1 1 1
  • copytree2.C: A macro to copy a subset of a TTree to a new TTree. One branch of the new Tree is written to a separate file. The input file has been generated by the program in $ROOTSYS/test/Event with: Event 1000 1 1 1

Reimplemented in TNtuple.

Definition at line 3173 of file TTree.cxx.

◆ Compare()

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

Compare two TNamed objects.

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

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ ConvertTypeName()

TString TTreeSQL::ConvertTypeName ( const TString & typeName)
protected

Convert from ROOT typename to SQL typename.

Definition at line 289 of file TTreeSQL.cxx.

◆ Copy() [1/4]

void TAttFill::Copy ( TAttFill & attfill) const
inherited

◆ Copy() [2/4]

void TAttLine::Copy ( TAttLine & attline) const
inherited

◆ Copy() [3/4]

void TAttMarker::Copy ( TAttMarker & attmarker) const
inherited

◆ Copy() [4/4]

void TNamed::Copy ( TObject & named) const
overridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

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

Definition at line 93 of file TNamed.cxx.

◆ CopyAddresses()

void TTree::CopyAddresses ( TTree * tree,
bool undo = false )
virtualinherited

Set branch addresses of passed tree equal to ours.

If undo is true, reset the branch addresses instead of copying them. This ensures 'separation' of a cloned tree from its original.

Definition at line 3339 of file TTree.cxx.

◆ CopyEntries()

Long64_t TTree::CopyEntries ( TTree * tree,
Long64_t nentries = -1,
Option_t * option = "",
bool needCopyAddresses = false )
virtualinherited

Copy nentries from given tree to this tree.

This routines assumes that the branches that intended to be copied are already connected. The typical case is that this tree was created using tree->CloneTree(0).

By default copy all entries.

Returns number of bytes copied to this tree.

If 'option' contains the word 'fast' and nentries is -1, the cloning will be done without unzipping or unstreaming the baskets (i.e., a direct copy of the raw bytes on disk).

When 'fast' is specified, 'option' can also contains a sorting order for the baskets in the output file.

There are currently 3 supported sorting order:

  • SortBasketsByOffset (the default)
  • SortBasketsByBranch
  • SortBasketsByEntry

See TTree::CloneTree for a detailed explanation of the semantics of these 3 options.

If the tree or any of the underlying tree of the chain has an index, that index and any index in the subsequent underlying TTree objects will be merged.

There are currently three 'options' to control this merging:

  • NoIndex : all the TTreeIndex object are dropped.
  • DropIndexOnError : if any of the underlying TTree object do no have a TTreeIndex, they are all dropped.
  • AsIsIndexOnError [default]: In case of missing TTreeIndex, the resulting TTree index has gaps.
  • BuildIndexOnError : If any of the underlying TTree objects do not have a TTreeIndex, all TTreeIndex are 'ignored' and the missing piece are rebuilt.

Definition at line 3574 of file TTree.cxx.

◆ CopyTree()

TTree * TTree::CopyTree ( const char * selection,
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Copy a tree with selection.

Important:

The returned copied tree stays connected with the original tree until the original tree is deleted. In particular, any changes to the branch addresses in the original tree are also made to the copied tree. Any changes made to the branch addresses of the copied tree are overridden anytime the original tree changes its branch addresses. When the original tree is deleted, all the branch addresses of the copied tree are set to zero.

For examples of CopyTree, see the tutorials:

  • copytree.C: Example macro to copy a subset of a tree to a new tree. The input file was generated by running the program in $ROOTSYS/test/Event in this way:
    ./Event 1000 1 1 1
  • copytree2.C Example macro to copy a subset of a tree to a new tree. One branch of the new tree is written to a separate file. The input file was generated by running the program in $ROOTSYS/test/Event in this way:
    ./Event 1000 1 1 1
  • copytree3.C Example macro to copy a subset of a tree to a new tree. Only selected entries are copied to the new tree. NOTE that only the active branches are copied.

Reimplemented in TChain.

Definition at line 3759 of file TTree.cxx.

◆ CreateBasket()

TBasket * TTreeSQL::CreateBasket ( TBranch * br)
overrideprotectedvirtual

Create a TBasketSQL.

Reimplemented from TTree.

Definition at line 350 of file TTreeSQL.cxx.

◆ CreateBranch()

void TTreeSQL::CreateBranch ( const TString & branchName,
const TString & typeName )
protectedvirtual

Create the column(s) in the database that correspond to the branch/.

Definition at line 368 of file TTreeSQL.cxx.

◆ CreateBranches()

void TTreeSQL::CreateBranches ( )
protected

determine leaf description string

Definition at line 390 of file TTreeSQL.cxx.

◆ CreateTable()

bool TTreeSQL::CreateTable ( const TString & table)
protected

Create the database table corresponding to this TTree.

Definition at line 487 of file TTreeSQL.cxx.

◆ Debug()

Int_t TTree::Debug ( ) const
inlineinherited

Definition at line 476 of file TTree.h.

◆ DeclFileName()

const char * TTreeSQL::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 94 of file TTreeSQL.h.

◆ Delete()

void TTree::Delete ( Option_t * option = "")
overridevirtualinherited

Delete this tree from memory or/and disk.

  • if option == "all" delete Tree object from memory AND from disk all baskets on disk are deleted. All keys with same name are deleted.
  • if option =="" only Tree object in memory is deleted.

Reimplemented from TObject.

Definition at line 3787 of file TTree.cxx.

◆ DirectoryAutoAdd()

void TTree::DirectoryAutoAdd ( TDirectory * dir)
virtualinherited

Called by TKey and TObject::Clone to automatically add us to a directory when we are read from a file.

Reimplemented in TChain.

Definition at line 3859 of file TTree.cxx.

◆ DistancetoLine()

Int_t TAttLine::DistancetoLine ( Int_t px,
Int_t py,
Double_t xp1,
Double_t yp1,
Double_t xp2,
Double_t yp2 )
inherited

◆ DistancetoPrimitive()

◆ DoError()

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

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw() [1/3]

Long64_t TTree::Draw ( const char * varexp,
const char * selection,
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Draw expression varexp for entries and objects that pass a (optional) selection.

Returns
-1 in case of error or number of selected events in case of success. If selection involves an array variable x[n], for example x[] > 0 or x > 0, then we return the number of selected instances rather than number of events. In the output of tree.Scan(), instances are shown in individual printed rows, thus each event (tree entry) is split across the various instances (lines) of the array. In contrast, the function GetEntries(selection) always returns the number of entries selected.
Parameters
[in]varexpA string that takes one of these general forms:
  • "e1" produces a 1-d histogram (TH1F) of expression "e1"
  • "e1:e2" produces an unbinned 2-d scatter-plot (TGraph) of "e1" on the y-axis versus "e2" on the x-axis
  • "e1:e2:e3" produces an unbinned 3-d scatter-plot (TPolyMarker3D) of "e1" vs "e2" vs "e3" on the z-, y-, x-axis, respectively
  • "e1:e2:e3:e4" produces an unbinned 3-d scatter-plot (TPolyMarker3D) of "e1" vs "e2" vs "e3" and "e4" mapped on the current color palette. (to create histograms in the 2, 3, and 4 dimensional case, see section "Saving the result of Draw to an histogram")

    • "e1:e2:e3:e4:e5" with option "GL5D" produces a 5D plot using OpenGL. gStyle->SetCanvasPreferGL(true) is needed.
    • Any number of variables no fewer than two can be used with the options "CANDLE" and "PARA"
    • An arbitrary number of variables can be used with the option "GOFF"

    Examples:

    • "x": the simplest case, it draws a 1-Dim histogram of column x
    • "sqrt(x)", "x*y/z": draw histogram with the values of the specified numerical expression across TTree events
    • "y:sqrt(x)": 2-Dim histogram of y versus sqrt(x)
    • "px:py:pz:2.5*E": produces a 3-d scatter-plot of px vs py ps pz and the color number of each marker will be 2.5*E. If the color number is negative it is set to 0. If the color number is greater than the current number of colors it is set to the highest color number. The default number of colors is 50. See TStyle::SetPalette for setting a new color palette.

    The expressions can use all the operations and built-in functions supported by TFormula (see TFormula::Analyze()), including free functions taking numerical arguments (e.g. TMath::Bessel()). In addition, you can call member functions taking numerical arguments. For example, these are two valid expressions:

    event.GetHistogram()->GetXaxis()->GetXmax()
    TH1 * GetHistogram()
    Definition TTree.h:566
    Double_t BreitWigner(Double_t x, Double_t mean=0, Double_t gamma=1)
    Calculates a Breit Wigner function with mean and gamma.
    Definition TMath.cxx:442
[in]selectionA string containing a selection expression. In a selection all usual C++ mathematical and logical operators are allowed. The value corresponding to the selection expression is used as a weight to fill the histogram (a weight of 0 is equivalent to not filling the histogram).

Examples:
  • "x<y && sqrt(z)>3.2": returns a weight = 0 or 1
  • "(x+y)*(sqrt(z)>3.2)": returns a weight = x+y if sqrt(z)>3.2, 0 otherwise

    If the selection expression returns an array, it is iterated over in sync with the array returned by the varexp argument (as described below in "Drawing expressions using arrays and array elements"). For example, if, for a given event, varexp evaluates to {1., 2., 3.} and selection evaluates to {0, 1, 0}, the resulting histogram is filled with the value 2. For example, for each event here we perform a simple object selection:
    // Muon_pt is an array: fill a histogram with the array elements > 100 in each event
    tree->Draw('Muon_pt', 'Muon_pt > 100')
[in]optionThe drawing option.
  • When an histogram is produced it can be any histogram drawing option listed in THistPainter.
  • when no option is specified:
    • the default histogram drawing option is used if the expression is of the form "e1".
    • if the expression is of the form "e1:e2"or "e1:e2:e3" a cloud of unbinned 2D or 3D points is drawn respectively.
    • if the expression has four fields "e1:e2:e3:e4" a cloud of unbinned 3D points is produced with e1 vs e2 vs e3, and e4 is mapped on the current color palette.
  • If option COL is specified when varexp has three fields:
    tree.Draw("e1:e2:e3","","col");
    a 2D scatter is produced with e1 vs e2, and e3 is mapped on the current color palette. The colors for e3 are evaluated once in linear scale before painting. Therefore changing the pad to log scale along Z as no effect on the colors.
  • if expression has more than four fields the option "PARA"or "CANDLE" can be used.
  • If option contains the string "goff", no graphics is generated.
[in]nentriesThe number of entries to process (default is all)
[in]firstentryThe first entry to process (default is 0)

Drawing expressions using arrays and array elements

Let assumes, a leaf fMatrix, on the branch fEvent, which is a 3 by 3 array, or a TClonesArray. In a TTree::Draw expression you can now access fMatrix using the following syntaxes:

String passed What is used for each entry of the tree
fMatrix the 9 elements of fMatrix
fMatrix[][] the 9 elements of fMatrix
fMatrix[2][2] only the elements fMatrix[2][2]
fMatrix[1] the 3 elements fMatrix[1][0], fMatrix[1][1] and fMatrix[1][2]
fMatrix[1][] the 3 elements fMatrix[1][0], fMatrix[1][1] and fMatrix[1][2]
fMatrix[][0] the 3 elements fMatrix[0][0], fMatrix[1][0] and fMatrix[2][0]

"fEvent.fMatrix...." same as "fMatrix..." (unless there is more than one leaf named fMatrix!).

In summary, if a specific index is not specified for a dimension, TTree::Draw will loop through all the indices along this dimension. Leaving off the last (right most) dimension of specifying then with the two characters '[]' is equivalent. For variable size arrays (and TClonesArray) the range of the first dimension is recalculated for each entry of the tree. You can also specify the index as an expression of any other variables from the tree.

TTree::Draw also now properly handling operations involving 2 or more arrays.

Let assume a second matrix fResults[5][2], here are a sample of some of the possible combinations, the number of elements they produce and the loop used:

expression element(s) Loop
fMatrix[2][1] - fResults[5][2] one no loop
fMatrix[2][] - fResults[5][2] three on 2nd dim fMatrix
fMatrix[2][] - fResults[5][] two on both 2nd dimensions
fMatrix[][2] - fResults[][1] three on both 1st dimensions
fMatrix[][2] - fResults[][] six on both 1st and 2nd dimensions of fResults
fMatrix[][2] - fResults[3][] two on 1st dim of fMatrix and 2nd of fResults (at the same time)
fMatrix[][] - fResults[][] six on 1st dim then on 2nd dim
fMatrix[][fResult[][]] 30 on 1st dim of fMatrix then on both dimensions of fResults. The value if fResults[j][k] is used as the second index of fMatrix.

In summary, TTree::Draw loops through all unspecified dimensions. To figure out the range of each loop, we match each unspecified dimension from left to right (ignoring ALL dimensions for which an index has been specified), in the equivalent loop matched dimensions use the same index and are restricted to the smallest range (of only the matched dimensions). When involving variable arrays, the range can of course be different for each entry of the tree.

So the loop equivalent to "fMatrix[][2] - fResults[3][]" is:

for (Int_t i0; i < min(3,2); i++) {
use the value of (fMatrix[i0][2] - fMatrix[3][i0])
}

So the loop equivalent to "fMatrix[][2] - fResults[][]" is:

for (Int_t i0; i < min(3,5); i++) {
for (Int_t i1; i1 < 2; i1++) {
use the value of (fMatrix[i0][2] - fMatrix[i0][i1])
}
}

So the loop equivalent to "fMatrix[][] - fResults[][]" is:

for (Int_t i0; i < min(3,5); i++) {
for (Int_t i1; i1 < min(3,2); i1++) {
use the value of (fMatrix[i0][i1] - fMatrix[i0][i1])
}
}

So the loop equivalent to "fMatrix[][fResults[][]]" is:

for (Int_t i0; i0 < 3; i0++) {
for (Int_t j2; j2 < 5; j2++) {
for (Int_t j3; j3 < 2; j3++) {
i1 = fResults[j2][j3];
use the value of fMatrix[i0][i1]
}
}

Retrieving the result of Draw

By default a temporary histogram called htemp is created. It will be:

  • A TH1F* in case of a mono-dimensional distribution: Draw("e1"),
  • A TH2F* in case of a bi-dimensional distribution: Draw("e1:e2"),
  • A TH3F* in case of a three-dimensional distribution: Draw("e1:e2:e3").

In the one dimensional case the htemp is filled and drawn whatever the drawing option is.

In the two and three dimensional cases, with the default drawing option (""), a cloud of points is drawn and the histogram htemp is not filled. For all the other drawing options htemp will be filled.

In all cases htemp can be retrieved by calling:

auto htemp = (TH1F*)gPad->GetPrimitive("htemp"); // 1D
auto htemp = (TH2F*)gPad->GetPrimitive("htemp"); // 2D
auto htemp = (TH3F*)gPad->GetPrimitive("htemp"); // 3D
#define gPad
1-D histogram with a float per channel (see TH1 documentation)
Definition TH1.h:878
2-D histogram with a float per channel (see TH1 documentation)
Definition TH2.h:345
3-D histogram with a float per channel (see TH1 documentation)
Definition TH3.h:369

In the two dimensional case (Draw("e1;e2")), with the default drawing option, the data is filled into a TGraph named Graph. This TGraph can be retrieved by calling

auto graph = (TGraph*)gPad->GetPrimitive("Graph");

For the three and four dimensional cases, with the default drawing option, an unnamed TPolyMarker3D is produced, and therefore cannot be retrieved.

In all cases htemp can be used to access the axes. For instance in the 2D case:

auto htemp = (TH2F*)gPad->GetPrimitive("htemp");
auto xaxis = htemp->GetXaxis();

When the option "A" is used (with TGraph painting option) to draw a 2D distribution:

tree.Draw("e1:e2","","A*");

a scatter plot is produced (with stars in that case) but the axis creation is delegated to TGraph and htemp is not created.

Saving the result of Draw to a histogram

If varexp contains >>hnew (following the variable(s) name(s)), the new histogram called hnew is created and it is kept in the current directory (and also the current pad). This works for all dimensions.

Example:

tree.Draw("sqrt(x)>>hsqrt","y>0")

will draw sqrt(x) and save the histogram as "hsqrt" in the current directory. To retrieve it do:

TH1F *hsqrt = (TH1F*)gDirectory->Get("hsqrt");
#define gDirectory
Definition TDirectory.h:385

The binning information is taken from the environment variables

Hist.Binning.?D.?

In addition, the name of the histogram can be followed by up to 9 numbers between '(' and ')', where the numbers describe the following:

  • 1 - bins in x-direction
  • 2 - lower limit in x-direction
  • 3 - upper limit in x-direction
  • 4-6 same for y-direction
  • 7-9 same for z-direction

When a new binning is used the new value will become the default. Values can be skipped.

Example:

tree.Draw("sqrt(x)>>hsqrt(500,10,20)")
// plot sqrt(x) between 10 and 20 using 500 bins
tree.Draw("sqrt(x):sin(y)>>hsqrt(100,10,60,50,.1,.5)")
// plot sqrt(x) against sin(y)
// 100 bins in x-direction; lower limit on x-axis is 10; upper limit is 60
// 50 bins in y-direction; lower limit on y-axis is .1; upper limit is .5

By default, the specified histogram is reset. To continue to append data to an existing histogram, use "+" in front of the histogram name.

A '+' in front of the histogram name is ignored, when the name is followed by binning information as described in the previous paragraph.

tree.Draw("sqrt(x)>>+hsqrt","y>0")

will not reset hsqrt, but will continue filling. This works for 1-D, 2-D and 3-D histograms.

Accessing collection objects

TTree::Draw default's handling of collections is to assume that any request on a collection pertain to it content. For example, if fTracks is a collection of Track objects, the following:

tree->Draw("event.fTracks.fPx");

will plot the value of fPx for each Track objects inside the collection. Also

tree->Draw("event.fTracks.size()");

would plot the result of the member function Track::size() for each Track object inside the collection. To access information about the collection itself, TTree::Draw support the '@' notation. If a variable which points to a collection is prefixed or postfixed with '@', the next part of the expression will pertain to the collection object. For example:

tree->Draw("event.@fTracks.size()");

will plot the size of the collection referred to by fTracks (i.e the number of Track objects).

Drawing 'objects'

When a class has a member function named AsDouble or AsString, requesting to directly draw the object will imply a call to one of the 2 functions. If both AsDouble and AsString are present, AsDouble will be used. AsString can return either a char*, a std::string or a TString.s For example, the following

tree->Draw("event.myTTimeStamp");

will draw the same histogram as

tree->Draw("event.myTTimeStamp.AsDouble()");

In addition, when the object is a type TString or std::string, TTree::Draw will call respectively TString::Data and std::string::c_str()

If the object is a TBits, the histogram will contain the index of the bit that are turned on.

Retrieving information about the tree itself.

You can refer to the tree (or chain) containing the data by using the string 'This'. You can then could any TTree methods. For example:

tree->Draw("This->GetReadEntry()");

will display the local entry numbers be read.

tree->Draw("This->GetUserInfo()->At(0)->GetName()");

will display the name of the first 'user info' object.

Special functions and variables

Entry$: A TTree::Draw formula can use the special variable Entry$ to access the entry number being read. For example to draw every other entry use:

tree.Draw("myvar","Entry$%2==0");
  • Entry$ : return the current entry number (== TTree::GetReadEntry())
  • LocalEntry$ : return the current entry number in the current tree of a chain (== GetTree()->GetReadEntry())
  • Entries$ : return the total number of entries (== TTree::GetEntries())
  • LocalEntries$ : return the total number of entries in the current tree of a chain (== GetTree()->TTree::GetEntries())
  • Length$ : return the total number of element of this formula for this entry (==TTreeFormula::GetNdata())
  • Iteration$ : return the current iteration over this formula for this entry (i.e. varies from 0 to Length$ - 1).
  • Length$(formula ) : return the total number of element of the formula given as a parameter.
  • Sum$(formula ) : return the sum of the value of the elements of the formula given as a parameter. For example the mean for all the elements in one entry can be calculated with: Sum$(formula )/Length$(formula )
  • Min$(formula ) : return the minimum (within one TTree entry) of the value of the elements of the formula given as a parameter.
  • Max$(formula ) : return the maximum (within one TTree entry) of the value of the elements of the formula given as a parameter.
  • MinIf$(formula,condition)
  • MaxIf$(formula,condition) : return the minimum (maximum) (within one TTree entry) of the value of the elements of the formula given as a parameter if they match the condition. If no element matches the condition, the result is zero. To avoid the resulting peak at zero, use the pattern:
    tree->Draw("MinIf$(formula,condition)","condition");
    which will avoid calculation MinIf$ for the entries that have no match for the condition.
  • Alt$(primary,alternate) : return the value of "primary" if it is available for the current iteration otherwise return the value of "alternate". For example, with arr1[3] and arr2[2]
    tree->Draw("arr1+Alt$(arr2,0)");
    will draw arr1[0]+arr2[0] ; arr1[1]+arr2[1] and arr1[2]+0 Or with a variable size array arr3
    tree->Draw("Alt$(arr3[0],0)+Alt$(arr3[1],0)+Alt$(arr3[2],0)");
    will draw the sum arr3 for the index 0 to min(2,actual_size_of_arr3-1) As a comparison
    tree->Draw("arr3[0]+arr3[1]+arr3[2]");
    will draw the sum arr3 for the index 0 to 2 only if the actual_size_of_arr3 is greater or equal to 3. Note that the array in 'primary' is flattened/linearized thus using Alt$ with multi-dimensional arrays of different dimensions is unlikely to yield the expected results. To visualize a bit more what elements would be matched by TTree::Draw, TTree::Scan can be used:
    tree->Scan("arr1:Alt$(arr2,0)");
    will print on one line the value of arr1 and (arr2,0) that will be matched by
    tree->Draw("arr1-Alt$(arr2,0)");
    The ternary operator is not directly supported in TTree::Draw however, to plot the equivalent of var2<20 ? -99 : var1, you can use:
    tree->Draw("(var2<20)*99+(var2>=20)*var1","");

Drawing a user function accessing the TTree data directly

If the formula contains a file name, TTree::MakeProxy will be used to load and execute this file. In particular it will draw the result of a function with the same name as the file. The function will be executed in a context where the name of the branches can be used as a C++ variable.

For example draw px using the file hsimple.root (generated by the hsimple.C tutorial), we need a file named hsimple.cxx:

double hsimple() {
return px;
}

MakeProxy can then be used indirectly via the TTree::Draw interface as follow:

new TFile("hsimple.root")
ntuple->Draw("hsimple.cxx");
void Draw(Option_t *opt) override
Default Draw method for all objects.
Definition TTree.h:478

A more complete example is available in the tutorials directory: h1analysisProxy.cxx, h1analysProxy.h and h1analysisProxyCut.C which reimplement the selector found in h1analysis.C

The main features of this facility are:

  • on-demand loading of branches
  • ability to use the 'branchname' as if it was a data member
  • protection against array out-of-bound
  • ability to use the branch data as object (when the user code is available)

See TTree::MakeProxy for more details.

Making a Profile histogram

In case of a 2-Dim expression, one can generate a TProfile histogram instead of a TH2F histogram by specifying option=prof or option=profs or option=profi or option=profg ; the trailing letter select the way the bin error are computed, See TProfile2D::SetErrorOption for details on the differences. The option=prof is automatically selected in case of y:x>>pf where pf is an existing TProfile histogram.

Making a 2D Profile histogram

In case of a 3-Dim expression, one can generate a TProfile2D histogram instead of a TH3F histogram by specifying option=prof or option=profs. or option=profi or option=profg ; the trailing letter select the way the bin error are computed, See TProfile2D::SetErrorOption for details on the differences. The option=prof is automatically selected in case of z:y:x>>pf where pf is an existing TProfile2D histogram.

Making a 5D plot using GL

If option GL5D is specified together with 5 variables, a 5D plot is drawn using OpenGL. See tree502_staff.C as example.

Making a parallel coordinates plot

In case of a 2-Dim or more expression with the option=para, one can generate a parallel coordinates plot. With that option, the number of dimensions is arbitrary. Giving more than 4 variables without the option=para or option=candle or option=goff will produce an error.

Making a candle sticks chart

In case of a 2-Dim or more expression with the option=candle, one can generate a candle sticks chart. With that option, the number of dimensions is arbitrary. Giving more than 4 variables without the option=para or option=candle or option=goff will produce an error.

Normalizing the output histogram to 1

When option contains "norm" the output histogram is normalized to 1.

Saving the result of Draw to a TEventList, a TEntryList or a TEntryListArray

TTree::Draw can be used to fill a TEventList object (list of entry numbers) instead of histogramming one variable. If varexp0 has the form >>elist , a TEventList object named "elist" is created in the current directory. elist will contain the list of entry numbers satisfying the current selection. If option "entrylist" is used, a TEntryList object is created If the selection contains arrays, vectors or any container class and option "entrylistarray" is used, a TEntryListArray object is created containing also the subentries satisfying the selection, i.e. the indices of the branches which hold containers classes. Example:

tree.Draw(">>yplus","y>0")

will create a TEventList object named "yplus" in the current directory. In an interactive session, one can type (after TTree::Draw)

yplus.Print("all")

to print the list of entry numbers in the list.

tree.Draw(">>yplus", "y>0", "entrylist")

will create a TEntryList object names "yplus" in the current directory

tree.Draw(">>yplus", "y>0", "entrylistarray")

will create a TEntryListArray object names "yplus" in the current directory

By default, the specified entry list is reset. To continue to append data to an existing list, use "+" in front of the list name;

tree.Draw(">>+yplus","y>0")

will not reset yplus, but will enter the selected entries at the end of the existing list.

Using a TEventList, TEntryList or TEntryListArray as Input

Once a TEventList or a TEntryList object has been generated, it can be used as input for TTree::Draw. Use TTree::SetEventList or TTree::SetEntryList to set the current event list

Example 1:

TEventList *elist = (TEventList*)gDirectory->Get("yplus");
tree->SetEventList(elist);
tree->Draw("py");
<div class="legacybox"><h2>Legacy Code</h2> TEventList is a legacy interface: there will be no bug fi...
Definition TEventList.h:31

Example 2:

TEntryList *elist = (TEntryList*)gDirectory->Get("yplus");
tree->SetEntryList(elist);
tree->Draw("py");

If a TEventList object is used as input, a new TEntryList object is created inside the SetEventList function. In case of a TChain, all tree headers are loaded for this transformation. This new object is owned by the chain and is deleted with it, unless the user extracts it by calling GetEntryList() function. See also comments to SetEventList() function of TTree and TChain.

If arrays are used in the selection criteria and TEntryListArray is not used, all the entries that have at least one element of the array that satisfy the selection are entered in the list.

Example:

tree.Draw(">>pyplus","fTracks.fPy>0");
tree->SetEventList(pyplus);
tree->Draw("fTracks.fPy");

will draw the fPy of ALL tracks in event with at least one track with a positive fPy.

To select only the elements that did match the original selection use TEventList::SetReapplyCut or TEntryList::SetReapplyCut.

Example:

tree.Draw(">>pyplus","fTracks.fPy>0");
pyplus->SetReapplyCut(true);
tree->SetEventList(pyplus);
tree->Draw("fTracks.fPy");

will draw the fPy of only the tracks that have a positive fPy.

To draw only the elements that match a selection in case of arrays, you can also use TEntryListArray (faster in case of a more general selection).

Example:

tree.Draw(">>pyplus","fTracks.fPy>0", "entrylistarray");
tree->SetEntryList(pyplus);
tree->Draw("fTracks.fPy");

will draw the fPy of only the tracks that have a positive fPy, but without redoing the selection.

Note: Use tree->SetEventList(0) if you do not want use the list as input.

How to obtain more info from TTree::Draw

Once TTree::Draw has been called, it is possible to access useful information still stored in the TTree object via the following functions:

  • GetSelectedRows() // return the number of values accepted by the selection expression. In case where no selection was specified, returns the number of values processed.
  • GetV1() // returns a pointer to the double array of V1
  • GetV2() // returns a pointer to the double array of V2
  • GetV3() // returns a pointer to the double array of V3
  • GetV4() // returns a pointer to the double array of V4
  • GetW() // returns a pointer to the double array of Weights where weight equal the result of the selection expression.

where V1,V2,V3 correspond to the expressions in

TTree::Draw("V1:V2:V3:V4",selection);

If the expression has more than 4 component use GetVal(index)

Example:

Root > ntuple->Draw("py:px","pz>4");
Root > TGraph *gr = new TGraph(ntuple->GetSelectedRows(),
ntuple->GetV2(), ntuple->GetV1());
Root > gr->Draw("ap"); //draw graph in current pad
TGraphErrors * gr
Definition legend1.C:25

A more complete complete tutorial (treegetval.C) shows how to use the GetVal() method.

creates a TGraph object with a number of points corresponding to the number of entries selected by the expression "pz>4", the x points of the graph being the px values of the Tree and the y points the py values.

Important note: By default TTree::Draw creates the arrays obtained with GetW, GetV1, GetV2, GetV3, GetV4, GetVal with a length corresponding to the parameter fEstimate. The content will be the last GetSelectedRows() % GetEstimate() values calculated. By default fEstimate=1000000 and can be modified via TTree::SetEstimate. To keep in memory all the results (in case where there is only one result per entry), use

tree->SetEstimate(tree->GetEntries()+1); // same as tree->SetEstimate(-1);

You must call SetEstimate if the expected number of selected rows you need to look at is greater than 1000000.

You can use the option "goff" to turn off the graphics output of TTree::Draw in the above example.

Automatic interface to TTree::Draw via the TTreeViewer

A complete graphical interface to this function is implemented in the class TTreeViewer. To start the TTreeViewer, three possibilities:

  • select TTree context menu item "StartViewer"
  • type the command "TTreeViewer TV(treeName)"
  • execute statement "tree->StartViewer();"

Reimplemented in TChain.

Definition at line 4557 of file TTree.cxx.

◆ Draw() [2/3]

Long64_t TTree::Draw ( const char * varexp,
const TCut & selection,
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Draw expression varexp for specified entries.

Returns
-1 in case of error or number of selected events in case of success. If selection involves an array variable x[n], for example x[] > 0 or x > 0, then we return the number of selected instances rather than number of events. In the output of tree.Scan(), instances are shown in individual printed rows, thus each event (tree entry) is split across the various instances (lines) of the array. In contrast, the function GetEntries(selection) always returns the number of entries selected.

This function accepts TCut objects as arguments. Useful to use the string operator +

Example:

ntuple.Draw("x",cut1+cut2+cut3);

Reimplemented in TChain.

Definition at line 3900 of file TTree.cxx.

◆ Draw() [3/3]

void TTree::Draw ( Option_t * option)
inlineoverridevirtualinherited

Default Draw method for all objects.

Reimplemented from TObject.

Definition at line 478 of file TTree.h.

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

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

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

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

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

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

If pad was not selected - gPad will be used.

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

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

Definition at line 319 of file TObject.cxx.

◆ DropBaskets()

void TTree::DropBaskets ( )
virtualinherited

Remove some baskets from memory.

Definition at line 4568 of file TTree.cxx.

◆ DropBranchFromCache() [1/2]

Int_t TTree::DropBranchFromCache ( const char * bname,
bool subbranches = false )
virtualinherited

Remove the branch with name 'bname' from the Tree cache.

If bname="*" all branches are removed from the cache. if subbranches is true all the branches of the subbranches are also removed from the cache.

Returns:

  • 0 branch dropped or not in cache
  • -1 on error

Definition at line 1169 of file TTree.cxx.

◆ DropBranchFromCache() [2/2]

Int_t TTree::DropBranchFromCache ( TBranch * b,
bool subbranches = false )
virtualinherited

Remove the branch b from the Tree cache.

if subbranches is true all the branches of the subbranches are also removed from the cache.

Returns:

  • 0 branch dropped or not in cache
  • -1 on error

Definition at line 1208 of file TTree.cxx.

◆ DropBuffers()

void TTree::DropBuffers ( Int_t nbytes)
virtualinherited

Drop branch buffers to accommodate nbytes below MaxVirtualsize.

Definition at line 4581 of file TTree.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

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

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
Style_t fFillStyle
Fill area style.
Definition TAttFill.h:25
Color_t fFillColor
Fill area color.
Definition TAttFill.h:24
Width_t fLineWidth
Line width.
Definition TAttLine.h:26
Style_t fLineStyle
Line style.
Definition TAttLine.h:25
Color_t fLineColor
Line color.
Definition TAttLine.h:24
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

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

Definition at line 367 of file TObject.cxx.

◆ EnableCache()

bool TTree::EnableCache ( )
inherited

Enable the TTreeCache unless explicitly disabled for this TTree by a prior call to SetCacheSize(0).

If the environment variable ROOT_TTREECACHE_SIZE or the rootrc config TTreeCache.Size has been set to zero, this call will over-ride them with a value of 1.0 (i.e. use a cache size to hold 1 cluster)

Return true if there is a cache attached to the TTree (either pre-exisiting or created as part of this call)

Definition at line 2715 of file TTree.cxx.

◆ Error()

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

Issue error message.

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

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

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

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

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

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

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

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

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

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

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

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ Fatal()

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

Issue fatal error message.

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

Definition at line 1126 of file TObject.cxx.

◆ Fill()

Int_t TTreeSQL::Fill ( )
overridevirtual

Copy the information from the user object to the TTree.

Reimplemented from TTree.

Definition at line 569 of file TTreeSQL.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ FindBranch()

TBranch * TTree::FindBranch ( const char * branchname)
virtualinherited

Return the branch that correspond to the path 'branchname', which can include the name of the tree or the omitted name of the parent branches.

In case of ambiguity, returns the first match.

See also
TTree::GetBranch

Reimplemented in TChain.

Definition at line 4890 of file TTree.cxx.

◆ FindLeaf()

TLeaf * TTree::FindLeaf ( const char * name)
virtualinherited

Find first leaf containing searchname.

Reimplemented in TChain.

Definition at line 4965 of file TTree.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

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 RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

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 RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ Fit()

Int_t TTree::Fit ( const char * funcname,
const char * varexp,
const char * selection = "",
Option_t * option = "",
Option_t * goption = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Fit a projected item(s) from a tree.

funcname is a TF1 function.

See TTree::Draw() for explanations of the other parameters.

By default the temporary histogram created is called htemp. If varexp contains >>hnew , the new histogram created is called hnew and it is kept in the current directory.

The function returns the number of selected entries.

Example:

tree.Fit(pol4,"sqrt(x)>>hsqrt","y>0")

will fit sqrt(x) and save the histogram as "hsqrt" in the current directory.

See also TTree::UnbinnedFit

Return status

The function returns the status of the histogram fit (see TH1::Fit) If no entries were selected, the function returns -1; (i.e. fitResult is null if the fit is OK)

Definition at line 5128 of file TTree.cxx.

◆ FlushBaskets()

Int_t TTree::FlushBaskets ( bool create_cluster = true) const
virtualinherited

Write to disk all the basket that have not yet been individually written and create an event cluster boundary (by default).

If the caller wishes to flush the baskets but not create an event cluster, then set create_cluster to false.

If ROOT has IMT-mode enabled, this will launch multiple TBB tasks in parallel via TThreadExecutor to do this operation; one per basket compression. If the caller utilizes TBB also, care must be taken to prevent deadlocks.

For example, let's say the caller holds mutex A and calls FlushBaskets; while TBB is waiting for the ROOT compression tasks to complete, it may decide to run another one of the user's tasks in this thread. If the second user task tries to acquire A, then a deadlock will occur. The example call sequence looks like this:

  • User acquires mutex A
  • User calls FlushBaskets.
  • ROOT launches N tasks and calls wait.
  • TBB schedules another user task, T2.
  • T2 tries to acquire mutex A.

At this point, the thread will deadlock: the code may function with IMT-mode disabled if the user assumed the legacy code never would run their own TBB tasks.

SO: users of TBB who want to enable IMT-mode should carefully review their locking patterns and make sure they hold no coarse-grained application locks when they invoke ROOT.

Return the number of bytes written or -1 in case of write error.

Definition at line 5178 of file TTree.cxx.

◆ FlushBasketsImpl()

Int_t TTree::FlushBasketsImpl ( ) const
privateinherited

Internal implementation of the FlushBaskets algorithm.

Unlike the public interface, this does NOT create an explicit event cluster boundary; it is up to the (internal) caller to determine whether that should done.

Otherwise, the comments for FlushBaskets applies.

Definition at line 5195 of file TTree.cxx.

◆ GetAlias()

const char * TTree::GetAlias ( const char * aliasName) const
virtualinherited

Returns the expanded value of the alias. Search in the friends if any.

Reimplemented in TChain.

Definition at line 5275 of file TTree.cxx.

◆ GetAllocationCount()

UInt_t TTree::GetAllocationCount ( ) const
inlineinherited

Definition at line 490 of file TTree.h.

◆ GetAutoFlush()

virtual Long64_t TTree::GetAutoFlush ( ) const
inlinevirtualinherited

Definition at line 494 of file TTree.h.

◆ GetAutoSave()

virtual Long64_t TTree::GetAutoSave ( ) const
inlinevirtualinherited

Definition at line 495 of file TTree.h.

◆ GetBranch()

TBranch * TTree::GetBranch ( const char * name)
virtualinherited

Return pointer to the branch with the given name in this tree or its friends.

The search is done breadth first.

See also
TTree::FindBranch

Reimplemented in TChain.

Definition at line 5430 of file TTree.cxx.

◆ GetBranchFromFriends()

TBranch * TTree::GetBranchFromFriends ( const char * branchName)
protectedinherited

Returns a pointer to the branch with the given name, if it can be found in the list of friends of this tree.

Otherwise, returns nullptr.

Definition at line 5378 of file TTree.cxx.

◆ GetBranchFromSelf()

TBranch * TTree::GetBranchFromSelf ( const char * branchName)
protectedinherited

Returns a pointer to the branch with the given name, if it can be found in this tree.

Otherwise, returns nullptr.

Definition at line 5342 of file TTree.cxx.

◆ GetBranchRef()

virtual TBranchRef * TTree::GetBranchRef ( ) const
inlinevirtualinherited

Definition at line 497 of file TTree.h.

◆ GetBranchStatus()

bool TTree::GetBranchStatus ( const char * branchname) const
virtualinherited

Return status of branch with name branchname.

  • 0 if branch is not activated
  • 1 if branch is activated

Reimplemented in TChain.

Definition at line 5456 of file TTree.cxx.

◆ GetBranchStyle()

Int_t TTree::GetBranchStyle ( )
staticinherited

Static function returning the current branch style.

  • style = 0 old Branch
  • style = 1 new Bronch

Definition at line 5471 of file TTree.cxx.

◆ GetCacheAutoSize()

Long64_t TTree::GetCacheAutoSize ( bool withDefault = false)
protectedinherited

Used for automatic sizing of the cache.

Estimates a suitable size in bytes for the tree cache based on AutoFlush. A cache sizing factor is taken from the configuration. If this yields zero and withDefault is true the historical algorithm for default size is used.

Definition at line 5483 of file TTree.cxx.

◆ GetCacheSize()

virtual Long64_t TTree::GetCacheSize ( ) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 500 of file TTree.h.

◆ GetChainEntryNumber()

virtual Long64_t TTree::GetChainEntryNumber ( Long64_t entry) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 502 of file TTree.h.

◆ GetChainOffset()

virtual Long64_t TTree::GetChainOffset ( ) const
inlinevirtualinherited

Definition at line 503 of file TTree.h.

◆ GetClusterIterator()

TTree::TClusterIterator TTree::GetClusterIterator ( Long64_t firstentry)
virtualinherited

Return an iterator over the cluster of baskets starting at firstentry.

This iterator is not yet supported for TChain object.

TTree::TClusterIterator clusterIter = tree->GetClusterIterator(entry);
Long64_t clusterStart;
while( (clusterStart = clusterIter()) < tree->GetEntries() ) {
printf("The cluster starts at %lld and ends at %lld (inclusive)\n",clusterStart,clusterIter.GetNextEntry()-1);
}
long long Long64_t
Portable signed long integer 8 bytes.
Definition RtypesCore.h:83
Helper class to iterate over cluster of baskets.
Definition TTree.h:314
Long64_t GetNextEntry()
Definition TTree.h:351

Reimplemented in TChain.

Definition at line 5543 of file TTree.cxx.

◆ GetClusterPrefetch()

virtual bool TTree::GetClusterPrefetch ( ) const
inlinevirtualinherited

Definition at line 504 of file TTree.h.

◆ GetColumnIndice()

std::vector< Int_t > * TTreeSQL::GetColumnIndice ( TBranch * branch)
protected

Return a vector of columns index corresponding to the current SQL table and the branch given as argument Returns 0 if no columns indices is found Otherwise returns a pointer to a vector to be deleted by the caller.

Definition at line 621 of file TTreeSQL.cxx.

◆ GetCurrentFile()

TFile * TTree::GetCurrentFile ( ) const
inherited

Return pointer to the current file.

Definition at line 5555 of file TTree.cxx.

◆ GetDebugMax()

Long64_t TTree::GetDebugMax ( ) const
inlineinherited

Definition at line 507 of file TTree.h.

◆ GetDebugMin()

Long64_t TTree::GetDebugMin ( ) const
inlineinherited

Definition at line 508 of file TTree.h.

◆ GetDefaultEntryOffsetLen()

Int_t TTree::GetDefaultEntryOffsetLen ( ) const
inlineinherited

Definition at line 506 of file TTree.h.

◆ GetDirectory()

TDirectory * TTree::GetDirectory ( ) const
inlineinherited

Definition at line 509 of file TTree.h.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

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

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

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

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEntries() [1/2]

Long64_t TTreeSQL::GetEntries ( ) const
overridevirtual

Get the number of rows in the database.

Reimplemented from TTree.

Definition at line 687 of file TTreeSQL.cxx.

◆ GetEntries() [2/2]

Long64_t TTreeSQL::GetEntries ( const char * selection)
inlineoverridevirtual

Return the number of entries matching the selection.

Return -1 in case of errors.

If the selection uses any arrays or containers, we return the number of entries where at least one element match the selection. GetEntries is implemented using the selector class TSelectorEntries, which can be used directly (see code in TTreePlayer::GetEntries) for additional option. If SetEventList was used on the TTree or TChain, only that subset of entries will be considered.

Reimplemented from TTree.

Definition at line 87 of file TTreeSQL.h.

◆ GetEntriesFast()

Long64_t TTreeSQL::GetEntriesFast ( ) const
overridevirtual

Return the number of entries as of the last check.

Use GetEntries for a more accurate count.

Reimplemented from TTree.

Definition at line 720 of file TTreeSQL.cxx.

◆ GetEntriesFriend()

Long64_t TTree::GetEntriesFriend ( ) const
virtualinherited

Returns a number corresponding to:

  • The number of entries in this tree, if greater than zero
  • The number of entries in the first friend tree, if there are any friends
  • 0 otherwise

Definition at line 5590 of file TTree.cxx.

◆ GetEntry()

Int_t TTreeSQL::GetEntry ( Long64_t entry = 0,
Int_t getall = 0 )
overridevirtual

Load the data for the entry from the database.

Reimplemented from TTree.

Definition at line 728 of file TTreeSQL.cxx.

◆ GetEntryList()

TEntryList * TTree::GetEntryList ( )
virtualinherited

Returns the entry list assigned to this tree.

Definition at line 5934 of file TTree.cxx.

◆ GetEntryNumber()

Long64_t TTree::GetEntryNumber ( Long64_t entry) const
virtualinherited

Return entry number corresponding to entry.

if no TEntryList set returns entry else returns the entry number corresponding to the list index=entry

Reimplemented in TChain.

Definition at line 5945 of file TTree.cxx.

◆ GetEntryNumberWithBestIndex()

Long64_t TTree::GetEntryNumberWithBestIndex ( Long64_t major,
Long64_t minor = 0 ) const
virtualinherited

Return entry number corresponding to major and minor number.

Note that this function returns only the entry number, not the data To read the data corresponding to an entry number, use TTree::GetEntryWithIndex the BuildIndex function has created a table of Long64_t* of sorted values corresponding to val = major<<31 + minor; The function performs binary search in this sorted table. If it finds a pair that matches val, it returns directly the index in the table. If an entry corresponding to major and minor is not found, the function returns the index of the major,minor pair immediately lower than the requested value, ie it will return -1 if the pair is lower than the first entry in the index.

See also GetEntryNumberWithIndex

Definition at line 5970 of file TTree.cxx.

◆ GetEntryNumberWithIndex()

Long64_t TTree::GetEntryNumberWithIndex ( Long64_t major,
Long64_t minor = 0 ) const
virtualinherited

Return entry number corresponding to major and minor number.

Note that this function returns only the entry number, not the data To read the data corresponding to an entry number, use TTree::GetEntryWithIndex the BuildIndex function has created a table of Long64_t* of sorted values corresponding to val = major<<31 + minor; The function performs binary search in this sorted table. If it finds a pair that matches val, it returns directly the index in the table, otherwise it returns -1.

See also GetEntryNumberWithBestIndex

Definition at line 5990 of file TTree.cxx.

◆ GetEntryWithIndex()

Int_t TTree::GetEntryWithIndex ( Long64_t major,
Long64_t minor = 0 )
virtualinherited

Read entry corresponding to major and minor number.

The function returns the total number of bytes read; -1 if entry not found. If the Tree has friend trees, the corresponding entry with the index values (major,minor) is read. Note that the master Tree and its friend may have different entry serial numbers corresponding to (major,minor).

Note
See TTreeIndex::GetEntryNumberWithIndex for information about the maximum values accepted for major and minor

Reimplemented in TChain.

Definition at line 6008 of file TTree.cxx.

◆ GetEstimate()

virtual Long64_t TTree::GetEstimate ( ) const
inlinevirtualinherited

Definition at line 554 of file TTree.h.

◆ GetEvent()

Int_t TTree::GetEvent ( Long64_t entry,
Int_t getall = 0 )
inlineinherited

Definition at line 556 of file TTree.h.

◆ GetEventList()

TEventList * TTree::GetEventList ( ) const
inlineinherited

Definition at line 560 of file TTree.h.

◆ GetFileNumber()

virtual Int_t TTree::GetFileNumber ( ) const
inlinevirtualinherited

Definition at line 563 of file TTree.h.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const
inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const
inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetFriend()

TTree * TTree::GetFriend ( const char * friendname) const
virtualinherited

Return a pointer to the TTree friend whose name or alias is friendname.

Definition at line 6056 of file TTree.cxx.

◆ GetFriendAlias()

const char * TTree::GetFriendAlias ( TTree * tree) const
virtualinherited

If the 'tree' is a friend, this method returns its alias name.

This alias is an alternate name for the tree.

It can be used in conjunction with a branch or leaf name in a TTreeFormula, to specify in which particular tree the branch or leaf can be found if the friend trees have branches or leaves with the same name as the master tree.

It can also be used in conjunction with an alias created using TTree::SetAlias in a TTreeFormula, e.g.:

maintree->Draw("treealias.fPx - treealias.myAlias");

where fPx is a branch of the friend tree aliased as 'treealias' and 'myAlias' was created using TTree::SetAlias on the friend tree.

However, note that 'treealias.myAlias' will be expanded literally, without remembering that it comes from the aliased friend and thus the branch name might not be disambiguated properly, which means that you may not be able to take advantage of this feature.

Definition at line 6113 of file TTree.cxx.

◆ GetHistogram()

TH1 * TTree::GetHistogram ( )
inlineinherited

Definition at line 566 of file TTree.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

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

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

Definition at line 472 of file TObject.cxx.

◆ GetImplicitMT()

virtual bool TTree::GetImplicitMT ( )
inlinevirtualinherited

Definition at line 567 of file TTree.h.

◆ GetIndex()

virtual Int_t * TTree::GetIndex ( )
inlinevirtualinherited

Definition at line 568 of file TTree.h.

◆ GetIndexValues()

virtual Double_t * TTree::GetIndexValues ( )
inlinevirtualinherited

Definition at line 569 of file TTree.h.

◆ GetIOFeatures()

ROOT::TIOFeatures TTree::GetIOFeatures ( ) const
inherited

Returns the current set of IO settings.

Definition at line 6185 of file TTree.cxx.

◆ GetIteratorOnAllLeaves()

TIterator * TTree::GetIteratorOnAllLeaves ( bool dir = kIterForward)
virtualinherited

Creates a new iterator that will go through all the leaves on the tree itself and its friend.

Definition at line 6193 of file TTree.cxx.

◆ GetLeaf() [1/2]

TLeaf * TTree::GetLeaf ( const char * branchname,
const char * leafname )
virtualinherited

Return pointer to the 1st Leaf named name in any Branch of this Tree or any branch in the list of friend trees.

The leaf name can contain the name of a friend tree with the syntax: friend_dir_and_tree.full_leaf_name the friend_dir_and_tree can be of the form:

TDirectoryName/TreeName 

Reimplemented in TChain.

Definition at line 6306 of file TTree.cxx.

◆ GetLeaf() [2/2]

TLeaf * TTree::GetLeaf ( const char * name)
virtualinherited

Return pointer to first leaf named "name" in any branch of this tree or its friend trees.

Parameters
[in]namemay be in the form 'branch/leaf'

Reimplemented in TChain.

Definition at line 6326 of file TTree.cxx.

◆ GetLeafImpl()

TLeaf * TTree::GetLeafImpl ( const char * branchname,
const char * leafname )
protectedvirtualinherited

Return pointer to the 1st Leaf named name in any Branch of this Tree or any branch in the list of friend trees.

The leaf name can contain the name of a friend tree with the syntax: friend_dir_and_tree.full_leaf_name the friend_dir_and_tree can be of the form:

TDirectoryName/TreeName

Definition at line 6209 of file TTree.cxx.

◆ GetLineColor()

virtual Color_t TAttLine::GetLineColor ( ) const
inlinevirtualinherited

Return the line color.

Reimplemented in TGraphMultiErrors, and TGWin32VirtualXProxy.

Definition at line 36 of file TAttLine.h.

◆ GetLineStyle()

virtual Style_t TAttLine::GetLineStyle ( ) const
inlinevirtualinherited

Return the line style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 37 of file TAttLine.h.

◆ GetLineWidth()

virtual Width_t TAttLine::GetLineWidth ( ) const
inlinevirtualinherited

Return the line width.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 38 of file TAttLine.h.

◆ GetListOfAliases()

virtual TList * TTree::GetListOfAliases ( ) const
inlinevirtualinherited

Definition at line 578 of file TTree.h.

◆ GetListOfBranches()

virtual TObjArray * TTree::GetListOfBranches ( )
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 575 of file TTree.h.

◆ GetListOfClones()

virtual TList * TTree::GetListOfClones ( )
inlinevirtualinherited

Definition at line 574 of file TTree.h.

◆ GetListOfFriends()

virtual TList * TTree::GetListOfFriends ( ) const
inlinevirtualinherited

Definition at line 577 of file TTree.h.

◆ GetListOfLeaves()

virtual TObjArray * TTree::GetListOfLeaves ( )
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 576 of file TTree.h.

◆ GetMakeClass()

Int_t TTree::GetMakeClass ( ) const
inlineinherited

Definition at line 582 of file TTree.h.

◆ GetMarkerColor()

virtual Color_t TAttMarker::GetMarkerColor ( ) const
inlinevirtualinherited

Return the marker color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 33 of file TAttMarker.h.

◆ GetMarkerLineWidth()

Width_t TAttMarker::GetMarkerLineWidth ( Style_t style)
staticinherited

◆ GetMarkerSize()

virtual Size_t TAttMarker::GetMarkerSize ( ) const
inlinevirtualinherited

Return the marker size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 35 of file TAttMarker.h.

◆ GetMarkerStyle()

virtual Style_t TAttMarker::GetMarkerStyle ( ) const
inlinevirtualinherited

Return the marker style.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 34 of file TAttMarker.h.

◆ GetMarkerStyleBase()

Style_t TAttMarker::GetMarkerStyleBase ( Style_t style)
staticinherited

◆ GetMaxEntryLoop()

virtual Long64_t TTree::GetMaxEntryLoop ( ) const
inlinevirtualinherited

Definition at line 584 of file TTree.h.

◆ GetMaximum()

Double_t TTree::GetMaximum ( const char * columname)
virtualinherited

Return maximum of column with name columname.

if the Tree has an associated TEventList or TEntryList, the maximum is computed for the entries in this list.

Reimplemented in TChain.

Definition at line 6346 of file TTree.cxx.

◆ GetMaxTreeSize()

Long64_t TTree::GetMaxTreeSize ( )
staticinherited

Static function which returns the tree file size limit in bytes.

Definition at line 6376 of file TTree.cxx.

◆ GetMaxVirtualSize()

virtual Long64_t TTree::GetMaxVirtualSize ( ) const
inlinevirtualinherited

Definition at line 587 of file TTree.h.

◆ GetMedianClusterSize()

Long64_t TTree::GetMedianClusterSize ( )
privateinherited

Estimate the median cluster size for the TTree.

This value provides e.g. a reasonable cache size default if other heuristics fail. Clusters with size 0 and the very last cluster range, that might not have been committed to fClusterSize yet, are ignored for the purposes of the calculation.

Definition at line 8504 of file TTree.cxx.

◆ GetMinimum()

Double_t TTree::GetMinimum ( const char * columname)
virtualinherited

Return minimum of column with name columname.

if the Tree has an associated TEventList or TEntryList, the minimum is computed for the entries in this list.

Reimplemented in TChain.

Definition at line 6386 of file TTree.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

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

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNbranches()

virtual Int_t TTree::GetNbranches ( )
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 589 of file TTree.h.

◆ GetNewlineValue()

char TTree::GetNewlineValue ( std::istream & inputStream)
protectedinherited

Determine which newline this file is using.

Return '\r' for Windows '\r\n' as that already terminates.

Definition at line 7781 of file TTree.cxx.

◆ GetNotify()

TObject * TTree::GetNotify ( ) const
inlineinherited

Definition at line 590 of file TTree.h.

◆ GetObjectInfo()

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

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

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

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

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetPacketSize()

virtual Int_t TTree::GetPacketSize ( ) const
inlinevirtualinherited

Definition at line 592 of file TTree.h.

◆ GetPerfStats()

virtual TVirtualPerfStats * TTree::GetPerfStats ( ) const
inlinevirtualinherited

Definition at line 593 of file TTree.h.

◆ GetPlayer()

TVirtualTreePlayer * TTree::GetPlayer ( )
inherited

Load the TTreePlayer (if not already done).

Definition at line 6416 of file TTree.cxx.

◆ GetReadCache() [1/2]

TTreeCache * TTree::GetReadCache ( TFile * file) const
inherited

Find and return the TTreeCache registered with the file and which may contain branches for us.

Definition at line 6429 of file TTree.cxx.

◆ GetReadCache() [2/2]

TTreeCache * TTree::GetReadCache ( TFile * file,
bool create )
inherited

Find and return the TTreeCache registered with the file and which may contain branches for us.

If create is true and there is no cache a new cache is created with default size.

Definition at line 6442 of file TTree.cxx.

◆ GetReadEntry()

virtual Long64_t TTree::GetReadEntry ( ) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 596 of file TTree.h.

◆ GetReadEvent()

virtual Long64_t TTree::GetReadEvent ( ) const
inlinevirtualinherited

Definition at line 597 of file TTree.h.

◆ GetScanField()

virtual Int_t TTree::GetScanField ( ) const
inlinevirtualinherited

Definition at line 598 of file TTree.h.

◆ GetSelect()

TTreeFormula * TTree::GetSelect ( )
inlineinherited

Definition at line 599 of file TTree.h.

◆ GetSelectedRows()

virtual Long64_t TTree::GetSelectedRows ( )
inlinevirtualinherited

Definition at line 600 of file TTree.h.

◆ GetTableName()

TString TTreeSQL::GetTableName ( )
inline

Definition at line 89 of file TTreeSQL.h.

◆ GetTargetMemoryRatio()

Float_t TTree::GetTargetMemoryRatio ( ) const
inlineinherited

Definition at line 607 of file TTree.h.

◆ GetTimerInterval()

virtual Int_t TTree::GetTimerInterval ( ) const
inlinevirtualinherited

Definition at line 601 of file TTree.h.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

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 from TObject.

Definition at line 50 of file TNamed.h.

◆ GetTotBytes()

virtual Long64_t TTree::GetTotBytes ( ) const
inlinevirtualinherited

Definition at line 603 of file TTree.h.

◆ GetTransientBuffer()

TBuffer * TTree::GetTransientBuffer ( Int_t size)
inherited

Returns the transient buffer currently used by this TTree for reading/writing baskets.

Definition at line 1064 of file TTree.cxx.

◆ GetTree()

virtual TTree * TTree::GetTree ( ) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 604 of file TTree.h.

◆ GetTreeIndex()

virtual TVirtualIndex * TTree::GetTreeIndex ( ) const
inlinevirtualinherited

Definition at line 605 of file TTree.h.

◆ GetTreeNumber()

virtual Int_t TTree::GetTreeNumber ( ) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 606 of file TTree.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetUpdate()

virtual Int_t TTree::GetUpdate ( ) const
inlinevirtualinherited

Definition at line 608 of file TTree.h.

◆ GetUserInfo()

TList * TTree::GetUserInfo ( )
virtualinherited

Return a pointer to the list containing user objects associated to this tree.

The list is automatically created if it does not exist.

WARNING: By default the TTree destructor will delete all objects added to this list. If you do not want these objects to be deleted, call:

mytree->GetUserInfo()->Clear();

before deleting the tree.

Definition at line 6467 of file TTree.cxx.

◆ GetV1()

virtual Double_t * TTree::GetV1 ( )
inlinevirtualinherited

Definition at line 623 of file TTree.h.

◆ GetV2()

virtual Double_t * TTree::GetV2 ( )
inlinevirtualinherited

Definition at line 625 of file TTree.h.

◆ GetV3()

virtual Double_t * TTree::GetV3 ( )
inlinevirtualinherited

Definition at line 627 of file TTree.h.

◆ GetV4()

virtual Double_t * TTree::GetV4 ( )
inlinevirtualinherited

Definition at line 629 of file TTree.h.

◆ GetVal()

virtual Double_t * TTree::GetVal ( Int_t i)
inlinevirtualinherited

Definition at line 621 of file TTree.h.

◆ GetVar()

TTreeFormula * TTree::GetVar ( Int_t i)
inlineinherited

Definition at line 611 of file TTree.h.

◆ GetVar1()

TTreeFormula * TTree::GetVar1 ( )
inlineinherited

Definition at line 613 of file TTree.h.

◆ GetVar2()

TTreeFormula * TTree::GetVar2 ( )
inlineinherited

Definition at line 615 of file TTree.h.

◆ GetVar3()

TTreeFormula * TTree::GetVar3 ( )
inlineinherited

Definition at line 617 of file TTree.h.

◆ GetVar4()

TTreeFormula * TTree::GetVar4 ( )
inlineinherited

Definition at line 619 of file TTree.h.

◆ GetW()

virtual Double_t * TTree::GetW ( )
inlinevirtualinherited

Definition at line 630 of file TTree.h.

◆ GetWeight()

virtual Double_t TTree::GetWeight ( ) const
inlinevirtualinherited

Reimplemented in TChain.

Definition at line 631 of file TTree.h.

◆ GetZipBytes()

virtual Long64_t TTree::GetZipBytes ( ) const
inlinevirtualinherited

Definition at line 632 of file TTree.h.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

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

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

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

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

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

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

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

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

missing call to RecursiveRemove in destructor).

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

Definition at line 366 of file TObject.h.

◆ ImportClusterRanges()

void TTree::ImportClusterRanges ( TTree * fromtree)
protectedinherited

Appends the cluster range information stored in 'fromtree' to this tree, including the value of fAutoFlush.

This is used when doing a fast cloning (by TTreeCloner). See also fAutoFlush and fAutoSave if needed.

Definition at line 6483 of file TTree.cxx.

◆ IncrementTotalBuffers()

virtual void TTree::IncrementTotalBuffers ( Int_t nbytes)
inlinevirtualinherited

Definition at line 633 of file TTree.h.

◆ Info()

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

Issue info message.

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

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

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

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

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

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Init()

void TTreeSQL::Init ( )
protected

Initialization routine.

Definition at line 549 of file TTreeSQL.cxx.

◆ InitializeBranchLists()

void TTree::InitializeBranchLists ( bool checkLeafCount)
privateinherited

Divides the top-level branches into two vectors: (i) branches to be processed sequentially and (ii) branches to be processed in parallel.

Even if IMT is on, some branches might need to be processed first and in a sequential fashion: in the parallelization of GetEntry, those are the branches that store the size of another branch for every entry (e.g. the size of an array branch). If such branches were processed in parallel with the rest, there could be two threads invoking TBranch::GetEntry on one of them at the same time, since a branch that depends on a size (or count) branch will also invoke GetEntry on the latter. This method can be invoked several times during the event loop if the TTree is being written, for example when adding new branches. In these cases, the checkLeafCount parameter is false.

Parameters
[in]checkLeafCountTrue if we need to check whether some branches are count leaves.

Definition at line 5861 of file TTree.cxx.

◆ InPlaceClone()

bool TTree::InPlaceClone ( TDirectory * newdirectory,
const char * options = "" )
virtualinherited

Copy the content to a new new file, update this TTree with the new location information and attach this TTree to the new directory.

options: Indicates a basket sorting method, see TTreeCloner::TTreeCloner for details

If new and old directory are in the same file, the data is untouched, this "just" does a call to SetDirectory. Equivalent to an "in place" cloning of the TTree.

Reimplemented in TChain.

Definition at line 7207 of file TTree.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

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

The following picture is the Inspect of a histogram object:

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

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TTreeSQL::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TTree.

Definition at line 94 of file TTreeSQL.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

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

Definition at line 186 of file TObject.h.

◆ IsEqual()

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

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

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

bool TTree::IsFolder ( ) const
inlineoverridevirtualinherited

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

Reimplemented from TObject.

Definition at line 634 of file TTree.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const
inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ KeepCircular()

void TTree::KeepCircular ( )
protectedvirtualinherited

Keep a maximum of fMaxEntries in memory.

Definition at line 6526 of file TTree.cxx.

◆ LoadBaskets()

Int_t TTree::LoadBaskets ( Long64_t maxmemory = 2000000000)
virtualinherited

Read in memory all baskets from all branches up to the limit of maxmemory bytes.

If maxmemory is non null and positive SetMaxVirtualSize is called with this value. Default for maxmemory is 2000000000 (2 Gigabytes). The function returns the total number of baskets read into memory if negative an error occurred while loading the branches. This method may be called to force branch baskets in memory when random access to branch entries is required. If random access to only a few branches is required, you should call directly TBranch::LoadBaskets.

Reimplemented in TChain.

Definition at line 6562 of file TTree.cxx.

◆ LoadTree()

Long64_t TTreeSQL::LoadTree ( Long64_t entry)
overridevirtual

Setup the tree to the load the specified entry.

Reimplemented from TTree.

Definition at line 737 of file TTreeSQL.cxx.

◆ LoadTreeFriend()

Long64_t TTree::LoadTreeFriend ( Long64_t entry,
TTree * masterTree )
virtualinherited

Load entry on behalf of our master tree, we may use an index.

Called by LoadTree() when the masterTree looks for the entry number in a friend tree (us) corresponding to the passed entry number in the masterTree.

If we have no index, our entry number and the masterTree entry number are the same.

If we do have an index, we must find the (major, minor) value pair in masterTree to locate our corresponding entry.

Definition at line 6676 of file TTree.cxx.

◆ ls()

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

List TNamed name and title.

Reimplemented from TObject.

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

Definition at line 112 of file TNamed.cxx.

◆ MakeClass()

Int_t TTree::MakeClass ( const char * classname = nullptr,
Option_t * option = "" )
virtualinherited

Generate a skeleton analysis class for this tree.

The following files are produced: classname.h and classname.C. If classname is 0, classname will be called "nameoftree".

The generated code in classname.h includes the following:

  • Identification of the original tree and the input file name.
  • Definition of an analysis class (data members and member functions).
  • The following member functions:
    • constructor (by default opening the tree file),
    • GetEntry(Long64_t entry),
    • Init(TTree* tree) to initialize a new TTree,
    • Show(Long64_t entry) to read and dump entry.

The generated code in classname.C includes only the main analysis function Loop.

To use this function:

  • Open your tree file (eg: TFile f("myfile.root");)
  • T->MakeClass("MyClass");

where T is the name of the TTree in file myfile.root, and MyClass.h, MyClass.C the name of the files created by this function. In a ROOT session, you can do:

root > .L MyClass.C
root > MyClass* t = new MyClass;
root > t->GetEntry(12); // Fill data members of t with entry number 12.
root > t->Show(); // Show values of entry 12.
root > t->Show(16); // Read and show values of entry 16.
root > t->Loop(); // Loop on all entries.

NOTE: Do not use the code generated for a single TTree which is part of a TChain to process that entire TChain. The maximum dimensions calculated for arrays on the basis of a single TTree from the TChain might be (will be!) too small when processing all of the TTrees in the TChain. You must use myChain.MakeClass() to generate the code, not myTree.MakeClass(...).

Definition at line 6726 of file TTree.cxx.

◆ MakeCode()

Int_t TTree::MakeCode ( const char * filename = nullptr)
virtualinherited

Generate a skeleton function for this tree.

The function code is written on filename. If filename is 0, filename will be called nameoftree.C

The generated code includes the following:

  • Identification of the original Tree and Input file name,
  • Opening the Tree file,
  • Declaration of Tree variables,
  • Setting of branches addresses,
  • A skeleton for the entry loop.

To use this function:

  • Open your Tree file (eg: TFile f("myfile.root");)
  • T->MakeCode("MyAnalysis.C");

where T is the name of the TTree in file myfile.root and MyAnalysis.C the name of the file created by this function.

NOTE: Since the implementation of this function, a new and better function TTree::MakeClass() has been developed.

Definition at line 6759 of file TTree.cxx.

◆ MakeProxy()

Int_t TTree::MakeProxy ( const char * proxyClassname,
const char * macrofilename = nullptr,
const char * cutfilename = nullptr,
const char * option = nullptr,
Int_t maxUnrolling = 3 )
virtualinherited

Generate a skeleton analysis class for this Tree using TBranchProxy.

TBranchProxy is the base of a class hierarchy implementing an indirect access to the content of the branches of a TTree.

"proxyClassname" is expected to be of the form:

[path/]fileprefix

The skeleton will then be generated in the file:

fileprefix.h

located in the current directory or in 'path/' if it is specified. The class generated will be named 'fileprefix'

"macrofilename" and optionally "cutfilename" are expected to point to source files which will be included by the generated skeleton. Method of the same name as the file(minus the extension and path) will be called by the generated skeleton's Process method as follow:

[if (cutfilename())] htemp->Fill(macrofilename());

"option" can be used select some of the optional features during the code generation. The possible options are:

  • nohist : indicates that the generated ProcessFill should not fill the histogram.

'maxUnrolling' controls how deep in the class hierarchy does the system 'unroll' classes that are not split. Unrolling a class allows direct access to its data members (this emulates the behavior of TTreeFormula).

The main features of this skeleton are:

  • on-demand loading of branches
  • ability to use the 'branchname' as if it was a data member
  • protection against array out-of-bounds errors
  • ability to use the branch data as an object (when the user code is available)

For example with Event.root, if

Double_t somePx = fTracks.fPx[2];
double Double_t
Double 8 bytes.
Definition RtypesCore.h:73

is executed by one of the method of the skeleton, somePx will updated with the current value of fPx of the 3rd track.

Both macrofilename and the optional cutfilename are expected to be the name of source files which contain at least a free standing function with the signature:

x_t macrofilename(); // i.e function with the same name as the file

and

y_t cutfilename(); // i.e function with the same name as the file

x_t and y_t needs to be types that can convert respectively to a double and a bool (because the skeleton uses:

if (cutfilename()) htemp->Fill(macrofilename());

These two functions are run in a context such that the branch names are available as local variables of the correct (read-only) type.

Note that if you use the same 'variable' twice, it is more efficient to 'cache' the value. For example:

Int_t n = fEventNumber; // Read fEventNumber
if (n<10 || n>10) { ... }

is more efficient than

if (fEventNumber<10 || fEventNumber>10)

Also, optionally, the generated selector will also call methods named macrofilename_methodname in each of 6 main selector methods if the method macrofilename_methodname exist (Where macrofilename is stripped of its extension).

Concretely, with the script named h1analysisProxy.C,

  • The method calls the method (if it exist)
  • Begin -> void h1analysisProxy_Begin(TTree*);
  • SlaveBegin -> void h1analysisProxy_SlaveBegin(TTree*);
  • Notify -> bool h1analysisProxy_Notify();
  • Process -> bool h1analysisProxy_Process(Long64_t);
  • SlaveTerminate -> void h1analysisProxy_SlaveTerminate();
  • Terminate -> void h1analysisProxy_Terminate();

If a file name macrofilename.h (or .hh, .hpp, .hxx, .hPP, .hXX) exist it is included before the declaration of the proxy class. This can be used in particular to insure that the include files needed by the macro file are properly loaded.

The default histogram is accessible via the variable named 'htemp'.

If the library of the classes describing the data in the branch is loaded, the skeleton will add the needed include statements and give the ability to access the object stored in the branches.

To draw px using the file hsimple.root (generated by the hsimple.C tutorial), we need a file named hsimple.cxx:

double hsimple() {
return px;
}

MakeProxy can then be used indirectly via the TTree::Draw interface as follow:

new TFile("hsimple.root")
ntuple->Draw("hsimple.cxx");

A more complete example is available in the tutorials directory: h1analysisProxy.cxx , h1analysProxy.h and h1analysisProxyCut.C which reimplement the selector found in h1analysis.C

Definition at line 6887 of file TTree.cxx.

◆ MakeSelector()

Int_t TTree::MakeSelector ( const char * selector = nullptr,
Option_t * option = "" )
virtualinherited

Generate skeleton selector class for this tree.

The following files are produced: selector.h and selector.C. If selector is 0, the selector will be called "nameoftree". The option can be used to specify the branches that will have a data member.

  • If option is "=legacy", a pre-ROOT6 selector will be generated (data members and branch pointers instead of TTreeReaders).
  • If option is empty, readers will be generated for each leaf.
  • If option is "@", readers will be generated for the topmost branches.
  • Individual branches can also be picked by their name:
    • "X" generates readers for leaves of X.
    • "@X" generates a reader for X as a whole.
    • "@X;Y" generates a reader for X as a whole and also readers for the leaves of Y.
  • For further examples see the figure below.

The generated code in selector.h includes the following:

  • Identification of the original Tree and Input file name
  • Definition of selector class (data and functions)
  • The following class functions:
    • constructor and destructor
    • void Begin(TTree *tree)
    • void SlaveBegin(TTree *tree)
    • void Init(TTree *tree)
    • bool Notify()
    • bool Process(Long64_t entry)
    • void Terminate()
    • void SlaveTerminate()

The class selector derives from TSelector. The generated code in selector.C includes empty functions defined above.

To use this function:

  • connect your Tree file (eg: TFile f("myfile.root");)
  • T->MakeSelector("myselect");

where T is the name of the Tree in file myfile.root and myselect.h, myselect.C the name of the files created by this function. In a ROOT session, you can do:

root > T->Process("myselect.C")

Definition at line 6941 of file TTree.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MarkEventCluster()

void TTree::MarkEventCluster ( )
privateinherited

Mark the previous event as being at the end of the event cluster.

So, if fEntries is set to 10 (and this is the first cluster) when MarkEventCluster is called, then the first cluster has 9 events.

Definition at line 8465 of file TTree.cxx.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
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.

◆ MemoryFull()

bool TTree::MemoryFull ( Int_t nbytes)
inherited

Check if adding nbytes to memory we are still below MaxVirtualsize.

Definition at line 6956 of file TTree.cxx.

◆ Merge() [1/2]

Long64_t TTree::Merge ( TCollection * li,
Option_t * options = "" )
virtualinherited

Merge the trees in the TList into this tree.

Returns the total number of entries in the merged tree. Trees with no branches will be skipped, the branch structure will be taken from the first non-zero-branch Tree of {this+li}

Reimplemented in TChain.

Definition at line 7021 of file TTree.cxx.

◆ Merge() [2/2]

Long64_t TTree::Merge ( TCollection * li,
TFileMergeInfo * info )
virtualinherited

Merge the trees in the TList into this tree.

If info->fIsFirst is true, first we clone this TTree info the directory info->fOutputDirectory and then overlay the new TTree information onto this TTree object (so that this TTree object is now the appropriate to use for further merging). Trees with no branches will be skipped, the branch structure will be taken from the first non-zero-branch Tree of {this+li}

Returns the total number of entries in the merged tree.

Reimplemented in TChain.

Definition at line 7092 of file TTree.cxx.

◆ MergeTrees()

TTree * TTree::MergeTrees ( TList * li,
Option_t * options = "" )
staticinherited

Static function merging the trees in the TList into a new tree.

Trees in the list can be memory or disk-resident trees. The new tree is created in the current directory (memory if gROOT). Trees with no branches will be skipped, the branch structure will be taken from the first non-zero-branch Tree of {li}

Definition at line 6972 of file TTree.cxx.

◆ Modify() [1/3]

virtual void TAttFill::Modify ( )
virtualinherited

◆ Modify() [2/3]

virtual void TAttLine::Modify ( )
virtualinherited

◆ Modify() [3/3]

virtual void TAttMarker::Modify ( )
virtualinherited

◆ ModifyOn() [1/3]

virtual void TAttFill::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ ModifyOn() [2/3]

virtual void TAttLine::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ ModifyOn() [3/3]

virtual void TAttMarker::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ MoveReadCache()

void TTree::MoveReadCache ( TFile * src,
TDirectory * dir )
protectedinherited

Move a cache from a file to the current file in dir.

if src is null no operation is done, if dir is null or there is no current file the cache is deleted.

Definition at line 7178 of file TTree.cxx.

◆ Notify()

bool TTree::Notify ( )
overridevirtualinherited

Function called when loading a new class library.

Reimplemented from TObject.

Definition at line 7228 of file TTree.cxx.

◆ Obsolete()

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

Use this method to declare a method obsolete.

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

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

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

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

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

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

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

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

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

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

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

Operator delete [].

Definition at line 1223 of file TObject.cxx.

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

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

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

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

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

Definition at line 191 of file TObject.h.

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

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

Definition at line 190 of file TObject.h.

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

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

Definition at line 192 of file TObject.h.

◆ OptimizeBaskets()

void TTree::OptimizeBaskets ( ULong64_t maxMemory = 10000000,
Float_t minComp = 1.1,
Option_t * option = "" )
virtualinherited

This function may be called after having filled some entries in a Tree.

Using the information in the existing branch buffers, it will reassign new branch buffer sizes to optimize time and memory.

The function computes the best values for branch buffer sizes such that the total buffer sizes is less than maxMemory and nearby entries written at the same time. In case the branch compression factor for the data written so far is less than compMin, the compression is disabled.

if option ="d" an analysis report is printed.

Definition at line 7252 of file TTree.cxx.

◆ Paint()

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

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

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

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

Definition at line 631 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

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

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

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ PrepEntry()

Long64_t TTreeSQL::PrepEntry ( Long64_t entry)
virtual

Make sure the server and result set are setup for the requested entry.

Definition at line 746 of file TTreeSQL.cxx.

◆ Principal()

TPrincipal * TTree::Principal ( const char * varexp = "",
const char * selection = "",
Option_t * option = "np",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
inherited

Interface to the Principal Components Analysis class.

Create an instance of TPrincipal

Fill it with the selected variables

  • if option "n" is specified, the TPrincipal object is filled with normalized variables.
  • If option "p" is specified, compute the principal components
  • If option "p" and "d" print results of analysis
  • If option "p" and "h" generate standard histograms
  • If option "p" and "c" generate code of conversion functions
  • return a pointer to the TPrincipal object. It is the user responsibility
  • to delete this object.
  • The option default value is "np"

see TTree::Draw for explanation of the other parameters.

The created object is named "principal" and a reference to it is added to the list of specials Root objects. you can retrieve a pointer to the created object via:

TPrincipal *principal =
(TPrincipal*)gROOT->GetListOfSpecials()->FindObject("principal");
#define gROOT
Definition TROOT.h:417

Definition at line 7395 of file TTree.cxx.

◆ Print()

void TTree::Print ( Option_t * option = "") const
overridevirtualinherited

Print a summary of the tree contents.

  • If option contains "all" friend trees are also printed.
  • If option contains "toponly" only the top level branches are printed.
  • If option contains "clusters" information about the cluster of baskets is printed.

Wildcarding can be used to print only a subset of the branches, e.g., T.Print("Elec*") will print all branches with name starting with "Elec".

Reimplemented from TNamed.

Definition at line 7414 of file TTree.cxx.

◆ PrintCacheStats()

void TTree::PrintCacheStats ( Option_t * option = "") const
virtualinherited

Print statistics about the TreeCache for this tree.

Like:

******TreeCache statistics for file: cms2.root ******
Reading 73921562 bytes in 716 transactions
Average transaction = 103.242405 Kbytes
Number of blocks in current cache: 202, total size : 6001193
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
static unsigned int total

if option = "a" the list of blocks in the cache is printed

Definition at line 7566 of file TTree.cxx.

◆ Process() [1/2]

Long64_t TTree::Process ( const char * filename,
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Process this tree executing the TSelector code in the specified filename.

The return value is -1 in case of error and TSelector::GetStatus() in in case of success.

The code in filename is loaded (interpreted or compiled, see below), filename must contain a valid class implementation derived from TSelector, where TSelector has the following member functions:

  • Begin(): called every time a loop on the tree starts, a convenient place to create your histograms.
  • SlaveBegin(): called after Begin()
  • Process(): called for each event, in this function you decide what to read and fill your histograms.
  • SlaveTerminate(): called at the end of the loop on the tree
  • Terminate(): called at the end of the loop on the tree, a convenient place to draw/fit your histograms.

If filename is of the form file.C, the file will be interpreted.

If filename is of the form file.C++, the file file.C will be compiled and dynamically loaded.

If filename is of the form file.C+, the file file.C will be compiled and dynamically loaded. At next call, if file.C is older than file.o and file.so, the file.C is not compiled, only file.so is loaded.

NOTE1

It may be more interesting to invoke directly the other Process function accepting a TSelector* as argument.eg

MySelector *selector = (MySelector*)TSelector::GetSelector(filename);
selector->CallSomeFunction(..);
mytree.Process(selector,..);
static TSelector * GetSelector(const char *filename)
The code in filename is loaded (interpreted or compiled, see below), filename must contain a valid cl...

NOTE2

One should not call this function twice with the same selector file in the same script. If this is required, proceed as indicated in NOTE1, by getting a pointer to the corresponding TSelector,eg

Workaround 1

void stubs1() {
TSelector *selector = TSelector::GetSelector("h1test.C");
TFile *f1 = new TFile("stubs_nood_le1.root");
TTree *h1 = (TTree*)f1->Get("h1");
h1->Process(selector);
TFile *f2 = new TFile("stubs_nood_le1_coarse.root");
TTree *h2 = (TTree*)f2->Get("h1");
h2->Process(selector);
}
TObject * Get(const char *namecycle) override
Return pointer to object identified by namecycle.
A TSelector object is used by the TTree::Draw, TTree::Scan, TTree::Process to navigate in a TTree and...
Definition TSelector.h:31
virtual Long64_t Process(const char *filename, Option_t *option="", Long64_t nentries=kMaxEntries, Long64_t firstentry=0)
Process this tree executing the TSelector code in the specified filename.
Definition TTree.cxx:7644
TH1F * h1
Definition legend1.C:5
TF1 * f1
Definition legend1.C:11

or use ACLIC to compile the selector

Workaround 2

void stubs2() {
TFile *f1 = new TFile("stubs_nood_le1.root");
TTree *h1 = (TTree*)f1->Get("h1");
h1->Process("h1test.C+");
TFile *f2 = new TFile("stubs_nood_le1_coarse.root");
TTree *h2 = (TTree*)f2->Get("h1");
h2->Process("h1test.C+");
}

Reimplemented in TChain.

Definition at line 7644 of file TTree.cxx.

◆ Process() [2/2]

Long64_t TTree::Process ( TSelector * selector,
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Process this tree executing the code in the specified selector.

The return value is -1 in case of error and TSelector::GetStatus() in in case of success.

The TSelector class has the following member functions:

  • Begin(): called every time a loop on the tree starts, a convenient place to create your histograms.
  • SlaveBegin(): called after Begin()
  • Process(): called for each event, in this function you decide what to read and fill your histograms.
  • SlaveTerminate(): called at the end of the loop on the tree
  • Terminate(): called at the end of the loop on the tree, a convenient place to draw/fit your histograms.

    If the Tree (Chain) has an associated EventList, the loop is on the nentries of the EventList, starting at firstentry, otherwise the loop is on the specified Tree entries.

Reimplemented in TChain.

Definition at line 7673 of file TTree.cxx.

◆ Project()

Long64_t TTree::Project ( const char * hname,
const char * varexp,
const char * selection = "",
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Make a projection of a tree using selections.

Depending on the value of varexp (described in Draw) a 1-D, 2-D, etc., projection of the tree will be filled in histogram hname. Note that the dimension of hname must match with the dimension of varexp.

Definition at line 7690 of file TTree.cxx.

◆ Query()

TSQLResult * TTree::Query ( const char * varexp = "",
const char * selection = "",
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Loop over entries and return a TSQLResult object containing entries following selection.

Definition at line 7705 of file TTree.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

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

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

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ ReadFile()

Long64_t TTree::ReadFile ( const char * filename,
const char * branchDescriptor = "",
char delimiter = ' ' )
virtualinherited

Create or simply read branches from filename.

if branchDescriptor = "" (default), it is assumed that the Tree descriptor is given in the first line of the file with a syntax like

A/D:Table[2]/F:Ntracks/I:astring/C
#define F(x, y, z)
#define I(x, y, z)

otherwise branchDescriptor must be specified with the above syntax. See all available datatypes here.

  • If the type of the first variable is not specified, it is assumed to be "/F"
  • If the type of any other variable is not specified, the type of the previous variable is assumed. eg
    • x:y:z (all variables are assumed of type "F")
    • x/D:y:z (all variables are of type "D")
    • x:y/D:z (x is type "F", y and z of type "D")

delimiter allows for the use of another delimiter besides whitespace. This provides support for direct import of common data file formats like csv. If delimiter != ' ' and branchDescriptor == "", then the branch description is taken from the first line in the file, but delimiter is used for the branch names tokenization rather than ':'. Note however that if the values in the first line do not use the /[type] syntax, all variables are assumed to be of type "F". If the filename ends with extensions .csv or .CSV and a delimiter is not specified (besides ' '), the delimiter is automatically set to ','.

Lines in the input file starting with "#" are ignored. Leading whitespace for each column data is skipped. Empty lines are skipped.

A TBranch object is created for each variable in the expression. The total number of rows read from the file is returned.

FILLING a TTree WITH MULTIPLE INPUT TEXT FILES

To fill a TTree with multiple input text files, proceed as indicated above for the first input file and omit the second argument for subsequent calls

T.ReadFile("file1.dat","branch descriptor");
T.ReadFile("file2.dat");

Definition at line 7757 of file TTree.cxx.

◆ ReadStream()

Long64_t TTree::ReadStream ( std::istream & inputStream,
const char * branchDescriptor = "",
char delimiter = ' ' )
virtualinherited

Create or simply read branches from an input stream.

See also
TTree::ReadFile

Reimplemented in TNtuple, and TNtupleD.

Definition at line 7808 of file TTree.cxx.

◆ RecursiveRemove()

void TTree::RecursiveRemove ( TObject * obj)
overridevirtualinherited

Make sure that obj (which is being deleted or will soon be) is no longer referenced by this TTree.

Reimplemented from TObject.

Definition at line 8074 of file TTree.cxx.

◆ Refresh()

void TTreeSQL::Refresh ( )
overridevirtual

Refresh contents of this Tree and its branches from the current Tree status in the database One can call this function in case the Tree on its file is being updated by another process.

Reimplemented from TTree.

Definition at line 795 of file TTreeSQL.cxx.

◆ RegisterBranchFullName()

void TTree::RegisterBranchFullName ( std::pair< std::string, TBranch * > && kv)
inlineprivateinherited

Definition at line 182 of file TTree.h.

◆ RegisterExternalFriend()

void TTree::RegisterExternalFriend ( TFriendElement * fe)
virtualinherited

Record a TFriendElement that we need to warn when the chain switches to a new file (typically this is because this chain is a friend of another TChain).

Definition at line 8150 of file TTree.cxx.

◆ RemoveExternalFriend()

void TTree::RemoveExternalFriend ( TFriendElement * fe)
virtualinherited

Removes external friend.

Definition at line 8161 of file TTree.cxx.

◆ RemoveFriend()

void TTree::RemoveFriend ( TTree * oldFriend)
virtualinherited

Remove a friend from the list of friends.

Reimplemented in TChain.

Definition at line 8170 of file TTree.cxx.

◆ Reset()

void TTree::Reset ( Option_t * option = "")
virtualinherited

Reset baskets, buffers and entries count in all branches and leaves.

Reimplemented in TChain.

Definition at line 8196 of file TTree.cxx.

◆ ResetAfterMerge()

void TTree::ResetAfterMerge ( TFileMergeInfo * info)
virtualinherited

Resets the state of this TTree after a merge (keep the customization but forget the data).

Reimplemented in TChain.

Definition at line 8227 of file TTree.cxx.

◆ ResetAttFill()

virtual void TAttFill::ResetAttFill ( Option_t * option = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetAttLine()

virtual void TAttLine::ResetAttLine ( Option_t * option = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetAttMarker()

virtual void TAttMarker::ResetAttMarker ( Option_t * toption = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ ResetBranchAddress()

void TTree::ResetBranchAddress ( TBranch * br)
virtualinherited

Tell a branch to set its address to zero.

Note
If the branch owns any objects, they are deleted.

Reimplemented in TChain, TNtuple, and TNtupleD.

Definition at line 8258 of file TTree.cxx.

◆ ResetBranchAddresses()

void TTree::ResetBranchAddresses ( )
virtualinherited

Tell all of our branches to drop their current objects and allocate new ones.

Reimplemented in TChain, TNtuple, and TNtupleD.

Definition at line 8268 of file TTree.cxx.

◆ ResetQuery()

void TTreeSQL::ResetQuery ( )
protected

Reset the internal query.

Definition at line 807 of file TTreeSQL.cxx.

◆ SaveAs()

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

Save this object in the file specified by filename.

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

    The function is available via the object context menu.

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

Definition at line 708 of file TObject.cxx.

◆ SaveFillAttributes()

virtual void TAttFill::SaveFillAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1001 )
virtualinherited

◆ SaveLineAttributes()

virtual void TAttLine::SaveLineAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1,
Int_t widdef = 1 )
virtualinherited

◆ SaveMarkerAttributes()

virtual void TAttMarker::SaveMarkerAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1,
Int_t sizdef = 1 )
virtualinherited

◆ SavePrimitive()

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

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

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

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

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

Save object constructor in the output stream "out".

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

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

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

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

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

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

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

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

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

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

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

Definition at line 796 of file TObject.cxx.

◆ Scan()

Long64_t TTree::Scan ( const char * varexp = "",
const char * selection = "",
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Loop over tree entries and print entries passing selection.

Interactive pagination break is on by default.

  • If varexp is 0 (or "") then print only first 8 columns.
  • If varexp = "*" print all columns.

Otherwise a columns selection can be made using "var1:var2:var3".

Parameters
firstentryfirst entry to scan
nentriestotal number of entries to scan (starting from firstentry). Defaults to all entries.
Note
see TTree::SetScanField to control how many lines are printed between pagination breaks (Use 0 to disable pagination)
See also
TTreePlayer::Scan, TTreePlayer::SetScanFileName, TTreePlayer::SetScanRedirect

Reimplemented in TChain.

Definition at line 8306 of file TTree.cxx.

◆ SetAlias()

bool TTree::SetAlias ( const char * aliasName,
const char * aliasFormula )
virtualinherited

Set a tree variable alias.

Set an alias for an expression/formula based on the tree 'variables'.

The content of 'aliasName' can be used in TTreeFormula (i.e. TTree::Draw, TTree::Scan, TTreeViewer) and will be evaluated as the content of 'aliasFormula'.

If the content of 'aliasFormula' only contains symbol names, periods and array index specification (for example event.fTracks[3]), then the content of 'aliasName' can be used as the start of symbol.

If the alias 'aliasName' already existed, it is replaced by the new value.

When being used, the alias can be preceded by an eventual 'Friend Alias' (see TTree::GetFriendAlias)

Return true if it was added properly.

For example:

tree->SetAlias("x1","(tdc1[1]-tdc1[0])/49");
tree->SetAlias("y1","(tdc1[3]-tdc1[2])/47");
tree->SetAlias("x2","(tdc2[1]-tdc2[0])/49");
tree->SetAlias("y2","(tdc2[3]-tdc2[2])/47");
tree->Draw("y2-y1:x2-x1");
tree->SetAlias("theGoodTrack","event.fTracks[3]");
tree->Draw("theGoodTrack.fPx"); // same as "event.fTracks[3].fPx"

Definition at line 8348 of file TTree.cxx.

◆ SetAutoFlush()

void TTree::SetAutoFlush ( Long64_t autof = -30000000)
virtualinherited

This function may be called at the start of a program to change the default value for fAutoFlush.

CASE 1 : autof > 0

autof is the number of consecutive entries after which TTree::Fill will flush all branch buffers to disk.

CASE 2 : autof < 0

When filling the Tree the branch buffers will be flushed to disk when more than autof bytes have been written to the file. At the first FlushBaskets TTree::Fill will replace fAutoFlush by the current value of fEntries.

Calling this function with autof<0 is interesting when it is hard to estimate the size of one entry. This value is also independent of the Tree.

The Tree is initialized with fAutoFlush=-30000000, ie that, by default, the first AutoFlush will be done when 30 MBytes of data are written to the file.

CASE 3 : autof = 0

The AutoFlush mechanism is disabled.

Flushing the buffers at regular intervals optimize the location of consecutive entries on the disk by creating clusters of baskets.

A cluster of baskets is a set of baskets that contains all the data for a (consecutive) set of entries and that is stored consecutively on the disk. When reading all the branches, this is the minimum set of baskets that the TTreeCache will read.

Definition at line 8403 of file TTree.cxx.

◆ SetAutoSave()

void TTree::SetAutoSave ( Long64_t autos = -300000000)
virtualinherited

In case of a program crash, it will be possible to recover the data in the tree up to the last AutoSave point.

This function may be called before filling a TTree to specify when the branch buffers and TTree header are flushed to disk as part of TTree::Fill(). The default is -300000000, ie the TTree will write data to disk once it exceeds 300 MBytes. CASE 1: If fAutoSave is positive the watermark is reached when a multiple of fAutoSave entries have been filled. CASE 2: If fAutoSave is negative the watermark is reached when -fAutoSave bytes can be written to the file. CASE 3: If fAutoSave is 0, AutoSave() will never be called automatically as part of TTree::Fill().

Definition at line 8549 of file TTree.cxx.

◆ SetBasketSize()

void TTree::SetBasketSize ( const char * bname,
Int_t bufsize = 16000 )
virtualinherited

Set a branch's basket size.

bname is the name of a branch.

  • if bname="*", apply to all branches.
  • if bname="xxx*", apply to all branches with name starting with xxx

see TRegexp for wildcarding options bufsize = branch basket size

Definition at line 8565 of file TTree.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

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

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

Definition at line 888 of file TObject.cxx.

◆ SetBranchAddress() [1/6]

template<class T>
Int_t TTree::SetBranchAddress ( const char * bname,
T ** add,
TBranch ** ptr = nullptr )
inlineinherited

Definition at line 675 of file TTree.h.

◆ SetBranchAddress() [2/6]

template<class T>
Int_t TTree::SetBranchAddress ( const char * bname,
T * add,
TBranch ** ptr = nullptr )
inlineinherited

Definition at line 684 of file TTree.h.

◆ SetBranchAddress() [3/6]

Int_t TTree::SetBranchAddress ( const char * bname,
void * addr,
TBranch ** ptr,
TClass * ptrClass,
EDataType datatype,
bool isptr )
virtualinherited

Verify the validity of the type of addr before calling SetBranchAddress.

See TTree::CheckBranchAddressType for the semantic of the return value.

Note: See the comments in TBranchElement::SetAddress() for the meaning of the addr parameter and the object ownership policy.

Reimplemented in TChain.

Definition at line 8666 of file TTree.cxx.

◆ SetBranchAddress() [4/6]

Int_t TTree::SetBranchAddress ( const char * bname,
void * add,
TBranch ** ptr,
TClass * realClass,
EDataType datatype,
bool isptr,
bool suppressMissingBranchError )
protectedvirtualinherited

Reimplemented in TChain.

Definition at line 8675 of file TTree.cxx.

◆ SetBranchAddress() [5/6]

Int_t TTree::SetBranchAddress ( const char * bname,
void * addr,
TBranch ** ptr = nullptr )
virtualinherited

Change branch address, dealing with clone trees properly.

See TTree::CheckBranchAddressType for the semantic of the return value.

Note: See the comments in TBranchElement::SetAddress() for the meaning of the addr parameter and the object ownership policy.

Reimplemented in TChain.

Definition at line 8592 of file TTree.cxx.

◆ SetBranchAddress() [6/6]

Int_t TTree::SetBranchAddress ( const char * bname,
void * addr,
TClass * ptrClass,
EDataType datatype,
bool isptr )
virtualinherited

Verify the validity of the type of addr before calling SetBranchAddress.

See TTree::CheckBranchAddressType for the semantic of the return value.

Note: See the comments in TBranchElement::SetAddress() for the meaning of the addr parameter and the object ownership policy.

Reimplemented in TChain.

Definition at line 8610 of file TTree.cxx.

◆ SetBranchAddressImp() [1/2]

Int_t TTree::SetBranchAddressImp ( const char * bname,
void * add,
TBranch ** ptr,
TClass * realClass,
EDataType datatype,
bool isptr )
privateinherited

Definition at line 8615 of file TTree.cxx.

◆ SetBranchAddressImp() [2/2]

Int_t TTree::SetBranchAddressImp ( TBranch * branch,
void * addr,
TBranch ** ptr )
protectedinherited

Change branch address, dealing with clone trees properly.

See TTree::CheckBranchAddressType for the semantic of the return value.

Note: See the comments in TBranchElement::SetAddress() for the meaning of the addr parameter and the object ownership policy.

Definition at line 8690 of file TTree.cxx.

◆ SetBranchStatus()

void TTree::SetBranchStatus ( const char * bname,
bool status = true,
UInt_t * found = nullptr )
virtualinherited

Set branch status to Process or DoNotProcess.

When reading a Tree, by default, all branches are read. One can speed up considerably the analysis phase by activating only the branches that hold variables involved in a query.

bname is the name of a branch.

  • if bname="*", apply to all branches.
  • if bname="xxx*", apply to all branches with name starting with xxx

see TRegexp for wildcarding options

  • status = 1 branch will be processed
  • = 0 branch will not be processed

Example:

Assume a tree T with sub-branches a,b,c,d,e,f,g,etc.. when doing T.GetEntry(i) all branches are read for entry i. to read only the branches c and e, one can do

T.SetBranchStatus("*",0); //disable all branches
T.SetBranchStatus("c",1);
T.setBranchStatus("e",1);
T.GetEntry(i);

bname is interpreted as a wild-carded TRegexp (see TRegexp::MakeWildcard). Thus, "a*b" or "a.*b" matches branches starting with "a" and ending with "b", but not any other branch with an "a" followed at some point by a "b". For this second behavior, use "*a*b*". Note that TRegExp does not support '|', and so you cannot select, e.g. track and shower branches with "track|shower".

WARNING! WARNING! WARNING!

SetBranchStatus is matching the branch based on match of the branch 'name' and not on the branch hierarchy! In order to be able to selectively enable a top level object that is 'split' you need to make sure the name of the top level branch is prefixed to the sub-branches' name (by adding a dot ('.') at the end of the Branch creation and use the corresponding bname.

I.e If your Tree has been created in split mode with a parent branch "parent." (note the trailing dot).

T.SetBranchStatus("parent",1);

will not activate the sub-branches of "parent". You should do:

T.SetBranchStatus("parent*",1);

Without the trailing dot in the branch creation you have no choice but to call SetBranchStatus explicitly for each of the sub branches.

An alternative to this function is to read directly and only the interesting branches. Example:

TBranch *brc = T.GetBranch("c");
TBranch *bre = T.GetBranch("e");
brc->GetEntry(i);
bre->GetEntry(i);
A TTree is a list of TBranches.
Definition TBranch.h:93
virtual Int_t GetEntry(Long64_t entry=0, Int_t getall=0)
Read all leaves of entry and return total number of bytes read.
Definition TBranch.cxx:1705

If found is not 0, the number of branch(es) found matching the regular expression is returned in *found AND the error message 'unknown branch' is suppressed.

Reimplemented in TChain.

Definition at line 8779 of file TTree.cxx.

◆ SetBranchStyle()

void TTree::SetBranchStyle ( Int_t style = 1)
staticinherited

Set the current branch style.

(static function)

  • style = 0 old Branch
  • style = 1 new Bronch

Definition at line 8910 of file TTree.cxx.

◆ SetCacheEntryRange()

Int_t TTree::SetCacheEntryRange ( Long64_t first,
Long64_t last )
virtualinherited

interface to TTreeCache to set the cache entry range

Returns:

  • 0 entry range set
  • -1 on error

Definition at line 9085 of file TTree.cxx.

◆ SetCacheLearnEntries()

void TTree::SetCacheLearnEntries ( Int_t n = 10)
virtualinherited

Interface to TTreeCache to set the number of entries for the learning phase.

Definition at line 9119 of file TTree.cxx.

◆ SetCacheSize()

Int_t TTree::SetCacheSize ( Long64_t cacheSize = -1)
virtualinherited

Set maximum size of the file cache (TTreeCache) in bytes.

  • if cachesize = 0 the existing cache (if any) is disabled (deleted if any).
  • if cachesize > 0, the cache is enabled or extended, if necessary
  • if cachesize = -1 (default) it is set to the AutoFlush value when writing the Tree (default is 30 MBytes).

The cacheSize might be clamped, see TFileCacheRead::SetBufferSize

TTreeCache's 'real' job is to actually prefetch (early grab from disk) the compressed data. The cachesize controls the size of the read bytes from disk.

Returns:

  • 0 size set, cache was created if possible
  • -1 on error

Reimplemented in TChain.

Definition at line 8932 of file TTree.cxx.

◆ SetCacheSizeAux()

Int_t TTree::SetCacheSizeAux ( bool autocache = true,
Long64_t cacheSize = 0 )
protectedinherited

Set the maximum size of the file cache (TTreeCache) in bytes and create it if possible.

If autocache is true: this may be an autocreated cache, possibly enlarging an existing autocreated cache. The size is calculated. The value passed in cacheSize:

  • cacheSize = 0 make cache if default cache creation is enabled.
  • cachesize > 0 the cache is enabled or extended, if necessary
  • cacheSize = -1 make a default sized cache in any case

If autocache is false: this is a user requested cache. cacheSize is used to size the cache. This cache should never be automatically adjusted. If cachesize is 0, the cache is disabled (deleted if any).

The cacheSize might be clamped, see TFileCacheRead::SetBufferSize

TTreeCache's 'real' job is to actually prefetch (early grab from disk) the compressed data. The cachesize controls the size of the read bytes from disk.

Returns:

  • 0 size set, or existing autosized cache almost large enough. (cache was created if possible)
  • -1 on error

Definition at line 8965 of file TTree.cxx.

◆ SetChainOffset()

virtual void TTree::SetChainOffset ( Long64_t offset = 0)
inlinevirtualinherited

Definition at line 696 of file TTree.h.

◆ SetCircular()

void TTree::SetCircular ( Long64_t maxEntries)
virtualinherited

Enable/Disable circularity for this tree.

if maxEntries > 0 a maximum of maxEntries is kept in one buffer/basket per branch in memory. Note that when this function is called (maxEntries>0) the Tree must be empty or having only one basket per branch. if maxEntries <= 0 the tree circularity is disabled.

NOTE 1:

Circular Trees are interesting in online real time environments to store the results of the last maxEntries events.

NOTE 2:

Calling SetCircular with maxEntries <= 0 is necessary before merging circular Trees that have been saved on files.

NOTE 3:

SetCircular with maxEntries <= 0 is automatically called by TChain::Merge

NOTE 4:

A circular Tree can still be saved in a file. When read back, it is still a circular Tree and can be filled again.

Definition at line 9146 of file TTree.cxx.

◆ SetClusterPrefetch()

virtual void TTree::SetClusterPrefetch ( bool enabled)
inlinevirtualinherited

Enables (or disables) the early decompression of the baskets of the current cluster (whose compressed data is already in memory if used in conjunction with the TTreeCache).

This affects performance only in conjunction with non-sequential use/load/read of the entries, ie within a cluster you can have cheap random access to the entries (instead of having to decompress again and again).

Note
This setting is totally different from SetCacheSize and from TFile.AsyncPrefetching, which save read calls

Definition at line 703 of file TTree.h.

◆ SetDebug()

void TTree::SetDebug ( Int_t level = 1,
Long64_t min = 0,
Long64_t max = 9999999 )
virtualinherited

Set the debug level and the debug range.

For entries in the debug range, the functions TBranchElement::Fill and TBranchElement::GetEntry will print the number of bytes filled or read for each branch.

Definition at line 9182 of file TTree.cxx.

◆ SetDefaultEntryOffsetLen()

void TTree::SetDefaultEntryOffsetLen ( Int_t newdefault,
bool updateExisting = false )
virtualinherited

Update the default value for the branch's fEntryOffsetLen.

If updateExisting is true, also update all the existing branches. If newdefault is less than 10, the new default value will be 10.

Definition at line 9194 of file TTree.cxx.

◆ SetDirectory()

void TTree::SetDirectory ( TDirectory * dir)
virtualinherited

Change the tree's directory.

Remove reference to this tree from current directory and add reference to new directory dir. The dir parameter can be 0 in which case the tree does not belong to any directory.

Reimplemented in TChain.

Definition at line 9220 of file TTree.cxx.

◆ SetDrawOption()

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

Set drawing option for object.

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

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

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEntries()

Long64_t TTree::SetEntries ( Long64_t n = -1)
virtualinherited

Change number of entries in the tree.

If n >= 0, set number of entries in the tree = n.

If n < 0, set number of entries in the tree to match the number of entries in each branch. (default for n is -1)

This function should be called only when one fills each branch independently via TBranch::Fill without calling TTree::Fill. Calling TTree::SetEntries() make sense only if the number of entries in each branch is identical, a warning is issued otherwise. The function returns the number of entries.

Reimplemented in THbookTree.

Definition at line 9265 of file TTree.cxx.

◆ SetEntryList()

void TTree::SetEntryList ( TEntryList * list,
Option_t * opt = "" )
virtualinherited

Set an EntryList.

Reimplemented in TChain.

Definition at line 9300 of file TTree.cxx.

◆ SetEstimate()

void TTree::SetEstimate ( Long64_t n = 1000000)
virtualinherited

Set number of entries to estimate variable limits.

If n is -1, the estimate is set to be the current maximum for the tree (i.e. GetEntries() + 1) If n is less than -1, the behavior is undefined.

Definition at line 9364 of file TTree.cxx.

◆ SetEventList()

void TTree::SetEventList ( TEventList * evlist)
virtualinherited

This function transfroms the given TEventList into a TEntryList The new TEntryList is owned by the TTree and gets deleted when the tree is deleted.

This TEntryList can be returned by GetEntryList() function.

Reimplemented in TChain.

Definition at line 9323 of file TTree.cxx.

◆ SetFileNumber()

void TTree::SetFileNumber ( Int_t number = 0)
virtualinherited

Set fFileNumber to number.

fFileNumber is used by TTree::Fill to set the file name for a new file to be created when the current file exceeds fgTreeMaxSize. (see TTree::ChangeFile) if fFileNumber=10, the new file name will have a suffix "_11", ie, fFileNumber is incremented before setting the file name

Definition at line 9407 of file TTree.cxx.

◆ SetFillAttributes()

virtual void TAttFill::SetFillAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor)
inlinevirtualinherited

Set the fill area color.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSpider, TSVG, TTeXDump, and TVirtualX.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber )
inherited

◆ SetFillColorAlpha()

virtual void TAttFill::SetFillColorAlpha ( Color_t fcolor,
Float_t falpha )
virtualinherited

Reimplemented in TGraphMultiErrors.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle)
inlinevirtualinherited

Set the fill area style.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPad, TSpider, and TVirtualX.

Definition at line 42 of file TAttFill.h.

◆ SetImplicitMT()

virtual void TTree::SetImplicitMT ( bool enabled)
inlinevirtualinherited

Definition at line 713 of file TTree.h.

◆ SetIOFeatures()

ROOT::TIOFeatures TTree::SetIOFeatures ( const ROOT::TIOFeatures & features)
inherited

Provide the end-user with the ability to enable/disable various experimental IO features for this TTree.

Returns all the newly-set IO settings.

Definition at line 9384 of file TTree.cxx.

◆ SetLineAttributes()

virtual void TAttLine::SetLineAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetLineColor() [1/2]

◆ SetLineColor() [2/2]

void TAttLine::SetLineColor ( TColorNumber lcolor)
inherited

◆ SetLineColorAlpha()

virtual void TAttLine::SetLineColorAlpha ( Color_t lcolor,
Float_t lalpha )
virtualinherited

Reimplemented in TGraphMultiErrors.

◆ SetLineStyle()

virtual void TAttLine::SetLineStyle ( Style_t lstyle)
inlinevirtualinherited

◆ SetLineWidth()

virtual void TAttLine::SetLineWidth ( Width_t lwidth)
inlinevirtualinherited

◆ SetMakeClass()

void TTree::SetMakeClass ( Int_t make)
virtualinherited

Set all the branches in this TTree to be in decomposed object mode (also known as MakeClass mode).

For MakeClass mode 0, the TTree expects the address where the data is stored to be set by either the user or the TTree to the address of a full object through the top level branch. For MakeClass mode 1, this address is expected to point to a numerical type or C-style array (variable or not) of numerical type, representing the primitive data members. The function's primary purpose is to allow the user to access the data directly with numerical type variable rather than having to have the original set of classes (or a reproduction thereof). In other words, SetMakeClass sets the branch(es) into a mode that allow its reading via a set of independent variables (see the result of running TTree::MakeClass on your TTree) by changing the interpretation of the address passed to SetAddress from being the beginning of the object containing the data to being the exact location where the data should be loaded. If you have the shared library corresponding to your object, it is better if you do MyClass *objp = 0; tree->SetBranchAddress("toplevel",&objp);, whereas if you do not have the shared library but know your branch data type, e.g. Int_t* ptr = new Int_t[10];, then: tree->SetMakeClass(1); tree->GetBranch("x")->SetAddress(ptr) is the way to go.

Reimplemented in TChain.

Definition at line 9442 of file TTree.cxx.

◆ SetMarkerAttributes()

virtual void TAttMarker::SetMarkerAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetMarkerColor() [1/2]

virtual void TAttMarker::SetMarkerColor ( Color_t mcolor = 1)
inlinevirtualinherited

◆ SetMarkerColor() [2/2]

void TAttMarker::SetMarkerColor ( TColorNumber lcolor)
inherited

◆ SetMarkerColorAlpha()

virtual void TAttMarker::SetMarkerColorAlpha ( Color_t mcolor,
Float_t malpha )
virtualinherited

◆ SetMarkerSize()

virtual void TAttMarker::SetMarkerSize ( Size_t msize = 1)
inlinevirtualinherited

Set the marker size.

Note that the marker styles number 1 6 and 7 (the dots), cannot be scaled. They are meant to be very fast to draw and are always drawn with the same number of pixels; therefore this method does not apply on them.

Reimplemented in ROOT::Experimental::REvePointSet, ROOT::Experimental::REvePointSetArray, ROOT::Experimental::REveTrackList, TEvePointSet, TEvePointSetArray, TEveTrackList, TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TTeXDump, and TVirtualX.

Definition at line 48 of file TAttMarker.h.

◆ SetMarkerStyle()

virtual void TAttMarker::SetMarkerStyle ( Style_t mstyle = 1)
inlinevirtualinherited

◆ SetMaxEntryLoop()

virtual void TTree::SetMaxEntryLoop ( Long64_t maxev = kMaxEntries)
inlinevirtualinherited

Definition at line 715 of file TTree.h.

◆ SetMaxTreeSize()

void TTree::SetMaxTreeSize ( Long64_t maxsize = 100000000000LL)
staticinherited

Set the maximum size in bytes of a Tree file (static function).

The default size is 100000000000LL, ie 100 Gigabytes.

In TTree::Fill, when the file has a size > fgMaxTreeSize, the function closes the current file and starts writing into a new file with a name of the style "file_1.root" if the original requested file name was "file.root".

Definition at line 9462 of file TTree.cxx.

◆ SetMaxVirtualSize()

virtual void TTree::SetMaxVirtualSize ( Long64_t size = 0)
inlinevirtualinherited

Definition at line 717 of file TTree.h.

◆ SetName()

void TTree::SetName ( const char * name)
overridevirtualinherited

Change the name of this tree.

Reimplemented from TNamed.

Definition at line 9470 of file TTree.cxx.

◆ SetNameTitle()

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

Set all the TNamed parameters (name and title).

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

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

Definition at line 163 of file TNamed.cxx.

◆ SetNotify()

void TTree::SetNotify ( TObject * obj)
virtualinherited

Sets the address of the object to be notified when the tree is loaded.

The method TObject::Notify is called for the given object when the tree is loaded. Specifically this occurs in the TTree::LoadTree method. To remove the notification call this method with nullptr:

tree->SetNotify(nullptr);

If this is a TChain, obj is most often going to be a TNotifyLink.

Parameters
[in]objPointer to a TObject to be notified.

Definition at line 9496 of file TTree.cxx.

◆ SetObject()

void TTree::SetObject ( const char * name,
const char * title )
virtualinherited

Change the name and title of this tree.

Definition at line 9525 of file TTree.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetParallelUnzip()

void TTree::SetParallelUnzip ( bool opt = true,
Float_t RelSize = -1 )
virtualinherited

Enable or disable parallel unzipping of Tree buffers.

Definition at line 9556 of file TTree.cxx.

◆ SetPerfStats()

void TTree::SetPerfStats ( TVirtualPerfStats * perf)
virtualinherited

Set perf stats.

Definition at line 9594 of file TTree.cxx.

◆ SetScanField()

virtual void TTree::SetScanField ( Int_t n = 50)
inlinevirtualinherited

Sets the default maximum number of lines to be shown before <CR> when calling Scan().

Parameters
nthe maximum number of lines. Default=50, if 0, all entries of the Tree are shown and there is no need to press <CR> or q to exit the function.
Note
See TTreePlayer::Scan for more details on how to redirect the output to an ASCII file

Definition at line 743 of file TTree.h.

◆ SetTargetMemoryRatio()

void TTree::SetTargetMemoryRatio ( Float_t ratio)
inlineinherited

Definition at line 744 of file TTree.h.

◆ SetTimerInterval()

virtual void TTree::SetTimerInterval ( Int_t msec = 333)
inlinevirtualinherited

Definition at line 745 of file TTree.h.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetTreeIndex()

void TTree::SetTreeIndex ( TVirtualIndex * index)
virtualinherited

The current TreeIndex is replaced by the new index.

Note that this function does not delete the previous index. This gives the possibility to play with more than one index, e.g.,

TVirtualIndex* oldIndex = tree.GetTreeIndex();
tree.SetTreeIndex(newIndex);
tree.Draw();
tree.SetTreeIndex(oldIndex);
tree.Draw(); etc
virtual void Draw(Option_t *option="")
Default Draw method for all objects.
Definition TObject.cxx:293
Abstract interface for Tree Index.

Definition at line 9611 of file TTree.cxx.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetUpdate()

virtual void TTree::SetUpdate ( Int_t freq = 0)
inlinevirtualinherited

Definition at line 748 of file TTree.h.

◆ SetWeight()

void TTree::SetWeight ( Double_t w = 1,
Option_t * option = "" )
virtualinherited

Set tree weight.

The weight is used by TTree::Draw to automatically weight each selected entry in the resulting histogram.

For example the equivalent of:

T.Draw("x", "w")

is:

T.SetWeight(w);
T.Draw("x");

This function is redefined by TChain::SetWeight. In case of a TChain, an option "global" may be specified to set the same weight for all trees in the TChain instead of the default behaviour using the weights of each tree in the chain (see TChain::SetWeight).

Reimplemented in TChain.

Definition at line 9639 of file TTree.cxx.

◆ Show()

void TTree::Show ( Long64_t entry = -1,
Int_t lenmax = 20 )
virtualinherited

Print values of all active leaves for entry.

  • if entry==-1, print current entry (default)
  • if a leaf is an array, a maximum of lenmax elements is printed.

Definition at line 9650 of file TTree.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

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

Definition at line 182 of file TNamed.cxx.

◆ SortBranchesByTime()

void TTree::SortBranchesByTime ( )
privateinherited

Sorts top-level branches by the last average task time recorded per branch.

Definition at line 5914 of file TTree.cxx.

◆ StartViewer()

void TTree::StartViewer ( )
virtualinherited

Start the TTreeViewer on this tree.

  • ww is the width of the canvas in pixels
  • wh is the height of the canvas in pixels

Definition at line 9724 of file TTree.cxx.

◆ StopCacheLearningPhase()

Int_t TTree::StopCacheLearningPhase ( )
virtualinherited

Stop the cache learning phase.

Returns:

  • 0 learning phase stopped or not active
  • -1 on error

Definition at line 9739 of file TTree.cxx.

◆ Streamer()

void TTreeSQL::Streamer ( TBuffer & b)
overridevirtual

Stream a class object.

Reimplemented from TTree.

◆ StreamerNVirtual()

void TTreeSQL::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 94 of file TTreeSQL.h.

◆ SysError()

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

Issue system error message.

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

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ UnbinnedFit()

Int_t TTree::UnbinnedFit ( const char * funcname,
const char * varexp,
const char * selection = "",
Option_t * option = "",
Long64_t nentries = kMaxEntries,
Long64_t firstentry = 0 )
virtualinherited

Unbinned fit of one or more variable(s) from a tree.

funcname is a TF1 function.

Note
see TTree::Draw for explanations of the other parameters.

Fit the variable varexp using the function funcname using the selection cuts given by selection.

The list of fit options is given in parameter option.

  • option = "Q" Quiet mode (minimum printing)
  • option = "V" Verbose mode (default is between Q and V)
  • option = "E" Perform better Errors estimation using Minos technique
  • option = "M" More. Improve fit results

You can specify boundary limits for some or all parameters via

func->SetParLimits(p_number, parmin, parmax);

if parmin>=parmax, the parameter is fixed

Note that you are not forced to fix the limits for all parameters. For example, if you fit a function with 6 parameters, you can do:

func->SetParameters(0,3.1,1.e-6,0.1,-8,100);
func->SetParLimits(4,-10,-4);
func->SetParLimits(5, 1,1);

With this setup:

  • Parameters 0->3 can vary freely
  • Parameter 4 has boundaries [-10,-4] with initial value -8
  • Parameter 5 is fixed to 100.

For the fit to be meaningful, the function must be self-normalized.

i.e. It must have the same integral regardless of the parameter settings. Otherwise the fit will effectively just maximize the area.

It is mandatory to have a normalization variable which is fixed for the fit. e.g.

TF1* f1 = new TF1("f1", "gaus(0)/sqrt(2*3.14159)/[2]", 0, 5);
f1->SetParameters(1, 3.1, 0.01);
f1->SetParLimits(0, 1, 1); // fix the normalization parameter to 1
data->UnbinnedFit("f1", "jpsimass", "jpsipt>3.0");
Definition TF1.h:182

1, 2 and 3 Dimensional fits are supported. See also TTree::Fit

Return status:

  • The function return the status of the fit in the following form fitResult = migradResult + 10*minosResult + 100*hesseResult + 1000*improveResult
  • The fitResult is 0 is the fit is OK.
  • The fitResult is negative in case of an error not connected with the fit.
  • The number of entries used in the fit can be obtained via mytree.GetSelectedRows();
  • If the number of selected entries is null the function returns -1

Definition at line 9970 of file TTree.cxx.

◆ UseCurrentStyle()

void TTree::UseCurrentStyle ( )
overridevirtualinherited

Replace current attributes by current style.

Reimplemented from TObject.

Definition at line 9982 of file TTree.cxx.

◆ Warning()

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

Issue warning message.

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

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

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

Write this object to the current directory.

For more see TObject::Write If option & kFlushBasket, call FlushBasket before writing the tree.

Reimplemented from TObject.

Definition at line 10009 of file TTree.cxx.

◆ Write() [2/2]

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

Write this object to the current directory.

For more see TObject::Write If option & kFlushBasket, call FlushBasket before writing the tree.

Reimplemented from TObject.

Definition at line 10021 of file TTree.cxx.

Member Data Documentation

◆ fAliases

TList* TTree::fAliases
protectedinherited

List of aliases for expressions based on the tree branches.

Definition at line 134 of file TTree.h.

◆ fAllocationCount

std::atomic<UInt_t> TTree::fAllocationCount {0}
mutableprotectedinherited

memory churn.

! Number of reallocations basket memory buffers.

Definition at line 162 of file TTree.h.

◆ fAutoFlush

Long64_t TTree::fAutoFlush
protectedinherited

Auto-flush tree when fAutoFlush entries written or -fAutoFlush (compressed) bytes produced.

Definition at line 111 of file TTree.h.

◆ fAutoSave

Long64_t TTree::fAutoSave
protectedinherited

Autosave tree when fAutoSave entries written or -fAutoSave (compressed) bytes produced.

Definition at line 110 of file TTree.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBranchChecked

bool TTreeSQL::fBranchChecked
protected

Definition at line 53 of file TTreeSQL.h.

◆ fBranches

TObjArray TTree::fBranches
protectedinherited

List of Branches.

Definition at line 132 of file TTree.h.

◆ fBranchRef

TBranchRef* TTree::fBranchRef
protectedinherited

Branch supporting the TRefTable (if any).

Definition at line 146 of file TTree.h.

◆ fCacheDoAutoInit

bool TTree::fCacheDoAutoInit
protectedinherited

! true if cache auto creation or resize check is needed

Definition at line 149 of file TTree.h.

◆ fCacheDoClusterPrefetch

bool TTree::fCacheDoClusterPrefetch
protectedinherited

! true if cache is prefetching whole clusters

Definition at line 150 of file TTree.h.

◆ fCacheSize

Long64_t TTree::fCacheSize
protectedinherited

! Maximum size of file buffers

Definition at line 115 of file TTree.h.

◆ fCacheUserSet

bool TTree::fCacheUserSet
protectedinherited

! true if the cache setting was explicitly given by user

Definition at line 151 of file TTree.h.

◆ fChainOffset

Long64_t TTree::fChainOffset
protectedinherited

! Offset of 1st entry of this Tree in a TChain

Definition at line 116 of file TTree.h.

◆ fClones

TList* TTree::fClones
protectedinherited

! List of cloned trees which share our addresses

Definition at line 145 of file TTree.h.

◆ fClusterRangeEnd

Long64_t* TTree::fClusterRangeEnd
protectedinherited

[fNClusterRange] Last entry of a cluster range.

Definition at line 113 of file TTree.h.

◆ fClusterSize

Long64_t* TTree::fClusterSize
protectedinherited

[fNClusterRange] Number of entries in each cluster for a given range.

Definition at line 114 of file TTree.h.

◆ fCurrentEntry

Int_t TTreeSQL::fCurrentEntry
protected

Definition at line 45 of file TTreeSQL.h.

◆ fDB

TString TTreeSQL::fDB
protected

Definition at line 46 of file TTreeSQL.h.

◆ fDebug

Int_t TTree::fDebug
protectedinherited

! Debug level

Definition at line 121 of file TTree.h.

◆ fDebugMax

Long64_t TTree::fDebugMax
protectedinherited

! Last entry number to debug

Definition at line 123 of file TTree.h.

◆ fDebugMin

Long64_t TTree::fDebugMin
protectedinherited

! First entry number to debug

Definition at line 122 of file TTree.h.

◆ fDefaultEntryOffsetLen

Int_t TTree::fDefaultEntryOffsetLen
protectedinherited

Initial Length of fEntryOffset table in the basket buffers.

Definition at line 104 of file TTree.h.

◆ fDirectory

TDirectory* TTree::fDirectory
protectedinherited

! Pointer to directory holding this tree

Definition at line 131 of file TTree.h.

◆ fEntries

Long64_t TTree::fEntries
protectedinherited

Number of entries.

Definition at line 94 of file TTree.h.

◆ fEntryList

TEntryList* TTree::fEntryList
protectedinherited

! Pointer to event selection list (if one)

Definition at line 136 of file TTree.h.

◆ fEstimate

Long64_t TTree::fEstimate
protectedinherited

Number of entries to estimate histogram limits.

Definition at line 112 of file TTree.h.

◆ fEventList

TEventList* TTree::fEventList
protectedinherited

! Pointer to event selection list (if one)

Definition at line 135 of file TTree.h.

◆ fExternalFriends

TList* TTree::fExternalFriends
protectedinherited

! List of TFriendsElement pointing to us and need to be notified of LoadTree. Content not owned.

Definition at line 141 of file TTree.h.

◆ fFileNumber

Int_t TTree::fFileNumber
protectedinherited

!

current file number (if file extensions)

Definition at line 126 of file TTree.h.

◆ fFillColor

Color_t TAttFill::fFillColor
protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle
protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fFlushedBytes

Long64_t TTree::fFlushedBytes
protectedinherited

Number of auto-flushed bytes.

Definition at line 99 of file TTree.h.

◆ fFriendLockStatus

UInt_t TTree::fFriendLockStatus
protectedinherited

! Record which method is locking the friend recursion

Definition at line 147 of file TTree.h.

◆ fFriends

TList* TTree::fFriends
protectedinherited

pointer to list of friend elements

Definition at line 140 of file TTree.h.

◆ fgBranchStyle

Int_t TTree::fgBranchStyle = 1
staticprotectedinherited

Old/New branch style.

Definition at line 164 of file TTree.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

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

Definition at line 49 of file TObject.h.

◆ fgMaxTreeSize

Long64_t TTree::fgMaxTreeSize = 100000000000LL
staticprotectedinherited

Maximum size of a file containing a Tree.

Definition at line 165 of file TTree.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fIMTEnabled

bool TTree::fIMTEnabled
protectedinherited

! true if implicit multi-threading is enabled for this tree

Definition at line 152 of file TTree.h.

◆ fIMTFlush

bool TTree::fIMTFlush {false}
mutableprivateinherited

! True if we are doing a multithreaded flush.

Definition at line 169 of file TTree.h.

◆ fIMTTotBytes

std::atomic<Long64_t> TTree::fIMTTotBytes
mutableprivateinherited

! Total bytes for the IMT flush baskets

Definition at line 170 of file TTree.h.

◆ fIMTZipBytes

std::atomic<Long64_t> TTree::fIMTZipBytes
mutableprivateinherited

! Zip bytes for the IMT flush baskets.

Definition at line 171 of file TTree.h.

◆ fIndex

TArrayI TTree::fIndex
protectedinherited

Index of sorted values.

Definition at line 138 of file TTree.h.

◆ fIndexValues

TArrayD TTree::fIndexValues
protectedinherited

Sorted index values.

Definition at line 137 of file TTree.h.

◆ fInsertQuery

TString TTreeSQL::fInsertQuery
protected

Definition at line 47 of file TTreeSQL.h.

◆ fIOFeatures

TIOFeatures TTree::fIOFeatures {0}
protectedinherited

IO features to define for newly-written baskets and branches.

Definition at line 124 of file TTree.h.

◆ fLeaves

TObjArray TTree::fLeaves
protectedinherited

Direct pointers to individual branch leaves.

Definition at line 133 of file TTree.h.

◆ fLineColor

Color_t TAttLine::fLineColor
protectedinherited

Line color.

Definition at line 24 of file TAttLine.h.

◆ fLineStyle

Style_t TAttLine::fLineStyle
protectedinherited

Line style.

Definition at line 25 of file TAttLine.h.

◆ fLineWidth

Width_t TAttLine::fLineWidth
protectedinherited

Line width.

Definition at line 26 of file TAttLine.h.

◆ fMakeClass

Int_t TTree::fMakeClass
protectedinherited

! not zero when processing code generated by MakeClass

Definition at line 125 of file TTree.h.

◆ fMarkerColor

Color_t TAttMarker::fMarkerColor
protectedinherited

Marker color.

Definition at line 24 of file TAttMarker.h.

◆ fMarkerSize

Size_t TAttMarker::fMarkerSize
protectedinherited

Marker size.

Definition at line 26 of file TAttMarker.h.

◆ fMarkerStyle

Style_t TAttMarker::fMarkerStyle
protectedinherited

Marker style.

Definition at line 25 of file TAttMarker.h.

◆ fMaxClusterRange

Int_t TTree::fMaxClusterRange
protectedinherited

! Memory allocated for the cluster range.

Definition at line 106 of file TTree.h.

◆ fMaxEntries

Long64_t TTree::fMaxEntries
protectedinherited

Maximum number of entries in case of circular buffers.

Definition at line 107 of file TTree.h.

◆ fMaxEntryLoop

Long64_t TTree::fMaxEntryLoop
protectedinherited

Maximum number of entries to process.

Definition at line 108 of file TTree.h.

◆ fMaxVirtualSize

Long64_t TTree::fMaxVirtualSize
protectedinherited

Maximum total size of buffers kept in memory.

Definition at line 109 of file TTree.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNamesToBranches

std::unordered_map<std::string, TBranch *> TTree::fNamesToBranches
privateinherited

! maps names to their branches, useful when retrieving branches by name

Definition at line 174 of file TTree.h.

◆ fNClusterRange

Int_t TTree::fNClusterRange
protectedinherited

Number of Cluster range in addition to the one defined by 'AutoFlush'.

Definition at line 105 of file TTree.h.

◆ fNEntriesSinceSorting

UInt_t TTree::fNEntriesSinceSorting
protectedinherited

! Number of entries processed since the last re-sorting of branches

Definition at line 153 of file TTree.h.

◆ fNfill

Int_t TTree::fNfill
protectedinherited

! Local for EntryLoop

Definition at line 120 of file TTree.h.

◆ fNotify

TObject* TTree::fNotify
protectedinherited

Object to be notified when loading a Tree.

TTree::LoadTree() and TChain::LoadTree() will call fNotify->Notify(). Usually points to a TNotifyLink if this is a TChain. !

Definition at line 130 of file TTree.h.

◆ fPacketSize

Int_t TTree::fPacketSize
protectedinherited

! Number of entries in one packet for parallel root

Definition at line 119 of file TTree.h.

◆ fPerfStats

TVirtualPerfStats* TTree::fPerfStats
protectedinherited

! pointer to the current perf stats object

Definition at line 142 of file TTree.h.

◆ fPlayer

TVirtualTreePlayer* TTree::fPlayer
protectedinherited

! Pointer to current Tree player

Definition at line 144 of file TTree.h.

◆ fQuery

TString TTreeSQL::fQuery
protected

Definition at line 48 of file TTreeSQL.h.

◆ fReadEntry

Long64_t TTree::fReadEntry
protectedinherited

! Number of the entry being processed

Definition at line 117 of file TTree.h.

◆ fResult

TSQLResult* TTreeSQL::fResult
protected

Definition at line 50 of file TTreeSQL.h.

◆ fRow

TSQLRow* TTreeSQL::fRow
protected

Definition at line 51 of file TTreeSQL.h.

◆ fSavedBytes

Long64_t TTree::fSavedBytes
protectedinherited

Number of autosaved bytes.

Definition at line 98 of file TTree.h.

◆ fScanField

Int_t TTree::fScanField
protectedinherited

Number of runs before prompting in Scan.

Definition at line 102 of file TTree.h.

◆ fSeqBranches

std::vector<TBranch*> TTree::fSeqBranches
protectedinherited

! Branches to be processed sequentially when IMT is on

Definition at line 155 of file TTree.h.

◆ fServer

TSQLServer* TTreeSQL::fServer
protected

Definition at line 52 of file TTreeSQL.h.

◆ fSortedBranches

std::vector<std::pair<Long64_t,TBranch*> > TTree::fSortedBranches
protectedinherited

! Branches to be processed in parallel when IMT is on, sorted by average task time

Definition at line 154 of file TTree.h.

◆ fTable

TString TTreeSQL::fTable
protected

Definition at line 49 of file TTreeSQL.h.

◆ fTableInfo

TSQLTableInfo* TTreeSQL::fTableInfo
protected

Definition at line 54 of file TTreeSQL.h.

◆ fTargetMemoryRatio

Float_t TTree::fTargetMemoryRatio {1.1f}
protectedinherited

!

Ratio for memory usage in uncompressed buffers versus actual occupancy. 1.0 indicates basket should be resized to exact memory usage, but causes significant

Definition at line 156 of file TTree.h.

◆ fTimerInterval

Int_t TTree::fTimerInterval
protectedinherited

Timer interval in milliseconds.

Definition at line 101 of file TTree.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fTotalBuffers

std::atomic<Long64_t> TTree::fTotalBuffers
protectedinherited

! Total number of bytes in branch buffers

Definition at line 118 of file TTree.h.

◆ fTotBytes

Long64_t TTree::fTotBytes
protectedinherited

Total number of bytes in all branches before compression.

Definition at line 96 of file TTree.h.

◆ fTransientBuffer

TBuffer* TTree::fTransientBuffer
protectedinherited

! Pointer to the current transient buffer.

Definition at line 148 of file TTree.h.

◆ fTreeIndex

TVirtualIndex* TTree::fTreeIndex
protectedinherited

Pointer to the tree Index (if any).

Definition at line 139 of file TTree.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fUpdate

Int_t TTree::fUpdate
protectedinherited

Update frequency for EntryLoop.

Definition at line 103 of file TTree.h.

◆ fUserInfo

TList* TTree::fUserInfo
protectedinherited

pointer to a list of user objects associated to this Tree

Definition at line 143 of file TTree.h.

◆ fWeight

Double_t TTree::fWeight
protectedinherited

Tree weight (see TTree::SetWeight).

Definition at line 100 of file TTree.h.

◆ fZipBytes

Long64_t TTree::fZipBytes
protectedinherited

Total number of bytes in all branches after compression.

Definition at line 97 of file TTree.h.

◆ kMaxEntries

Long64_t TTree::kMaxEntries = TVirtualTreePlayer::kMaxEntries
staticconstexprinherited

Used as the max value for any TTree range operation.

The maximum number of entries allowed in a TTree is strictly smaller than this value (maxTreeEntries<= kMaxEntries-1), ie the last entry index is at maximum kMaxEntries-2.

Definition at line 273 of file TTree.h.


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