A Tree Index with majorname and minorname.

Definition at line 29 of file TTreeIndex.h.

Public Member Functions
	TTreeIndex ()
	Default constructor for TTreeIndex.

	TTreeIndex (const TTree T, const char majorname, const char *minorname)
	Normal constructor for TTreeIndex.

virtual	~TTreeIndex ()
	Destructor.

virtual void	Append (const TVirtualIndex *, Bool_t delaySort=kFALSE)
	Append 'add' to this index.

bool	ConvertOldToNew ()
	conversion from old 64bit indexes return true if index was converted

Long64_t	FindValues (Long64_t major, Long64_t minor) const
	find position where major\|minor values are in the IndexValues tables this is the index in IndexValues table, not entry# ! use lower_bound STD algorithm.

virtual Long64_t	GetEntryNumberFriend (const TTree *parent)
	Returns the entry number in this (friend) Tree corresponding to entry in the master Tree 'parent'.

virtual Long64_t	GetEntryNumberWithBestIndex (Long64_t major, Long64_t minor) const
	Return entry number corresponding to major and minor number.

virtual Long64_t	GetEntryNumberWithIndex (Long64_t major, Long64_t minor) const
	Return entry number corresponding to major and minor number.

virtual Long64_t *	GetIndex () const

virtual Long64_t *	GetIndexValues () const

virtual Long64_t *	GetIndexValuesMinor () const

virtual TTreeFormula *	GetMajorFormula ()
	Return a pointer to the TreeFormula corresponding to the majorname.

const char *	GetMajorName () const

virtual TTreeFormula *	GetMinorFormula ()
	Return a pointer to the TreeFormula corresponding to the minorname.

const char *	GetMinorName () const

virtual Long64_t	GetN () const

virtual Bool_t	IsValidFor (const TTree *parent)
	Return kTRUE if index can be applied to the TTree.

virtual void	Print (Option_t *option="") const
	Print the table with : serial number, majorname, minorname.

virtual void	SetTree (const TTree *T)
	this function is called by TChain::LoadTree and TTreePlayer::UpdateFormulaLeaves when a new Tree is loaded.

virtual void	UpdateFormulaLeaves (const TTree *parent)
	Called by TChain::LoadTree when the parent chain changes it's tree.

Public Member Functions inherited from TVirtualIndex
	TVirtualIndex ()
	pointer to Tree

virtual	~TVirtualIndex ()

virtual TTree *	GetTree () const

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

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 two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual const char *	GetName () const
	Returns name of object.

virtual const char *	GetTitle () const
	Returns title of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

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	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 for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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 char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

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)

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

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

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)
	Operator delete [].

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

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
TTreeFormula *	GetMajorFormulaParent (const TTree *parent)
	Pointer to minor TreeFormula in Parent tree (if any)

TTreeFormula *	GetMinorFormulaParent (const TTree *parent)
	Return a pointer to the TreeFormula corresponding to the minorname in parent tree.

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 ()

Protected Attributes
Long64_t *	fIndex

Long64_t *	fIndexValues

Long64_t *	fIndexValuesMinor

TTreeFormula *	fMajorFormula

TTreeFormula *	fMajorFormulaParent
	Pointer to minor TreeFormula.

TString	fMajorName

TTreeFormula *	fMinorFormula
	Pointer to major TreeFormula.

TTreeFormula *	fMinorFormulaParent
	Pointer to major TreeFormula in Parent tree (if any)

TString	fMinorName

Long64_t	fN

Protected Attributes inherited from TVirtualIndex
TTree *	fTree

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TTreeIndex (const TTreeIndex &)=delete

TTreeIndex &	operator= (const TTreeIndex &)=delete

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <TTreeIndex.h>

Inheritance diagram for TTreeIndex:

[legend]

Constructor & Destructor Documentation

◆ TTreeIndex() [1/3]

TTreeIndex::TTreeIndex ( const TTreeIndex & )

privatedelete

◆ TTreeIndex() [2/3]

TTreeIndex::TTreeIndex ( )

Default constructor for TTreeIndex.

Definition at line 49 of file TTreeIndex.cxx.

◆ TTreeIndex() [3/3]

TTreeIndex::TTreeIndex	(	const TTree *	T,
		const char *	majorname,
		const char *	minorname
	)

Normal constructor for TTreeIndex.

Build an index table using the leaves of Tree T with major & minor names The index is built with the expressions given in "majorname" and "minorname".

a Long64_t array fIndexValues is built with:

major = the value of majorname converted to an integer
minor = the value of minorname converted to an integer
fIndexValues[i] = major<<31 + minor

This array is sorted. The sorted fIndex[i] contains the serial number in the Tree corresponding to the pair "major,minor" in fIndexvalues[i].

Once the index is computed, one can retrieve one entry via

T->GetEntryWithIndex(majornumber, minornumber)

Example:

tree.BuildIndex("Run","Event"); //creates an index using leaves Run and Event
tree.GetEntryWithIndex(1234,56789); // reads entry corresponding to
                                    // Run=1234 and Event=56789

Note that majorname and minorname may be expressions using original Tree variables eg: "run-90000", "event +3*xx". However the result must be integer.

In case an expression is specified, the equivalent expression must be computed when calling GetEntryWithIndex.

To build an index with only majorname, specify minorname="0" (default)

TreeIndex and Friend Trees

Assuming a parent Tree T and a friend Tree TF, the following cases are supported:

CASE 1: T->GetEntry(entry) is called In this case, the serial number entry is used to retrieve the data in both Trees.
CASE 2: T->GetEntry(entry) is called, TF has a TreeIndex the expressions given in major/minorname of TF are used to compute the value pair major,minor with the data in T. TF->GetEntryWithIndex(major,minor) is then called (tricky case!)
CASE 3: T->GetEntryWithIndex(major,minor) is called. It is assumed that both T and TF have a TreeIndex built using the same major and minor name.

Saving the TreeIndex

Once the index is built, it can be saved with the TTree object with tree.Write(); (if the file has been open in "update" mode).

The most convenient place to create the index is at the end of the filling process just before saving the Tree header. If a previous index was computed, it is redefined by this new call.

Note that this function can also be applied to a TChain.

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

It is possible to play with different TreeIndex in the same Tree. see comments in TTree::SetTreeIndex.

Definition at line 126 of file TTreeIndex.cxx.

◆ ~TTreeIndex()

TTreeIndex::~TTreeIndex ( )

virtual

Destructor.

Definition at line 213 of file TTreeIndex.cxx.

Member Function Documentation

◆ Append()

void TTreeIndex::Append	(	const TVirtualIndex *	add,
		Bool_t	delaySort = `kFALSE`
	)

virtual

Append 'add' to this index.

Entry 0 in add will become entry n+1 in this. If delaySort is true, do not sort the value, then you must call Append(0,kFALSE);

Implements TVirtualIndex.

Definition at line 230 of file TTreeIndex.cxx.

◆ ConvertOldToNew()

bool TTreeIndex::ConvertOldToNew ( )

conversion from old 64bit indexes return true if index was converted

Definition at line 311 of file TTreeIndex.cxx.

◆ FindValues()

Long64_t TTreeIndex::FindValues	(	Long64_t	major,
		Long64_t	minor
	)		const

find position where major|minor values are in the IndexValues tables this is the index in IndexValues table, not entry# ! use lower_bound STD algorithm.

Definition at line 371 of file TTreeIndex.cxx.

◆ GetEntryNumberFriend()

Long64_t TTreeIndex::GetEntryNumberFriend ( const TTree * parent )

virtual

Returns the entry number in this (friend) Tree corresponding to entry in the master Tree 'parent'.

In case this (friend) Tree and 'master' do not share an index with the same major and minor name, the entry serial number in the (friend) tree and in the master Tree are assumed to be the same

Implements TVirtualIndex.

Definition at line 333 of file TTreeIndex.cxx.

◆ GetEntryNumberWithBestIndex()

Long64_t TTreeIndex::GetEntryNumberWithBestIndex	(	Long64_t	major,
		Long64_t	minor
	)		const

virtual

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 Double_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 maches 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 immediatly lower than the requested value, ie it will return -1 if the pair is lower than the first entry in the index.

◆ GetEntryNumberWithIndex()

Long64_t TTreeIndex::GetEntryNumberWithIndex	(	Long64_t	major,
		Long64_t	minor
	)		const

virtual

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 Double_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 maches val, it returns directly the index in the table, otherwise it returns -1.

◆ GetIndex()

virtual Long64_t * TTreeIndex::GetIndex ( ) const

inlinevirtual

Definition at line 60 of file TTreeIndex.h.

◆ GetIndexValues()

virtual Long64_t * TTreeIndex::GetIndexValues ( ) const

inlinevirtual

Definition at line 61 of file TTreeIndex.h.

◆ GetIndexValuesMinor()

Long64_t * TTreeIndex::GetIndexValuesMinor ( ) const

virtual

Definition at line 444 of file TTreeIndex.cxx.

◆ GetMajorFormula()

TTreeFormula * TTreeIndex::GetMajorFormula ( )

virtual

Return a pointer to the TreeFormula corresponding to the majorname.

Definition at line 454 of file TTreeIndex.cxx.

◆ GetMajorFormulaParent()

TTreeFormula * TTreeIndex::GetMajorFormulaParent ( const TTree * parent )

protected

Pointer to minor TreeFormula in Parent tree (if any)

Return a pointer to the TreeFormula corresponding to the majorname in parent tree.

Definition at line 478 of file TTreeIndex.cxx.

◆ GetMajorName()

const char * TTreeIndex::GetMajorName ( ) const

inlinevirtual

Implements TVirtualIndex.

Definition at line 63 of file TTreeIndex.h.

◆ GetMinorFormula()

TTreeFormula * TTreeIndex::GetMinorFormula ( )

virtual

Return a pointer to the TreeFormula corresponding to the minorname.

Definition at line 466 of file TTreeIndex.cxx.

◆ GetMinorFormulaParent()

TTreeFormula * TTreeIndex::GetMinorFormulaParent ( const TTree * parent )

protected

Return a pointer to the TreeFormula corresponding to the minorname in parent tree.

Definition at line 497 of file TTreeIndex.cxx.

◆ GetMinorName()

const char * TTreeIndex::GetMinorName ( ) const

inlinevirtual

Implements TVirtualIndex.

Definition at line 64 of file TTreeIndex.h.

◆ GetN()

virtual Long64_t TTreeIndex::GetN ( ) const

inlinevirtual

Implements TVirtualIndex.

Definition at line 65 of file TTreeIndex.h.

◆ IsValidFor()

Bool_t TTreeIndex::IsValidFor ( const TTree * parent )

virtual

Return kTRUE if index can be applied to the TTree.

Implements TVirtualIndex.

Definition at line 516 of file TTreeIndex.cxx.

◆ operator=()

TTreeIndex & TTreeIndex::operator= ( const TTreeIndex & )

privatedelete

◆ Print()

void TTreeIndex::Print ( Option_t * option = "" ) const

virtual

Print the table with : serial number, majorname, minorname.

if option = "10" print only the first 10 entries
if option = "100" print only the first 100 entries
if option = "1000" print only the first 1000 entries

Reimplemented from TNamed.

Definition at line 532 of file TTreeIndex.cxx.

◆ SetTree()

void TTreeIndex::SetTree ( const TTree * T )

virtual

this function is called by TChain::LoadTree and TTreePlayer::UpdateFormulaLeaves when a new Tree is loaded.

Because Trees in a TChain may have a different list of leaves, one must update the leaves numbers in the TTreeFormula used by the TreeIndex.

Implements TVirtualIndex.

Definition at line 628 of file TTreeIndex.cxx.

◆ UpdateFormulaLeaves()

void TTreeIndex::UpdateFormulaLeaves ( const TTree * parent )

virtual

Called by TChain::LoadTree when the parent chain changes it's tree.

Implements TVirtualIndex.

Definition at line 609 of file TTreeIndex.cxx.

Member Data Documentation

◆ fIndex

Long64_t* TTreeIndex::fIndex

protected

Definition at line 37 of file TTreeIndex.h.

◆ fIndexValues

Long64_t* TTreeIndex::fIndexValues

protected

Definition at line 35 of file TTreeIndex.h.

◆ fIndexValuesMinor

Long64_t* TTreeIndex::fIndexValuesMinor

protected

Definition at line 36 of file TTreeIndex.h.

◆ fMajorFormula

TTreeFormula* TTreeIndex::fMajorFormula

protected

Definition at line 38 of file TTreeIndex.h.

◆ fMajorFormulaParent

TTreeFormula* TTreeIndex::fMajorFormulaParent

protected

Pointer to minor TreeFormula.

Definition at line 40 of file TTreeIndex.h.

◆ fMajorName

TString TTreeIndex::fMajorName

protected

Definition at line 32 of file TTreeIndex.h.

◆ fMinorFormula

TTreeFormula* TTreeIndex::fMinorFormula

protected

Pointer to major TreeFormula.

Definition at line 39 of file TTreeIndex.h.

◆ fMinorFormulaParent

TTreeFormula* TTreeIndex::fMinorFormulaParent

protected

Pointer to major TreeFormula in Parent tree (if any)

Definition at line 41 of file TTreeIndex.h.

◆ fMinorName

TString TTreeIndex::fMinorName

protected

Definition at line 33 of file TTreeIndex.h.

◆ fN

Long64_t TTreeIndex::fN

protected

Definition at line 34 of file TTreeIndex.h.

Libraries for TTreeIndex:

[legend]

The documentation for this class was generated from the following files:

tree/treeplayer/inc/TTreeIndex.h
tree/treeplayer/src/TTreeIndex.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TTreeIndex() [1/3]

◆ TTreeIndex() [2/3]

◆ TTreeIndex() [3/3]

TreeIndex and Friend Trees

Saving the TreeIndex

◆ ~TTreeIndex()

Member Function Documentation

◆ Append()

◆ ConvertOldToNew()

◆ FindValues()

◆ GetEntryNumberFriend()

◆ GetEntryNumberWithBestIndex()

◆ GetEntryNumberWithIndex()

◆ GetIndex()

◆ GetIndexValues()

◆ GetIndexValuesMinor()

◆ GetMajorFormula()

◆ GetMajorFormulaParent()

◆ GetMajorName()

◆ GetMinorFormula()

◆ GetMinorFormulaParent()

◆ GetMinorName()

◆ GetN()

◆ IsValidFor()

◆ operator=()

◆ Print()

◆ SetTree()

◆ UpdateFormulaLeaves()

Member Data Documentation

◆ fIndex

◆ fIndexValues

◆ fIndexValuesMinor

◆ fMajorFormula

◆ fMajorFormulaParent

◆ fMajorName

◆ fMinorFormula

◆ fMinorFormulaParent

◆ fMinorName

◆ fN