MuonVal::EventInfoBranch Class Reference

#include <EventInfoBranch.h>

Inheritance diagram for MuonVal::EventInfoBranch:

Collaboration diagram for MuonVal::EventInfoBranch:

Public Types
enum	WriteOpts {   isMC = 1 , writePileUp = 1 << 1 , writePRW = 1 << 2 , writeBeamSpot = 1 << 3 ,   writeTrigger = 1 << 4 , writeLHE = 1<<5 }
using	DataDependency = SG::VarHandleKey*

Public Member Functions
	EventInfoBranch (MuonTesterTree &tree, unsigned int write_mask, const std::string &evtKey="EventInfo")
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.
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.
std::string	name () const override final
	Returns the name of the branch.
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.
TTree *	tree () override final
	Returns the underlying TTree object.
const TTree *	tree () const override final
std::vector< DataDependency >	data_dependencies () override final
	Returns the data dependencies needed by the MuonTesterBranch.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Static Public Member Functions
static void	setNumLHE (unsigned int numLHE) ATLAS_THREAD_SAFE
	Specify the number of LHE variations that are available in the sample.
static unsigned int	getNumLHE ()
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.
template<class Key>
bool	declare_dependency (Key &key)
	Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.
MuonTesterTree &	parent ()
	Returns the reference to the MuonTesterTree parent.

Private Types
using	EvtInfoDecor = SG::ReadDecorHandleKey<xAOD::EventInfo>
	Access to the pile up weights if requested.

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

Private Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_key {"EventInfo"}
	Common access to the EventInfo.
std::vector< EvtInfoDecor >	m_prwKeys {}
unsigned int	m_writemask {0}
ScalarBranch< unsigned long long > &	m_evtNumber {parent().newScalar<unsigned long long>("eventNumber")}
ScalarBranch< uint32_t > &	m_runNumber {parent().newScalar<uint32_t>("runNumber")}
ScalarBranch< uint32_t > &	m_lbNumber {parent().newScalar<uint32_t>("lbNumber")}
ScalarBranch< uint32_t > &	m_bcid {parent().newScalar<uint32_t>("bcid")}
ScalarBranch< uint32_t > &	m_l1id {parent().newScalar<uint32_t>("l1id")}
	Toggled by the write trigger flag.
ScalarBranch< float > &	m_average_mu {parent().newScalar<float>("average_mu")}
	Toggled by the Write PileUp flag.
ScalarBranch< float > &	m_actual_mu {parent().newScalar<float>("actual_mu")}
ScalarBranch< uint32_t > &	m_mcChannel {parent().newScalar<uint32_t>("mcChannelNumber")}
	###################################################################### Disabled if the job runs on data # #####################################################################
ScalarBranch< double > &	m_weight {parent().newScalar<double>("mcEventWeight")}
	Removed from output if writeLHE is switched on.
std::map< unsigned int, std::shared_ptr< ScalarBranch< double > > >	m_lhe_weights {}
ScalarBranch< double > &	m_prwWeight {parent().newScalar<double>("prwWeight")}
	Branches toggled by the write prw Flag.
ScalarBranch< uint32_t > &	m_rnd_run {parent().newScalar<uint32_t>("randomRunNumber")}
ScalarBranch< uint32_t > &	m_rnd_lumi_block {parent().newScalar<uint32_t>("randomLumiBlockNumber")}
ScalarBranch< double > &	m_beamSpotWeight {parent().newScalar<double>("BeamSpotWeight")}
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.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.

Static Private Attributes
static std::atomic< unsigned int > s_num_lhe	ATLAS_THREAD_SAFE

Detailed Description

Definition at line 15 of file EventInfoBranch.h.

Member Typedef Documentation

DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

EvtInfoDecor

using MuonVal::EventInfoBranch::EvtInfoDecor = SG::ReadDecorHandleKey<xAOD::EventInfo>

private

Access to the pile up weights if requested.

Definition at line 48 of file EventInfoBranch.h.

Member Enumeration Documentation

WriteOpts

enum MuonVal::EventInfoBranch::WriteOpts

Enumerator
isMC	Flag determining whether the branch is simulation.
writePileUp	Write pile-up information.
writePRW	Write the corrected pile-up.
writeBeamSpot	Write the beamspot weight.
writeTrigger	Write the trigger information.
writeLHE	Write each of the LHE weights.

Definition at line 18 of file EventInfoBranch.h.

                   {
        isMC = 1,       
        writePileUp = 1 << 1,
        writePRW = 1 << 2,
        writeBeamSpot = 1 << 3,
        writeTrigger = 1 << 4,
        writeLHE = 1<<5
    };

Constructor & Destructor Documentation

EventInfoBranch()

MuonVal::EventInfoBranch::EventInfoBranch	(	MuonTesterTree &	tree,
		unsigned int	write_mask,
		const std::string &	evtKey = "EventInfo" )

Definition at line 17 of file EventInfoBranch.cxx.

                                                         :
    MuonTesterBranch{tree, " event info "},    
    m_key{evtKey},
    m_writemask{write_mask}{
    if (m_writemask & WriteOpts::isMC) {
        if (m_writemask & WriteOpts::writeLHE) {
            for (unsigned int lhe = 1; lhe < s_num_lhe ; ++lhe ) {
                std::shared_ptr<ScalarBranch<double>>& new_br = m_lhe_weights[lhe];                
                new_br = std::make_shared<ScalarBranch<double>>(tree.tree(),  "mcEventWeight_LHE_" + std::to_string(lhe),0.);
                if (!tree.addBranch(new_br)) {
                  THROW_EXCEPTION("EventInfoBranch: Failed to create Scalar branch in c'tor");
                }
            }            
        }
    } else {
         tree.disableBranch(m_mcChannel.name());
         tree.disableBranch(m_weight.name()); 
         m_writemask&= ~(WriteOpts::writePRW | WriteOpts::writeBeamSpot);   
    }
    
    if (m_writemask & WriteOpts::writePRW) {
        m_prwKeys.emplace_back(m_key.key() + "." + SG::AuxTypeRegistry::instance().getName(acc_Random.auxid()));
        m_prwKeys.emplace_back(m_key.key() + "." + SG::AuxTypeRegistry::instance().getName(acc_LumiBlock.auxid()));
        m_prwKeys.emplace_back(m_key.key() + "." + SG::AuxTypeRegistry::instance().getName(acc_PuW.auxid()));
     } else {
        tree.disableBranch(m_prwWeight.name());
        tree.disableBranch(m_rnd_run.name());
        tree.disableBranch(m_rnd_lumi_block.name());
     }
     if (!(m_writemask & WriteOpts::writeBeamSpot)) tree.disableBranch(m_beamSpotWeight.name());
     if (!(m_writemask & WriteOpts::writePileUp)) {
        tree.disableBranch(m_average_mu.name());
        tree.disableBranch(m_actual_mu.name());
     }
     if (!(m_writemask & WriteOpts::writeTrigger)) tree.disableBranch(m_l1id.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.

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

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

fill()

bool MuonVal::EventInfoBranch::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 57 of file EventInfoBranch.cxx.

                                                  {
    SG::ReadHandle<xAOD::EventInfo> evt_info{m_key, ctx};
    if (!evt_info.isValid()) {
        ATH_MSG_ERROR("Could not retrieve the EventInfo " << m_key.fullKey());
        return false;
    }
 
    m_evtNumber = evt_info->eventNumber();
    m_runNumber = evt_info->runNumber();
    m_lbNumber = evt_info->lumiBlock();
    m_bcid = evt_info->bcid();
    
    m_average_mu = evt_info->averageInteractionsPerCrossing();
    m_actual_mu = evt_info->actualInteractionsPerCrossing();
    if (m_writemask & WriteOpts::writeTrigger) {
        m_l1id = evt_info->extendedLevel1ID();
    }    
    if (m_writemask & WriteOpts::isMC) {
        m_mcChannel = evt_info->mcChannelNumber();
        m_weight = evt_info->mcEventWeight(0);
        const unsigned int n_weights = evt_info->mcEventWeights().size();
        for (auto & [lhe_idx, lhe_branch] : m_lhe_weights) { 
            (*lhe_branch) = lhe_idx < n_weights ? evt_info->mcEventWeight(lhe_idx) : 0.; 
        }       
    }
    if (m_writemask & WriteOpts::writePRW) {
        m_prwWeight = acc_PuW(*evt_info);
        m_rnd_run = acc_Random(*evt_info);
        m_rnd_lumi_block = acc_LumiBlock(*evt_info);
    }
    if (m_writemask & WriteOpts::writeBeamSpot) {
        m_beamSpotWeight = evt_info->beamSpotWeight();
    }
    return true;
}

getNumLHE()

unsigned int MuonVal::EventInfoBranch::getNumLHE ( )

static

Definition at line 16 of file EventInfoBranch.cxx.

{ return s_num_lhe;}

init()

bool MuonVal::EventInfoBranch::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 92 of file EventInfoBranch.cxx.

                           { 
    return declare_dependency(m_key) && std::find_if(m_prwKeys.begin(), m_prwKeys.end(), 
                                                     [this](EvtInfoDecor& decor){
                                                        return !declare_dependency(decor);
                                                     }) == m_prwKeys.end();
}

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    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 163 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 178 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_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;
}

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

setNumLHE()

void MuonVal::EventInfoBranch::setNumLHE ( unsigned int numLHE )

static

Specify the number of LHE variations that are available in the sample.

Definition at line 15 of file EventInfoBranch.cxx.

{ s_num_lhe = n;}

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<unsigned int> s_num_lhe MuonVal::EventInfoBranch::ATLAS_THREAD_SAFE

staticprivate

Definition at line 44 of file EventInfoBranch.h.

m_actual_mu

ScalarBranch<float>& MuonVal::EventInfoBranch::m_actual_mu {parent().newScalar<float>("actual_mu")}

private

Definition at line 64 of file EventInfoBranch.h.

{parent().newScalar<float>("actual_mu")};

m_average_mu

ScalarBranch<float>& MuonVal::EventInfoBranch::m_average_mu {parent().newScalar<float>("average_mu")}

private

Toggled by the Write PileUp flag.

Definition at line 63 of file EventInfoBranch.h.

{parent().newScalar<float>("average_mu")};

m_bcid

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_bcid {parent().newScalar<uint32_t>("bcid")}

private

Definition at line 57 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("bcid")};

m_beamSpotWeight

ScalarBranch<double>& MuonVal::EventInfoBranch::m_beamSpotWeight {parent().newScalar<double>("BeamSpotWeight")}

private

Definition at line 77 of file EventInfoBranch.h.

{parent().newScalar<double>("BeamSpotWeight")};

m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

{};

m_evtNumber

ScalarBranch<unsigned long long>& MuonVal::EventInfoBranch::m_evtNumber {parent().newScalar<unsigned long long>("eventNumber")}

private

Definition at line 53 of file EventInfoBranch.h.

{parent().newScalar<unsigned long long>("eventNumber")};

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_init

bool MuonVal::MuonTesterBranch::m_init {false}

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

{false};

m_key

SG::ReadHandleKey<xAOD::EventInfo> MuonVal::EventInfoBranch::m_key {"EventInfo"}

private

Common access to the EventInfo.

Definition at line 46 of file EventInfoBranch.h.

{"EventInfo"};

m_l1id

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_l1id {parent().newScalar<uint32_t>("l1id")}

private

Toggled by the write trigger flag.

Definition at line 60 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("l1id")};

m_lbNumber

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_lbNumber {parent().newScalar<uint32_t>("lbNumber")}

private

Definition at line 56 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("lbNumber")};

m_lhe_weights

std::map<unsigned int, std::shared_ptr<ScalarBranch<double> > > MuonVal::EventInfoBranch::m_lhe_weights {}

private

Definition at line 71 of file EventInfoBranch.h.

{};

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_mcChannel

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_mcChannel {parent().newScalar<uint32_t>("mcChannelNumber")}

private

###################################################################### Disabled if the job runs on data # #####################################################################

Definition at line 68 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("mcChannelNumber")};

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.

{nullptr};

m_prwKeys

std::vector<EvtInfoDecor> MuonVal::EventInfoBranch::m_prwKeys {}

private

Definition at line 49 of file EventInfoBranch.h.

{};

m_prwWeight

ScalarBranch<double>& MuonVal::EventInfoBranch::m_prwWeight {parent().newScalar<double>("prwWeight")}

private

Branches toggled by the write prw Flag.

Definition at line 74 of file EventInfoBranch.h.

{parent().newScalar<double>("prwWeight")};

m_rnd_lumi_block

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_rnd_lumi_block {parent().newScalar<uint32_t>("randomLumiBlockNumber")}

private

Definition at line 76 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("randomLumiBlockNumber")};

m_rnd_run

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_rnd_run {parent().newScalar<uint32_t>("randomRunNumber")}

private

Definition at line 75 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("randomRunNumber")};

m_runNumber

ScalarBranch<uint32_t>& MuonVal::EventInfoBranch::m_runNumber {parent().newScalar<uint32_t>("runNumber")}

private

Definition at line 54 of file EventInfoBranch.h.

{parent().newScalar<uint32_t>("runNumber")};

m_tree

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

{nullptr};

m_weight

ScalarBranch<double>& MuonVal::EventInfoBranch::m_weight {parent().newScalar<double>("mcEventWeight")}

private

Removed from output if writeLHE is switched on.

Definition at line 70 of file EventInfoBranch.h.

{parent().newScalar<double>("mcEventWeight")};    

m_writemask

unsigned int MuonVal::EventInfoBranch::m_writemask {0}

private

Definition at line 50 of file EventInfoBranch.h.

{0};

---

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

• EventInfoBranch.h
• EventInfoBranch.cxx