A TSelector object is used by the TTree::Draw, TTree::Scan, TTree::Process to navigate in a TTree and make selections.
It contains the following main methods:
WARNING when a selector is used with a TChain:
in the Process, ProcessCut, ProcessFill function, you must use the pointer to the current Tree to call GetEntry(entry)
. entry is always the local entry number in the current tree. Assuming that fChain is the pointer to the TChain being processed, use fChain->GetTree()->GetEntry(entry);
Definition at line 31 of file TSelector.h.
Public Types | |
enum | EAbort { kContinue , kAbortProcess , kAbortFile } |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Public Member Functions | |
TSelector () | |
Default selector ctor. | |
~TSelector () override | |
Selector destructor. | |
virtual void | Abort (const char *why, EAbort what=kAbortProcess) |
Abort processing. | |
virtual void | Begin (TTree *) |
virtual EAbort | GetAbort () const |
virtual Int_t | GetEntry (Long64_t, Int_t=0) |
virtual TList * | GetInputList () const |
const char * | GetOption () const override |
virtual TList * | GetOutputList () const |
virtual Long64_t | GetStatus () const |
virtual void | ImportOutput (TList *output) |
Imports the content of 'output' in the internal output list. | |
virtual void | Init (TTree *) |
TClass * | IsA () const override |
bool | Notify () override |
This method must be overridden to handle object notification (the base implementation is no-op). | |
virtual bool | Process (Long64_t) |
The Process() function is called for each entry in the tree (or possibly keyed object in the case of PROOF) to be processed. | |
virtual bool | ProcessCut (Long64_t) |
This method is called before processing entry. | |
virtual void | ProcessFill (Long64_t) |
This method is called for all selected entries. | |
virtual void | ResetAbort () |
virtual void | SetInputList (TList *input) |
virtual void | SetObject (TObject *obj) |
virtual void | SetOption (const char *option) |
virtual void | SetStatus (Long64_t status) |
virtual void | SlaveBegin (TTree *) |
virtual void | SlaveTerminate () |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | Terminate () |
virtual int | Version () const |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. | |
virtual void | Copy (TObject &object) const |
Copy this to obj. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual 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. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual const char * | GetName () const |
Returns name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual const char * | GetTitle () const |
Returns title of object. | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
Bool_t | IsDestructed () const |
IsDestructed. | |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. | |
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). | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
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 *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) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. | |
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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static TSelector * | GetSelector (const char *filename) |
The code in filename is loaded (interpreted or compiled, see below), filename must contain a valid class implementation derived from TSelector. | |
static bool | IsStandardDraw (const char *selec) |
Find out if this is a standard selection used for Draw actions (either TSelectorDraw, TProofDraw or deriving from them). | |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Protected Attributes | |
EAbort | fAbort |
Abort status. | |
TList * | fInput |
List of objects available during processing. | |
TObject * | fObject |
! Current object if processing object (vs. TTree) | |
TString | fOption |
Option given to TTree::Process. | |
TSelectorList * | fOutput |
! List of objects created during processing | |
Long64_t | fStatus |
Selector status. | |
Private Member Functions | |
TSelector (const TSelector &) | |
TSelector & | operator= (const TSelector &) |
Additional Inherited Members | |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
#include <TSelector.h>
enum TSelector::EAbort |
Enumerator | |
---|---|
kContinue | |
kAbortProcess | |
kAbortFile |
Definition at line 34 of file TSelector.h.
|
private |
TSelector::TSelector | ( | ) |
Default selector ctor.
Definition at line 89 of file TSelector.cxx.
|
override |
Selector destructor.
Definition at line 102 of file TSelector.cxx.
|
virtual |
Abort processing.
If what = kAbortProcess, the Process() loop will be aborted. If what = kAbortFile, the current file in a chain will be aborted and the processing will continue with the next file, if there is no next file then Process() will be aborted. Abort() can also be called from Begin(), SlaveBegin(), Init() and Notify(). After abort the SlaveTerminate() and Terminate() are always called. The abort flag can be checked in these methods using GetAbort().
Definition at line 116 of file TSelector.cxx.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TProofDraw, h1analysisTreeReader, TProofDrawHist, TProofDrawProfile, TProofDrawProfile2D, TSelHist, TSelectorDraw, TSelectorEntries, and h1analysis.
Definition at line 54 of file TSelector.h.
|
static |
|
inlinestaticconstexpr |
Definition at line 79 of file TSelector.h.
|
inlinestatic |
Definition at line 79 of file TSelector.h.
|
inlinevirtual |
Definition at line 73 of file TSelector.h.
Reimplemented in RooProofDriverSelector, and TSelectorEntries.
Definition at line 59 of file TSelector.h.
|
inlinevirtual |
Definition at line 68 of file TSelector.h.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 57 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, RooProofDriverSelector, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 69 of file TSelector.h.
|
static |
The code in filename is loaded (interpreted or compiled, see below), filename must contain a valid class implementation derived from TSelector.
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. The corresponding binary file and shared library will be deleted at the end of the function. 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.
The static function returns a pointer to a TSelector object
Definition at line 142 of file TSelector.cxx.
|
inlinevirtual |
Definition at line 58 of file TSelector.h.
|
virtual |
Imports the content of 'output' in the internal output list.
Existing content in the output list is discarded (unless found also in 'output'). In particular, if 'output' is nullptr or empty, reset the internal list. On return, the content of 'output' is cleared to avoid double deletion issues. (The caller is responsible of 'output' as container: its content is transferred under the selector ownership).
Definition at line 270 of file TSelector.cxx.
|
inlinevirtual |
Reimplemented in TSelVerifyDataSet, TSelHandleDataSet, TProofDraw, TProofDrawHist, TProofDrawEventList, TProofDrawEntryList, TProofDrawProfile, TProofDrawProfile2D, h1analysisTreeReader, TSelEvent, TSelEventGen, TProofDrawGraph, TProofDrawPolyMarker3D, RooProofDriverSelector, TSelectorEntries, and h1analysis.
Definition at line 53 of file TSelector.h.
|
inlineoverridevirtual |
Reimplemented from TObject.
Reimplemented in TSelVerifyDataSet, TSelEvent, TSelEventGen, TSelHandleDataSet, TSelHist, TSelectorDraw, and TSelectorEntries.
Definition at line 79 of file TSelector.h.
|
static |
Find out if this is a standard selection used for Draw actions (either TSelectorDraw, TProofDraw or deriving from them).
Definition at line 237 of file TSelector.cxx.
|
inlineoverridevirtual |
This method must be overridden to handle object notification (the base implementation is no-op).
Different objects in ROOT use the Notify
method for different purposes, in coordination with other objects that call this method at the appropriate time.
For example, TLeaf
uses it to load class information; TBranchRef
to load contents of referenced branches TBranchRef
; most notably, based on Notify
, TChain
implements a callback mechanism to inform interested parties when it switches to a new sub-tree.
Reimplemented from TObject.
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelectorDraw, and TSelectorEntries.
Definition at line 56 of file TSelector.h.
The Process() function is called for each entry in the tree (or possibly keyed object in the case of PROOF) to be processed.
The entry argument specifies which entry in the currently loaded tree is to be processed. It can be passed to either t01::GetEntry() or TBranch::GetEntry() to read either all or the required parts of the data. When processing keyed objects with PROOF, the object is already loaded and is available via the fObject pointer.
This function should contain the "body" of the analysis. It can contain simple or elaborate selection criteria, run algorithms on the data of the event and typically fill histograms.
The processing can be stopped by calling Abort().
Use fStatus to set the return value of TTree::Process().
The return value is currently not used.
WARNING when a selector is used with a TChain, you must use the pointer to the current TTree to call GetEntry(entry). The entry is always the local entry number in the current tree. Assuming that fChain is the pointer to the TChain being processed, use: fChain->GetTree()->GetEntry(entry)
.
Reimplemented in TSelEvent, TEveSelectorToEventList, ROOT::Experimental::REveSelectorToEventList, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, RooProofDriverSelector, TSelectorEntries, h1analysis, h1analysisTreeReader, TProofDraw, and TSelectorDraw.
Definition at line 360 of file TSelector.cxx.
This method is called before processing entry.
It is the user's responsibility to read the corresponding entry in memory (may be just a partial read). The function returns true if the entry must be processed, false otherwise. This method is obsolete, use Process().
WARNING when a selector is used with a TChain: in the Process, ProcessCut, ProcessFill function, you must use the pointer to the current Tree to call GetEntry(entry). entry is always the local entry number in the current tree. Assuming that fChain is the pointer to the TChain being processed, use fChain->GetTree()->GetEntry(entry);
Definition at line 313 of file TSelector.cxx.
|
virtual |
This method is called for all selected entries.
User fills histograms in this function. This method is obsolete, use Process().
WARNING when a selector is used with a TChain: in the Process, ProcessCut, ProcessFill function, you must use the pointer to the current Tree to call GetEntry(entry). entry is always the local entry number in the current tree. Assuming that fChain is the pointer to the TChain being processed, use fChain->GetTree()->GetEntry(entry);
Reimplemented in TSelectorDraw.
Definition at line 330 of file TSelector.cxx.
|
inlinevirtual |
Definition at line 74 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, RooProofDriverSelector, h1analysis, and h1analysisTreeReader.
Definition at line 66 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, RooProofDriverSelector, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 65 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, RooProofDriverSelector, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 64 of file TSelector.h.
|
inlinevirtual |
Definition at line 67 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelHandleDataSet, TProofDraw, TProofDrawHist, TProofDrawEventList, TProofDrawEntryList, TProofDrawProfile, TProofDrawProfile2D, TProofDrawGraph, TProofDrawPolyMarker3D, TProofDrawListOfGraphs, TProofDrawListOfPolyMarkers3D, h1analysisTreeReader, TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHist, RooProofDriverSelector, TSelectorEntries, and h1analysis.
Definition at line 55 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, TProofDraw, TProofDrawEventList, TProofDrawEntryList, RooProofDriverSelector, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 70 of file TSelector.h.
|
overridevirtual |
Stream an object of class TObject.
Reimplemented from TObject.
Reimplemented in TSelVerifyDataSet, TSelEvent, TSelEventGen, TSelHandleDataSet, TSelHist, TSelectorDraw, and TSelectorEntries.
|
inline |
Definition at line 79 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, TProofDraw, TProofDrawHist, TProofDrawEventList, TProofDrawEntryList, TProofDrawProfile, TProofDrawProfile2D, TProofDrawGraph, TProofDrawPolyMarker3D, TProofDrawListOfGraphs, TProofDrawListOfPolyMarkers3D, TSelectorDraw, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 71 of file TSelector.h.
|
inlinevirtual |
Reimplemented in TSelEvent, TEveSelectorToEventList, ROOT::Experimental::REveSelectorToEventList, TSelVerifyDataSet, TSelEventGen, TSelHandleDataSet, TSelHist, TProofDraw, RooProofDriverSelector, TSelectorEntries, h1analysis, and h1analysisTreeReader.
Definition at line 52 of file TSelector.h.
|
protected |
Abort status.
Definition at line 38 of file TSelector.h.
|
protected |
List of objects available during processing.
Definition at line 41 of file TSelector.h.
|
protected |
! Current object if processing object (vs. TTree)
Definition at line 40 of file TSelector.h.
|
protected |
Option given to TTree::Process.
Definition at line 39 of file TSelector.h.
|
protected |
! List of objects created during processing
Definition at line 42 of file TSelector.h.
|
protected |
Selector status.
Definition at line 37 of file TSelector.h.