ORUtils::TauAntiTauJetOverlapTool Class Reference

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

#include <TauAntiTauJetOverlapTool.h>

Inheritance diagram for ORUtils::TauAntiTauJetOverlapTool:

Collaboration diagram for ORUtils::TauAntiTauJetOverlapTool:

Classes
struct	Accessors
	Columnar accessors. More...

Public Member Functions
	TauAntiTauJetOverlapTool (const std::string &name)
	Create proper constructor for Athena.
virtual StatusCode	findOverlaps (columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext) const override
	Identify overlapping taus and jets.
virtual StatusCode	internalFindOverlaps (columnar::Particle1Range jets, columnar::Particle2Range taus, columnar::EventContextId eventContext) const
	Identify overlapping taus and jets.
StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2, const EventContext &eventContext=Gaudi::Hive::currentContext()) const
StatusCode	initialize () override final
	Initialize base class functionality.
virtual void	callEvents (columnar::EventContextRange events) const override
	The callEvents() for columnar tools.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>
StatusCode	handleOverlap (const columnar::ObjectId< CI1, CM > &testParticle, const columnar::ObjectId< CI2, CM > &refParticle) const
	Common helper method to handle an overlap result.
template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>
StatusCode	checkForXAODContainer (columnar::ObjectRange< CI, CM > cont, std::string_view message) const
	check whether the container is of the right type
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.
Helper methods
virtual StatusCode	initializeDerived () override
	Initialize the tool.
bool	isBJet (columnar::Particle1Id jet) const
	Is this jet a b-jet?
bool	isSurvivingTau (columnar::Particle2Id tau) const
	Is this an ID tau?
bool	isSurvivingAntiTau (columnar::Particle2Id tau) const
	Is this an anti-tau?
Helper Functions
void	initializeDecorations (columnar::Particle1Range container) const
void	initializeDecorations (columnar::Particle2Range container) const
char	getObjectPriority (columnar::Particle1Id obj) const
char	getObjectPriority (columnar::Particle2Id obj) const
bool	isSurvivingObject (columnar::Particle1Id obj) const
bool	isSurvivingObject (columnar::Particle2Id obj) const
bool	isRejectedObject (columnar::Particle1Id obj) const
bool	isRejectedObject (columnar::Particle2Id obj) const
void	setObjectFail (columnar::Particle1Id obj) const
void	setObjectFail (columnar::Particle2Id obj) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle1Id p1, columnar::ObjectId< CI > p2) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle2Id p1, columnar::ObjectId< CI > p2) const

Protected Attributes
Common configurable properties
std::string	m_inputLabel
	Input object decoration which specifies which objects to look at.
std::string	m_outputLabel
	Output object decoration which specifies overlapping objects.
bool	m_outputPassValue
	Toggle the output flag logic.
bool	m_linkOverlapObjects
	Flag to toggle overlap object links.
bool	m_enableUserPrio
	Enable user-priority scoring.
Utilities
std::unique_ptr< BaseAccessors >	m_baseAccessors {std::make_unique<BaseAccessors> (this)}
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > >	m_decHelper1
	Helper for handling input/output decorations.
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > >	m_decHelper2
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle1 > >	m_objLinkHelper1
	Helper for linking overlap objects.
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle2 > >	m_objLinkHelper2

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
Configurable properties
std::string	m_bJetLabel
	Input jet decoration which labels a bjet.
std::string	m_tauLabel
	Decoration labelling an IDed tau.
std::string	m_antiTauLabel
	Decoration labelling an anti-tau.
float	m_dR
	Flat delta-R cone for matching objects.
bool	m_useRapidity
	Calculate deltaR using rapidity.
Utilities
std::unique_ptr< Accessors >	m_accessors {std::make_unique<Accessors> (this)}
std::unique_ptr< IParticleAssociator >	m_dRMatcher
	Delta-R matcher.
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > >	m_tauDecHelper
	Decoration helper for the IDed taus.
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > >	m_antiTauDecHelper
	Decoration helper for the anti-taus.
std::string	m_antiTauEventCategoryDecorName
Gaudi::Property< std::string >	m_evtKeyName {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.

1. Remove bjets overlapping with ID taus.
2. Remove anti-taus from remaining bjets.
3. 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 60 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_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

addObjectLink() [1/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink ( columnar::Particle1Id p1, columnar::ObjectId< CI > p2 ) const

inlineprotectedinherited

Definition at line 163 of file BaseOverlapTool.h.

                                                                                       {
        return m_objLinkHelper1->addObjectLink (p1, p2); }

addObjectLink() [2/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink ( columnar::Particle2Id p1, columnar::ObjectId< CI > p2 ) const

inlineprotectedinherited

Definition at line 166 of file BaseOverlapTool.h.

                                                                                       {
        return m_objLinkHelper2->addObjectLink (p1, p2); }

callEvents()

void ORUtils::BaseOverlapTool::callEvents ( columnar::EventContextRange events ) const

overridevirtualinherited

The callEvents() for columnar tools.

Definition at line 65 of file BaseOverlapTool.cxx.

  {
    auto& baseAcc = *m_baseAccessors;
    for (auto event : events)
    {
      ANA_CHECK_THROW (findOverlaps (baseAcc.m_particles1Acc (event), baseAcc.m_particles2Acc (event), event));
    }
  }

checkForXAODContainer()

template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>

StatusCode ORUtils::BaseOverlapTool::checkForXAODContainer ( columnar::ObjectRange< CI, CM > cont, std::string_view message ) const

inlineprotectedinherited

check whether the container is of the right type

Definition at line 83 of file BaseOverlapTool.h.

      {
        if constexpr (CM::isXAOD) {
          if(typeid(cont.getXAODObjectNoexcept()) != typeid(XAODContainer) &&
            typeid(cont.getXAODObjectNoexcept()) != typeid(ConstDataVector<XAODContainer>)) {
            ATH_MSG_ERROR(message);
            return StatusCode::FAILURE;
          }
        }
        return StatusCode::SUCCESS;
      }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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.

{ return m_detStore; }

evtStore()

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.

{ 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::IOverlapTool::findOverlaps ( const xAOD::IParticleContainer & cont1, const xAOD::IParticleContainer & cont2, const EventContext & eventContext = Gaudi::Hive::currentContext() ) const

inlineinherited

Definition at line 46 of file IOverlapTool.h.

                                                                                                  {
        return findOverlaps(
          columnar::Particle1Range(cont1),
          columnar::Particle2Range(cont2),
          eventContext);
      }

findOverlaps() [2/2]

StatusCode ORUtils::TauAntiTauJetOverlapTool::findOverlaps ( columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext ) const

overridevirtual

Identify overlapping taus and jets.

Implements ORUtils::IOverlapTool.

Definition at line 88 of file TauAntiTauJetOverlapTool.cxx.

  {
    // Check the container types
    ATH_CHECK( checkForXAODContainer<xAOD::JetContainer>(cont1, "First container arg is not of type JetContainer!") );
    ATH_CHECK( checkForXAODContainer<xAOD::TauJetContainer>(cont2, "Second container arg is not of type TauJetContainer!") );
 
    ATH_CHECK( internalFindOverlaps(cont1, cont2, eventContext) );
    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
   }

getObjectPriority() [1/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 146 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper1->getObjectPriority (obj); }

getObjectPriority() [2/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 148 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper2->getObjectPriority (obj); }

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

handleOverlap()

template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>

StatusCode ORUtils::BaseOverlapTool::handleOverlap ( const columnar::ObjectId< CI1, CM > & testParticle, const columnar::ObjectId< CI2, CM > & refParticle ) const

protectedinherited

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.

Unit conversion constant

Definition at line 177 of file BaseOverlapTool.h.

  {
    // Apply user-priority override
    if(!m_enableUserPrio ||
       getObjectPriority(testParticle) <=
       getObjectPriority(refParticle))
    {
      if constexpr (CM::isXAOD)
      {
        const float invGeV = 1e-3;
        ATH_MSG_DEBUG("  Found overlap " << testParticle.getXAODObject().type() <<
                      " pt " << testParticle.getXAODObject().pt()*invGeV);
      } else
      {
        ATH_MSG_DEBUG("  Found overlap " << testParticle);
      }
      setObjectFail(testParticle);
      if(m_linkOverlapObjects) {
        ATH_CHECK( addObjectLink(testParticle, refParticle) );
      }
    }
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode ORUtils::BaseOverlapTool::initialize ( void )

finaloverridevirtualinherited

Initialize base class functionality.

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

Reimplemented from asg::AsgTool.

Definition at line 32 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_decHelper1 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle1>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper1);
    m_decHelper2 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle2>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper2);
 
    // Initialize the obj-link helper
    if(m_linkOverlapObjects)
    {
      m_objLinkHelper1 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle1>>("overlapObject");
      addSubtool(*m_objLinkHelper1);
      m_objLinkHelper2 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle2>>("overlapObject");
      addSubtool(*m_objLinkHelper2);
    }
 
    // Initialize the derived tool
    ATH_CHECK( initializeDerived() );
 
    ATH_CHECK ( initializeColumns() );
 
    return StatusCode::SUCCESS;
  }

initializeDecorations() [1/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle1Range container ) const

inlineprotectedinherited

Definition at line 142 of file BaseOverlapTool.h.

                                                                         {
        m_decHelper1->initializeDecorations (container); }

initializeDecorations() [2/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle2Range container ) const

inlineprotectedinherited

Definition at line 144 of file BaseOverlapTool.h.

                                                                         {
        m_decHelper2->initializeDecorations (container); }

initializeDerived()

StatusCode ORUtils::TauAntiTauJetOverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 49 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);
      resetAccessor (m_accessors->m_bJetAcc, *m_accessors, m_bJetLabel);
    }
 
    // Initialize the dR matcher
    m_dRMatcher = std::make_unique<DeltaRMatcher>(m_dR, m_useRapidity);
    ATH_CHECK (m_dRMatcher->setObjectTypes (xAODType::ObjectType::Jet, xAODType::ObjectType::Tau));
    addSubtool(*m_dRMatcher);
 
    // 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<columnar::ContainerId::particle2>>
          (m_tauLabel, m_outputLabel, m_outputPassValue);
      addSubtool(*m_tauDecHelper);
    }
 
    // 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<columnar::ContainerId::particle2>>
          (m_antiTauLabel, m_outputLabel, m_outputPassValue);
      addSubtool(*m_antiTauDecHelper);
    }
 
    resetAccessor (m_accessors->m_evtAcc, *m_accessors, m_evtKeyName, {.addMTDependency = true});
    resetAccessor (m_accessors->m_categoryAcc, *m_accessors, m_antiTauEventCategoryDecorName);
    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.

internalFindOverlaps()

StatusCode ORUtils::TauAntiTauJetOverlapTool::internalFindOverlaps ( columnar::Particle1Range jets, columnar::Particle2Range taus, columnar::EventContextId eventContext ) const

virtual

Identify overlapping taus and jets.

The above method calls this one.

Definition at line 104 of file TauAntiTauJetOverlapTool.cxx.

  {
    ATH_MSG_DEBUG("Removing overlapping taus and jets");
    auto& acc = *m_accessors;
 
    // Initialize output decorations if necessary
    initializeDecorations(taus);
    initializeDecorations(jets);
 
    // Start by discarding all taus which are not ID or anti-ID
    for(const auto tau : taus) {
      if(!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(!isSurvivingObject(tau)) continue;
      // Only consider ID taus
      if(!isSurvivingTau(tau)) continue;
      ntaus++;
      for(const auto jet : jets) {
        if(!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(!isSurvivingObject(jet)) continue;
      if(!isBJet(jet)) continue;
      for(const auto tau : taus) {
        if(!isSurvivingObject(tau)) continue;
        if(!isSurvivingAntiTau(tau)) continue;
        if(m_dRMatcher->objectsMatch(tau, jet)) {
          ATH_CHECK( handleOverlap(tau, jet) );
        }
      }
    }
 
    int nantitaus = 0;
    int antiTauCategory = 0;
    for(const auto tau : taus) {
      if(!isSurvivingObject(tau)) continue;
      if(!isSurvivingAntiTau(tau)) continue;
      nantitaus++;
      antiTauCategory = acc.m_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 
    auto eventInfo = acc.m_evtAcc(eventContext);
    auto eventIndex = eventInfo(acc.m_eventNumberAcc);    // 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(!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(!isSurvivingObject(tau)) continue;
      if(!isSurvivingAntiTau(tau)) continue;
      // if isSurviving
      for(const auto jet : jets) {
        if(!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;
  }

isBJet()

bool ORUtils::TauAntiTauJetOverlapTool::isBJet ( columnar::Particle1Id 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 206 of file TauAntiTauJetOverlapTool.cxx.

  {
    if(!m_bJetLabel.empty() && m_accessors->m_bJetAcc(jet)) return true;
    return false;
  }

isRejectedObject() [1/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 154 of file BaseOverlapTool.h.

                                                                         {
        return m_decHelper1->isRejectedObject (obj); }

isRejectedObject() [2/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 156 of file BaseOverlapTool.h.

                                                                         {
        return m_decHelper2->isRejectedObject (obj); }

isSurvivingAntiTau()

bool ORUtils::TauAntiTauJetOverlapTool::isSurvivingAntiTau ( columnar::Particle2Id 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 224 of file TauAntiTauJetOverlapTool.cxx.

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

isSurvivingObject() [1/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 150 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper1->isSurvivingObject (obj);}

isSurvivingObject() [2/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 152 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper2->isSurvivingObject (obj);}

isSurvivingTau()

bool ORUtils::TauAntiTauJetOverlapTool::isSurvivingTau ( columnar::Particle2Id 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 215 of file TauAntiTauJetOverlapTool.cxx.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

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

setObjectFail() [1/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle1Id obj ) const

inlineprotectedinherited

Definition at line 158 of file BaseOverlapTool.h.

                                                        {
        m_decHelper1->setObjectFail (obj); }

setObjectFail() [2/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle2Id obj ) const

inlineprotectedinherited

Definition at line 160 of file BaseOverlapTool.h.

                                                        {
        m_decHelper2->setObjectFail (obj); }

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_accessors

std::unique_ptr<Accessors> ORUtils::TauAntiTauJetOverlapTool::m_accessors {std::make_unique<Accessors> (this)}

private

Definition at line 144 of file TauAntiTauJetOverlapTool.h.

{std::make_unique<Accessors> (this)};

m_antiTauDecHelper

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle2> > ORUtils::TauAntiTauJetOverlapTool::m_antiTauDecHelper

private

Decoration helper for the anti-taus.

Definition at line 153 of file TauAntiTauJetOverlapTool.h.

m_antiTauEventCategoryDecorName

std::string ORUtils::TauAntiTauJetOverlapTool::m_antiTauEventCategoryDecorName

private

Definition at line 155 of file TauAntiTauJetOverlapTool.h.

m_antiTauLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_antiTauLabel

private

Decoration labelling an anti-tau.

Definition at line 117 of file TauAntiTauJetOverlapTool.h.

m_baseAccessors

std::unique_ptr<BaseAccessors> ORUtils::BaseOverlapTool::m_baseAccessors {std::make_unique<BaseAccessors> (this)}

protectedinherited

Definition at line 125 of file BaseOverlapTool.h.

{std::make_unique<BaseAccessors> (this)};

m_bJetLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_bJetLabel

private

Input jet decoration which labels a bjet.

Definition at line 111 of file TauAntiTauJetOverlapTool.h.

m_decHelper1

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_decHelper1

protectedinherited

Helper for handling input/output decorations.

Definition at line 128 of file BaseOverlapTool.h.

m_decHelper2

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_decHelper2

protectedinherited

Definition at line 129 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 120 of file TauAntiTauJetOverlapTool.h.

m_dRMatcher

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

private

Delta-R matcher.

Definition at line 147 of file TauAntiTauJetOverlapTool.h.

m_enableUserPrio

bool ORUtils::BaseOverlapTool::m_enableUserPrio

protectedinherited

Enable user-priority scoring.

Definition at line 111 of file BaseOverlapTool.h.

m_evtKeyName

Gaudi::Property<std::string> ORUtils::TauAntiTauJetOverlapTool::m_evtKeyName {this, "EventInfoKey", "EventInfo", "xAOD::EventInfo ReadHandleKey"}

private

Definition at line 157 of file TauAntiTauJetOverlapTool.h.

{this, "EventInfoKey", "EventInfo", "xAOD::EventInfo ReadHandleKey"};

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 99 of file BaseOverlapTool.h.

m_linkOverlapObjects

bool ORUtils::BaseOverlapTool::m_linkOverlapObjects

protectedinherited

Flag to toggle overlap object links.

Definition at line 108 of file BaseOverlapTool.h.

m_objLinkHelper1

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_objLinkHelper1

protectedinherited

Helper for linking overlap objects.

Definition at line 132 of file BaseOverlapTool.h.

m_objLinkHelper2

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_objLinkHelper2

protectedinherited

Definition at line 133 of file BaseOverlapTool.h.

m_outputLabel

std::string ORUtils::BaseOverlapTool::m_outputLabel

protectedinherited

Output object decoration which specifies overlapping objects.

Definition at line 101 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 105 of file BaseOverlapTool.h.

m_tauDecHelper

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle2> > ORUtils::TauAntiTauJetOverlapTool::m_tauDecHelper

private

Decoration helper for the IDed taus.

Definition at line 150 of file TauAntiTauJetOverlapTool.h.

m_tauLabel

std::string ORUtils::TauAntiTauJetOverlapTool::m_tauLabel

private

Decoration labelling an IDed tau.

Definition at line 114 of file TauAntiTauJetOverlapTool.h.

m_useRapidity

bool ORUtils::TauAntiTauJetOverlapTool::m_useRapidity

private

Calculate deltaR using rapidity.

Definition at line 122 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:

• TauAntiTauJetOverlapTool.h
• TauAntiTauJetOverlapTool.cxx