A Tree Index with majorname and minorname.

Definition at line 32 of file TTreeIndex.h.

Public Member Functions
	TTreeIndex ()
	Default constructor for TTreeIndex. More...

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

virtual	~TTreeIndex ()
	Destructor. More...

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

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

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

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

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

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

virtual Long64_t *	GetIndex () const

virtual Long64_t *	GetIndexValues () const

virtual Long64_t *	GetIndexValuesMinor () const

const char *	GetMajorName () const

const char *	GetMinorName () const

virtual Long64_t	GetN () const

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

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

virtual TTreeFormula *	GetMajorFormulaParent (const TTree *parent)
	Return a pointer to the TreeFormula corresponding to the majorname in parent tree. More...

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

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

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

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

	ClassDef (TTreeIndex, 2)

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

virtual	~TVirtualIndex ()

virtual TTree *	GetTree () const

	ClassDef (TVirtualIndex, 1)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

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

	TNamed (const TNamed &named)

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

virtual	~TNamed ()

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

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

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

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

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

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

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

virtual Bool_t	IsSortable () const

virtual void	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

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

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

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual	~TObject ()
	TObject destructor. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

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

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual Option_t *	GetOption () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

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

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

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

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

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

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

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

void *	operator new (size_t sz, void *vp)

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

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

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

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

Protected Attributes
TString	fMajorName

TString	fMinorName

Long64_t	fN

Long64_t *	fIndexValues

Long64_t *	fIndexValuesMinor

Long64_t *	fIndex

TTreeFormula *	fMajorFormula

TTreeFormula *	fMinorFormula
	Pointer to major TreeFormula. More...

TTreeFormula *	fMajorFormulaParent
	Pointer to minor TreeFormula. More...

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

Protected Attributes inherited from TVirtualIndex
TTree *	fTree

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TTreeIndex (const TTreeIndex &)
	Pointer to minor TreeFormula in Parent tree (if any) More...

TTreeIndex &	operator= (const TTreeIndex &)

Additional Inherited Members
Public Types inherited from TObject
enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

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

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

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

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

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

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

#include <TTreeIndex.h>

Inheritance diagram for TTreeIndex:

Collaboration diagram for TTreeIndex:

Constructor & Destructor Documentation

TTreeIndex::TTreeIndex ( const TTreeIndex & )

private

Pointer to minor TreeFormula in Parent tree (if any)

TTreeIndex::TTreeIndex ( )

Default constructor for TTreeIndex.

Definition at line 46 of file TTreeIndex.cxx.

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 123 of file TTreeIndex.cxx.

TTreeIndex::~TTreeIndex ( )

virtual

Destructor.

Definition at line 199 of file TTreeIndex.cxx.

Member Function Documentation

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 216 of file TTreeIndex.cxx.

TTreeIndex::ClassDef	(	TTreeIndex	,
		2
	)

bool TTreeIndex::ConvertOldToNew ( )

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

Definition at line 297 of file TTreeIndex.cxx.

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 354 of file TTreeIndex.cxx.

Referenced by GetEntryNumberWithBestIndex(), and GetEntryNumberWithIndex().

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 319 of file TTreeIndex.cxx.

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.