Manages extraction of trigger results and filling of their branches. More...

#include <TriggerResponseManager.h>

Inheritance diagram for sbn::details::TriggerResponseManager:

Classes
class	Extractors
	Trigger information extractors tied to an event. More...

struct	TriggerInfo_t
	Information about a single trigger logic (hardware or emulated). More...

struct	TriggerInfoBranch_t
	Data for a single trigger logic output branch. More...

struct	TriggerInputSpec_t
	Configuration specifications for the emulation of a trigger logic. More...

Public Member Functions
	TriggerResponseManager (std::vector< TriggerInputSpec_t > const &triggerSpecs, art::ConsumesCollector &collector, TTree &tree)
	Initializes `tree` to accommodate the specified trigger information. More...

Extractors	extractorsFor (art::Event const &event)
	Returns an object to extract trigger information from `event`. More...

	TriggerResponseManager (std::vector< TriggerInputSpec_t > const &triggerSpecs, art::ConsumesCollector &collector, TTree &tree)
	Initializes `tree` to accommodate the specified trigger information. More...

Extractors	extractorsFor (art::Event const &event)
	Returns an object to extract trigger information from `event`. More...

Private Member Functions
std::vector< TriggerInfoBranch_t >	buildTriggerResponseBranches (TTree &tree, std::vector< TriggerInputSpec_t > const &triggerSpecs) const
	Sets up the tree branches and returns the branch information structures. More...

TriggerInfoBranch_t	buildTriggerResponseBranch (TTree &tree, TriggerInputSpec_t const &spec) const
	Sets up a tree branch and returns its branch information structure. More...

void	declareConsumables (art::ConsumesCollector &collector) const
	Declares all the data products we are going to read. More...

std::vector< TriggerInfoBranch_t >	buildTriggerResponseBranches (TTree &tree, std::vector< TriggerInputSpec_t > const &triggerSpecs) const
	Sets up the tree branches and returns the branch information structures. More...

TriggerInfoBranch_t	buildTriggerResponseBranch (TTree &tree, TriggerInputSpec_t const &spec) const
	Sets up a tree branch and returns its branch information structure. More...

void	declareConsumables (art::ConsumesCollector &collector) const
	Declares all the data products we are going to read. More...

Private Member Functions inherited from lar::UncopiableClass
	UncopiableClass ()=default
	Default constructor. More...

	~UncopiableClass ()=default
	Default destructor. More...

	UncopiableClass (UncopiableClass const &)=delete
	Deleted copy and move constructors and assignments. More...

	UncopiableClass (UncopiableClass &&)=default

UncopiableClass &	operator= (UncopiableClass const &)=delete

UncopiableClass &	operator= (UncopiableClass &&)=default

Private Attributes
std::vector< TriggerInfoBranch_t >	fBranchInfo
	Data structures for the tree. More...

Detailed Description

Manages extraction of trigger results and filling of their branches.

This class defines and manages the structure of the branches pertaining the trigger simulation in a ROOT tree.

It supports multiple trigger algorithms in a single ROOT tree entry (which may be defined for example as a physics event or as a particle within a physics event).

Configuration

The manager is configured with a list of trigger specifications (TriggerInputSpec_t). One simple branch (with multiple leaves) is created for each specifications.

Usage pattern

This manager class encloses all the steps needed to fill a tree with trigger response data. Users will have to take very few steps to integrate its functionality in a module.

A single instance of this class is created associated to a ROOT tree, configured with a set of trigger specifications. A class data member is recommended for this pattern.
On each art event, an extractor object is created (extractFor()) which will manage the extraction of trigger data from that event.
On each entry in the tree, Extractor::fetch() is called for that entry, which will fill all the relevant branch data from the available information. This single steps makes all trigger data ready for filling.
When all additional data is ready, the tree can be filled with the entry data (TTree::Fill()).

The configuration of this class is performed via a custom configuration data structure. The module may read it directly from its own (FHiCL) configuration or fill it in any other way.

Note: This class owns the memory associated to the tree branches. As such, it needs to exist as long as the buffers are needed, and those buffers must not change memory location. For this reason, the class is not copyable, but it is moveable (moving will preserve the address of the buffers).

This class defines and manages the structure of the branches pertaining the trigger simulation in a ROOT tree.

It supports multiple trigger algorithms in a single ROOT tree entry (which may be defined for example as a physics event or as a particle within a physics event).

Configuration

The manager is configured with a list of trigger specifications (TriggerInputSpec_t). One simple branch (with multiple leaves) is created for each specifications.

Usage pattern

This manager class encloses all the steps needed to fill a tree with trigger response data. Users will have to take very few steps to integrate its functionality in a module.

A single instance of this class is created associated to a ROOT tree, configured with a set of trigger specifications. A class data member is recommended for this pattern.
On each art event, an extractor object is created (extractFor()) which will manage the extraction of trigger data from that event.
On each entry in the tree, Extractor::fetch() is called for that entry, which will fill all the relevant branch data from the available information. This single steps makes all trigger data ready for filling.
When all additional data is ready, the tree can be filled with the entry data (TTree::Fill()).

The configuration of this class is performed via a custom configuration data structure. The module may read it directly from its own (FHiCL) configuration or fill it in any other way.

Note: This class owns the memory associated to the tree branches. As such, it needs to exist as long as the buffers are needed, and those buffers must not change memory location. For this reason, the class is not copyable, but it is movable (moving will preserve the address of the buffers).

Definition at line 86 of file Analysis/trigger/details/TriggerResponseManager.h.

Constructor & Destructor Documentation

sbn::details::TriggerResponseManager::TriggerResponseManager	(	std::vector< TriggerInputSpec_t > const &	triggerSpecs,
		art::ConsumesCollector &	collector,
		TTree &	tree
	)

Initializes tree to accommodate the specified trigger information.

Definition at line 116 of file Analysis/trigger/details/TriggerResponseManager.cxx.

   : fBranchInfo{ buildTriggerResponseBranches(tree, triggerSpecs) }
 {
   
   declareConsumables(collector);
   
 } // sbn::details::TriggerResponseManager::TriggerResponseManager()

sbn::details::TriggerResponseManager::TriggerResponseManager	(	std::vector< TriggerInputSpec_t > const &	triggerSpecs,
		art::ConsumesCollector &	collector,
		TTree &	tree
	)

Initializes tree to accommodate the specified trigger information.

Member Function Documentation

auto sbn::details::TriggerResponseManager::buildTriggerResponseBranch	(	TTree &	tree,
		TriggerInputSpec_t const &	spec
	)		const

private

Sets up a tree branch and returns its branch information structure.

Definition at line 160 of file Analysis/trigger/details/TriggerResponseManager.cxx.

 {
   TriggerInfoBranch_t branchInfo {
       spec.name     // name
     , spec.inputTag // triggerTag
     // the rest is default-constructed
     }; // TriggerInfoBranch_t
   
   branchInfo.branch = tree.Branch(
     spec.name.c_str(), branchInfo.data.get(),
     TriggerInfo_t::TriggerResponseBranchStructure().c_str()
     );
   
   return branchInfo;
 } // sbn::details::TriggerResponseManager::buildTriggerResponseBranches()

TriggerInfoBranch_t sbn::details::TriggerResponseManager::buildTriggerResponseBranch	(	TTree &	tree,
		TriggerInputSpec_t const &	spec
	)		const

private

Sets up a tree branch and returns its branch information structure.

auto sbn::details::TriggerResponseManager::buildTriggerResponseBranches	(	TTree &	tree,
		std::vector< TriggerInputSpec_t > const &	triggerSpecs
	)		const

private

Sets up the tree branches and returns the branch information structures.

Definition at line 148 of file Analysis/trigger/details/TriggerResponseManager.cxx.

 {
   std::vector<TriggerInfoBranch_t> branchInfoList;
   for (TriggerInputSpec_t const& spec: triggerSpecs)
     branchInfoList.push_back(buildTriggerResponseBranch(tree, spec));
   return branchInfoList;
 } // sbn::details::TriggerResponseManager::buildTriggerResponseBranches()

std::vector<TriggerInfoBranch_t> sbn::details::TriggerResponseManager::buildTriggerResponseBranches	(	TTree &	tree,
		std::vector< TriggerInputSpec_t > const &	triggerSpecs
	)		const

private

Sets up the tree branches and returns the branch information structures.

void sbn::details::TriggerResponseManager::declareConsumables ( art::ConsumesCollector & collector ) const

private

Declares all the data products we are going to read.

Definition at line 139 of file Analysis/trigger/details/TriggerResponseManager.cxx.

 {
   for (TriggerInfoBranch_t const& branchInfo: fBranchInfo)
     Extractors::consumesInputData(collector, branchInfo);
 } // sbn::details::TriggerResponseManager::declareConsumables()

void sbn::details::TriggerResponseManager::declareConsumables ( art::ConsumesCollector & collector ) const

private

Declares all the data products we are going to read.

auto sbn::details::TriggerResponseManager::extractorsFor ( art::Event const & event )

Returns an object to extract trigger information from event.

Definition at line 131 of file Analysis/trigger/details/TriggerResponseManager.cxx.

 {
   return Extractors{ event, fBranchInfo };
 } // sbn::details::TriggerResponseManager::extractorsFor()

Extractors sbn::details::TriggerResponseManager::extractorsFor ( art::Event const & event )

Returns an object to extract trigger information from event.

Member Data Documentation

std::vector< TriggerInfoBranch_t > sbn::details::TriggerResponseManager::fBranchInfo

private

Data structures for the tree.

Definition at line 201 of file Analysis/trigger/details/TriggerResponseManager.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Configuration

Usage pattern

Configuration

Usage pattern

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation