Wrapper class for ROOT tree management with vector-based data storage. More...

#include <QwRootFile.h>

Collaboration diagram for QwRootTree:

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

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

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

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

virtual	~QwRootTree ()
	Destructor.

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

Long64_t	AutoSave (Option_t *option)

Int_t	Fill ()
	Fill the tree.

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

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

Private Member Functions
void	ConstructNewTree ()
	Construct the tree.

void	ConstructUnitsBranch ()

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

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

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

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

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

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

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

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

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

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

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

void	SetCircular (Long64_t buff=100000)

Private Attributes
TTree *	fTree
	Tree pointer.

QwRootTreeBranchVector	fVector
	Vector of leaves.

const std::string	fName
	Name, description.

const std::string	fDesc

const std::string	fPrefix

std::string	fType
	Object type.

UInt_t	fCurrentEvent
	Tree prescaling parameters.

UInt_t	fNumEventsCycle

UInt_t	fNumEventsToSave

UInt_t	fNumEventsToSkip

Long64_t	fMaxTreeSize
	Maximum tree size, autoflush and autosave.

Long64_t	fAutoFlush

Long64_t	fAutoSave

Int_t	fBasketSize

Static Private Attributes
static const TString	kUnitsName = "ppm/D:ppb/D:um/D:mm/D:mV_uA/D:V_uA/D"

static Double_t	kUnitsValue [] = { 1e-6, 1e-9, 1e-3, 1 , 1e-3, 1}

Friends
class	QwRootFile

Detailed Description

Wrapper class for ROOT tree management with vector-based data storage.

Provides functionality to write to ROOT trees using vectors of doubles, with support for branch construction, event filtering, and tree sharing. Handles both new tree creation and attachment to existing trees, enabling multiple subsystems to contribute data to a single ROOT tree.

Definition at line 369 of file QwRootFile.h.

Constructor & Destructor Documentation

◆ QwRootTree() [1/4]

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

inline

Constructor with name, and description.

Definition at line 374 of file QwRootFile.h.

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

References ConstructNewTree(), fCurrentEvent, fDesc, fName, fNumEventsCycle, fNumEventsToSave, fNumEventsToSkip, fPrefix, and fType.

Referenced by ConstructIndexTo(), QwRootTree(), and QwRootTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ QwRootTree() [2/4]

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

inline

Constructor with existing tree.

Definition at line 382 of file QwRootFile.h.

    : 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;
    }

References QwLog::endl(), fCurrentEvent, fDesc, fName, fNumEventsCycle, fNumEventsToSave, fNumEventsToSkip, fPrefix, fTree, fType, GetDesc(), GetName(), QwMessage, and QwRootTree().

Here is the call graph for this function:

◆ QwRootTree() [3/4]

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 391 of file QwRootFile.h.

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

References ConstructBranchAndVector(), ConstructNewTree(), ConstructUnitsBranch(), fCurrentEvent, fDesc, fName, fNumEventsCycle, fNumEventsToSave, fNumEventsToSkip, fPrefix, and fType.

Here is the call graph for this function:

◆ QwRootTree() [4/4]

template<class T>

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

inline

Constructor with existing tree, and object.

Definition at line 406 of file QwRootFile.h.

    : 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);
    }

References ConstructBranchAndVector(), QwLog::endl(), fCurrentEvent, fDesc, fName, fNumEventsCycle, fNumEventsToSave, fNumEventsToSkip, fPrefix, fTree, fType, GetDesc(), GetName(), QwMessage, and QwRootTree().

Here is the call graph for this function:

◆ ~QwRootTree()

virtual QwRootTree::~QwRootTree ( )

inlinevirtual

Destructor.

Definition at line 417 of file QwRootFile.h.

417{ }

Member Function Documentation

◆ AutoSave()

Long64_t QwRootTree::AutoSave ( Option_t * option )

inline

Definition at line 498 of file QwRootFile.h.

                                       {
      return fTree->AutoSave(option);
    }

References fTree.

◆ ConstructBranchAndVector()

template<class T>

void QwRootTree::ConstructBranchAndVector ( T & object )

inlineprivate

Construct the branches and vector for generic objects.

Definition at line 453 of file QwRootFile.h.

                                             {
      // 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);
      }
    }

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

Referenced by QwRootTree(), and QwRootTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConstructIndexTo()

void QwRootTree::ConstructIndexTo ( QwRootTree * to )

inlineprivate

Construct index from this tree to another tree.

Definition at line 446 of file QwRootFile.h.

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

References fCurrentEvent, fName, fTree, and QwRootTree().

Here is the call graph for this function:

◆ ConstructNewTree()

void QwRootTree::ConstructNewTree ( )

inlineprivate

Construct the tree.

Definition at line 426 of file QwRootFile.h.

                            {
      QwMessage << "New tree: " << fName << ", " << fDesc << QwLog::endl;
 
      fTree = new TTree(fName.c_str(), fDesc.c_str());
 
      // Ensure tree is in the current directory
      if (gDirectory) {
        fTree->SetDirectory(gDirectory);
 
      } else {
 
      }
    }

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

Referenced by QwRootTree(), and QwRootTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConstructUnitsBranch()

void QwRootTree::ConstructUnitsBranch ( )

inlineprivate

Definition at line 440 of file QwRootFile.h.

                                {
      std::string name = "units";
      fTree->Branch(name.c_str(), &kUnitsValue, kUnitsName);
    }

References fTree, kUnitsName, and kUnitsValue.

Referenced by QwRootTree().

Here is the caller graph for this function:

◆ Fill()

Int_t QwRootTree::Fill ( )

inline

Fill the tree.

Definition at line 503 of file QwRootFile.h.

                 {
      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;
    }

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

Here is the call graph for this function:

◆ FillTreeBranches()

template<class T>

void QwRootTree::FillTreeBranches ( const T & object )

inline

Fill the branches for generic objects.

Definition at line 477 of file QwRootFile.h.

                                           {
      // Prescale peek.  Gathering the branch vector (FillTreeVector) copies
      // every channel value and is a sizeable fraction of the per-event cost.
      // When the tree is prescaled, Fill() will discard this event anyway, so
      // skip the gather as well.  This mirrors Fill()'s computation exactly
      // (Fill() does ++fCurrentEvent then %= fNumEventsCycle), so the gather
      // and the write always agree on which events are kept.
      if (fNumEventsCycle > 0) {
        UInt_t predicted = (fCurrentEvent + 1) % fNumEventsCycle;
        if (predicted > fNumEventsToSave) return;
      }
      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);
      }
    }

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

Here is the call graph for this function:

◆ GetDesc()

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

inlineprivate

Get the description of the tree.

Definition at line 554 of file QwRootFile.h.

554{ return fDesc; };

References fDesc.

Referenced by QwRootTree(), and QwRootTree().

Here is the caller graph for this function:

◆ GetName()

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

inlineprivate

Get the name of the tree.

Definition at line 552 of file QwRootFile.h.

552{ return fName; };

References fName.

Referenced by Print(), QwRootTree(), and QwRootTree().

Here is the caller graph for this function:

◆ GetPrefix()

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

inlineprivate

Get the description of the tree.

Definition at line 556 of file QwRootFile.h.

556{ return fPrefix; };

References fPrefix.

Referenced by Print().

Here is the caller graph for this function:

◆ GetTree()

TTree * QwRootTree::GetTree ( ) const

inline

Get the tree pointer for low level operations.

Definition at line 533 of file QwRootFile.h.

533{ return fTree; };

References fTree.

◆ GetType()

std::string QwRootTree::GetType ( ) const

inlineprivate

Get the object type.

Definition at line 563 of file QwRootFile.h.

563{ return fType; };

References fType.

Referenced by Print().

Here is the caller graph for this function:

◆ Print()

void QwRootTree::Print ( ) const

inline

Print the tree name and description.

Definition at line 525 of file QwRootFile.h.

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

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

Here is the call graph for this function:

◆ SetAutoFlush()

void QwRootTree::SetAutoFlush ( Long64_t autoflush = 30000000 )

inlineprivate

Set autoflush size.

Definition at line 593 of file QwRootFile.h.

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

References fAutoFlush, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

◆ SetAutoSave()

void QwRootTree::SetAutoSave ( Long64_t autosave = 300000000 )

inlineprivate

Set autosave size.

Definition at line 601 of file QwRootFile.h.

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

References fAutoSave, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

◆ SetBasketSize()

void QwRootTree::SetBasketSize ( Int_t basketsize = 16000 )

inlineprivate

Set basket size.

Definition at line 607 of file QwRootFile.h.

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

References fBasketSize, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

◆ SetCircular()

void QwRootTree::SetCircular ( Long64_t buff = 100000 )

inlineprivate

Definition at line 613 of file QwRootFile.h.

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

References fTree.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

◆ SetMaxTreeSize()

void QwRootTree::SetMaxTreeSize ( Long64_t maxsize = 1900000000 )

inlineprivate

Set maximum tree size.

Definition at line 587 of file QwRootFile.h.

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

References fMaxTreeSize, and fTree.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

◆ SetPrescaling()

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

inlineprivate

Set tree prescaling parameters.

Definition at line 573 of file QwRootFile.h.

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

References fNumEventsCycle, fNumEventsToSave, and fNumEventsToSkip.

Referenced by QwRootFile::ConstructTreeBranches().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QwRootFile

friend class QwRootFile

friend

Definition at line 536 of file QwRootFile.h.

References QwRootFile.

Referenced by QwRootFile.

Field Documentation

◆ fAutoFlush

Long64_t QwRootTree::fAutoFlush

private

Definition at line 582 of file QwRootFile.h.

Referenced by SetAutoFlush().

◆ fAutoSave

Long64_t QwRootTree::fAutoSave

private

Definition at line 583 of file QwRootFile.h.

Referenced by SetAutoSave().

◆ fBasketSize

Int_t QwRootTree::fBasketSize

private

Definition at line 584 of file QwRootFile.h.

Referenced by SetBasketSize().

◆ fCurrentEvent

UInt_t QwRootTree::fCurrentEvent

private

Tree prescaling parameters.

Definition at line 567 of file QwRootFile.h.

Referenced by ConstructIndexTo(), Fill(), FillTreeBranches(), QwRootTree(), QwRootTree(), QwRootTree(), and QwRootTree().

◆ fDesc

const std::string QwRootTree::fDesc

private

Definition at line 548 of file QwRootFile.h.

Referenced by ConstructNewTree(), GetDesc(), QwRootTree(), QwRootTree(), QwRootTree(), and QwRootTree().

◆ fMaxTreeSize

Long64_t QwRootTree::fMaxTreeSize

private

Maximum tree size, autoflush and autosave.

Definition at line 581 of file QwRootFile.h.

Referenced by SetMaxTreeSize().

◆ fName

const std::string QwRootTree::fName

private

Name, description.

Definition at line 547 of file QwRootFile.h.

Referenced by ConstructIndexTo(), ConstructNewTree(), GetName(), QwRootTree(), QwRootTree(), QwRootTree(), and QwRootTree().

◆ fNumEventsCycle

UInt_t QwRootTree::fNumEventsCycle

private

Definition at line 568 of file QwRootFile.h.

Referenced by Fill(), FillTreeBranches(), QwRootTree(), QwRootTree(), QwRootTree(), QwRootTree(), and SetPrescaling().

◆ fNumEventsToSave

UInt_t QwRootTree::fNumEventsToSave

private

Definition at line 569 of file QwRootFile.h.

Referenced by Fill(), FillTreeBranches(), QwRootTree(), QwRootTree(), QwRootTree(), QwRootTree(), and SetPrescaling().

◆ fNumEventsToSkip

UInt_t QwRootTree::fNumEventsToSkip

private

Definition at line 570 of file QwRootFile.h.

Referenced by QwRootTree(), QwRootTree(), QwRootTree(), QwRootTree(), and SetPrescaling().

◆ fPrefix

const std::string QwRootTree::fPrefix

private

Definition at line 549 of file QwRootFile.h.

Referenced by ConstructBranchAndVector(), GetPrefix(), Print(), QwRootTree(), QwRootTree(), QwRootTree(), and QwRootTree().

◆ fTree

TTree* QwRootTree::fTree

private

Tree pointer.

Definition at line 541 of file QwRootFile.h.

Referenced by AutoSave(), ConstructBranchAndVector(), ConstructIndexTo(), ConstructNewTree(), ConstructUnitsBranch(), Fill(), GetTree(), QwRootTree(), QwRootTree(), SetAutoFlush(), SetAutoSave(), SetBasketSize(), SetCircular(), and SetMaxTreeSize().

◆ fType

std::string QwRootTree::fType

private

Object type.

Definition at line 560 of file QwRootFile.h.

Referenced by ConstructBranchAndVector(), FillTreeBranches(), GetType(), QwRootTree(), QwRootTree(), QwRootTree(), and QwRootTree().

◆ fVector

QwRootTreeBranchVector QwRootTree::fVector

private

Vector of leaves.

Definition at line 543 of file QwRootFile.h.

Referenced by ConstructBranchAndVector(), and FillTreeBranches().

◆ kUnitsName

const TString QwRootTree::kUnitsName = "ppm/D:ppb/D:um/D:mm/D:mV_uA/D:V_uA/D"

staticprivate

Definition at line 422 of file QwRootFile.h.

Referenced by ConstructUnitsBranch().

◆ kUnitsValue

Double_t QwRootTree::kUnitsValue = { 1e-6, 1e-9, 1e-3, 1 , 1e-3, 1}

staticprivate

Definition at line 23 of file QwRootFile.h.

Referenced by ConstructUnitsBranch().

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QwRootTree() [1/4]

◆ QwRootTree() [2/4]

◆ QwRootTree() [3/4]

◆ QwRootTree() [4/4]

◆ ~QwRootTree()

Member Function Documentation

◆ AutoSave()

◆ ConstructBranchAndVector()

◆ ConstructIndexTo()

◆ ConstructNewTree()

◆ ConstructUnitsBranch()

◆ Fill()

◆ FillTreeBranches()

◆ GetDesc()

◆ GetName()

◆ GetPrefix()

◆ GetTree()

◆ GetType()

◆ Print()

◆ SetAutoFlush()

◆ SetAutoSave()

◆ SetBasketSize()

◆ SetCircular()

◆ SetMaxTreeSize()

◆ SetPrescaling()

Friends And Related Symbol Documentation

◆ QwRootFile

Field Documentation

◆ fAutoFlush

◆ fAutoSave

◆ fBasketSize

◆ fCurrentEvent

◆ fDesc

◆ fMaxTreeSize

◆ fName

◆ fNumEventsCycle

◆ fNumEventsToSave

◆ fNumEventsToSkip

◆ fPrefix

◆ fTree

◆ fType

◆ fVector

◆ kUnitsName

◆ kUnitsValue