TestMuonSF::MuonSFBranches Class Reference

#include <MuonSFTestHelper.h>

Inheritance diagram for TestMuonSF::MuonSFBranches:

Collaboration diagram for TestMuonSF::MuonSFBranches:

Classes
struct	SFSet
	Helper struct to store scale factor, data efficiency + mc efficiency for each systematic variation. More...

Public Types
using	DataDependency = SG::VarHandleKey*

Public Member Functions
	MuonSFBranches (MuonVal::MuonTesterTree &tree, const ToolHandle< CP::IMuonEfficiencyScaleFactors > &handle, const std::string &rel_name="")
virtual	~MuonSFBranches ()=default
void	setMuon (const xAOD::Muon &muon) 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.
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 std::string	systName (const CP::SystematicSet &set)
	Dummy helper function that encodes the systname set.
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 Member Functions
CP::CorrectionCode	fillSystematic (const xAOD::Muon &muon, SFSet &set)
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
ToolHandle< CP::IMuonEfficiencyScaleFactors >	m_handle {}
bool	m_uncorrelate_sys {false}
std::vector< std::unique_ptr< SFSet > >	m_SFs {}
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.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Definition at line 71 of file MuonSFTestHelper.h.

Member Typedef Documentation

DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

MuonSFBranches()

TestMuonSF::MuonSFBranches::MuonSFBranches	(	MuonVal::MuonTesterTree &	tree,
		const ToolHandle< CP::IMuonEfficiencyScaleFactors > &	handle,
		const std::string &	rel_name = "" )

Definition at line 90 of file MuonSFTestHelper.cxx.

                                                            :
        MuonVal::MuonTesterBranch{tree, relName + (relName.empty() ? "" : "_") + 
                                        getProperty<std::string>(handle.get(), "WorkingPoint")},
        m_handle{handle} {}

~MuonSFBranches()

virtual TestMuonSF::MuonSFBranches::~MuonSFBranches ( )

virtualdefault

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 TestMuonSF::MuonSFBranches::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 112 of file MuonSFTestHelper.cxx.

                                                     {
        for (auto& sys : m_SFs) {
            if (!sys->fill(ctx)) return false;
        }
        return true;
    }

fillSystematic()

CP::CorrectionCode TestMuonSF::MuonSFBranches::fillSystematic ( const xAOD::Muon & muon, SFSet & set )

private

No data-mc efficiencies provided for eta beyond 2.5

Definition at line 154 of file MuonSFTestHelper.cxx.

                                                                      {
        if (m_handle->applySystematicVariation(Syst_SF.cpSet) != StatusCode::SUCCESS) {
            ATH_MSG_ERROR("Failed to apply variation "<< Syst_SF.cpSet.name()<<" for "<< name());
            return CP::CorrectionCode::Error;
        }  
        float sf{1.f};
        CP::CorrectionCode cc = m_handle->getEfficiencyScaleFactor(muon, sf);
        if (cc == CP::CorrectionCode::Error) {
            ATH_MSG_ERROR("Failed to retrieve the scale factor variation "<< Syst_SF.cpSet.name()<<" for "<< name());
            return CP::CorrectionCode::Error;
        }
        Syst_SF.scaleFactor = sf;
       
        if (std::abs(muon.eta()) > 2.5) {
            Syst_SF.dataEff = -1;
            Syst_SF.mcEff = -1;
            return CP::CorrectionCode::Ok;
        }            
        cc = m_handle->getDataEfficiency(muon, sf);
        if (cc == CP::CorrectionCode::Error) {
            ATH_MSG_ERROR("Failed to retrieve the data efficiency variation "<< Syst_SF.cpSet.name()<<" for "<< name());
            return cc;
        }
        Syst_SF.dataEff = sf;          
        cc = m_handle->getMCEfficiency(muon, sf);
        if (cc == CP::CorrectionCode::Error) {
            ATH_MSG_ERROR("Failed to retrieve the mc efficiency variation "<< Syst_SF.cpSet.name()<<" for "<< name());
            return CP::CorrectionCode::Error;
        }
        Syst_SF.mcEff = sf;
        return CP::CorrectionCode::Ok;        
    }

init()

bool TestMuonSF::MuonSFBranches::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 97 of file MuonSFTestHelper.cxx.

                             {
        auto mesf = dynamic_cast<const CP::MuonEfficiencyScaleFactors*>(m_handle.get());
        if (!mesf) {
            ATH_MSG_ERROR("Given tool not MuonCP::MuonEfficiencyScaleFactors");
            return false;
        }
        m_uncorrelate_sys = mesf->uncorrelate_sys();
 
        for (const auto& set : CP::make_systematics_vector(m_handle->recommendedSystematics())) {
            m_SFs.emplace_back(std::make_unique<SFSet>(set, *this));
            if (!m_SFs.back()->init()) return false;
        }
        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.

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

setMuon()

void TestMuonSF::MuonSFBranches::setMuon ( const xAOD::Muon & muon )

finaloverridevirtual

Only the raw systematic sets have been activated We can loop over each set and fill it properly

Only process the nominal set or the set matching the syst bin

Implements TestMuonSF::MuonEffiBranch.

Definition at line 120 of file MuonSFTestHelper.cxx.

                                                     {
        if (!m_uncorrelate_sys) {
            for (auto& Syst_SF : m_SFs) {            
                CP::CorrectionCode cc = fillSystematic(muon, *Syst_SF);
                if (cc == CP::CorrectionCode::Error){
                    return;
                }
            }
        }  else {            
            int bin =  m_handle->getUnCorrelatedSystBin(muon);
            if (bin < 0){
                ATH_MSG_WARNING("Did not find a valid bin for muon  with pT: "<<muon.pt() *MeVtoGeV <<" GeV, eta:"<<
                        muon.eta()<<", phi: "<<muon.phi());
                return;
            }        
            for (auto& Syst_SF: m_SFs){
                bool process =  Syst_SF->cpSet.name().empty() ||
                                std::find_if(Syst_SF->cpSet.begin(), Syst_SF->cpSet.end(), 
                                            [bin](const CP::SystematicVariation& t){
                                                return t.isToyVariation() && t.getToyVariation().first == 
                                                                            static_cast<unsigned>(bin);
                                            }) != Syst_SF->cpSet.end();
                if (!process) continue;
                CP::CorrectionCode cc = fillSystematic(muon, *Syst_SF);
                if (cc == CP::CorrectionCode::Error) {
                    return;
                }                
            }           
        } 
    }

systName()

std::string TestMuonSF::MuonSFBranches::systName ( const CP::SystematicSet & set )

inlinestatic

Dummy helper function that encodes the systname set.

Definition at line 87 of file MuonSFTestHelper.h.

                                                                  {
                return set.name().empty() ? std::string("") : std::string("__") + set.name();
            }

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_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

{};

m_handle

ToolHandle<CP::IMuonEfficiencyScaleFactors> TestMuonSF::MuonSFBranches::m_handle {}

private

Definition at line 92 of file MuonSFTestHelper.h.

{};

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_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_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_SFs

std::vector<std::unique_ptr<SFSet> > TestMuonSF::MuonSFBranches::m_SFs {}

private

Definition at line 121 of file MuonSFTestHelper.h.

{};

m_tree

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

{nullptr};

m_uncorrelate_sys

bool TestMuonSF::MuonSFBranches::m_uncorrelate_sys {false}

private

Definition at line 93 of file MuonSFTestHelper.h.

{false};

---

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

• MuonSFTestHelper.h
• MuonSFTestHelper.cxx