Implementation of the hardscatter selection tool. More...

#include <InDetHardScatterSelectionTool.h>

Inheritance diagram for InDet::InDetHardScatterSelectionTool:

Collaboration diagram for InDet::InDetHardScatterSelectionTool:

Classes
class	Sum

Public Types
Running mode(s) for hardscatter determination
enum	Mode { SumPt2 = 0, SumPt = 1, SumPtw = 2, HSGN2 = 3 }

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

Constructor(s)/destructor(s)
	InDetHardScatterSelectionTool (const std::string &name)
	Constructor. More...

	~InDetHardScatterSelectionTool ()
	Destructor. More...

Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize () override
	Function initialising the tool. More...

virtual StatusCode	finalize () override
	Function finalizing the tool. More...

Function(s) implementing the IInDetHardScatterSelectionTool interface
const xAOD::Vertex *	getHardScatter (const xAOD::VertexContainer *vtxCont) const override
	Function for returning the hardscatter vertex. More...

const xAOD::Vertex *	getHardScatter () const override

ElementLink< xAOD::VertexContainer >	getHardScatterLink (const xAOD::VertexContainer *vtxCont) const override
	Function for returning the hardscatter vertex link. More...

ElementLink< xAOD::VertexContainer >	getHardScatterLink () const override

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

Truly private internal data members
std::unique_ptr< Sum >	m_sum
	A helper class which either sums pt2 or pt or ptw. More...

bool	m_doTrkSelection = false
	A flag which will be true if an InDetTrackSelectionTool was provided. More...

SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"}
	xAOD::EventInfo ReadHandleKey More...

SG::ReadHandleKey< xAOD::VertexContainer >	m_vtxContKey {this, "VertexContainer", "PrimaryVertices", "Name of the primary vertex container"}

SG::ReadHandleKey< xAOD::JetContainer >	m_jetContKey { this, "JetContainer", "AntiKt4EMTopoJets", "Name of the jet container" }

BooleanProperty	m_redoHardScatter { this, "RedoHardScatter", false, "If true, redo the hardscatter selection using sumpt2 or sumpt or sumptw"}

IntegerProperty	m_mode { this, "SelectionMode", InDet::InDetHardScatterSelectionTool::Mode::SumPt2, "Mode for selecting the hardscatter: sumpt2[0] or sumpt[1] or sumptw[2]"}

ToolHandle< InDet::IInDetTrackSelectionTool >	m_trkSelectTool {this, "TrackSelectionTool", "InDet::InDetTrackSelectionTool/TrackSelectionTool", "Track selection tool to use"}

BooleanProperty	m_returnDeco { this, "ReturnDeco", false, "If true, return the hardscatter as the vertex decorated with some boolean"}

StringProperty	m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink", "The decoration name of the ElementLink to the hardscatter vertex (applied to xAOD::EventInfo)"}

FloatProperty	m_jetMinPt {this, "jetMinPt", 15000.0, "minimum jet pt"}

FloatProperty	m_jetTrkMaxDr {this, "jetTrkMaxDr", 0.8, "max dR between jet & Trk"}

FloatProperty	m_trkMaxPt {this, "trkMaxPt", 10045000, "max track pt"}

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_hardScatterDecoKey {this, "VertexScatterKey", "" , "Overwrriten in the configuration step by the <HardScatterLinkDeco> property"}
	The decoration name of the ElementLink to the hardscatter vertex (applied to xAOD::EventInfo) More...

SG::ReadDecorHandleKey< xAOD::VertexContainer >	m_gnnScoreKey {this, "GNNKey", "PrimaryVertices.HSGN2_phsvertex", "Name of the hard-scatter GNN decoration"}
	xAOD::EventInfo ReadDecorHandleKey More...

Detailed Description

Implementation of the hardscatter selection tool.

Definition at line 45 of file InDetHardScatterSelectionTool.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

◆ Mode

enum InDet::InDetHardScatterSelectionTool::Mode

Enumerator
SumPt2
SumPt
SumPtw
HSGN2

Definition at line 60 of file InDetHardScatterSelectionTool.h.

               {
       SumPt2 = 0,
       SumPt  = 1,
       SumPtw = 2,
       HSGN2 = 3,
     };

Constructor & Destructor Documentation

◆ InDetHardScatterSelectionTool()

InDet::InDetHardScatterSelectionTool::InDetHardScatterSelectionTool ( const std::string & name )

Constructor.

Definition at line 45 of file InDetHardScatterSelectionTool.cxx.

                                                                                        :
   asg::AsgTool(name)
 {}

◆ ~InDetHardScatterSelectionTool()

InDet::InDetHardScatterSelectionTool::~InDetHardScatterSelectionTool ( )

default

Destructor.

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

◆ finalize()

StatusCode InDet::InDetHardScatterSelectionTool::finalize ( )

overridevirtual

Function finalizing the tool.

Definition at line 132 of file InDetHardScatterSelectionTool.cxx.

 {
   ATH_MSG_DEBUG("Finalizing " << name() << "...");
  
   // Release our tool
   if (m_redoHardScatter && !m_trkSelectTool.empty()) ATH_CHECK(m_trkSelectTool.release());
  
   return StatusCode::SUCCESS;
 }

◆ getHardScatter() [1/2]

const xAOD::Vertex * InDet::InDetHardScatterSelectionTool::getHardScatter ( ) const

overridevirtual

Implements InDet::IInDetHardScatterSelectionTool.

Definition at line 240 of file InDetHardScatterSelectionTool.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_vtxContKey, ctx);
   if (!vtxCont.isValid()) {
     ATH_MSG_ERROR("Could not open primary vertex container, returning nullptr!");
     return nullptr;
   }
   return getHardScatter(vtxCont.get());
 }

◆ getHardScatter() [2/2]

const xAOD::Vertex * InDet::InDetHardScatterSelectionTool::getHardScatter ( const xAOD::VertexContainer * vtxCont ) const

overridevirtual

Function for returning the hardscatter vertex.

Implements InDet::IInDetHardScatterSelectionTool.

Definition at line 142 of file InDetHardScatterSelectionTool.cxx.

 {
   ATH_MSG_DEBUG("In getHardScatter(...) for " << name() <<  "...");
  
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   // If we are simply returning a decoration on the EventInfo:
   if (m_returnDeco) {
     SG::ReadHandle<xAOD::EventInfo> evtInfo(m_evtInfoKey, ctx);
     if (!evtInfo.isValid()) {
       ATH_MSG_ERROR("Could not open event info, returning nullptr!");
       return nullptr;
     }
     SG::ReadDecorHandle<xAOD::EventInfo, ElementLink<xAOD::VertexContainer>> hardScatterDeco(m_hardScatterDecoKey, ctx);
     const ElementLink<xAOD::VertexContainer>& vtxLink = hardScatterDeco(*evtInfo);
     if (!vtxLink.isValid()) {
       ATH_MSG_ERROR("Hardscatter vertex link is not valid, returning nullptr!");
       return nullptr;
     }
     return *vtxLink;
   }
   //::get the jet container if the mode of HS selection is sumptw
   const xAOD::JetContainer* jetCont{nullptr};
   if ( m_mode == InDet::InDetHardScatterSelectionTool::Mode::SumPtw ){
     //::First get the jet containers
     SG::ReadHandle<xAOD::JetContainer> jetContHandle(m_jetContKey, ctx);
     if (!jetContHandle.isValid()){  
       ATH_MSG_ERROR ("HardScatterSelectionTool configured to use jet collection "<<m_jetContKey.key()<<", but collection is not found!"); 
     }
     jetCont = jetContHandle.cptr(); 
   }
  
   float maxsum = -999.0;
   float max_gnn_score = -999.0;
   const xAOD::Vertex* hardscatter = nullptr;
   for (const auto *const vtx : *vtxCont) {
     float sum = 0.;
     // If we are redoing the hardscatter determination:
     if (m_redoHardScatter) {
       if ( m_mode == InDet::InDetHardScatterSelectionTool::Mode::SumPtw ){
         for (const auto& trkLink : vtx->trackParticleLinks()) {
           if (!trkLink.isValid()) continue;
           if (m_doTrkSelection && !static_cast<bool>(m_trkSelectTool->accept(**trkLink, vtx))) continue;
           if ( (*trkLink)->pt() >m_trkMaxPt) continue;
           float jetPt=0.0;
           float minDr=10.0;
  
           for (const xAOD::Jet* jet : *jetCont) {
             if (jet->pt() < m_jetMinPt) {continue;} //skip jets below pT threshold
             float DR = xAOD::P4Helpers::deltaR(*trkLink, jet);
             if(DR<minDr) { 
               minDr = DR;
               jetPt = jet->pt();
             }
           }
           if(minDr <= m_jetTrkMaxDr){//check if jet is within dR 1.
             sum = m_sum->add(sum, (*trkLink)->pt(),jetPt,minDr );
           }
         }
         if (sum > maxsum) {
           maxsum = sum;
           hardscatter = vtx;
         }
       }  
       else if ( m_mode == InDet::InDetHardScatterSelectionTool::Mode::HSGN2 ) {
         SG::ReadDecorHandle<xAOD::VertexContainer, float> acc_gnn(m_gnnScoreKey, ctx);
         float gnn_score = acc_gnn(*vtx);
         if (gnn_score > max_gnn_score) {
           max_gnn_score = gnn_score;
           hardscatter = vtx;
         }
       }
       //::keeping Matt's (old) method for sumpt & sumpt2
       else {
         for (const auto& trkLink : vtx->trackParticleLinks()) {
           if (trkLink.isValid()) {
             if (m_doTrkSelection && !static_cast<bool>(m_trkSelectTool->accept(**trkLink, vtx))) continue;
             sum = m_sum->add(sum, (*trkLink)->pt(),0.,0.);
           }
         }
         if (sum > maxsum) {
           maxsum = sum;
           hardscatter = vtx;
         }
       } 
     }
     // Else, return the PV:
     else {
       if (vtx->vertexType() == xAOD::VxType::PriVtx) {
         hardscatter = vtx;
         break;
       }
     }
   }
  
   return hardscatter;
 }

◆ getHardScatterLink() [1/2]

ElementLink< xAOD::VertexContainer > InDet::InDetHardScatterSelectionTool::getHardScatterLink ( ) const

overridevirtual

Implements InDet::IInDetHardScatterSelectionTool.

Definition at line 269 of file InDetHardScatterSelectionTool.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
   SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_vtxContKey, ctx);
   if (!vtxCont.isValid()) {
     ATH_MSG_ERROR("Could not open primary vertex container, returning empty ElementLink!");
     return {};
   }
   return getHardScatterLink(vtxCont.get());
 }

◆ getHardScatterLink() [2/2]

ElementLink< xAOD::VertexContainer > InDet::InDetHardScatterSelectionTool::getHardScatterLink ( const xAOD::VertexContainer * vtxCont ) const

overridevirtual

Function for returning the hardscatter vertex link.

Implements InDet::IInDetHardScatterSelectionTool.

Definition at line 251 of file InDetHardScatterSelectionTool.cxx.

 {
   ATH_MSG_DEBUG("In getHardScatterLink(...) for " << name() <<  "...");
  
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   // Get our hardscatter vertex
   const xAOD::Vertex* hardscatter = getHardScatter(vtxCont);
  
   // Create our element link
   ElementLink<xAOD::VertexContainer> hardscatterLink;
   if (hardscatter) {
     hardscatterLink.toContainedElement(*vtxCont, hardscatter, ctx);
   }
  
   return hardscatterLink;
 }

◆ 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 InDet::InDetHardScatterSelectionTool::initialize ( )

overridevirtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 54 of file InDetHardScatterSelectionTool.cxx.

 {
   // Print configuration
   ATH_MSG_DEBUG("Initializing " << name() << "...");
   ATH_MSG_DEBUG("Using RedoHardScatter: "     << m_redoHardScatter);
   ATH_MSG_DEBUG("Using SelectionMode: "       << m_mode);
   ATH_MSG_DEBUG("Using TrackSelectionTool: "  << m_trkSelectTool);
   ATH_MSG_DEBUG("Using ReturnDeco: "          << m_returnDeco);
   ATH_MSG_DEBUG("Using HardScatterLinkDeco: " << m_hardScatterDeco.toString());
   ATH_MSG_DEBUG("Using VertexContainer: "     << m_vtxContKey);
   ATH_MSG_DEBUG("Using JetContainer: "        << m_jetContKey);
  
   if (m_redoHardScatter && m_returnDeco) {
     ATH_MSG_ERROR("RedoHardScatter and ReturnDeco cannot both be set to true.");
     return StatusCode::FAILURE;
   }
  
   // If we are re-doing the hardscatter
   if (m_redoHardScatter) {
     ATH_MSG_DEBUG("Setting the hard scatter strategy to: " << m_mode);
  
     // Determine how we will sum the track pt
     switch (m_mode) {
       case InDet::InDetHardScatterSelectionTool::Mode::SumPt2: {
         m_sum = std::make_unique<::SumPt2>();
         break;
       }
       case InDet::InDetHardScatterSelectionTool::Mode::SumPt: {
         m_sum = std::make_unique<::SumPt>();
         break;
       }
       case InDet::InDetHardScatterSelectionTool::Mode::SumPtw: {
         m_sum = std::make_unique<::SumPtw>();
         break;
       }
       case InDet::InDetHardScatterSelectionTool::Mode::HSGN2: {
         break;
       }
       default: {
         ATH_MSG_ERROR("Unknown running mode  : "  << m_mode);
         return StatusCode::FAILURE;
       }
     }
  
     // Fetch our InDetTrackSelectionTool
     if (m_redoHardScatter && !m_trkSelectTool.empty()) {
       m_doTrkSelection = true;
       ATH_CHECK(m_trkSelectTool.retrieve());
     }
  
   }
  
   // If we are returning a decoration
   else if (m_returnDeco) {
     if (m_hardScatterDeco.empty()) {
       ATH_MSG_ERROR("Hardscatter vertex decoration cannot be empty!");
       return StatusCode::FAILURE;
     }
   }
  
   // Initialize our EventInfo container and decoration reads
   ATH_CHECK(m_evtInfoKey.initialize());
   m_hardScatterDecoKey = m_evtInfoKey.key() + "." + m_hardScatterDeco;
   ATH_CHECK(m_hardScatterDecoKey.initialize(m_returnDeco));
  
   // Initialize our vertex container read
   ATH_CHECK(m_vtxContKey.initialize());
  
   // Initialize our jet container read if it is non empty
   ATH_CHECK(m_jetContKey.initialize(!m_jetContKey.empty()));
  
   // Initialize the GNN score handle if relevant mode is selected
   ATH_CHECK(m_gnnScoreKey.initialize(m_mode == InDet::InDetHardScatterSelectionTool::Mode::HSGN2));
  
   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()

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

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

bool InDet::InDetHardScatterSelectionTool::m_doTrkSelection = false

private

A flag which will be true if an InDetTrackSelectionTool was provided.

Definition at line 131 of file InDetHardScatterSelectionTool.h.

◆ m_evtInfoKey

SG::ReadHandleKey<xAOD::EventInfo> InDet::InDetHardScatterSelectionTool::m_evtInfoKey {this, "EventInfo", "EventInfo", "EventInfo key"}

private

xAOD::EventInfo ReadHandleKey

Definition at line 134 of file InDetHardScatterSelectionTool.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_gnnScoreKey

SG::ReadDecorHandleKey<xAOD::VertexContainer> InDet::InDetHardScatterSelectionTool::m_gnnScoreKey {this, "GNNKey", "PrimaryVertices.HSGN2_phsvertex", "Name of the hard-scatter GNN decoration"}

private

xAOD::EventInfo ReadDecorHandleKey

Definition at line 151 of file InDetHardScatterSelectionTool.h.

◆ m_hardScatterDeco

StringProperty InDet::InDetHardScatterSelectionTool::m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink", "The decoration name of the ElementLink to the hardscatter vertex (applied to xAOD::EventInfo)"}

private

Definition at line 142 of file InDetHardScatterSelectionTool.h.

◆ m_hardScatterDecoKey

SG::ReadDecorHandleKey<xAOD::EventInfo> InDet::InDetHardScatterSelectionTool::m_hardScatterDecoKey {this, "VertexScatterKey", "" , "Overwrriten in the configuration step by the <HardScatterLinkDeco> property"}

private

The decoration name of the ElementLink to the hardscatter vertex (applied to xAOD::EventInfo)

Definition at line 148 of file InDetHardScatterSelectionTool.h.

◆ m_jetContKey

SG::ReadHandleKey<xAOD::JetContainer> InDet::InDetHardScatterSelectionTool::m_jetContKey { this, "JetContainer", "AntiKt4EMTopoJets", "Name of the jet container" }

private

Definition at line 136 of file InDetHardScatterSelectionTool.h.

◆ m_jetMinPt

FloatProperty InDet::InDetHardScatterSelectionTool::m_jetMinPt {this, "jetMinPt", 15000.0, "minimum jet pt"}

private

Definition at line 143 of file InDetHardScatterSelectionTool.h.

◆ m_jetTrkMaxDr

FloatProperty InDet::InDetHardScatterSelectionTool::m_jetTrkMaxDr {this, "jetTrkMaxDr", 0.8, "max dR between jet & Trk"}

private

Definition at line 144 of file InDetHardScatterSelectionTool.h.

◆ m_mode

IntegerProperty InDet::InDetHardScatterSelectionTool::m_mode { this, "SelectionMode", InDet::InDetHardScatterSelectionTool::Mode::SumPt2, "Mode for selecting the hardscatter: sumpt2[0] or sumpt[1] or sumptw[2]"}

private

Definition at line 139 of file InDetHardScatterSelectionTool.h.

◆ m_redoHardScatter

BooleanProperty InDet::InDetHardScatterSelectionTool::m_redoHardScatter { this, "RedoHardScatter", false, "If true, redo the hardscatter selection using sumpt2 or sumpt or sumptw"}

private

Definition at line 138 of file InDetHardScatterSelectionTool.h.

◆ m_returnDeco

BooleanProperty InDet::InDetHardScatterSelectionTool::m_returnDeco { this, "ReturnDeco", false, "If true, return the hardscatter as the vertex decorated with some boolean"}

private

Definition at line 141 of file InDetHardScatterSelectionTool.h.

◆ m_sum

std::unique_ptr<Sum> InDet::InDetHardScatterSelectionTool::m_sum

private

A helper class which either sums pt2 or pt or ptw.

Definition at line 128 of file InDetHardScatterSelectionTool.h.

◆ m_trkMaxPt

FloatProperty InDet::InDetHardScatterSelectionTool::m_trkMaxPt {this, "trkMaxPt", 10045000, "max track pt"}

private

Definition at line 145 of file InDetHardScatterSelectionTool.h.

◆ m_trkSelectTool

ToolHandle<InDet::IInDetTrackSelectionTool> InDet::InDetHardScatterSelectionTool::m_trkSelectTool {this, "TrackSelectionTool", "InDet::InDetTrackSelectionTool/TrackSelectionTool", "Track selection tool to use"}

private

Definition at line 140 of file InDetHardScatterSelectionTool.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.

◆ m_vtxContKey

SG::ReadHandleKey<xAOD::VertexContainer> InDet::InDetHardScatterSelectionTool::m_vtxContKey {this, "VertexContainer", "PrimaryVertices", "Name of the primary vertex container"}

private

Definition at line 135 of file InDetHardScatterSelectionTool.h.

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

Classes

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

◆ Mode

Constructor & Destructor Documentation

◆ InDetHardScatterSelectionTool()

◆ ~InDetHardScatterSelectionTool()

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

◆ finalize()

◆ getHardScatter() [1/2]

◆ getHardScatter() [2/2]

◆ getHardScatterLink() [1/2]

◆ getHardScatterLink() [2/2]

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_doTrkSelection

◆ m_evtInfoKey

◆ m_evtStore

◆ m_gnnScoreKey

◆ m_hardScatterDeco

◆ m_hardScatterDecoKey

◆ m_jetContKey

◆ m_jetMinPt

◆ m_jetTrkMaxDr

◆ m_mode

◆ m_redoHardScatter

◆ m_returnDeco

◆ m_sum

◆ m_trkMaxPt

◆ m_trkSelectTool

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_vtxContKey