Class-algorithm for electron particle collection merging. More...

#include <ElectronLRTOverlapRemovalTool.h>

Inheritance diagram for CP::ElectronLRTOverlapRemovalTool:

Collaboration diagram for CP::ElectronLRTOverlapRemovalTool:

Public Types
enum	overlapStrategy { defaultStrategy = 0, promptStrategy = 1, passThrough = 2 }
	Allow to specify a number of supported overlap removal strategies. More...

Public Member Functions
	ElectronLRTOverlapRemovalTool (const std::string &name)
	Standard algorithm methods: More...

virtual	~ElectronLRTOverlapRemovalTool ()=default

virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function. More...

virtual void	checkOverlap (const xAOD::ElectronContainer &promptCollection, const xAOD::ElectronContainer &lrtCollection, std::set< const xAOD::Electron * > &ElectronsToRemove) const
	Check the overlap between the prompt and LRT electron collections. More...

virtual void	print () const =0
	Print the state of the tool. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

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

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	electronPassesID (const xAOD::Electron *electron, const std::string &IDWorkingPoint) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< int >	m_strategy {this, "overlapStrategy", CP::IElectronLRTOverlapRemovalTool::defaultStrategy, "Overlap removal strategy to use (0 = default)"}

Gaudi::Property< float >	m_ORThreshold {this, "ORThreshold", 0.001, "Delta R threshold for matching in overlap removal."}
	Allows for setting the overlap removal strategy in case of future variations. More...

Gaudi::Property< bool >	m_isDAOD {this, "isDAOD", true, "Switch for running on AOD (false) or DAOD (true)"}
	Delta R threshold for matching in overlap removal. More...

Gaudi::Property< std::string >	m_IDWorkingPoint {this, "IDWorkingPoint", "DFCommonElectronsLHVeryLooseNoPix", "ID working point for checking if ID is passed"}
	Switches method for retrieving electron ID. More...

ToolHandle< IAsgElectronLikelihoodTool >	m_electronLLHToolVeryLooseNoPix {this, "ElectronLLHToolVeryLooseNoPix", "", "Electron LLH tool to use for the overlap removal"}
	Switches method for retrieving electron ID. More...

ToolHandle< IAsgElectronLikelihoodTool >	m_electronLLHToolLooseNoPix {this, "ElectronLLHToolLooseNoPix", "", "Electron LLH tool to use for the overlap removal"}

ToolHandle< IAsgElectronLikelihoodTool >	m_electronLLHToolMediumNoPix {this, "ElectronLLHToolMediumNoPix", "", "Electron LLH tool to use for the overlap removal"}

ToolHandle< IAsgElectronLikelihoodTool >	m_electronLLHToolTightNoPix {this, "ElectronLLHToolTightNoPix", "", "Electron LLH tool to use for the overlap removal"}

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Class-algorithm for electron particle collection merging.

Definition at line 33 of file ElectronLRTOverlapRemovalTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ overlapStrategy

enum CP::IElectronLRTOverlapRemovalTool::overlapStrategy

inherited

Allow to specify a number of supported overlap removal strategies.

Enumerator
defaultStrategy
promptStrategy
passThrough

Definition at line 47 of file IElectronLRTOverlapRemovalTool.h.

         {
             defaultStrategy = 0,
             promptStrategy = 1,
             passThrough = 2
         } overlapStrategy;

Constructor & Destructor Documentation

◆ ElectronLRTOverlapRemovalTool()

CP::ElectronLRTOverlapRemovalTool::ElectronLRTOverlapRemovalTool ( const std::string & name )

Standard algorithm methods:

Definition at line 15 of file ElectronLRTOverlapRemovalTool.cxx.

                                                                                       : asg::AsgTool(name)
     {
     }

◆ ~ElectronLRTOverlapRemovalTool()

virtual CP::ElectronLRTOverlapRemovalTool::~ElectronLRTOverlapRemovalTool ( )

virtualdefault

Member Function Documentation

◆ checkOverlap()

void CP::ElectronLRTOverlapRemovalTool::checkOverlap	(	const xAOD::ElectronContainer &	promptCollection,
		const xAOD::ElectronContainer &	lrtCollection,
		std::set< const xAOD::Electron * > &	ElectronsToRemove
	)		const

virtual

Check the overlap between the prompt and LRT electron collections.

Saves a set of points to electrons to be removed.

Implements CP::IElectronLRTOverlapRemovalTool.

Definition at line 109 of file ElectronLRTOverlapRemovalTool.cxx.

     {
  
         // Loop over lrt electrons to remove those that do not pass ID.
         // Needed in case there are no prompt electrons passing ID
         if (m_strategy == CP::IElectronLRTOverlapRemovalTool::promptStrategy){
             ATH_MSG_DEBUG("Implementing overlap removal strategy 1");
             for (const xAOD::Electron *LRTElectron : LRTElectronCol)
             {
                 if (!electronPassesID(LRTElectron,"DFCommonElectronsLHVeryLooseNoPix"))  ElectronsToRemove.insert(LRTElectron);
             }
         }
         else if (m_strategy == CP::IElectronLRTOverlapRemovalTool::passThrough){
             ATH_MSG_DEBUG("Implementing overlap removal strategy 2");
             ATH_MSG_DEBUG("Electrons with overlapping clusters will be kept");
         }
  
  
         // loop over prompt electrons
         for (const xAOD::Electron *promptElectron : promptElectronCol)
         {
             const ElementLink promptClusterLink = promptElectron->caloClusterLink(0);
             const xAOD::CaloCluster_v1 *prompt_cluster = (*promptClusterLink);
  
             // Skip electrons that do not pass ID threshold
             if (m_strategy == CP::IElectronLRTOverlapRemovalTool::promptStrategy){
                 if (!electronPassesID(promptElectron,m_IDWorkingPoint))
                 {
                     ElectronsToRemove.insert(promptElectron);
                     continue;
                 }  
             }      
  
             // loop over lrt electrons
             for (const xAOD::Electron *LRTElectron : LRTElectronCol)
             {
                 const ElementLink LRTClusterLink = LRTElectron->caloClusterLink(0);
                 const xAOD::CaloCluster_v1 *lrt_cluster = (*LRTClusterLink);
  
                 // Skip LRT electrons that do not pass ID threshold
                 if (m_strategy == CP::IElectronLRTOverlapRemovalTool::promptStrategy){
                     if (!electronPassesID(LRTElectron,m_IDWorkingPoint)) continue;
                 }
                 // check that clusters exist (necessary? copied from MuonSpec overlap, but all electrons have clusters...)
                 // TODO: This should then fall back to delta R if clusters are missing
                 if (!lrt_cluster and !prompt_cluster)
                     continue;
  
                 // matching based on hottest cell of cluster
                 //  as in ambiguity res for el/ph 
  
                 const double prompt_elEta0 = prompt_cluster->eta0();
                 const double prompt_elPhi0 = prompt_cluster->phi0();
  
                 const double lrt_elEta0 = lrt_cluster->eta0();
                 const double lrt_elPhi0 = lrt_cluster->phi0();
                 ATH_MSG_DEBUG("Prompt eta, phi: "<<prompt_elEta0<< ", "<<prompt_elPhi0);
                 ATH_MSG_DEBUG("LRT eta, phi: "<<lrt_elEta0<< ", "<<lrt_elPhi0);
  
                 if (prompt_elEta0 == lrt_elEta0 && prompt_elPhi0 == lrt_elPhi0) 
                 {
                     if (m_strategy == CP::IElectronLRTOverlapRemovalTool::promptStrategy){
                         ATH_MSG_DEBUG("Found a Calo cluster shared by LRT electron and prompt electron !");
                         ATH_MSG_DEBUG("Removing LRT Electron");
                         // Save pointer to LRT electrons failing overlap
                         // This removes the LRT electron in favor of prompt
                         ElectronsToRemove.insert(LRTElectron);
                     }
                     else if (m_strategy == CP::IElectronLRTOverlapRemovalTool::defaultStrategy){ //use tighter electron, if both equally tight use std collection
                     
                         ATH_MSG_DEBUG("Removing Electron with looser WP");
                         if (electronPassesID(promptElectron,"DFCommonElectronsLHTightNoPix")){
                             ElectronsToRemove.insert(LRTElectron);
                         }
                         else if (electronPassesID(promptElectron,"DFCommonElectronsLHMediumNoPix") ) {
                             if (electronPassesID(LRTElectron,"DFCommonElectronsLHTightNoPix") ){
                                 ElectronsToRemove.insert(promptElectron);
                             }
                             else ElectronsToRemove.insert(LRTElectron);
                         }
                         else if (electronPassesID(promptElectron,"DFCommonElectronsLHLooseNoPix") ) {
                             if (electronPassesID(LRTElectron,"DFCommonElectronsLHMediumNoPix") ){
                                 ElectronsToRemove.insert(promptElectron);
                             }
                             else ElectronsToRemove.insert(LRTElectron);
                         }
                         else if (electronPassesID(promptElectron,"DFCommonElectronsLHVeryLooseNoPix") ) {
                             if (electronPassesID(LRTElectron,"DFCommonElectronsLHLooseNoPix") ){
                                 ElectronsToRemove.insert(promptElectron);
                             }
                             else ElectronsToRemove.insert(LRTElectron);
                         }
                         else { 
                             if (electronPassesID(LRTElectron,"DFCommonElectronsLHVeryLooseNoPix") ) {
                                 ElectronsToRemove.insert(promptElectron);
                             }
                             else ElectronsToRemove.insert(LRTElectron);
                         }
                     }
                 }
             } // end lrt loop
         }   // end prompt loop
     }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ electronPassesID()

bool CP::ElectronLRTOverlapRemovalTool::electronPassesID	(	const xAOD::Electron *	electron,
		const std::string &	IDWorkingPoint
	)		const

private

Definition at line 75 of file ElectronLRTOverlapRemovalTool.cxx.

     {
  
         if (m_isDAOD)
         {
             SG::AuxElement::ConstAccessor<char> DFCommonElectronsWP(IDWorkingPoint);
             return bool(DFCommonElectronsWP(*electron) );
         } else
         {
             if (IDWorkingPoint == "DFCommonElectronsLHTightNoPix"){
                 return bool(m_electronLLHToolTightNoPix->accept(electron));
             }
             else if (IDWorkingPoint == "DFCommonElectronsLHMediumNoPix"){
                 return bool(m_electronLLHToolMediumNoPix->accept(electron));
             }
             else if (IDWorkingPoint == "DFCommonElectronsLHLooseNoPix"){
                 return bool(m_electronLLHToolLooseNoPix->accept(electron));
             }    
             else if (IDWorkingPoint == "DFCommonElectronsLHVeryLooseNoPix"){
                 return bool(m_electronLLHToolVeryLooseNoPix->accept(electron));
             }
             else{ 
                 ATH_MSG_ERROR("IDWorkingPoint provided is not a valid Working Point!");
                 return false;
             }
         }
  
     }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode CP::ElectronLRTOverlapRemovalTool::initialize ( )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 22 of file ElectronLRTOverlapRemovalTool.cxx.

     {
  
         if (!m_isDAOD)
         {
             if (m_electronLLHToolVeryLooseNoPix.empty())
             {
                 asg::AsgToolConfig config("AsgElectronLikelihoodTool/ElectronLHSelectorVeryLooseNoPix");
                 ATH_CHECK(config.setProperty("WorkingPoint", "VeryLooseLHElectron_LLP"));
                 ATH_CHECK(config.makePrivateTool(m_electronLLHToolVeryLooseNoPix));
             }
  
             ATH_MSG_DEBUG("Retrieving electron selection tool");
             ATH_CHECK(m_electronLLHToolVeryLooseNoPix.retrieve());
  
             if (m_electronLLHToolLooseNoPix.empty())
             {
                 asg::AsgToolConfig config("AsgElectronLikelihoodTool/ElectronLHSelectorLooseNoPix");
                 ATH_CHECK(config.setProperty("WorkingPoint", "LooseLHElectron_LLP"));
                 ATH_CHECK(config.makePrivateTool(m_electronLLHToolLooseNoPix));
             }
  
             ATH_MSG_DEBUG("Retrieving electron selection tool");
             ATH_CHECK(m_electronLLHToolLooseNoPix.retrieve());
  
             if (m_electronLLHToolMediumNoPix.empty())
             {
                 asg::AsgToolConfig config("AsgElectronLikelihoodTool/ElectronLHSelectorMediumNoPix");
                 ATH_CHECK(config.setProperty("WorkingPoint", "MediumLHElectron_LLP"));
                 ATH_CHECK(config.makePrivateTool(m_electronLLHToolMediumNoPix));
             }
  
             ATH_MSG_DEBUG("Retrieving electron selection tool");
             ATH_CHECK(m_electronLLHToolMediumNoPix.retrieve());
  
             if (m_electronLLHToolTightNoPix.empty())
             {
                 asg::AsgToolConfig config("AsgElectronLikelihoodTool/ElectronLHSelectorTightNoPix");
                 ATH_CHECK(config.setProperty("WorkingPoint", "TightLHElectron_LLP"));
                 ATH_CHECK(config.makePrivateTool(m_electronLLHToolTightNoPix));
             }
  
             ATH_MSG_DEBUG("Retrieving electron selection tool");
             ATH_CHECK(m_electronLLHToolTightNoPix.retrieve());
         } 
  
         return StatusCode::SUCCESS;
     }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_electronLLHToolLooseNoPix

ToolHandle<IAsgElectronLikelihoodTool> CP::ElectronLRTOverlapRemovalTool::m_electronLLHToolLooseNoPix {this, "ElectronLLHToolLooseNoPix", "", "Electron LLH tool to use for the overlap removal"}

private

Definition at line 59 of file ElectronLRTOverlapRemovalTool.h.

◆ m_electronLLHToolMediumNoPix

ToolHandle<IAsgElectronLikelihoodTool> CP::ElectronLRTOverlapRemovalTool::m_electronLLHToolMediumNoPix {this, "ElectronLLHToolMediumNoPix", "", "Electron LLH tool to use for the overlap removal"}

private

Definition at line 60 of file ElectronLRTOverlapRemovalTool.h.

◆ m_electronLLHToolTightNoPix

ToolHandle<IAsgElectronLikelihoodTool> CP::ElectronLRTOverlapRemovalTool::m_electronLLHToolTightNoPix {this, "ElectronLLHToolTightNoPix", "", "Electron LLH tool to use for the overlap removal"}

private

Definition at line 61 of file ElectronLRTOverlapRemovalTool.h.

◆ m_electronLLHToolVeryLooseNoPix

ToolHandle<IAsgElectronLikelihoodTool> CP::ElectronLRTOverlapRemovalTool::m_electronLLHToolVeryLooseNoPix {this, "ElectronLLHToolVeryLooseNoPix", "", "Electron LLH tool to use for the overlap removal"}

private

Switches method for retrieving electron ID.

Definition at line 58 of file ElectronLRTOverlapRemovalTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_IDWorkingPoint

Gaudi::Property<std::string> CP::ElectronLRTOverlapRemovalTool::m_IDWorkingPoint {this, "IDWorkingPoint", "DFCommonElectronsLHVeryLooseNoPix", "ID working point for checking if ID is passed"}

private

Switches method for retrieving electron ID.

Definition at line 56 of file ElectronLRTOverlapRemovalTool.h.

◆ m_isDAOD

Gaudi::Property<bool> CP::ElectronLRTOverlapRemovalTool::m_isDAOD {this, "isDAOD", true, "Switch for running on AOD (false) or DAOD (true)"}

private

Delta R threshold for matching in overlap removal.

Definition at line 55 of file ElectronLRTOverlapRemovalTool.h.

◆ m_ORThreshold

Gaudi::Property<float> CP::ElectronLRTOverlapRemovalTool::m_ORThreshold {this, "ORThreshold", 0.001, "Delta R threshold for matching in overlap removal."}

private

Allows for setting the overlap removal strategy in case of future variations.

Definition at line 54 of file ElectronLRTOverlapRemovalTool.h.

◆ m_strategy

Gaudi::Property<int> CP::ElectronLRTOverlapRemovalTool::m_strategy {this, "overlapStrategy", CP::IElectronLRTOverlapRemovalTool::defaultStrategy, "Overlap removal strategy to use (0 = default)"}

private

Definition at line 53 of file ElectronLRTOverlapRemovalTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ overlapStrategy

Constructor & Destructor Documentation

◆ ElectronLRTOverlapRemovalTool()

◆ ~ElectronLRTOverlapRemovalTool()

Member Function Documentation

◆ checkOverlap()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ electronPassesID()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/2]

◆ print() [2/2]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_electronLLHToolLooseNoPix

◆ m_electronLLHToolMediumNoPix

◆ m_electronLLHToolTightNoPix

◆ m_electronLLHToolVeryLooseNoPix

◆ m_evtStore

◆ m_IDWorkingPoint

◆ m_isDAOD

◆ m_ORThreshold

◆ m_strategy

◆ m_varHandleArraysDeclared

◆ m_vhka