module to blindly dump a particle container to the Tree More...

#include <ParticleVariables.h>

Inheritance diagram for MuonPRDTest::ParticleVariables:

Collaboration diagram for MuonPRDTest::ParticleVariables:

Public Types
using	DataDependency = SG::VarHandleKey *

Public Member Functions
	ParticleVariables (MuonTesterTree &tree, const std::string &containerKey, const std::string &outName, MSG::Level msglvl)

bool	fill (const EventContext &ctx) override final
	The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided. More...

bool	declare_keys () override final

template<typename T >
bool	addVariable (const std::string &variable, const bool declareDep=false)
	Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration. More...

template<typename T >
bool	addVariable (const std::string &variable, const std::string &accName, const bool declareDep=false)
	Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration. More...

template<typename T >
bool	addVariableGeV (const std::string &variable, const bool declareDep=false)
	Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration. More...

template<typename T >
bool	addVariableGeV (const std::string &variable, const std::string &accName, const bool declareDep=false)
	Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration. More...

bool	addVariable (std::shared_ptr< IParticleDecorationBranch > branch)
	Adds a generic IParticle decoration branch to the collection. More...

size_t	push_back (const xAOD::IParticle *p)

void	declare_decorator (const std::string &decorName)
	Declares the dependency on a decorator. More...

bool	init () override final
	The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty. More...

std::string	name () const override final
	Returns the name of the branch. More...

bool	initialized () const
	Returns whether the object has been initialized or not The outcome of the variable is bound to a successful call of the addToTree method. More...

TTree *	tree () override final
	Returns the underlying TTree object. More...

const TTree *	tree () const override final

std::vector< DataDependency >	data_dependencies () override final
	Returns the data dependencies needed by the MuonTesterBranch. More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Static Public Member Functions
static std::string	eraseWhiteSpaces (const std::string &In)

Protected Member Functions
const Muon::IMuonIdHelperSvc *	idHelperSvc () const

const MuonGM::MuonDetectorManager *	getDetMgr (const EventContext &ctx) const

template<class T >
bool	addToTree (T &variable)
	Connects the Memory buffer with the TTree. More...

template<class Key >
bool	declare_dependency (Key &key)
	Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm. More...

MuonTesterTree &	parent ()
	Returns the reference to the MuonTesterTree parent. More...

Private Types
using	DecorKey_t = SG::ReadDecorHandleKey< xAOD::IParticleContainer >

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
SG::ReadHandleKey< xAOD::IParticleContainer >	m_key {}

SG::ReadDecorHandleKeyArray< xAOD::IParticleContainer >	m_decorKeys {}

std::shared_ptr< IParticleFourMomBranch >	m_branch {}

SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_detMgrKey {"MuonDetectorManager"}

ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {"Muon::MuonIdHelperSvc/MuonIdHelperSvc", name()}

TTree *	m_tree {nullptr}

MuonTesterTree *	m_parent {nullptr}

std::string	m_name {}

bool	m_init {false}

std::vector< DataDependency >	m_dependencies {}

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

module to blindly dump a particle container to the Tree

Definition at line 15 of file ParticleVariables.h.

Member Typedef Documentation

◆ DataDependency

using MuonVal::IMuonTesterBranch::DataDependency = SG::VarHandleKey*

inherited

Definition at line 39 of file IMuonTesterBranch.h.

◆ DecorKey_t

using MuonPRDTest::ParticleVariables::DecorKey_t = SG::ReadDecorHandleKey<xAOD::IParticleContainer>

private

Definition at line 86 of file ParticleVariables.h.

Constructor & Destructor Documentation

◆ ParticleVariables()

MuonPRDTest::ParticleVariables::ParticleVariables	(	MuonTesterTree &	tree,
		const std::string &	containerKey,
		const std::string &	outName,
		MSG::Level	msglvl
	)

Definition at line 9 of file ParticleVariables.cxx.

                                                           :
         PrdTesterModule(tree, "Particles"+ containerKey+outName, msglvl), 
         m_key{containerKey},
         m_branch{std::make_shared<IParticleFourMomBranch>(tree, outName)} {}

Member Function Documentation

◆ addToTree()

template<class T >

bool MuonVal::MuonTesterBranch::addToTree ( T & variable )

protectedinherited

Connects the Memory buffer with the TTree.

◆ addVariable() [1/3]

template<typename T >

bool MuonPRDTest::ParticleVariables::addVariable	(	const std::string &	variable,
		const bool	declareDep = `false`
	)

inline

Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration.

Parameters

variable	Name of the variable in the output tree. The output variable matches the name of the decorator used to read it
declareDep	Switch whether the module shall declare a dependency on the decorator

Definition at line 30 of file ParticleVariables.h.

                                                                                            {
                     if (declareDep) {
                         declare_decorator(variable);
                     } 
                     return m_branch->addVariable<T>(variable);
                 }

◆ addVariable() [2/3]

template<typename T >

bool MuonPRDTest::ParticleVariables::addVariable	(	const std::string &	variable,
		const std::string &	accName,
		const bool	declareDep = `false`
	)

inline

Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration.

Parameters

variable	Name of the variable in the output tree.
accName	Use a different decorator name than for the output
declareDep	Switch whether the module shall declare a dependency on the decorator

Definition at line 42 of file ParticleVariables.h.

                                                             {
                 if (declareDep){
                     declare_decorator(variable);
                 }
                 return m_branch->addVariable<T>(variable, accName);
             }

◆ addVariable() [3/3]

bool MuonPRDTest::ParticleVariables::addVariable ( std::shared_ptr< IParticleDecorationBranch > branch )

Adds a generic IParticle decoration branch to the collection.

Definition at line 43 of file ParticleVariables.cxx.

                                                                                        {
         return m_branch->addVariable(std::move(branch));
     }

◆ addVariableGeV() [1/2]

template<typename T >

bool MuonPRDTest::ParticleVariables::addVariableGeV	(	const std::string &	variable,
		const bool	declareDep = `false`
	)

inline

Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration.

Before storing the value to the tree it's divided by 1000.

Parameters

variable	Name of the variable in the output tree. The output variable matches the name of the decorator used to read it
declareDep	Switch whether the module shall declare a dependency on the decorator

Definition at line 56 of file ParticleVariables.h.

                                                                                               {
                     if (declareDep) {
                         declare_decorator(variable);
                     } 
                     return m_branch->addVariableGeV<T>(variable);
                 }

◆ addVariableGeV() [2/2]

template<typename T >

bool MuonPRDTest::ParticleVariables::addVariableGeV	(	const std::string &	variable,
		const std::string &	accName,
		const bool	declareDep = `false`
	)

inline

Adds a variable of the primitive data type that can be directly read-off from the xAOD::IParticle as decoration.

Before storing the value to the tree it's divided by 1000.

Parameters

variable	Name of the variable in the output tree.
accName	Use a different decorator name than for the output
declareDep	Switch whether the module shall declare a dependency on the decorator

Definition at line 69 of file ParticleVariables.h.

                                                                {
                 if (declareDep){
                     declare_decorator(variable);
                 }
                 return m_branch->addVariableGeV<T>(variable, accName);
             }

◆ data_dependencies()

std::vector< MuonTesterBranch::DataDependency > MuonVal::MuonTesterBranch::data_dependencies ( )

finaloverridevirtualinherited

Returns the data dependencies needed by the MuonTesterBranch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 61 of file MuonTesterBranch.cxx.

61 { return m_dependencies;}

◆ declare_decorator()

void MuonPRDTest::ParticleVariables::declare_decorator ( const std::string & decorName )

Declares the dependency on a decorator.

Parameters

decorName Name of the decorator to declare. May not be empty

Definition at line 35 of file ParticleVariables.cxx.

                                                                         {
         if (decorName.empty()){
             ATH_MSG_WARNING("Empty decorator names are not allowed");
         } else {
             m_decorKeys.emplace_back(m_key, decorName);
             ATH_MSG_DEBUG("Declare new dependency on "<<m_decorKeys.back().fullKey());
         }
     }

◆ declare_dependency()

template<class Key >

bool MuonVal::MuonTesterBranch::declare_dependency ( Key & key )

protectedinherited

Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.

◆ declare_keys()

bool MuonPRDTest::ParticleVariables::declare_keys ( )

finaloverridevirtual

Implements MuonPRDTest::PrdTesterModule.

Definition at line 28 of file ParticleVariables.cxx.

                                          {
         return declare_dependency(m_key) && 
                std::ranges::find_if(m_decorKeys,[this](DecorKey_t& key) {
                     return !declare_dependency(key);
                }) == m_decorKeys.end() && 
                 parent().addBranch(m_branch);
     } 

◆ eraseWhiteSpaces()

std::string MuonVal::MuonTesterBranch::eraseWhiteSpaces ( const std::string & In )

staticinherited

Definition at line 56 of file MuonTesterBranch.cxx.

                                                                 {
     std::string out = In;
     out.erase(std::remove_if(out.begin(), out.end(), isspace), out.end());
     return out;
 }

◆ fill()

bool MuonPRDTest::ParticleVariables::fill ( const EventContext & ctx )

finaloverridevirtual

The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided.

--> returns false if no update is called or the dummy value has not been defined

Implements MuonVal::IMuonTesterBranch.

Definition at line 17 of file ParticleVariables.cxx.

                                                         {
         SG::ReadHandle readHandle{m_key, ctx};
         if(!readHandle.isPresent()) {
             ATH_MSG_FATAL("Failed to retrieve "<<m_key.fullKey());
             return false;
         }       
         for (const xAOD::IParticle* particle : *readHandle){
             m_branch->push_back(particle);
         }
         return true;
     }

◆ getDetMgr()

const MuonGM::MuonDetectorManager * MuonPRDTest::PrdTesterModule::getDetMgr ( const EventContext & ctx ) const

protectedinherited

Definition at line 16 of file PrdTesterModule.cxx.

                                                                                              {
         SG::ReadCondHandle handle{m_detMgrKey, ctx};
         if (!handle.isValid()) {
             ATH_MSG_ERROR("Failed to retrieve MuonDetectorManager " << m_detMgrKey.fullKey());
             return nullptr;
         }
         return handle.cptr();
     }

◆ idHelperSvc()

const Muon::IMuonIdHelperSvc * MuonPRDTest::PrdTesterModule::idHelperSvc ( ) const

protectedinherited

Definition at line 15 of file PrdTesterModule.cxx.

15 { return m_idHelperSvc.get(); }

◆ init()

bool MuonPRDTest::PrdTesterModule::init ( )

finaloverridevirtualinherited

The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty.

Implements MuonVal::IMuonTesterBranch.

Definition at line 24 of file PrdTesterModule.cxx.

                                {
         return declare_dependency(m_detMgrKey) && 
                m_idHelperSvc.retrieve().isSuccess() && declare_keys();
     }

◆ initialized()

bool MuonVal::MuonTesterBranch::initialized ( ) const

inherited

Returns whether the object has been initialized or not The outcome of the variable is bound to a successful call of the addToTree method.

Definition at line 52 of file MuonTesterBranch.cxx.

52 { return m_init; }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ name()

std::string MuonVal::MuonTesterBranch::name ( ) const

finaloverridevirtualinherited

Returns the name of the branch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 51 of file MuonTesterBranch.cxx.

51 { return m_name; }

◆ parent()

MuonTesterTree & MuonVal::MuonTesterBranch::parent ( )

protectedinherited

Returns the reference to the MuonTesterTree parent.

Definition at line 38 of file MuonTesterBranch.cxx.

                                          {
     if (!m_parent) {
         ATH_MSG_WARNING("The parent of  " << name() << " is null.");
     }
     return *m_parent;
 }

◆ push_back()

size_t MuonPRDTest::ParticleVariables::push_back ( const xAOD::IParticle * p )

Definition at line 46 of file ParticleVariables.cxx.

                                                               {
         m_branch->push_back(p);
         return m_branch->find(p);
     }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

◆ tree() [1/2]

const TTree * MuonVal::MuonTesterBranch::tree ( ) const

finaloverridevirtualinherited

Implements MuonVal::IMuonTesterBranch.

Definition at line 54 of file MuonTesterBranch.cxx.

54 { return m_tree; }

◆ tree() [2/2]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverridevirtualinherited

Returns the underlying TTree object.

Implements MuonVal::IMuonTesterBranch.

Definition at line 53 of file MuonTesterBranch.cxx.

53 { return m_tree; }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_branch

std::shared_ptr<IParticleFourMomBranch> MuonPRDTest::ParticleVariables::m_branch {}

private

Definition at line 88 of file ParticleVariables.h.

◆ m_decorKeys

SG::ReadDecorHandleKeyArray<xAOD::IParticleContainer> MuonPRDTest::ParticleVariables::m_decorKeys {}

private

Definition at line 87 of file ParticleVariables.h.

◆ m_dependencies

std::vector<DataDependency> MuonVal::MuonTesterBranch::m_dependencies {}

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

◆ m_detMgrKey

SG::ReadCondHandleKey<MuonGM::MuonDetectorManager> MuonPRDTest::PrdTesterModule::m_detMgrKey {"MuonDetectorManager"}

privateinherited

Definition at line 29 of file PrdTesterModule.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> MuonPRDTest::PrdTesterModule::m_idHelperSvc {"Muon::MuonIdHelperSvc/MuonIdHelperSvc", name()}

privateinherited

Definition at line 30 of file PrdTesterModule.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_init

bool MuonVal::MuonTesterBranch::m_init {false}

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

◆ m_key

SG::ReadHandleKey<xAOD::IParticleContainer> MuonPRDTest::ParticleVariables::m_key {}

private

Definition at line 85 of file ParticleVariables.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_name

std::string MuonVal::MuonTesterBranch::m_name {}

privateinherited

Definition at line 60 of file MuonTesterBranch.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_parent

MuonTesterTree* MuonVal::MuonTesterBranch::m_parent {nullptr}

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

◆ m_tree

TTree* MuonVal::MuonTesterBranch::m_tree {nullptr}

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataDependency

◆ DecorKey_t

Constructor & Destructor Documentation

◆ ParticleVariables()

Member Function Documentation

◆ addToTree()

◆ addVariable() [1/3]

◆ addVariable() [2/3]

◆ addVariable() [3/3]

◆ addVariableGeV() [1/2]

◆ addVariableGeV() [2/2]

◆ data_dependencies()

◆ declare_decorator()

◆ declare_dependency()

◆ declare_keys()

◆ eraseWhiteSpaces()

◆ fill()

◆ getDetMgr()

◆ idHelperSvc()

◆ init()

◆ initialized()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ parent()

◆ push_back()

◆ setLevel()

◆ tree() [1/2]

◆ tree() [2/2]

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_branch

◆ m_decorKeys

◆ m_dependencies

◆ m_detMgrKey

◆ m_idHelperSvc

◆ m_imsg

◆ m_init

◆ m_key

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_parent

◆ m_tree