A tool implementing a specialized tau-jet overlap removal. More...

#include <TauAntiTauJetOverlapTool.h>

Inheritance diagram for ORUtils::TauAntiTauJetOverlapTool:

Collaboration diagram for ORUtils::TauAntiTauJetOverlapTool:

Public Member Functions
	TauAntiTauJetOverlapTool (const std::string &name)
	Create proper constructor for Athena. More...

virtual StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2) const override
	Identify overlapping taus and jets. More...

virtual StatusCode	findOverlaps (const xAOD::JetContainer &jets, const xAOD::TauJetContainer &taus) const
	Identify overlapping taus and jets. More...

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

StatusCode	initialize () override final
	Initialize base class functionality. 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
virtual StatusCode	handleOverlap (const xAOD::IParticle testParticle, const xAOD::IParticle refParticle) const
	Common helper method to handle an overlap result. More...

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

Helper methods
virtual StatusCode	initializeDerived () override
	Initialize the tool. More...

bool	isBJet (const xAOD::Jet &jet) const
	Is this jet a b-jet? Returns false if bjet ID not configured. More...

bool	isSurvivingTau (const xAOD::TauJet &tau) const
	Is this an ID tau? Returns false if tau ID not configured. More...

bool	isSurvivingAntiTau (const xAOD::TauJet &tau) const
	Is this an anti-tau? Returns false if anti-tau ID not configured. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
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

Configurable properties
std::string	m_bJetLabel
	Input jet decoration which labels a bjet. More...

std::string	m_tauLabel
	Decoration labelling an IDed tau. More...

std::string	m_antiTauLabel
	Decoration labelling an anti-tau. More...

float	m_dR
	Flat delta-R cone for matching objects. More...

bool	m_useRapidity
	Calculate deltaR using rapidity. More...

Utilities
std::unique_ptr< BJetHelper >	m_bJetHelper
	BJet helper. More...

std::unique_ptr< IParticleAssociator >	m_dRMatcher
	Delta-R matcher. More...

std::unique_ptr< OverlapDecorationHelper >	m_tauDecHelper
	Decoration helper for the IDed taus. More...

std::unique_ptr< OverlapDecorationHelper >	m_antiTauDecHelper
	Decoration helper for the anti-taus. More...

std::string	m_antiTauEventCategoryDecorName

SG::ReadHandleKey< xAOD::EventInfo >	m_evtKey {this, "EventInfoKey", "EventInfo", "xAOD::EventInfo ReadHandleKey"}

Detailed Description

A tool implementing a specialized tau-jet overlap removal.

This tool was implemented by request for the h->bbtautau analysis which uses a loose-ish btag working point and also considers anti-tau ID.

Object precedence: ID-tau > bjet > anti-tau > light-jet

The procedure works as follows.

Remove bjets overlapping with ID taus.
Remove anti-taus from remaining bjets.
Remove light jets from remaining ID-taus and anti-taus.

To fully utilize the above procedure you have to set the following properties:

TauLabel: The user-set decoration name labeling IDed taus. E.g., "isIDTau". Default is empty, which does not apply any selection.
AntiTauLabel: The user-set decoration name labeling anti-taus. E.g., "isAntiTau". Default is empty, which disables anti-taus.
BJetLabel: The usual user-set decoration name labeling bjets. E.g., "isBJet". Default is empty, which disables bjet OR.

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

Definition at line 54 of file TauAntiTauJetOverlapTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TauAntiTauJetOverlapTool()

ORUtils::TauAntiTauJetOverlapTool::TauAntiTauJetOverlapTool ( const std::string & name )

Create proper constructor for Athena.

Standalone constructor

Definition at line 23 of file TauAntiTauJetOverlapTool.cxx.

     : BaseOverlapTool(name),
       m_bJetLabel(""),
       m_tauLabel(""),
       m_antiTauLabel(""),
       m_dR(0.2),
       m_useRapidity(true),
       m_bJetHelper(nullptr),
       m_dRMatcher(nullptr),
       m_antiTauDecHelper(nullptr)
   {
     declareProperty("BJetLabel", m_bJetLabel,
                     "Input b-jet flag. Disabled by default.");
     declareProperty("TauLabel", m_tauLabel,
                     "Decoration which labels ID-ed taus");
     declareProperty("AntiTauLabel", m_antiTauLabel,
                     "Decoration which labels anti-taus");
     declareProperty("antiTauEventCategory", m_antiTauEventCategoryDecorName="antiTauEventCategory",
                     "Decoration which labels event type");
     declareProperty("DR", m_dR, "Maximum dR for overlap match");
     declareProperty("UseRapidity", m_useRapidity,
                     "Calculate delta-R using rapidity");
   }

Member Function Documentation

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

◆ 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

◆ findOverlaps() [1/2]

StatusCode ORUtils::TauAntiTauJetOverlapTool::findOverlaps	(	const xAOD::IParticleContainer &	cont1,
		const xAOD::IParticleContainer &	cont2
	)		const

overridevirtual

Identify overlapping taus and jets.

Implements ORUtils::IOverlapTool.

Definition at line 83 of file TauAntiTauJetOverlapTool.cxx.

   {
     // Check the container types
     if(typeid(cont1) != typeid(xAOD::JetContainer) &&
        typeid(cont1) != typeid(ConstDataVector<xAOD::JetContainer>)) {
       ATH_MSG_ERROR("First container arg is not of type JetContainer!");
       return StatusCode::FAILURE;
     }
     if(typeid(cont2) != typeid(xAOD::TauJetContainer) &&
        typeid(cont2) != typeid(ConstDataVector<xAOD::TauJetContainer>)) {
       ATH_MSG_ERROR("Second container arg is not of type TauJetContainer!");
       return StatusCode::FAILURE;
     }
     ATH_CHECK( findOverlaps(static_cast<const xAOD::JetContainer&>(cont1),
                             static_cast<const xAOD::TauJetContainer&>(cont2)) );
     return StatusCode::SUCCESS;
   }

◆ findOverlaps() [2/2]

StatusCode ORUtils::TauAntiTauJetOverlapTool::findOverlaps	(	const xAOD::JetContainer &	jets,
		const xAOD::TauJetContainer &	taus
	)		const

virtual

Identify overlapping taus and jets.

The above method calls this one.

Definition at line 106 of file TauAntiTauJetOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("Removing overlapping taus and jets");
     const EventContext& ctx = Gaudi::Hive::currentContext();
  
     // Initialize output decorations if necessary
     m_decHelper->initializeDecorations(taus);
     m_decHelper->initializeDecorations(jets);
  
     // Start by discarding all taus which are not ID or anti-ID
     for(const auto tau : taus) {
       if(!m_decHelper->isSurvivingObject(*tau)) continue;
       if(isSurvivingTau(*tau)) continue;
       if(isSurvivingAntiTau(*tau)) continue;
       // remove it with trivial overlap with itself
       ATH_CHECK( handleOverlap(tau, tau) );
     }
  
     // Remove bjets overlapping with ID taus
     int ntaus = 0;
     for(const auto tau : taus) {
       if(!m_decHelper->isSurvivingObject(*tau)) continue;
       // Only consider ID taus
       if(!isSurvivingTau(*tau)) continue;
       ntaus++;
       for(const auto jet : jets) {
         if(!m_decHelper->isSurvivingObject(*jet)) continue;
         if(m_dRMatcher->objectsMatch(*tau, *jet)){
           ATH_CHECK( handleOverlap(jet, tau) );
         }
       }
     }
  
     // Remove anti-taus from remaining bjets
     for(const auto jet : jets) {
       if(!m_decHelper->isSurvivingObject(*jet)) continue;
       if(!isBJet(*jet)) continue;
       for(const auto tau : taus) {
         if(!m_decHelper->isSurvivingObject(*jet)) continue;
         if(!isSurvivingAntiTau(*tau)) continue;
         if(m_dRMatcher->objectsMatch(*tau, *jet)) {
           ATH_CHECK( handleOverlap(tau, jet) );
         }
       }
     }
  
     int nantitaus = 0;
     int antiTauCategory = 0;
     static const SG::AuxElement::ConstAccessor<int> categoryAcc(m_antiTauEventCategoryDecorName);
     for(const auto tau : taus) {
       if(!m_decHelper->isSurvivingObject(*tau)) continue;
       if(!isSurvivingAntiTau(*tau)) continue;
       nantitaus++;
       antiTauCategory = categoryAcc(*tau);
     }
  
     int nAntiTauMax = int(ntaus<antiTauCategory);
  
     // AntiTauCategory = 1 for lephad event, 2 for hadhad events
     // nAntiTauMax = 1 if we didn't get enough ID taus, 0 otherwise 
     SG::ReadHandle<xAOD::EventInfo> eventInfo(m_evtKey,ctx);
     auto eventIndex = eventInfo->eventNumber();    // pseudo-random selection of anti-taus    // pseudo-random selection of anti-taus
     if (nantitaus > 0) {
       int selIndex = eventIndex%nantitaus;
  
       int nSelectedAntitaus = 0;
       int idx = 0;
       for(const auto tau : taus) {
         if(!m_decHelper->isSurvivingObject(*tau)) continue;
         if(!isSurvivingAntiTau(*tau) ) continue;
         if (idx == selIndex  && nSelectedAntitaus < nAntiTauMax) nSelectedAntitaus++;
         else {
           // remove excess anti-taus by applying OR fail (it trivially overlaps with itself)
           ATH_CHECK( handleOverlap(tau, tau) );
         }
         idx++;
       }
     }
  
     // Remove light jets from remaining anti-taus.
     for(const auto tau : taus) {
       if(!m_decHelper->isSurvivingObject(*tau)) continue;
       if(!isSurvivingAntiTau(*tau)) continue;
       // if isSurviving
       for(const auto jet : jets) {
         if(!m_decHelper->isSurvivingObject(*jet)) continue;
         // We don't need to check the bjet label, but it might save CPU.
         if(isBJet(*jet)) continue;
         if(m_dRMatcher->objectsMatch(*tau, *jet)){
           ATH_CHECK( handleOverlap(jet, tau) );
         }
       }
     }
  
     return StatusCode::SUCCESS;
   }

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

◆ handleOverlap()

StatusCode ORUtils::BaseOverlapTool::handleOverlap	(	const xAOD::IParticle *	testParticle,
		const xAOD::IParticle *	refParticle
	)		const

protectedvirtualinherited

Common helper method to handle an overlap result.

This method for now applies the user-defined object priorities set as the input decoration, so if the testParticle is higher prio than the refParticle, nothing happens. Otherwise, this method prints a debug message, decorates the testParticle as overlap, and optionally sets the object element link.

Definition at line 63 of file BaseOverlapTool.cxx.

   {
     // Apply user-priority override
     if(!m_enableUserPrio ||
        m_decHelper->getObjectPriority(*testParticle) <=
        m_decHelper->getObjectPriority(*refParticle))
     {
       ATH_MSG_DEBUG("  Found overlap " << testParticle->type() <<
                     " pt " << testParticle->pt()*invGeV);
       m_decHelper->setObjectFail(*testParticle);
       if(m_objLinkHelper) {
         ATH_CHECK( m_objLinkHelper->addObjectLink(*testParticle, *refParticle) );
       }
     }
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode ORUtils::BaseOverlapTool::initialize ( )

finaloverridevirtualinherited

Initialize base class functionality.

Concrete tool specific initialization can be implemented by overriding the initializeDerived() method.

Reimplemented from asg::AsgTool.

Definition at line 38 of file BaseOverlapTool.cxx.

   {
     ATH_MSG_DEBUG("Initializing " << name());
     ATH_MSG_DEBUG("Base config options: InputLabel " << m_inputLabel <<
                   " OutputLabel " << m_outputLabel <<
                   " OutputPassValue " << m_outputPassValue <<
                   " UserPrio " << m_enableUserPrio);
  
     // Initialize the decoration helper
     m_decHelper = std::make_unique<OverlapDecorationHelper>
       (m_inputLabel, m_outputLabel, m_outputPassValue);
  
     // Initialize the obj-link helper
     if(m_linkOverlapObjects)
       m_objLinkHelper = std::make_unique<OverlapLinkHelper>("overlapObject");
  
     // Initialize the derived tool
     ATH_CHECK( initializeDerived() );
  
     return StatusCode::SUCCESS;
   }

◆ initializeDerived()

StatusCode ORUtils::TauAntiTauJetOverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 50 of file TauAntiTauJetOverlapTool.cxx.

   {
     // Initialize the b-jet helper
     if(!m_bJetLabel.empty()) {
       ATH_MSG_DEBUG("Configuring btag-aware OR with btag label: " << m_bJetLabel);
       m_bJetHelper = std::make_unique<BJetHelper>(m_bJetLabel);
     }
  
     // Initialize the dR matcher
     ATH_CHECK(m_evtKey.initialize());
     m_dRMatcher = std::make_unique<DeltaRMatcher>(m_dR, m_useRapidity);
  
     // Initialize the IDed-tau decoration helper
     if(!m_tauLabel.empty()) {
       ATH_MSG_DEBUG("Configuring tau OR with label: " << m_tauLabel);
       m_tauDecHelper =
         std::make_unique<OverlapDecorationHelper>
           (m_tauLabel, m_outputLabel, m_outputPassValue);
     }
  
     // Initialize the anti-tau decoration helper
     if(!m_antiTauLabel.empty()) {
       ATH_MSG_DEBUG("Configuring anti-tau OR with label: " << m_antiTauLabel);
       m_antiTauDecHelper =
         std::make_unique<OverlapDecorationHelper>
           (m_antiTauLabel, m_outputLabel, m_outputPassValue);
     }
     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.

◆ isBJet()

bool ORUtils::TauAntiTauJetOverlapTool::isBJet ( const xAOD::Jet & jet ) const

protected

Is this jet a b-jet? Returns false if bjet ID not configured.

Does not check if the jet is "surviving" OR.

Definition at line 208 of file TauAntiTauJetOverlapTool.cxx.

   {
     if(m_bJetHelper && m_bJetHelper->isBJet(jet)) return true;
     return false;
   }

◆ isSurvivingAntiTau()

bool ORUtils::TauAntiTauJetOverlapTool::isSurvivingAntiTau ( const xAOD::TauJet & tau ) const

protected

Is this an anti-tau? Returns false if anti-tau ID not configured.

This one does check if the tau is "surviving" OR.

Definition at line 226 of file TauAntiTauJetOverlapTool.cxx.

   {
     if(m_antiTauDecHelper && m_antiTauDecHelper->isSurvivingObject(tau))
       return true;
     return false;
   }

◆ isSurvivingTau()

bool ORUtils::TauAntiTauJetOverlapTool::isSurvivingTau ( const xAOD::TauJet & tau ) const

protected

Is this an ID tau? Returns false if tau ID not configured.

This one does check if the tau is "surviving" OR.

Definition at line 217 of file TauAntiTauJetOverlapTool.cxx.

   {
     if(m_tauDecHelper && m_tauDecHelper->isSurvivingObject(tau)) return true;
     return false;
   }

◆ 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, top::TopObjectSelection, 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, top::TopObjectSelection, 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_antiTauDecHelper

std::unique_ptr<OverlapDecorationHelper> ORUtils::TauAntiTauJetOverlapTool::m_antiTauDecHelper

private

Decoration helper for the anti-taus.

Definition at line 132 of file TauAntiTauJetOverlapTool.h.

◆ m_antiTauEventCategoryDecorName

std::string ORUtils::TauAntiTauJetOverlapTool::m_antiTauEventCategoryDecorName

private

Definition at line 134 of file TauAntiTauJetOverlapTool.h.

◆ m_antiTauLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_antiTauLabel

private

Decoration labelling an anti-tau.

Definition at line 109 of file TauAntiTauJetOverlapTool.h.

◆ m_bJetHelper

std::unique_ptr<BJetHelper> ORUtils::TauAntiTauJetOverlapTool::m_bJetHelper

private

BJet helper.

Definition at line 123 of file TauAntiTauJetOverlapTool.h.

◆ m_bJetLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_bJetLabel

private

Input jet decoration which labels a bjet.

Definition at line 103 of file TauAntiTauJetOverlapTool.h.

◆ m_decHelper

std::unique_ptr<OverlapDecorationHelper> ORUtils::BaseOverlapTool::m_decHelper

protectedinherited

Helper for handling input/output decorations.

Definition at line 95 of file BaseOverlapTool.h.

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

float ORUtils::TauAntiTauJetOverlapTool::m_dR

private

Flat delta-R cone for matching objects.

Definition at line 112 of file TauAntiTauJetOverlapTool.h.

◆ m_dRMatcher

std::unique_ptr<IParticleAssociator> ORUtils::TauAntiTauJetOverlapTool::m_dRMatcher

private

Delta-R matcher.

Definition at line 126 of file TauAntiTauJetOverlapTool.h.

◆ m_enableUserPrio

bool ORUtils::BaseOverlapTool::m_enableUserPrio

protectedinherited

Enable user-priority scoring.

Definition at line 86 of file BaseOverlapTool.h.

◆ m_evtKey

SG::ReadHandleKey<xAOD::EventInfo> ORUtils::TauAntiTauJetOverlapTool::m_evtKey {this, "EventInfoKey", "EventInfo", "xAOD::EventInfo ReadHandleKey"}

private

Definition at line 135 of file TauAntiTauJetOverlapTool.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_inputLabel

std::string ORUtils::BaseOverlapTool::m_inputLabel

protectedinherited

Input object decoration which specifies which objects to look at.

Definition at line 74 of file BaseOverlapTool.h.

◆ m_linkOverlapObjects

bool ORUtils::BaseOverlapTool::m_linkOverlapObjects

protectedinherited

Flag to toggle overlap object links.

Definition at line 83 of file BaseOverlapTool.h.

◆ m_objLinkHelper

std::unique_ptr<OverlapLinkHelper> ORUtils::BaseOverlapTool::m_objLinkHelper

protectedinherited

Helper for linking overlap objects.

Definition at line 98 of file BaseOverlapTool.h.

◆ m_outputLabel

std::string ORUtils::BaseOverlapTool::m_outputLabel

protectedinherited

Output object decoration which specifies overlapping objects.

Definition at line 76 of file BaseOverlapTool.h.

◆ m_outputPassValue

bool ORUtils::BaseOverlapTool::m_outputPassValue

protectedinherited

Toggle the output flag logic.

If true, then non-overlapping objects will be assigned "true".

Definition at line 80 of file BaseOverlapTool.h.

◆ m_tauDecHelper

std::unique_ptr<OverlapDecorationHelper> ORUtils::TauAntiTauJetOverlapTool::m_tauDecHelper

private

Decoration helper for the IDed taus.

Definition at line 129 of file TauAntiTauJetOverlapTool.h.

◆ m_tauLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_tauLabel

private

Decoration labelling an IDed tau.

Definition at line 106 of file TauAntiTauJetOverlapTool.h.

◆ m_useRapidity

bool ORUtils::TauAntiTauJetOverlapTool::m_useRapidity

private

Calculate deltaR using rapidity.

Definition at line 114 of file TauAntiTauJetOverlapTool.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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TauAntiTauJetOverlapTool()

Member Function Documentation

◆ 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()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ findOverlaps() [1/2]

◆ findOverlaps() [2/2]

◆ getKey()

◆ getName()

◆ getProperty()

◆ handleOverlap()

◆ initialize()

◆ initializeDerived()

◆ inputHandles()

◆ isBJet()

◆ isSurvivingAntiTau()

◆ isSurvivingTau()

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

◆ m_antiTauEventCategoryDecorName

◆ m_antiTauLabel

◆ m_bJetHelper

◆ m_bJetLabel

◆ m_decHelper

◆ m_detStore

◆ m_dR

◆ m_dRMatcher

◆ m_enableUserPrio

◆ m_evtKey

◆ m_evtStore

◆ m_inputLabel

◆ m_linkOverlapObjects

◆ m_objLinkHelper

◆ m_outputLabel

◆ m_outputPassValue

◆ m_tauDecHelper

◆ m_tauLabel

◆ m_useRapidity

◆ m_varHandleArraysDeclared

◆ m_vhka