A class that hopefully makes making a flat ntuple tree a bit easier since you don't need to worry about what type to make the branches and stuff. More...

#include <TreeManager.h>

Collaboration diagram for top::TreeManager:

Public Types
typedef std::function< int(top::TreeManager const *, std::string const &)>	BranchFilter
	function object type used for branch filters More...

Public Member Functions
	TreeManager ()
	Default constructor - note need to initialize the class if you use this. More...

	TreeManager (const std::string &name, TFile *outputFile, const int, const int, const int)
	You need to construct this at the start (in the same way as for the plot manager. More...

	TreeManager (const TreeManager &&rhs)
	We do allow you to move it. More...

	TreeManager (const TreeManager &)=delete
	But not to copy it. More...

TreeManager &	operator= (TreeManager const &)=delete
	Or assign it. More...

void	initialize (const std::string &name, TFile *outputFile, const int, const int, const int)
	Initialize the class with a new output file. More...

void	fill ()
	Calls TTree::Fill. More...

const std::string &	name () const
	name of the TTree More...

std::vector< BranchFilter > &	branchFilters ()
	list of functions that control which variables are written out More...

std::vector< BranchFilter > const &	branchFilters () const
	list of functions that control which variables are written out More...

template<class T >
void	makeOutputVariable (T &obj, const std::string name)
	The idea is to simplify the creation of branches so that you don't have to write tree->Branch("blah", &blah, "blah/I") because the computer can figure out the "blah/I" bit for you. More...

Private Member Functions
const char *	RootType (const char *typeid_type)
	Stolen from SFrame code. More...

const char *	TypeidType (const char *root_type)
	Stolen from SFrame code. More...

Private Attributes
std::string	m_name
	name of the tree More...

TTree *	m_tree
	Pointer to the TTree, created by this class in the constructor. More...

std::list< void * >	m_outputVarPointers
	Stolen from SFrame code. More...

std::vector< BranchFilter >	m_branchFilters
	list of functions that control which variables are written out More...

int	m_basketSizePrimitive

int	m_basketSizeVector

Detailed Description

A class that hopefully makes making a flat ntuple tree a bit easier since you don't need to worry about what type to make the branches and stuff.

Almost all this code is stolen from SFrame: http://sourceforge.net/p/sframe

Definition at line 26 of file TreeManager.h.

Member Typedef Documentation

◆ BranchFilter

typedef std::function<int (top::TreeManager const*, std::string const&)> top::TreeManager::BranchFilter

function object type used for branch filters

Definition at line 67 of file TreeManager.h.

Constructor & Destructor Documentation

◆ TreeManager() [1/4]

top::TreeManager::TreeManager ( )

Default constructor - note need to initialize the class if you use this.

Definition at line 15 of file TreeManager.cxx.

                            :
     m_name("NULL"),
     m_tree(nullptr) {
   }

◆ TreeManager() [2/4]

top::TreeManager::TreeManager	(	const std::string &	name,
		TFile *	outputFile,
		const int	nEventAutoFlush,
		const int	basketSizePrimitive,
		const int	basketSizeVector
	)

You need to construct this at the start (in the same way as for the plot manager.

Parameters

file	The file to write the tree to.
name	The name of the tree (e.g. nominal, systematic1 etc).

Definition at line 20 of file TreeManager.cxx.

                                                                                       :
     m_name(name),
     m_tree(nullptr) {
     outputFile->cd();
     m_tree = new TTree(name.c_str(), "tree");
     m_tree->SetAutoFlush(nEventAutoFlush);
     m_tree->SetAutoSave(0);
     m_basketSizePrimitive = basketSizePrimitive;
     m_basketSizeVector = basketSizeVector;
   }

◆ TreeManager() [3/4]

top::TreeManager::TreeManager ( const TreeManager && rhs )

We do allow you to move it.

Definition at line 32 of file TreeManager.cxx.

                                                   :
     m_name(std::move(rhs.m_name)),
     m_tree(std::move(rhs.m_tree)),
     m_outputVarPointers(std::move(rhs.m_outputVarPointers)) {
   }

◆ TreeManager() [4/4]

top::TreeManager::TreeManager ( const TreeManager & )

delete

But not to copy it.

Member Function Documentation

◆ branchFilters() [1/2]

std::vector<BranchFilter>& top::TreeManager::branchFilters ( )

inline

list of functions that control which variables are written out

The function objects are called in order, with the TreeManager instance and the variable name as parameters. A return value of 1 (0) tells the TreeManager that the variable should (not) be written to the n-tuple. If the function returns -1, the decision is left to the next function in the list. If there are no functions in the list, or all functions return -1, the variable is written to the n-tuple.

Definition at line 70 of file TreeManager.h.

70 {return m_branchFilters;}

◆ branchFilters() [2/2]

std::vector<BranchFilter> const& top::TreeManager::branchFilters ( ) const

inline

list of functions that control which variables are written out

The function objects are called in order, with the TreeManager instance and the variable name as parameters. A return value of 1 (0) tells the TreeManager that the variable should (not) be written to the n-tuple. If the function returns -1, the decision is left to the next function in the list. If there are no functions in the list, or all functions return -1, the variable is written to the n-tuple.

Definition at line 73 of file TreeManager.h.

73 {return m_branchFilters;}

◆ fill()

void top::TreeManager::fill ( )

Calls TTree::Fill.

Needed to fill the tree.

Definition at line 53 of file TreeManager.cxx.

                          {
     m_tree->Fill();
   }

◆ initialize()

void top::TreeManager::initialize	(	const std::string &	name,
		TFile *	outputFile,
		const int	nEventAutoFlush,
		const int	basketSizePrimitive,
		const int	basketSizeVector
	)

Initialize the class with a new output file.

Definition at line 38 of file TreeManager.cxx.

                                                                                           {
     if (m_tree) {
       ATH_MSG_WARNING("Tried to call initialize, but tree is already created. Doing nothing.");
       return;
     }
  
     outputFile->cd();
     m_tree = new TTree(name.c_str(), "tree");
     m_tree->SetAutoFlush(nEventAutoFlush);
     m_tree->SetAutoSave(0);
     m_basketSizePrimitive = basketSizePrimitive;
     m_basketSizeVector = basketSizeVector;
   }

◆ makeOutputVariable()

template<class T >

void top::TreeManager::makeOutputVariable	(	T &	obj,
		const std::string	name
	)

inline

The idea is to simplify the creation of branches so that you don't have to write tree->Branch("blah", &blah, "blah/I") because the computer can figure out the "blah/I" bit for you.

Stolen from SFrame.

Parameters

obj	The object that you would like to save in a branch. This can be a primitive type (e.g. int, unsigned int, etc.) or an object (e.g. std::vector<float>).
name	The name you would like to give this branch.

Definition at line 88 of file TreeManager.h.

                                                           {
       for (auto branchFilter : branchFilters()) {
         int status = branchFilter(this, name);
         if (status > 0) break;
         if (status == 0) return;
       }
       const char* type_name = typeid(obj).name();
       if (strlen(type_name) == 1) {
         std::ostringstream leaflist;
         leaflist << name << "/" << RootType(type_name);
         m_tree->Branch(name.c_str(), &obj, leaflist.str().c_str(), m_basketSizePrimitive);
       } else {
         m_outputVarPointers.push_back(&obj);
         T** pointer = reinterpret_cast< T** >(&m_outputVarPointers.back());
         m_tree->Branch(name.c_str(), pointer, m_basketSizeVector);
       }
     }

◆ name()

const std::string & top::TreeManager::name ( ) const

name of the TTree

Definition at line 57 of file TreeManager.cxx.

                                            {
     return m_name;
   }

◆ operator=()

TreeManager& top::TreeManager::operator= ( TreeManager const & )

delete

Or assign it.

◆ RootType()

const char * top::TreeManager::RootType ( const char * typeid_type )

private

Stolen from SFrame code.

This is a tricky one. In SCycleBaseNTuple::DeclareVariable(...) the function automatically detects the type of the variable to be put into the output tree. Since ROOT uses a different naming scheme for the primitives than C++'s typeid call, the typeid names have to be translated for ROOT. This is the function doing that.

Warning: The translation is probably only valid on various UNIX systems, probably doesn't work on Windows. (Did anyone ever try SFrame on Windows anyway???)

Parameters

typeid_type Primitive type name in the "typeid" format

Returns: The primitive type name in ROOT's format

Definition at line 61 of file TreeManager.cxx.

                                                            {
     // Check that we received a reasonable input:
     if (strlen(typeid_type) != 1) {
       //    SLogger m_logger( "SCycleBaseNTuple" );
       //    REPORT_ERROR( "Received a complex object description: " << typeid_type );
       //    throw SError( "SCycleBaseNTuple::RootType received complex object "
       //                  "description", SError::StopExecution );
     }
  
     // Do the hard-coded translation:
     switch (typeid_type[ 0 ]) {
     case 'c':
       return "B";
  
       break;
  
     case 'h':
       return "b";
  
       break;
  
     case 's':
       return "S";
  
       break;
  
     case 't':
       return "s";
  
       break;
  
     case 'i':
       return "I";
  
       break;
  
     case 'j':
       return "i";
  
       break;
  
     case 'f':
       return "F";
  
       break;
  
     case 'd':
       return "D";
  
       break;
  
     case 'x':
       return "L";
  
       break;
  
     case 'y':
       return "l";
  
       break;
  
     case 'b':
       return "O";
  
       break;
     }
  
     return "";
   }

◆ TypeidType()

const char * top::TreeManager::TypeidType ( const char * root_type )

private

Stolen from SFrame code.

This function is used internally to check whether the user tries to connect the correct type of primitive to the branches. ROOT can have some trouble identifying such code problems...

Warning: The implementation might be platform specific!

Parameters

root_type ROOT primitive type name

Returns: The typeid type name for the ROOT primitive type

Definition at line 131 of file TreeManager.cxx.

                                                            {
     // Do the hard-coded translation:
     if (!strcmp(root_type, "Char_t")) {
       return "c";
     } else if (!strcmp(root_type, "UChar_t")) {
       return "h";
     } else if (!strcmp(root_type, "Short_t")) {
       return "s";
     } else if (!strcmp(root_type, "UShort_t")) {
       return "t";
     } else if (!strcmp(root_type, "Int_t")) {
       return "i";
     } else if (!strcmp(root_type, "UInt_t")) {
       return "j";
     } else if (!strcmp(root_type, "Float_t")) {
       return "f";
     } else if (!strcmp(root_type, "Double_t")) {
       return "d";
     } else if (!strcmp(root_type, "Long64_t")) {
       return "x";
     } else if (!strcmp(root_type, "ULong64_t")) {
       return "y";
     } else if (!strcmp(root_type, "Bool_t")) {
       return "b";
     }
  
     return "";
   }

Member Data Documentation

◆ m_basketSizePrimitive

int top::TreeManager::m_basketSizePrimitive

private

Definition at line 172 of file TreeManager.h.

◆ m_basketSizeVector

int top::TreeManager::m_basketSizeVector

private

Definition at line 173 of file TreeManager.h.

◆ m_branchFilters

std::vector<BranchFilter> top::TreeManager::m_branchFilters

private

list of functions that control which variables are written out

The function objects are called in order, with the TreeManager instance and the variable name as parameters. A return value of 1 (0) tells the TreeManager that the variable should (not) be written to the n-tuple. If the function returns -1, the decision is left to the next function in the list. If there are no functions in the list, or all functions return -1, the variable is written to the n-tuple.

Definition at line 169 of file TreeManager.h.

◆ m_name

std::string top::TreeManager::m_name

private

name of the tree

Definition at line 110 of file TreeManager.h.

◆ m_outputVarPointers

std::list< void* > top::TreeManager::m_outputVarPointers

private

Stolen from SFrame code.

We have to keep the pointers to the output variables defined by the user. ROOT keeps track of the objects by storing pointers to pointers to the objects. Since the user probably wants to use the output objects directly and not through pointers, the base class has to take care of this pointer issue by itself...

Definition at line 157 of file TreeManager.h.

◆ m_tree

TTree* top::TreeManager::m_tree

private

Pointer to the TTree, created by this class in the constructor.

Definition at line 146 of file TreeManager.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BranchFilter

Constructor & Destructor Documentation

◆ TreeManager() [1/4]

◆ TreeManager() [2/4]

◆ TreeManager() [3/4]

◆ TreeManager() [4/4]

Member Function Documentation

◆ branchFilters() [1/2]

◆ branchFilters() [2/2]

◆ fill()

◆ initialize()

◆ makeOutputVariable()

◆ name()

◆ operator=()

◆ RootType()

◆ TypeidType()

Member Data Documentation

◆ m_basketSizePrimitive

◆ m_basketSizeVector

◆ m_branchFilters

◆ m_name

◆ m_outputVarPointers

◆ m_tree