A container and helper class for overlap removal tools. More...

#include <ToolBox.h>

Inheritance diagram for ORUtils::ToolBox:

Collaboration diagram for ORUtils::ToolBox:

Public Types
using	parentType_t = INamedInterface
	Aliases.
using	MasterHandle_t = asg::AnaToolHandle<IOverlapRemovalTool>
using	OverlapHandle_t = asg::AnaToolHandle<IOverlapTool>

Public Member Functions
	ToolBox (const std::string &name="ORToolBox", parentType_t *theParent=nullptr)
	Basic constructor with name and parent.
StatusCode	initialize ()
	Attach and initialize all tools.
std::vector< OverlapHandle_t * >	getOverlapTools ()
	Get a list of all handles to loop over.
template<class T>
StatusCode	setGlobalProperty (const std::string &property, const T &value)
	Apply a global property to all tools.
parentType_t *	parent ()
	Pointer to the parent component for the tool handles.
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Public Attributes
MasterHandle_t	masterTool
	Master overlap removal tool handle.
overlap tool handles
OverlapHandle_t	muPFJetORT
OverlapHandle_t	eleEleORT
OverlapHandle_t	eleMuORT
OverlapHandle_t	eleJetORT
OverlapHandle_t	muJetORT
OverlapHandle_t	tauEleORT
OverlapHandle_t	tauMuORT
OverlapHandle_t	tauJetORT
OverlapHandle_t	phoEleORT
OverlapHandle_t	phoMuORT
OverlapHandle_t	phoJetORT
OverlapHandle_t	eleFatJetORT
OverlapHandle_t	jetFatJetORT

Private Member Functions
StatusCode	initTool (OverlapHandle_t &handle, const std::string &key)
	Initialize and attach one overlap tool.
StatusCode	initMaster ()
	Initialize master tool.
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
parentType_t *	m_parent
	Pointer to the parent component for the tool handles.
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

A container and helper class for overlap removal tools.

This implementation uses AnaToolHandles to setup, manage, and configure the overlap tools and a master overlap removal tool.

Todo: Add some more usage details.

Author: Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 38 of file ToolBox.h.

Member Typedef Documentation

◆ MasterHandle_t

using ORUtils::ToolBox::MasterHandle_t = asg::AnaToolHandle<IOverlapRemovalTool>

Definition at line 45 of file ToolBox.h.

◆ OverlapHandle_t

using ORUtils::ToolBox::OverlapHandle_t = asg::AnaToolHandle<IOverlapTool>

Definition at line 46 of file ToolBox.h.

◆ parentType_t

using ORUtils::ToolBox::parentType_t = INamedInterface

Aliases.

Definition at line 44 of file ToolBox.h.

Constructor & Destructor Documentation

◆ ToolBox()

ORUtils::ToolBox::ToolBox	(	const std::string &	name = "ORToolBox",
		parentType_t *	theParent = nullptr )

Basic constructor with name and parent.

Definition at line 14 of file ToolBox.cxx.

    : asg::AsgMessaging(name),
      masterTool("", theParent),
      eleEleORT("", theParent),
      eleMuORT("", theParent),
      eleJetORT("", theParent),
      muJetORT("", theParent),
      tauEleORT("", theParent),
      tauMuORT("", theParent),
      tauJetORT("", theParent),
      phoEleORT("", theParent),
      phoMuORT("", theParent),
      phoJetORT("", theParent),
      eleFatJetORT("", theParent),
      jetFatJetORT("", theParent),
      m_parent(theParent)
  {}

Member Function Documentation

◆ getOverlapTools()

std::vector< ToolBox::OverlapHandle_t * > ORUtils::ToolBox::getOverlapTools ( )

Get a list of all handles to loop over.

Definition at line 71 of file ToolBox.cxx.

  {
    // This is somewhat error prone, but better than not having it.
    std::vector<OverlapHandle_t*> tools;
    tools.reserve(13);
    if(!eleEleORT.empty()) tools.push_back(&eleEleORT);
    if(!eleMuORT.empty())  tools.push_back(&eleMuORT);
    if(!eleJetORT.empty()) tools.push_back(&eleJetORT);
    if(!muJetORT.empty())  tools.push_back(&muJetORT);
    if(!tauEleORT.empty()) tools.push_back(&tauEleORT);
    if(!tauMuORT.empty())  tools.push_back(&tauMuORT);
    if(!tauJetORT.empty()) tools.push_back(&tauJetORT);
    if(!phoEleORT.empty()) tools.push_back(&phoEleORT);
    if(!phoMuORT.empty())  tools.push_back(&phoMuORT);
    if(!phoJetORT.empty()) tools.push_back(&phoJetORT);
    if(!eleFatJetORT.empty()) tools.push_back(&eleFatJetORT);
    if(!jetFatJetORT.empty()) tools.push_back(&jetFatJetORT);
    return tools;
  }

◆ initialize()

StatusCode ORUtils::ToolBox::initialize ( )

Attach and initialize all tools.

Definition at line 35 of file ToolBox.cxx.

  {
 
#ifndef XAOD_STANDALONE
    // For now, in Athena, things only work with private tools.
    // See ATLASG-957 for more details.
    if(!m_parent) {
      ATH_MSG_ERROR("For now, if you want to use the ToolBox in Athena, " <<
                    "the tools must be private to some algorithm, tool, etc.");
      return StatusCode::FAILURE;
    }
#endif
 
    // Initialize the overlap tools
    ATH_CHECK( initTool(eleEleORT, "EleEleORT") );
    ATH_CHECK( initTool(eleMuORT, "EleMuORT") );
    ATH_CHECK( initTool(eleJetORT, "EleJetORT") );
    ATH_CHECK( initTool(muJetORT, "MuJetORT") );
    ATH_CHECK( initTool(tauEleORT, "TauEleORT") );
    ATH_CHECK( initTool(tauMuORT, "TauMuORT") );
    ATH_CHECK( initTool(tauJetORT, "TauJetORT") );
    ATH_CHECK( initTool(phoEleORT, "PhoEleORT") );
    ATH_CHECK( initTool(phoMuORT, "PhoMuORT") );
    ATH_CHECK( initTool(phoJetORT, "PhoJetORT") );
    ATH_CHECK( initTool(eleFatJetORT, "EleFatJetORT") );
    ATH_CHECK( initTool(jetFatJetORT, "JetFatJetORT") );
 
    // Initialize the master tool
    ATH_CHECK( initMaster() );
 
    return StatusCode::SUCCESS;
  }

◆ initMaster()

StatusCode ORUtils::ToolBox::initMaster ( )

private

Initialize master tool.

Definition at line 120 of file ToolBox.cxx.

  {
    // For now, we look for a non-empty "type"
    if(!masterTool.empty()) {
      ATH_MSG_DEBUG("Initializing master " << masterTool.name());
      ATH_MSG_DEBUG("  type " << masterTool.type());
      ATH_MSG_DEBUG("  isInitialized  " << masterTool.isInitialized());
      if(!masterTool.isInitialized()) {
        ATH_CHECK( masterTool.initialize() );
      }
    }
    return StatusCode::SUCCESS;
  }

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

◆ initTool()

StatusCode ORUtils::ToolBox::initTool	(	OverlapHandle_t &	handle,
		const std::string &	key )

private

Initialize and attach one overlap tool.

Definition at line 94 of file ToolBox.cxx.

  {
    // Handle must be non-empty
    if(!handle.empty()) {
      ATH_MSG_DEBUG("Initializing " << handle.name());
      ATH_MSG_DEBUG("  type " << handle.type());
      ATH_MSG_DEBUG("  isInitialized  " << handle.isInitialized());
 
      // Initialize the handle - WB: NO DON'T DO THIS ...
      // the naming of the tool implies it's a subtool, so it mustn't be created before
      // the parent tool is, because otherwise the parent tool doesn't get configured properly
      // if the configuration has been done on the C++ side (the state of the joboptionsvc hasn't
      // been updated yet) ... triggering the initialization would trigger the creation of the master tool
      // because it's deemed to be a parent by the naming convention parent.child
      
      // Add it to the master tool
      if(!masterTool.empty()) {
        ATH_CHECK( masterTool.setProperty(key, handle) );
      }
    }
    return StatusCode::SUCCESS;
  }

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

◆ parent()

parentType_t * ORUtils::ToolBox::parent ( )

inline

Pointer to the parent component for the tool handles.

Definition at line 84 of file ToolBox.h.

84{ return m_parent; }

◆ setGlobalProperty()

template<class T>

StatusCode ORUtils::ToolBox::setGlobalProperty	(	const std::string &	property,
		const T &	value )

Apply a global property to all tools.

Definition at line 104 of file ToolBox.h.

  {
    // Handle the overlap tools
    for(auto handlePtr : getOverlapTools()) {
      ATH_CHECK( handlePtr->setProperty(property, value) );
    }
    // Handle the master tool
    if(!masterTool.empty()) ATH_CHECK( masterTool.setProperty(property, value) );
    return StatusCode::SUCCESS;
  }

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

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.

◆ eleEleORT

OverlapHandle_t ORUtils::ToolBox::eleEleORT

Definition at line 69 of file ToolBox.h.

◆ eleFatJetORT

OverlapHandle_t ORUtils::ToolBox::eleFatJetORT

Definition at line 79 of file ToolBox.h.

◆ eleJetORT

OverlapHandle_t ORUtils::ToolBox::eleJetORT

Definition at line 71 of file ToolBox.h.

◆ eleMuORT

OverlapHandle_t ORUtils::ToolBox::eleMuORT

Definition at line 70 of file ToolBox.h.

◆ jetFatJetORT

OverlapHandle_t ORUtils::ToolBox::jetFatJetORT

Definition at line 80 of file ToolBox.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_parent

parentType_t* ORUtils::ToolBox::m_parent

private

Pointer to the parent component for the tool handles.

Definition at line 95 of file ToolBox.h.

◆ masterTool

MasterHandle_t ORUtils::ToolBox::masterTool

Master overlap removal tool handle.

Definition at line 64 of file ToolBox.h.

◆ muJetORT

OverlapHandle_t ORUtils::ToolBox::muJetORT

Definition at line 72 of file ToolBox.h.

◆ muPFJetORT

OverlapHandle_t ORUtils::ToolBox::muPFJetORT

Definition at line 68 of file ToolBox.h.

◆ phoEleORT

OverlapHandle_t ORUtils::ToolBox::phoEleORT

Definition at line 76 of file ToolBox.h.

◆ phoJetORT

OverlapHandle_t ORUtils::ToolBox::phoJetORT

Definition at line 78 of file ToolBox.h.

◆ phoMuORT

OverlapHandle_t ORUtils::ToolBox::phoMuORT

Definition at line 77 of file ToolBox.h.

◆ tauEleORT

OverlapHandle_t ORUtils::ToolBox::tauEleORT

Definition at line 73 of file ToolBox.h.

◆ tauJetORT

OverlapHandle_t ORUtils::ToolBox::tauJetORT

Definition at line 75 of file ToolBox.h.

◆ tauMuORT

OverlapHandle_t ORUtils::ToolBox::tauMuORT

Definition at line 74 of file ToolBox.h.

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

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MasterHandle_t

◆ OverlapHandle_t

◆ parentType_t

Constructor & Destructor Documentation

◆ ToolBox()

Member Function Documentation

◆ getOverlapTools()

◆ initialize()

◆ initMaster()

◆ initMessaging()

◆ initTool()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ parent()

◆ setGlobalProperty()

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ eleEleORT

◆ eleFatJetORT

◆ eleJetORT

◆ eleMuORT

◆ jetFatJetORT

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_parent

◆ masterTool

◆ muJetORT

◆ muPFJetORT

◆ phoEleORT

◆ phoJetORT

◆ phoMuORT

◆ tauEleORT

◆ tauJetORT

◆ tauMuORT