MuonValR4::SimHitTester Class Reference

#include <SimHitTester.h>

Inheritance diagram for MuonValR4::SimHitTester:

Collaboration diagram for MuonValR4::SimHitTester:

Public Types
using	DataDependency = SG::VarHandleKey *

Public Member Functions
	SimHitTester (MuonTesterTree &tree, const std::string &inContainer, const ActsTrk::DetectorType detType, MSG::Level msgLvl=MSG::Level::INFO)
bool	declare_keys () override final
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...
unsigned	push_back (const xAOD::MuonSimHit &hit)
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 MuonGMR4::MuonDetectorManager *	getDetMgr () const
const ActsGeometryContext &	getGeoCtx (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 Member Functions
unsigned int	fillHit (const EventContext &ctx, const xAOD::MuonSimHit &hit)
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
SG::ReadHandleKey< xAOD::MuonSimHitContainer >	m_key {}
	Key of the SimHit container in the StoreGate. More...
std::string	m_collName {}
	Name of the SimHit collection in the output tree. More...
ThreeVectorBranch	m_globPos {parent(), m_collName+"GlobPos"}
	Global position of the SimHits. More...
ThreeVectorBranch	m_globDir {parent(), m_collName+"GlobDir"}
	Global direction of the traversing particle generating the hit. More...
ThreeVectorBranch	m_locPos {parent(), m_collName+"LocalPos"}
	Local position of the produced simHit. More...
ThreeVectorBranch	m_locDir {parent(), m_collName+"LocalDir"}
	Local direction of the traversing particle generating the hit. More...
VectorBranch< float > &	m_globTime {parent().newVector<float>(m_collName+"GlobalTime")}
	Global time when the simHit was produced. More...
VectorBranch< float > &	m_beta {parent().newVector<float>(m_collName+"Beta")}
	Velocity of the simHit expressed in terms of beta. More...
VectorBranch< int > &	m_pdgId {parent().newVector<int>(m_collName+"PdgId")}
	PdgId of the particle generating the hit. More...
VectorBranch< float > &	m_energyDep {parent().newVector<float>(m_collName+"EnergyDeposit")}
	Energy deposited in the volume. More...
VectorBranch< float > &	m_kinE {parent().newVector<float>(m_collName+"KinericEnergy")}
	Kinetic energy of the traversing particle. More...
VectorBranch< float > &	m_mass {parent().newVector<float>(m_collName+"Mass")}
	Mass of the traversing particle. More...
std::shared_ptr< MuonIdentifierBranch >	m_identifier {}
	Pointer to the Identifier branch. More...
std::unordered_map< const xAOD::MuonSimHit *, unsigned int >	m_idxLookUp {}
	look up table of alrady dumped sim hits More...
const MuonGMR4::MuonDetectorManager *	m_detMgr {}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {"Muon::MuonIdHelperSvc/MuonIdHelperSvc", name()}
SG::ReadHandleKey< ActsGeometryContext >	m_geoCtxKey {"ActsAlignment"}
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

Definition at line 11 of file SimHitTester.h.

Member Typedef Documentation

DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

SimHitTester()

MuonValR4::SimHitTester::SimHitTester	(	MuonTesterTree &	tree,
		const std::string &	inContainer,
		const ActsTrk::DetectorType	detType,
		MSG::Level	msgLvl = MSG::Level::INFO
	)

Definition at line 8 of file SimHitTester.cxx.

                                               :
        TesterModuleBase{tree, inContainer, msgLvl},
        m_key{inContainer},
        m_collName{ActsTrk::to_string(detType)+"SimHits"} {
      switch (detType) {
         case ActsTrk::DetectorType::Mdt:
            m_identifier = std::make_shared<MdtIdentifierBranch>(tree, m_collName);
            break;
        case ActsTrk::DetectorType::Rpc:
            m_identifier = std::make_shared<RpcIdentifierBranch>(tree, m_collName);
            break;
        case ActsTrk::DetectorType::Tgc:
            m_identifier = std::make_shared<TgcIdentifierBranch>(tree, m_collName);
            break;
        case ActsTrk::DetectorType::sTgc:
            m_identifier = std::make_shared<sTgcIdentifierBranch>(tree, m_collName);
            break;
        case ActsTrk::DetectorType::Mm:
            m_identifier = std::make_shared<MmIdentifierBranch>(tree, m_collName);
            break;
        default:
            ATH_MSG_WARNING("Unsupported detector type "<<ActsTrk::to_string(detType));
      };
 
    }

Member Function Documentation

addToTree()

template<class T >

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

protectedinherited

Connects the Memory buffer with the TTree.

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.

{ return m_dependencies;}

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 MuonValR4::SimHitTester::declare_keys ( )

finaloverridevirtual

Implements MuonValR4::TesterModuleBase.

Definition at line 36 of file SimHitTester.cxx.

                                    {
        return declare_dependency(m_key) && parent().addBranch(m_identifier);
    }

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 MuonValR4::SimHitTester::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 39 of file SimHitTester.cxx.

                                                  {
 
        SG::ReadHandle inContainer{m_key, ctx};
        if (!inContainer.isPresent()) {
            ATH_MSG_FATAL("Failed to retrieve "<<m_key.fullKey());
            return false;
        }
        
        for (const xAOD::MuonSimHit* simHit : *inContainer) {
            fillHit(ctx, *simHit);
        }  
        m_idxLookUp.clear();      
        return true;
    }

fillHit()

unsigned int MuonValR4::SimHitTester::fillHit ( const EventContext &  ctx, const xAOD::MuonSimHit &  hit  )

private

Definition at line 56 of file SimHitTester.cxx.

                                                                     {
 
        const auto insertItr = m_idxLookUp.insert(std::make_pair(&simHit, m_idxLookUp.size()));
        if (!insertItr.second) {
            return insertItr.first->second;
        }
        const ActsGeometryContext& gctx{getGeoCtx(ctx)};
 
        const MuonGMR4::MuonDetectorManager* detMgr = getDetMgr();
 
        const Identifier id = simHit.identify();
        ATH_MSG_VERBOSE("Filling information for "<<idHelperSvc()->toString(id));
        
        const MuonGMR4::MuonReadoutElement* re = detMgr->getReadoutElement(id);
 
        const IdentifierHash trfHash{idHelperSvc()->isMdt(id) ? re->measurementHash(id)
                                                              : re->layerHash(id)};
 
        const Amg::Vector3D locPos{xAOD::toEigen(simHit.localPosition())};
        const Amg::Vector3D locDir{xAOD::toEigen(simHit.localDirection())};
 
        const Amg::Transform3D& locToGlobal{re->localToGlobalTrans(gctx, trfHash)};
        m_globPos.push_back(locToGlobal*locPos);
        m_globDir.push_back(Amg::Vector3D(locToGlobal.linear()* locDir));
        m_locPos.push_back(locPos);
        m_locDir.push_back(locDir);
        m_globTime.push_back(simHit.globalTime());
        m_beta.push_back(simHit.beta());
        m_pdgId.push_back(simHit.pdgId());
        m_energyDep.push_back(simHit.energyDeposit());
        m_kinE.push_back(simHit.kineticEnergy());
        m_mass.push_back(simHit.mass());
        m_identifier->push_back(id);
 
        return insertItr.first->second;
    }

getDetMgr()

const MuonGMR4::MuonDetectorManager * MuonValR4::TesterModuleBase::getDetMgr ( ) const

protectedinherited

Definition at line 19 of file TesterModuleBase.cxx.

                                                                         {
        return m_detMgr;
    }

getGeoCtx()

const ActsGeometryContext & MuonValR4::TesterModuleBase::getGeoCtx ( const EventContext &  ctx ) const

protectedinherited

Definition at line 22 of file TesterModuleBase.cxx.

                                                                                        {
        SG::ReadHandle handle{m_geoCtxKey, ctx};
        if (!handle.isValid()) {
            THROW_EXCEPTION("Failed to retrieve "<<m_geoCtxKey.fullKey());
        }
        return *handle;
    }

idHelperSvc()

const Muon::IMuonIdHelperSvc * MuonValR4::TesterModuleBase::idHelperSvc ( ) const

protectedinherited

Definition at line 18 of file TesterModuleBase.cxx.

{ return m_idHelperSvc.get(); }

init()

bool MuonValR4::TesterModuleBase::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 30 of file TesterModuleBase.cxx.

                                {
        ServiceHandle<StoreGateSvc> detStore{"StoreGateSvc/DetectorStore", name()};
        if (!detStore.retrieve().isSuccess() || !detStore->retrieve(m_detMgr).isSuccess()) return false;       
        if (!declare_dependency(m_geoCtxKey)) return false;       
        if (!m_idHelperSvc.retrieve().isSuccess()) return false;
        return 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.

{ 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.

{ 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.

{ 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()

unsigned MuonValR4::SimHitTester::push_back

(

const xAOD::MuonSimHit &

hit

)

Definition at line 53 of file SimHitTester.cxx.

                                                              {
        return fillHit(Gaudi::Hive::currentContext(), hit);
    } 

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.

{ 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.

{ 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_beta

VectorBranch<float>& MuonValR4::SimHitTester::m_beta {parent().newVector<float>(m_collName+"Beta")}

private

Velocity of the simHit expressed in terms of beta.

Definition at line 42 of file SimHitTester.h.

m_collName

std::string MuonValR4::SimHitTester::m_collName {}

private

Name of the SimHit collection in the output tree.

Definition at line 30 of file SimHitTester.h.

m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

m_detMgr

const MuonGMR4::MuonDetectorManager* MuonValR4::TesterModuleBase::m_detMgr {}

privateinherited

Definition at line 32 of file TesterModuleBase.h.

m_energyDep

VectorBranch<float>& MuonValR4::SimHitTester::m_energyDep {parent().newVector<float>(m_collName+"EnergyDeposit")}

private

Energy deposited in the volume.

Definition at line 46 of file SimHitTester.h.

m_geoCtxKey

SG::ReadHandleKey<ActsGeometryContext> MuonValR4::TesterModuleBase::m_geoCtxKey {"ActsAlignment"}

privateinherited

Definition at line 34 of file TesterModuleBase.h.

m_globDir

ThreeVectorBranch MuonValR4::SimHitTester::m_globDir {parent(), m_collName+"GlobDir"}

private

Global direction of the traversing particle generating the hit.

Definition at line 34 of file SimHitTester.h.

m_globPos

ThreeVectorBranch MuonValR4::SimHitTester::m_globPos {parent(), m_collName+"GlobPos"}

private

Global position of the SimHits.

Definition at line 32 of file SimHitTester.h.

m_globTime

VectorBranch<float>& MuonValR4::SimHitTester::m_globTime {parent().newVector<float>(m_collName+"GlobalTime")}

private

Global time when the simHit was produced.

Definition at line 40 of file SimHitTester.h.

m_identifier

std::shared_ptr<MuonIdentifierBranch> MuonValR4::SimHitTester::m_identifier {}

private

Pointer to the Identifier branch.

Definition at line 52 of file SimHitTester.h.

m_idHelperSvc

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

privateinherited

Definition at line 33 of file TesterModuleBase.h.

m_idxLookUp

std::unordered_map<const xAOD::MuonSimHit*, unsigned int> MuonValR4::SimHitTester::m_idxLookUp {}

private

look up table of alrady dumped sim hits

Definition at line 55 of file SimHitTester.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::MuonSimHitContainer> MuonValR4::SimHitTester::m_key {}

private

Key of the SimHit container in the StoreGate.

Definition at line 28 of file SimHitTester.h.

m_kinE

VectorBranch<float>& MuonValR4::SimHitTester::m_kinE {parent().newVector<float>(m_collName+"KinericEnergy")}

private

Kinetic energy of the traversing particle.

Definition at line 48 of file SimHitTester.h.

m_locDir

ThreeVectorBranch MuonValR4::SimHitTester::m_locDir {parent(), m_collName+"LocalDir"}

private

Local direction of the traversing particle generating the hit.

Definition at line 38 of file SimHitTester.h.

m_locPos

ThreeVectorBranch MuonValR4::SimHitTester::m_locPos {parent(), m_collName+"LocalPos"}

private

Local position of the produced simHit.

Definition at line 36 of file SimHitTester.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_mass

VectorBranch<float>& MuonValR4::SimHitTester::m_mass {parent().newVector<float>(m_collName+"Mass")}

private

Mass of the traversing particle.

Definition at line 50 of file SimHitTester.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_pdgId

VectorBranch<int>& MuonValR4::SimHitTester::m_pdgId {parent().newVector<int>(m_collName+"PdgId")}

private

PdgId of the particle generating the hit.

Definition at line 44 of file SimHitTester.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:

• SimHitTester.h
• SimHitTester.cxx