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

Helper class to store the four-momentum in a TTree using the X,Y,Z,T or Px,Py,Pz,E representation. More...

#include <FourVectorBranch.h>

Inheritance diagram for MuonVal::CartesFourVecBranch:
Collaboration diagram for MuonVal::CartesFourVecBranch:

Public Types

enum  Type { Type::Mom, Type::Pos }
 
using DataDependency = SG::VarHandleKey *
 

Public Member Functions

 CartesFourVecBranch (MuonTesterTree &tree, const std::string &vec_name, Type t)
 
void push_back (const TLorentzVector &vec)
 
void operator+= (const TLorentzVector &vec)
 
void set (const TLorentzVector &vec, size_t pos)
 
void push_back (const HepMC::FourVector &vec)
 
void operator+= (const HepMC::FourVector &vec)
 
void set (const HepMC::FourVector &vec, size_t pos)
 
void push_back (const float x, const float y, const float z, const float t)
 
void set (const float x, const float y, const float z, const float t, size_t pos)
 
size_t size () const
 
bool fill (const EventContext &) 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 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

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

bool m_mom {false}
 
VectorBranch< float > & m_x {parent().newVector<float>(name() + (m_mom ? "Px" : "X"))}
 
VectorBranch< float > & m_y {parent().newVector<float>(name() + (m_mom ? "Py" : "Y"))}
 
VectorBranch< float > & m_z {parent().newVector<float>(name() + (m_mom ? "Pz" : "Z"))}
 
VectorBranch< float > & m_t {parent().newVector<float>(name() + (m_mom ? "E" : "T"))}
 
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

Helper class to store the four-momentum in a TTree using the X,Y,Z,T or Px,Py,Pz,E representation.

Definition at line 45 of file FourVectorBranch.h.

Member Typedef Documentation

◆ DataDependency

Definition at line 39 of file IMuonTesterBranch.h.

Member Enumeration Documentation

◆ Type

Enumerator
Mom 
Pos 

Definition at line 47 of file FourVectorBranch.h.

47 { Mom, Pos };

Constructor & Destructor Documentation

◆ CartesFourVecBranch()

MuonVal::CartesFourVecBranch::CartesFourVecBranch ( MuonTesterTree tree,
const std::string &  vec_name,
Type  t 
)

Definition at line 32 of file FourVectorBranch.cxx.

32  :
33  MuonTesterBranch(tree, vec_name), m_mom{t == Type::Mom} {}

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.

◆ 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 MuonVal::CartesFourVecBranch::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 43 of file FourVectorBranch.cxx.

43 { return true; }

◆ init()

bool MuonVal::CartesFourVecBranch::init ( )
finaloverridevirtual

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 44 of file FourVectorBranch.cxx.

44 { return true; }

◆ 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; }

◆ operator+=() [1/2]

void MuonVal::CartesFourVecBranch::operator+= ( const HepMC::FourVector &  vec)

Definition at line 39 of file FourVectorBranch.cxx.

39 { push_back(vec); }

◆ operator+=() [2/2]

void MuonVal::CartesFourVecBranch::operator+= ( const TLorentzVector &  vec)

Definition at line 35 of file FourVectorBranch.cxx.

35 { push_back(vec); }

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

◆ push_back() [1/3]

void MuonVal::CartesFourVecBranch::push_back ( const float  x,
const float  y,
const float  z,
const float  t 
)

Definition at line 45 of file FourVectorBranch.cxx.

45  {
46  m_x += x;
47  m_y += y;
48  m_z += z;
49  m_t += t;
50 }

◆ push_back() [2/3]

void MuonVal::CartesFourVecBranch::push_back ( const HepMC::FourVector &  vec)

Definition at line 38 of file FourVectorBranch.cxx.

38 { push_back(vec.x(), vec.y(), vec.z(), vec.t()); }

◆ push_back() [3/3]

void MuonVal::CartesFourVecBranch::push_back ( const TLorentzVector &  vec)

Definition at line 34 of file FourVectorBranch.cxx.

34 { push_back(vec.X(), vec.Y(), vec.Z(), vec.T()); }

◆ set() [1/3]

void MuonVal::CartesFourVecBranch::set ( const float  x,
const float  y,
const float  z,
const float  t,
size_t  pos 
)

Definition at line 51 of file FourVectorBranch.cxx.

51  {
52  m_x[pos] = x;
53  m_y[pos] = y;
54  m_z[pos] = z;
55  m_t[pos] = t;
56 }

◆ set() [2/3]

void MuonVal::CartesFourVecBranch::set ( const HepMC::FourVector &  vec,
size_t  pos 
)

Definition at line 40 of file FourVectorBranch.cxx.

40 { set(vec.x(), vec.y(), vec.z(), vec.t(), pos); }

◆ set() [3/3]

void MuonVal::CartesFourVecBranch::set ( const TLorentzVector &  vec,
size_t  pos 
)

Definition at line 36 of file FourVectorBranch.cxx.

36 { set(vec.X(), vec.Y(), vec.Z(), vec.T(), pos); }

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

◆ size()

size_t MuonVal::CartesFourVecBranch::size ( ) const

Definition at line 42 of file FourVectorBranch.cxx.

42 { return m_x.size(); }

◆ 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_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_lvl

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

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_mom

bool MuonVal::CartesFourVecBranch::m_mom {false}
private

Definition at line 67 of file FourVectorBranch.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_t

VectorBranch<float>& MuonVal::CartesFourVecBranch::m_t {parent().newVector<float>(name() + (m_mom ? "E" : "T"))}
private

Definition at line 71 of file FourVectorBranch.h.

◆ m_tree

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

Definition at line 58 of file MuonTesterBranch.h.

◆ m_x

VectorBranch<float>& MuonVal::CartesFourVecBranch::m_x {parent().newVector<float>(name() + (m_mom ? "Px" : "X"))}
private

Definition at line 68 of file FourVectorBranch.h.

◆ m_y

VectorBranch<float>& MuonVal::CartesFourVecBranch::m_y {parent().newVector<float>(name() + (m_mom ? "Py" : "Y"))}
private

Definition at line 69 of file FourVectorBranch.h.

◆ m_z

VectorBranch<float>& MuonVal::CartesFourVecBranch::m_z {parent().newVector<float>(name() + (m_mom ? "Pz" : "Z"))}
private

Definition at line 70 of file FourVectorBranch.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
MuonVal::CartesFourVecBranch::m_mom
bool m_mom
Definition: FourVectorBranch.h:67
MuonVal::CartesFourVecBranch::m_y
VectorBranch< float > & m_y
Definition: FourVectorBranch.h:69
MuonVal::MuonTesterBranch::m_dependencies
std::vector< DataDependency > m_dependencies
Definition: MuonTesterBranch.h:62
MuonVal::MuonTesterBranch::m_tree
TTree * m_tree
Definition: MuonTesterBranch.h:58
python.AthDsoLogger.out
out
Definition: AthDsoLogger.py:71
vec
std::vector< size_t > vec
Definition: CombinationsGeneratorTest.cxx:12
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
MuonVal::MuonTesterBranch::MuonTesterBranch
MuonTesterBranch(MuonTesterTree &tree, const std::string &br_name)
Definition: MuonTesterBranch.cxx:33
AthMessaging::m_imsg
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
Definition: AthMessaging.h:135
x
#define x
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
MuonVal::CartesFourVecBranch::push_back
void push_back(const TLorentzVector &vec)
Definition: FourVectorBranch.cxx:34
TrigConf::MSGTC::Level
Level
Definition: Trigger/TrigConfiguration/TrigConfBase/TrigConfBase/MsgStream.h:21
z
#define z
MuonVal::MuonTesterBranch::m_init
bool m_init
Definition: MuonTesterBranch.h:61
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::CartesFourVecBranch::set
void set(const TLorentzVector &vec, size_t pos)
Definition: FourVectorBranch.cxx:36
MuonVal::CartesFourVecBranch::m_z
VectorBranch< float > & m_z
Definition: FourVectorBranch.h:70
python.LumiBlobConversion.pos
pos
Definition: LumiBlobConversion.py:18
MuonVal::MuonTesterBranch::m_name
std::string m_name
Definition: MuonTesterBranch.h:60
MuonVal::CartesFourVecBranch::m_x
VectorBranch< float > & m_x
Definition: FourVectorBranch.h:68
y
#define y
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
MuonVal::CartesFourVecBranch::Type::Mom
@ Mom
MuonVal::VectorBranch::size
size_t size() const
Returns the number of actual saved elements.
AthMessaging::initMessaging
void initMessaging() const
Initialize our message level and MessageSvc.
Definition: AthMessaging.cxx:39
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
MuonVal::CartesFourVecBranch::m_t
VectorBranch< float > & m_t
Definition: FourVectorBranch.h:71