ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
MuonPRDTest::MuEntryVariables Class Reference

#include <MuEntryVariables.h>

Inheritance diagram for MuonPRDTest::MuEntryVariables:
Collaboration diagram for MuonPRDTest::MuEntryVariables:

Public Types

using DataDependency = SG::VarHandleKey *
 

Public Member Functions

 MuEntryVariables (MuonTesterTree &tree, const std::string &container_name, 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
 
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< DataDependencydata_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::IMuonIdHelperSvcidHelperSvc () const
 
const MuonGM::MuonDetectorManagergetDetMgr (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...
 
MuonTesterTreeparent ()
 Returns the reference to the MuonTesterTree parent. More...
 

Private Member Functions

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

Private Attributes

SG::ReadHandleKey< TrackRecordCollectionm_key {}
 
ScalarBranch< unsigned int > & m_MuEntry_nParticles {parent().newScalar<unsigned int>("Muontry_numPart")}
 
PtEtaPhiEBranch m_MuEntry_mom {parent(), "MuEntry_Particle"}
 
ThreeVectorBranch m_MuEntry_pos {parent(), "MuEntry_Position"}
 
VectorBranch< int > & m_MuEntry_particlePdg_id {parent().newVector<int>("MuEntry_Pdg")}
 
VectorBranch< int > & m_MuEntry_particleBarcode {parent().newVector<int>("MuEntry_Barcode")}
 
SG::ReadCondHandleKey< MuonGM::MuonDetectorManagerm_detMgrKey {"MuonDetectorManager"}
 
ServiceHandle< StoreGateSvcm_detStore {"StoreGateSvc/DetectorStore", name()}
 
ServiceHandle< Muon::IMuonIdHelperSvcm_idHelperSvc {"Muon::MuonIdHelperSvc/MuonIdHelperSvc", name()}
 
const MuonGM::MuonDetectorManagerm_detMgr {nullptr}
 
bool m_useCondDetMgr {false}
 
TTree * m_tree {nullptr}
 
MuonTesterTreem_parent {nullptr}
 
std::string m_name {}
 
bool m_init {false}
 
std::vector< DataDependencym_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 14 of file MuEntryVariables.h.

Member Typedef Documentation

◆ DataDependency

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

◆ MuEntryVariables()

MuonPRDTest::MuEntryVariables::MuEntryVariables ( MuonTesterTree tree,
const std::string &  container_name,
MSG::Level  msglvl 
)

Definition at line 13 of file MuEntryVariables.cxx.

13  :
14  PrdTesterModule(tree, "MuEntryVariables", true, msglvl), m_key{container_name} {}

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.

61 { 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::MuEntryVariables::declare_keys ( )
finaloverridevirtual

Implements MuonPRDTest::PrdTesterModule.

Definition at line 15 of file MuEntryVariables.cxx.

15 { return declare_dependency(m_key); }

◆ eraseWhiteSpaces()

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

Definition at line 56 of file MuonTesterBranch.cxx.

56  {
57  std::string out = In;
58  out.erase(std::remove_if(out.begin(), out.end(), isspace), out.end());
59  return out;
60 }

◆ fill()

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

17  {
18  ATH_MSG_DEBUG("do fillNSWMuEntryVariables()");
19  const MuonGM::MuonDetectorManager* MuonDetMgr = getDetMgr(ctx);
20  if (!MuonDetMgr) { return false; }
21  SG::ReadHandle<TrackRecordCollection> trackRecordCollection{m_key, ctx};
22  if (!trackRecordCollection.isValid()) {
23  ATH_MSG_FATAL("Failed to retrieve track collection container " << m_key.fullKey());
24  return false;
25  }
26  m_MuEntry_nParticles = trackRecordCollection->size();
27  for(const auto& it : *trackRecordCollection ) {
29  m_MuEntry_particleBarcode.push_back(it.barcode()); // FIXME barcode-based
30  const Amg::Vector3D threeMom = Amg::Hep3VectorToEigen(it.GetMomentum());
31  m_MuEntry_mom.push_back(threeMom.perp(), threeMom.eta(), threeMom.phi(), it.GetEnergy());
33  }
34  return true;
35  }

◆ getDetMgr()

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

Definition at line 15 of file PrdTesterModule.cxx.

15  {
16  if (!m_useCondDetMgr) return m_detMgr;
18  if (!handle.isValid()) {
19  ATH_MSG_ERROR("Failed to retrieve MuonDetectorManager " << m_detMgrKey.fullKey());
20  return nullptr;
21  }
22  return handle.cptr();
23  }

◆ idHelperSvc()

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

Definition at line 14 of file PrdTesterModule.cxx.

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

24  {
25  if (!m_useCondDetMgr && (!m_detStore.retrieve().isSuccess() || !m_detStore->retrieve(m_detMgr).isSuccess())) return false;
26  if (!m_useCondDetMgr) {
27  m_detMgrKey = std::string{""};
28  }
29  if (!declare_dependency(m_detMgrKey)) return false;
30  if (!m_idHelperSvc.retrieve().isSuccess()) return false;
31  return declare_keys();
32  }

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

40 {
42  m_lvl = m_imsg ?
43  static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
44  MSG::INFO;
45 }

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

165 {
166  MsgStream* ms = m_msg_tls.get();
167  if (!ms) {
168  if (!m_initialized.test_and_set()) initMessaging();
169  ms = new MsgStream(m_imsg,m_nm);
170  m_msg_tls.reset( ms );
171  }
172 
173  ms->setLevel (m_lvl);
174  return *ms;
175 }

◆ 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
lvlThe message level to test against
Returns
boolean Indicating if messages at given level will be printed
Return values
trueMessages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

152 {
153  if (!m_initialized.test_and_set()) initMessaging();
154  if (m_lvl <= lvl) {
155  msg() << lvl;
156  return true;
157  } else {
158  return false;
159  }
160 }

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

38  {
39  if (!m_parent) {
40  ATH_MSG_WARNING("The parent of " << name() << " is null.");
41  }
42  return *m_parent;
43 }

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

29 {
30  m_lvl = lvl;
31 }

◆ 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_dependencies

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

Definition at line 62 of file MuonTesterBranch.h.

◆ m_detMgr

const MuonGM::MuonDetectorManager* MuonPRDTest::PrdTesterModule::m_detMgr {nullptr}
privateinherited

Definition at line 32 of file PrdTesterModule.h.

◆ m_detMgrKey

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

Definition at line 29 of file PrdTesterModule.h.

◆ m_detStore

ServiceHandle<StoreGateSvc> MuonPRDTest::PrdTesterModule::m_detStore {"StoreGateSvc/DetectorStore", name()}
privateinherited

Definition at line 30 of file PrdTesterModule.h.

◆ m_idHelperSvc

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

Definition at line 31 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<TrackRecordCollection> MuonPRDTest::MuEntryVariables::m_key {}
private

Definition at line 23 of file MuEntryVariables.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_MuEntry_mom

PtEtaPhiEBranch MuonPRDTest::MuEntryVariables::m_MuEntry_mom {parent(), "MuEntry_Particle"}
private

Definition at line 25 of file MuEntryVariables.h.

◆ m_MuEntry_nParticles

ScalarBranch<unsigned int>& MuonPRDTest::MuEntryVariables::m_MuEntry_nParticles {parent().newScalar<unsigned int>("Muontry_numPart")}
private

Definition at line 24 of file MuEntryVariables.h.

◆ m_MuEntry_particleBarcode

VectorBranch<int>& MuonPRDTest::MuEntryVariables::m_MuEntry_particleBarcode {parent().newVector<int>("MuEntry_Barcode")}
private

Definition at line 28 of file MuEntryVariables.h.

◆ m_MuEntry_particlePdg_id

VectorBranch<int>& MuonPRDTest::MuEntryVariables::m_MuEntry_particlePdg_id {parent().newVector<int>("MuEntry_Pdg")}
private

Definition at line 27 of file MuEntryVariables.h.

◆ m_MuEntry_pos

ThreeVectorBranch MuonPRDTest::MuEntryVariables::m_MuEntry_pos {parent(), "MuEntry_Position"}
private

Definition at line 26 of file MuEntryVariables.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.

◆ m_useCondDetMgr

bool MuonPRDTest::PrdTesterModule::m_useCondDetMgr {false}
privateinherited

Definition at line 33 of file PrdTesterModule.h.


The documentation for this class was generated from the following files:
AthMessaging::m_lvl
std::atomic< MSG::Level > m_lvl
Current logging level.
Definition: AthMessaging.h:138
ATH_MSG_FATAL
#define ATH_MSG_FATAL(x)
Definition: AthMsgStreamMacros.h:34
MuonPRDTest::MuEntryVariables::m_key
SG::ReadHandleKey< TrackRecordCollection > m_key
Definition: MuEntryVariables.h:23
SG::ReadCondHandle
Definition: ReadCondHandle.h:44
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
MuonVal::MuonTesterBranch::m_dependencies
std::vector< DataDependency > m_dependencies
Definition: MuonTesterBranch.h:62
skel.it
it
Definition: skel.GENtoEVGEN.py:423
MuonVal::MuonTesterBranch::m_tree
TTree * m_tree
Definition: MuonTesterBranch.h:58
python.AthDsoLogger.out
out
Definition: AthDsoLogger.py:71
MuonPRDTest::PrdTesterModule::getDetMgr
const MuonGM::MuonDetectorManager * getDetMgr(const EventContext &ctx) const
Definition: PrdTesterModule.cxx:15
AthMessaging::m_imsg
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
Definition: AthMessaging.h:135
python.SystemOfUnits.ms
int ms
Definition: SystemOfUnits.py:132
Athena::getMessageSvc
IMessageSvc * getMessageSvc(bool quiet=false)
Definition: getMessageSvc.cxx:20
MuonVal::MuonTesterBranch::tree
TTree * tree() override final
Returns the underlying TTree object.
Definition: MuonTesterBranch.cxx:53
MuonVal::MuonTesterBranch::m_parent
MuonTesterTree * m_parent
Definition: MuonTesterBranch.h:59
Amg::Hep3VectorToEigen
Amg::Vector3D Hep3VectorToEigen(const CLHEP::Hep3Vector &CLHEPvector)
Converts a CLHEP-based CLHEP::Hep3Vector into an Eigen-based Amg::Vector3D.
Definition: CLHEPtoEigenConverter.h:137
MuonVal::MuonTesterBranch::declare_dependency
bool declare_dependency(Key &key)
Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.
MuonPRDTest::PrdTesterModule::m_detStore
ServiceHandle< StoreGateSvc > m_detStore
Definition: PrdTesterModule.h:30
MuonVal::ThreeVectorBranch::push_back
void push_back(const Amg::Vector3D &vec)
interface using the Amg::Vector3D
Definition: ThreeVectorBranch.cxx:23
TrigConf::MSGTC::Level
Level
Definition: Trigger/TrigConfiguration/TrigConfBase/TrigConfBase/MsgStream.h:21
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
MuonPRDTest::MuEntryVariables::m_MuEntry_mom
PtEtaPhiEBranch m_MuEntry_mom
Definition: MuEntryVariables.h:25
MuonVal::MuonTesterBranch::m_init
bool m_init
Definition: MuonTesterBranch.h:61
MuonPRDTest::PrdTesterModule::m_useCondDetMgr
bool m_useCondDetMgr
Definition: PrdTesterModule.h:33
MuonPRDTest::PrdTesterModule::m_idHelperSvc
ServiceHandle< Muon::IMuonIdHelperSvc > m_idHelperSvc
Definition: PrdTesterModule.h:31
AthMessaging::msg
MsgStream & msg() const
The standard message stream.
Definition: AthMessaging.h:164
MuonVal::MuonTesterBranch::name
std::string name() const override final
Returns the name of the branch.
Definition: MuonTesterBranch.cxx:51
MuonVal::VectorBranch::push_back
void push_back(const T &value)
Adds a new element at the end of the vector.
MuonPRDTest::PrdTesterModule::declare_keys
virtual bool declare_keys()=0
Definition: PrdTesterModule.cxx:33
MuonVal::PtEtaPhiEBranch::push_back
void push_back(const TLorentzVector &vec)
Definition: FourVectorBranch.cxx:20
MuonPRDTest::PrdTesterModule::m_detMgrKey
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager > m_detMgrKey
Definition: PrdTesterModule.h:29
Amg::Vector3D
Eigen::Matrix< double, 3, 1 > Vector3D
Definition: GeoPrimitives.h:47
MuonPRDTest::MuEntryVariables::m_MuEntry_particleBarcode
VectorBranch< int > & m_MuEntry_particleBarcode
Definition: MuEntryVariables.h:28
MuonVal::MuonTesterBranch::m_name
std::string m_name
Definition: MuonTesterBranch.h:60
MuonGM::MuonDetectorManager
The MuonDetectorManager stores the transient representation of the Muon Spectrometer geometry and pro...
Definition: MuonDetDescr/MuonReadoutGeometry/MuonReadoutGeometry/MuonDetectorManager.h:49
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
AthMessaging::m_nm
std::string m_nm
Message source name.
Definition: AthMessaging.h:129
MuonPRDTest::PrdTesterModule::PrdTesterModule
PrdTesterModule(MuonTesterTree &tree, const std::string &grp_name, bool useCondGeo, MSG::Level msglvl)
Definition: PrdTesterModule.cxx:8
MuonPRDTest::MuEntryVariables::m_MuEntry_pos
ThreeVectorBranch m_MuEntry_pos
Definition: MuEntryVariables.h:26
AthMessaging::initMessaging
void initMessaging() const
Initialize our message level and MessageSvc.
Definition: AthMessaging.cxx:39
MuonPRDTest::MuEntryVariables::m_MuEntry_particlePdg_id
VectorBranch< int > & m_MuEntry_particlePdg_id
Definition: MuEntryVariables.h:27
MuonPRDTest::MuEntryVariables::m_MuEntry_nParticles
ScalarBranch< unsigned int > & m_MuEntry_nParticles
Definition: MuEntryVariables.h:24
AthMessaging::m_msg_tls
boost::thread_specific_ptr< MsgStream > m_msg_tls
MsgStream instance (a std::cout like with print-out levels)
Definition: AthMessaging.h:132
MuonPRDTest::PrdTesterModule::m_detMgr
const MuonGM::MuonDetectorManager * m_detMgr
Definition: PrdTesterModule.h:32