MuonPRDTest::SegmentVariables Class Reference

Tester module to dump the segment container. More...

#include <SegmentVariables.h>

Inheritance diagram for MuonPRDTest::SegmentVariables:

Collaboration diagram for MuonPRDTest::SegmentVariables:

Public Types
using	DataDependency = SG::VarHandleKey *

Public Member Functions
	SegmentVariables (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
unsigned int	push_back (const xAOD::MuonSegment &segment)
	push back a particuar segment More...
bool	addVariable (std::shared_ptr< IAuxElementDecorationBranch > br)
	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 Member Functions
unsigned int	fill (const xAOD::MuonSegment &segment)
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
SG::ReadHandleKey< xAOD::MuonSegmentContainer >	m_key {}
	Store gate key of the segment container. More...
std::string	m_name {}
	Name of the segment collection in the output collection. More...
ThreeVectorBranch	m_pos {parent(), m_name+"_pos"}
	Global position of the segment. More...
ThreeVectorBranch	m_dir {parent(), m_name+"_dir"}
	Global direction of the segment. More...
VectorBranch< char > &	m_etaIdx {parent().newVector<char>(m_name+"_etaIndex")}
	Station-eta index of the segment's precision hits. More...
VectorBranch< uint8_t > &	m_sector {parent().newVector<uint8_t>(m_name+"_sector")}
	MS-sector of the segment's precision hits. More...
VectorBranch< uint8_t > &	m_chamberIdx {parent().newVector<uint8_t>(m_name+"_chamberIdx")}
	MS station of the segment. More...
VectorBranch< float > &	m_chi2 {parent().newVector<float>(m_name+"_chi2")}
	chi 2 of the segment fit More...
VectorBranch< unsigned int > &	m_nDoF {parent().newVector<unsigned int>(m_name+"_nDoF")}
	number of degrees of freedom More...
VectorBranch< uint8_t > &	m_nPrecHits {parent().newVector<uint8_t>(m_name+"_nPrecHits")}
	Number of precision hits i.e. More...
VectorBranch< uint8_t > &	m_nTrigEtaLayers {parent().newVector<uint8_t>(m_name+"_nTrigEtaLayers")}
	Number of trigger hits, i.e. More...
VectorBranch< uint8_t > &	m_nTrigPhiLayers {parent().newVector<uint8_t>(m_name+"_nTrigPhiLayers")}
	Number of trigger hits, i.e. More...
std::vector< std::shared_ptr< IAuxElementDecorationBranch > >	m_addBranches {}
	More...
bool	m_filterMode {false}
std::unordered_map< const xAOD::MuonSegment *, unsigned int >	m_idxLookUp {}
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_detMgrKey {"MuonDetectorManager"}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {"Muon::MuonIdHelperSvc/MuonIdHelperSvc", name()}
TTree *	m_tree {nullptr}
MuonTesterTree *	m_parent {nullptr}
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

Tester module to dump the segment container.

For each event, the module dumps all segments.

Definition at line 16 of file SegmentVariables.h.

Member Typedef Documentation

DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

SegmentVariables()

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

Definition at line 9 of file SegmentVariables.cxx.

                                                        :
        PrdTesterModule(tree, "Segments"+ containerKey+outName, msglvl), 
            m_key{containerKey},
            m_name{outName}{}

Member Function Documentation

addToTree()

template<class T >

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

protectedinherited

Connects the Memory buffer with the TTree.

addVariable()

bool MuonPRDTest::SegmentVariables::addVariable

(

std::shared_ptr< IAuxElementDecorationBranch >

br

)

Definition at line 38 of file SegmentVariables.cxx.

                                                                                    {
        m_addBranches.push_back(br);
        return parent().addBranch(br);
    }

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 MuonPRDTest::SegmentVariables::declare_keys ( )

finaloverridevirtual

Implements MuonPRDTest::PrdTesterModule.

Definition at line 31 of file SegmentVariables.cxx.

                                        {
        return declare_dependency(m_key);
    }

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() [1/2]

bool MuonPRDTest::SegmentVariables::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 SegmentVariables.cxx.

                                                      {
        SG::ReadHandle readHandle{m_key, ctx};
        if(!readHandle.isPresent()) {
            ATH_MSG_FATAL("Failed to retrieve "<<m_key.fullKey());
            return false;
        }
        if (!m_filterMode) {
            for (const xAOD::MuonSegment* segment : *readHandle){
                fill(*segment);
            }
        }
        m_idxLookUp.clear();
        return true;
   }

fill() [2/2]

unsigned int MuonPRDTest::SegmentVariables::fill ( const xAOD::MuonSegment &  segment )

private

Definition at line 42 of file SegmentVariables.cxx.

                                                                     { 
       auto insert_itr = m_idxLookUp.insert(std::make_pair(&segment, m_idxLookUp.size()));
       if (!insert_itr.second) {
            return insert_itr.first->second;
       }
       m_pos.push_back(segment.position());
       m_dir.push_back(segment.direction());
       m_etaIdx += segment.etaIndex();
       m_sector += segment.sector();
       m_chamberIdx +=segment.chamberIndex();
       m_chi2 +=segment.chiSquared();
       m_nDoF +=segment.numberDoF();
 
        m_nPrecHits += segment.nPrecisionHits();
        m_nTrigEtaLayers += segment.nTrigEtaLayers();
        m_nTrigPhiLayers += segment.nPhiLayers();
        for(const auto& br : m_addBranches){
            br->push_back(segment);
        }
 
        return insert_itr.first->second;
    } 

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.

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

{ 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 int MuonPRDTest::SegmentVariables::push_back

(

const xAOD::MuonSegment &

segment

)

push back a particuar segment

Definition at line 34 of file SegmentVariables.cxx.

                                                                           {
        m_filterMode = true;
        return fill(segment);
    }

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_addBranches

std::vector<std::shared_ptr<IAuxElementDecorationBranch> > MuonPRDTest::SegmentVariables::m_addBranches {}

private

Definition at line 58 of file SegmentVariables.h.

m_chamberIdx

VectorBranch<uint8_t>& MuonPRDTest::SegmentVariables::m_chamberIdx {parent().newVector<uint8_t>(m_name+"_chamberIdx")}

private

MS station of the segment.

Definition at line 46 of file SegmentVariables.h.

m_chi2

VectorBranch<float>& MuonPRDTest::SegmentVariables::m_chi2 {parent().newVector<float>(m_name+"_chi2")}

private

chi 2 of the segment fit

Definition at line 48 of file SegmentVariables.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_dir

ThreeVectorBranch MuonPRDTest::SegmentVariables::m_dir {parent(), m_name+"_dir"}

private

Global direction of the segment.

Definition at line 40 of file SegmentVariables.h.

m_etaIdx

VectorBranch<char>& MuonPRDTest::SegmentVariables::m_etaIdx {parent().newVector<char>(m_name+"_etaIndex")}

private

Station-eta index of the segment's precision hits.

Definition at line 42 of file SegmentVariables.h.

m_filterMode

bool MuonPRDTest::SegmentVariables::m_filterMode {false}

private

Definition at line 59 of file SegmentVariables.h.

m_idHelperSvc

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

privateinherited

Definition at line 30 of file PrdTesterModule.h.

m_idxLookUp

std::unordered_map<const xAOD::MuonSegment*, unsigned int> MuonPRDTest::SegmentVariables::m_idxLookUp {}

private

Definition at line 60 of file SegmentVariables.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::MuonSegmentContainer> MuonPRDTest::SegmentVariables::m_key {}

private

Store gate key of the segment container.

Definition at line 34 of file SegmentVariables.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 MuonPRDTest::SegmentVariables::m_name {}

private

Name of the segment collection in the output collection.

Definition at line 36 of file SegmentVariables.h.

m_nDoF

VectorBranch<unsigned int>& MuonPRDTest::SegmentVariables::m_nDoF {parent().newVector<unsigned int>(m_name+"_nDoF")}

private

number of degrees of freedom

Definition at line 50 of file SegmentVariables.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_nPrecHits

VectorBranch<uint8_t>& MuonPRDTest::SegmentVariables::m_nPrecHits {parent().newVector<uint8_t>(m_name+"_nPrecHits")}

private

Number of precision hits i.e.

Mdt / sTGC (strip) / Mm hits

Definition at line 52 of file SegmentVariables.h.

m_nTrigEtaLayers

VectorBranch<uint8_t>& MuonPRDTest::SegmentVariables::m_nTrigEtaLayers {parent().newVector<uint8_t>(m_name+"_nTrigEtaLayers")}

private

Number of trigger hits, i.e.

Rpc / Tgc, meausuring the eta coordinate

Definition at line 54 of file SegmentVariables.h.

m_nTrigPhiLayers

VectorBranch<uint8_t>& MuonPRDTest::SegmentVariables::m_nTrigPhiLayers {parent().newVector<uint8_t>(m_name+"_nTrigPhiLayers")}

private

Number of trigger hits, i.e.

Rpc / Tgc, meausuring the phi coordinate

Definition at line 56 of file SegmentVariables.h.

m_parent

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

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

m_pos

ThreeVectorBranch MuonPRDTest::SegmentVariables::m_pos {parent(), m_name+"_pos"}

private

Global position of the segment.

Definition at line 38 of file SegmentVariables.h.

m_sector

VectorBranch<uint8_t>& MuonPRDTest::SegmentVariables::m_sector {parent().newVector<uint8_t>(m_name+"_sector")}

private

MS-sector of the segment's precision hits.

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

• SegmentVariables.h
• SegmentVariables.cxx