A wrapper class for a ROOT tree. More...

#include <QwRootFile.h>

Public Member Functions
	QwRootTree (const std::string &name, const std::string &desc, const std::string &prefix="")
	Constructor with name, and description. More...

	QwRootTree (const QwRootTree *tree, const std::string &prefix="")
	Constructor with existing tree. More...

template<class T >
	QwRootTree (const std::string &name, const std::string &desc, T &object, const std::string &prefix="")
	Constructor with name, description, and object. More...

template<class T >
	QwRootTree (const QwRootTree *tree, T &object, const std::string &prefix="")
	Constructor with existing tree, and object. More...

virtual	~QwRootTree ()
	Destructor. More...

template<class T >
void	FillTreeBranches (const T &object)
	Fill the branches for generic objects. More...

Int_t	Fill ()
	Fill the tree. More...

void	Print () const
	Print the tree name and description. More...

TTree *	GetTree () const
	Get the tree pointer for low level operations. More...

Private Member Functions
void	ConstructNewTree ()
	Construct the tree. More...

void	ConstructIndexTo (QwRootTree *to)
	Construct index from this tree to another tree. More...

template<class T >
void	ConstructBranchAndVector (T &object)
	Construct the branches and vector for generic objects. More...

const std::string &	GetName () const
	Get the name of the tree. More...

const std::string &	GetDesc () const
	Get the description of the tree. More...

const std::string &	GetPrefix () const
	Get the description of the tree. More...

std::string	GetType () const
	Get the object type. More...

void	SetPrescaling (UInt_t num_to_save, UInt_t num_to_skip)
	Set tree prescaling parameters. More...

void	SetMaxTreeSize (Long64_t maxsize=1900000000)
	Set maximum tree size. More...

void	SetAutoFlush (Long64_t autoflush=30000000)
	Set autoflush size. More...

void	SetAutoSave (Long64_t autosave=300000000)
	Set autosave size. More...

void	SetBasketSize (Int_t basketsize=16000)
	Set basket size. More...

void	SetCircular (Long64_t buff=100000)

Private Attributes
TTree *	fTree
	Tree pointer. More...

std::vector< Double_t >	fVector
	Vector of leaves. More...

const std::string	fName
	Name, description. More...

const std::string	fDesc

const std::string	fPrefix

std::string	fType
	Object type. More...

UInt_t	fCurrentEvent
	Tree prescaling parameters. More...

UInt_t	fNumEventsCycle

UInt_t	fNumEventsToSave

UInt_t	fNumEventsToSkip

Long64_t	fMaxTreeSize
	Maximum tree size, autoflush and autosave. More...

Long64_t	fAutoFlush

Long64_t	fAutoSave

Int_t	fBasketSize

Friends
class	QwRootFile

Detailed Description

A wrapper class for a ROOT tree.

This class provides the functionality to write to ROOT trees using a vector of doubles. The vector is part of this object, as well as a pointer to the tree that contains the branches. One ROOT tree can have multiple QwRootTree objects, for example in tracking mode both parity and tracking detectors can be stored in the same tree.

Definition at line 36 of file QwRootFile.h.

Constructor & Destructor Documentation

QwRootTree::QwRootTree	(	const std::string &	name,
		const std::string &	desc,
		const std::string &	prefix = `""`
	)

inline

Constructor with name, and description.

Definition at line 41 of file QwRootFile.h.

References ConstructNewTree().

     : fName(name),fDesc(desc),fPrefix(prefix),fType("type undefined"),
       fCurrentEvent(0),fNumEventsCycle(0),fNumEventsToSave(0),fNumEventsToSkip(0) {
       // Construct tree
       ConstructNewTree();
     }

Here is the call graph for this function:

QwRootTree::QwRootTree	(	const QwRootTree *	tree,
		const std::string &	prefix = `""`
	)

inline

Constructor with existing tree.

Definition at line 49 of file QwRootFile.h.

References QwLog::endl(), fTree, GetDesc(), GetName(), and QwMessage.

     : fName(tree->GetName()),fDesc(tree->GetDesc()),fPrefix(prefix),fType("type undefined"),
       fCurrentEvent(0),fNumEventsCycle(0),fNumEventsToSave(0),fNumEventsToSkip(0) {
       QwMessage << "Existing tree: " << tree->GetName() << ", " << tree->GetDesc() << QwLog::endl;
       fTree = tree->fTree;
     }

Here is the call graph for this function:

template<class T >

QwRootTree::QwRootTree	(	const std::string &	name,
		const std::string &	desc,
		T &	object,
		const std::string &	prefix = `""`
	)

inline

Constructor with name, description, and object.

Definition at line 58 of file QwRootFile.h.

References ConstructBranchAndVector(), and ConstructNewTree().

     : fName(name),fDesc(desc),fPrefix(prefix),fType("type undefined"),
       fCurrentEvent(0),fNumEventsCycle(0),fNumEventsToSave(0),fNumEventsToSkip(0) {
       // Construct tree
       ConstructNewTree();
 
       // Construct branches and vector
       ConstructBranchAndVector(object);
     }

Here is the call graph for this function:

template<class T >

QwRootTree::QwRootTree	(	const QwRootTree *	tree,
		T &	object,
		const std::string &	prefix = `""`
	)

inline

Constructor with existing tree, and object.

Definition at line 70 of file QwRootFile.h.

References ConstructBranchAndVector(), QwLog::endl(), fTree, GetDesc(), GetName(), and QwMessage.

     : fName(tree->GetName()),fDesc(tree->GetDesc()),fPrefix(prefix),fType("type undefined"),
       fCurrentEvent(0),fNumEventsCycle(0),fNumEventsToSave(0),fNumEventsToSkip(0) {
       QwMessage << "Existing tree: " << tree->GetName() << ", " << tree->GetDesc() << QwLog::endl;
       fTree = tree->fTree;
 
       // Construct branches and vector
       ConstructBranchAndVector(object);
     }

Here is the call graph for this function:

virtual QwRootTree::~QwRootTree ( )

inlinevirtual

Destructor.

Definition at line 81 of file QwRootFile.h.

81 { }

Member Function Documentation

template<class T >

void QwRootTree::ConstructBranchAndVector ( T & object )

inlineprivate

Construct the branches and vector for generic objects.

Definition at line 100 of file QwRootFile.h.

References BRANCH_VECTOR_MAX_SIZE, QwLog::endl(), fPrefix, fTree, fType, fVector, and QwError.

Referenced by QwRootTree().

                                              {
       // Reserve space for the branch vector
       fVector.reserve(BRANCH_VECTOR_MAX_SIZE);
       // Associate branches with vector
       TString prefix = Form("%s",fPrefix.c_str());
       object.ConstructBranchAndVector(fTree, prefix, fVector);
 
       // Store the type of object
       fType = typeid(object).name();
 
       // Check memory reservation
       if (fVector.size() > BRANCH_VECTOR_MAX_SIZE) {
         QwError << "The branch vector is too large: " << fVector.size() << " leaves!  "
                 << "The maximum size is " << BRANCH_VECTOR_MAX_SIZE << "."
                 << QwLog::endl;
         exit(-1);
       }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwRootTree::ConstructIndexTo ( QwRootTree * to )

inlineprivate

Construct index from this tree to another tree.

Definition at line 93 of file QwRootFile.h.

References fCurrentEvent, fName, and fTree.

                                           {
       std::string name = "previous_entry_in_" + to->fName;
       fTree->Branch(name.c_str(), &(to->fCurrentEvent));
     }

void QwRootTree::ConstructNewTree ( )

inlineprivate

Construct the tree.

Definition at line 87 of file QwRootFile.h.

References QwLog::endl(), fDesc, fName, fTree, and QwMessage.

Referenced by QwRootTree().

                             {
       QwMessage << "New tree: " << fName << ", " << fDesc << QwLog::endl;
       fTree = new TTree(fName.c_str(), fDesc.c_str());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Int_t QwRootTree::Fill ( )

inline

Fill the tree.

Definition at line 136 of file QwRootFile.h.

References QwLog::endl(), fCurrentEvent, fNumEventsCycle, fNumEventsToSave, fTree, and QwError.

                  {
       fCurrentEvent++;
 
       // Tree prescaling
       if (fNumEventsCycle > 0) {
         fCurrentEvent %= fNumEventsCycle;
         if (fCurrentEvent > fNumEventsToSave)
           return 0;
       }
 
       // Fill the tree
       Int_t retval = fTree->Fill();
       // Check for errors
       if (retval < 0) {
         QwError << "Writing tree failed!  Check disk space or quota." << QwLog::endl;
         exit(retval);
       }
       return retval;
     }

Here is the call graph for this function:

template<class T >

void QwRootTree::FillTreeBranches ( const T & object )

inline

Fill the branches for generic objects.

Definition at line 124 of file QwRootFile.h.

References QwLog::endl(), fType, fVector, and QwError.

                                            {
       if (typeid(object).name() == fType) {
         // Fill the branch vector
         object.FillTreeVector(fVector);
       } else {
         QwError << "Attempting to fill tree vector for type " << fType << " with "
                 << "object of type " << typeid(object).name() << QwLog::endl;
         exit(-1);
       }
     }

Here is the call graph for this function:

const std::string& QwRootTree::GetDesc ( ) const

inlineprivate

Get the description of the tree.

Definition at line 187 of file QwRootFile.h.

References fDesc.

Referenced by QwRootTree().

187 { return fDesc; };

QwRootTree::fDesc

const std::string fDesc

Definition: QwRootFile.h:181

Here is the caller graph for this function:

const std::string& QwRootTree::GetName ( ) const

inlineprivate

Get the name of the tree.

Definition at line 185 of file QwRootFile.h.

References fName.

Referenced by Print(), and QwRootTree().

185 { return fName; };

QwRootTree::fName

const std::string fName

Name, description.

Definition: QwRootFile.h:180

Here is the caller graph for this function:

const std::string& QwRootTree::GetPrefix ( ) const

inlineprivate

Get the description of the tree.

Definition at line 189 of file QwRootFile.h.

References fPrefix.

Referenced by Print().

189 { return fPrefix; };

QwRootTree::fPrefix

const std::string fPrefix

Definition: QwRootFile.h:182

Here is the caller graph for this function:

TTree* QwRootTree::GetTree ( ) const

inline

Get the tree pointer for low level operations.

Definition at line 166 of file QwRootFile.h.

166 { return fTree; };

QwRootTree::fTree

TTree * fTree

Tree pointer.

Definition: QwRootFile.h:174

std::string QwRootTree::GetType ( ) const

inlineprivate

Get the object type.

Definition at line 196 of file QwRootFile.h.

References fType.

Referenced by Print().

196 { return fType; };

QwRootTree::fType

std::string fType

Object type.

Definition: QwRootFile.h:189

Here is the caller graph for this function:

void QwRootTree::Print ( ) const

inline

Print the tree name and description.

Definition at line 158 of file QwRootFile.h.

References QwLog::endl(), fPrefix, GetName(), GetPrefix(), GetType(), and QwMessage.

                        {
       QwMessage << GetName() << ", " << GetType();
       if (fPrefix != "")
         QwMessage << " (prefix " << GetPrefix() << ")";
       QwMessage << QwLog::endl;
     }

Here is the call graph for this function:

void QwRootTree::SetAutoFlush ( Long64_t autoflush = 30000000 )

inlineprivate

Set autoflush size.

Definition at line 226 of file QwRootFile.h.

References fAutoFlush, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

                                                      {
       fAutoFlush = autoflush;
       #if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,00)
         if (fTree) fTree->SetAutoFlush(autoflush);
       #endif
     }

Here is the caller graph for this function:

void QwRootTree::SetAutoSave ( Long64_t autosave = 300000000 )

inlineprivate

Set autosave size.

Definition at line 234 of file QwRootFile.h.

References fAutoSave, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

                                                     {
       fAutoSave = autosave;
       if (fTree) fTree->SetAutoSave(autosave);
     }

Here is the caller graph for this function:

void QwRootTree::SetBasketSize ( Int_t basketsize = 16000 )

inlineprivate

Set basket size.

Definition at line 240 of file QwRootFile.h.

References fBasketSize, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

                                                  {
       fBasketSize = basketsize;
       if (fTree) fTree->SetBasketSize("*",basketsize);
     }

Here is the caller graph for this function:

void QwRootTree::SetCircular ( Long64_t buff = 100000 )

inlineprivate

Definition at line 246 of file QwRootFile.h.

References fTree.

Referenced by QwRootFile::ConstructTreeBranches().

                                              {
       if (fTree) fTree->SetCircular(buff);
     }

Here is the caller graph for this function:

void QwRootTree::SetMaxTreeSize ( Long64_t maxsize = 1900000000 )

inlineprivate

Set maximum tree size.

Definition at line 220 of file QwRootFile.h.

References fMaxTreeSize, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

                                                        {
       fMaxTreeSize = maxsize;
       if (fTree) fTree->SetMaxTreeSize(maxsize);
     }

Here is the caller graph for this function:

void QwRootTree::SetPrescaling	(	UInt_t	num_to_save,
		UInt_t	num_to_skip
	)

inlineprivate

Set tree prescaling parameters.

Definition at line 206 of file QwRootFile.h.

References fNumEventsCycle, fNumEventsToSave, and fNumEventsToSkip.

Referenced by QwRootFile::ConstructTreeBranches().

                                                                {
       fNumEventsToSave = num_to_save;
       fNumEventsToSkip = num_to_skip;
       fNumEventsCycle = fNumEventsToSave + fNumEventsToSkip;
     }