#include <METSoftTermsTool.h>

Inheritance diagram for met::METSoftTermsTool:

Collaboration diagram for met::METSoftTermsTool:

Public Member Functions
	METSoftTermsTool (const std::string &name)

	~METSoftTermsTool ()=default

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

virtual StatusCode	execute (xAOD::MissingET metTerm, xAOD::MissingETComponentMap metMap) const override

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	executeTool (xAOD::MissingET metTerm, xAOD::MissingETComponentMap metMap) const override

virtual bool	accept (const xAOD::IParticle *object) const override

bool	accept (const xAOD::CaloCluster *clus) const

virtual bool	resolveOverlap (const xAOD::IParticle object, xAOD::MissingETComponentMap metMap, std::vector< const xAOD::IParticle * > &acceptedSignals, MissingETBase::Types::weight_t &objWeight) const override

bool	resolveOverlap (xAOD::MissingETComponentMap metMap, std::vector< const xAOD::IParticle > &acceptedSignals) const

virtual bool	addToMET (const xAOD::IParticle object, const std::vector< const xAOD::IParticle > &acceptedSignals, xAOD::MissingET metTerm, xAOD::MissingETComponentMap metMap, MissingETBase::Types::weight_t &objWeight, MissingETBase::UsageHandler::Policy p=MissingETBase::UsageHandler::TrackCluster) const

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

Static Protected Member Functions
static bool	accept (const xAOD::TrackParticle *trk)

Protected Attributes
Gaudi::Property< std::string >	m_output_met_key {this, "MissingETKey", "", "output MET key"}

Gaudi::Property< std::string >	m_mod_clus_key {this, "ModifiedClusKey", "", "modified clusters key"}

Gaudi::Property< bool >	m_useRapidity {this, "UseRapidity", false, }

bool	m_useModClus {}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	METSoftTermsTool ()

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

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

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

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

Private Attributes
Gaudi::Property< std::string >	m_inputType {this, "InputComposition", "Clusters", ""}

xAOD::Type::ObjectType	m_st_objtype

Gaudi::Property< bool >	m_cl_vetoNegE {this, "VetoNegEClus", true, ""}

Gaudi::Property< bool >	m_cl_onlyNegE {this, "OnlyNegEClus", false, ""}

SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_caloClusterKey {this, "CaloClusterKey", "", "Input calo cluster container name (not to be configured manually)"}

SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trackParticleKey {this, "TrackKey", "", "Input track container name (not to be configured manually)"}

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

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

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

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 39 of file METSoftTermsTool.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

◆ METSoftTermsTool() [1/2]

met::METSoftTermsTool::METSoftTermsTool ( const std::string & name )

Definition at line 53 of file METSoftTermsTool.cxx.

                                                           : 
     AsgTool(name),
     METBuilderTool(name)
   {
   }

◆ ~METSoftTermsTool()

met::METSoftTermsTool::~METSoftTermsTool ( )

default

◆ METSoftTermsTool() [2/2]

met::METSoftTermsTool::METSoftTermsTool ( )

private

Member Function Documentation

◆ accept() [1/3]

bool met::METSoftTermsTool::accept ( const xAOD::CaloCluster * clus ) const

protected

Definition at line 108 of file METSoftTermsTool.cxx.

   {
     if(!clus) return false;
     if(m_cl_vetoNegE && clus->e()<0) return false;
     if(m_cl_onlyNegE && clus->e()>0) return false;
  
     return true;
   }

◆ accept() [2/3]

bool met::METSoftTermsTool::accept ( const xAOD::IParticle * object ) const

overrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 81 of file METSoftTermsTool.cxx.

   {
  
     if(object->type() != m_st_objtype){
       ATH_MSG_WARNING("Type mismatch: Expected " << m_st_objtype << ", given " << object->type());
       return false;
     }
  
     // Apply cuts 
     if ( m_st_objtype == xAOD::Type::CaloCluster ) {
       ATH_MSG_VERBOSE("Check if cluster is accepted");
  
       const xAOD::CaloCluster* clus = static_cast<const xAOD::CaloCluster*>(object);
       return (clus) ? accept(clus) : false;
  
     } // end of if using clusters 
     else if (  m_st_objtype == xAOD::Type::TrackParticle ) {
       ATH_MSG_VERBOSE("Check if track is accepted");
  
       const xAOD::TrackParticle* track = static_cast<const xAOD::TrackParticle*>(object);
       return (track) ? accept(track) : false;
  
     } // end of if using tracks
     
     return false; // Default 
   }

◆ accept() [3/3]

bool met::METSoftTermsTool::accept ( const xAOD::TrackParticle * trk )

staticprotected

Definition at line 117 of file METSoftTermsTool.cxx.

   {
     // if(!trk) return false;
  
 //    if(fabs(trk->pt())<500/*MeV*/ || fabs(trk->eta())>2.5) return false;
 //
 //    // could add some error checking to make sure we successfully read the details
 //    uint8_t nPixHits(0), nSctHits(0);
 //    trk->summaryValue(nPixHits,xAOD::numberOfPixelHits);
 //    if(nPixHits<1) return false;
 //    trk->summaryValue(nSctHits,xAOD::numberOfSCTHits);
 //    if(nSctHits<6) return false;
  
     return true;
   }

◆ addToMET()

bool met::METBuilderTool::addToMET	(	const xAOD::IParticle *	object,
		const std::vector< const xAOD::IParticle * > &	acceptedSignals,
		xAOD::MissingET *	metTerm,
		xAOD::MissingETComponentMap *	metMap,
		MissingETBase::Types::weight_t &	objWeight,
		MissingETBase::UsageHandler::Policy	p = `MissingETBase::UsageHandler::TrackCluster`
	)		const

protectedvirtualinherited

Definition at line 77 of file METBuilderTool.cxx.

   {
  
     metTerm->add(object->pt()*cos(object->phi())*objWeight.wpx(),
          object->pt()*sin(object->phi())*objWeight.wpy(),
          object->pt()*objWeight.wet()); // or actually ET?)
  
     return MissingETComposition::insert(metMap,metTerm,object,acceptedSignals,objWeight,p);
   }

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

◆ execute()

StatusCode met::METBuilderTool::execute	(	xAOD::MissingET *	metTerm,
		xAOD::MissingETComponentMap *	metMap
	)		const

overridevirtualinherited

Implements IMETToolBase.

Definition at line 55 of file METBuilderTool.cxx.

   {
     ATH_MSG_DEBUG ("In execute: " << name() << "...");
  
     if( metTerm==nullptr ) {
       ATH_MSG_ERROR("Invalid input MissingET pointer provided!");
       return StatusCode::FAILURE;
     }
     if( metMap==nullptr ) {
       ATH_MSG_ERROR("Invalid input MissingETComponentMap pointer provided!");
       return StatusCode::FAILURE;
     }
  
     metTerm->setName(m_output_met_key);
     return this->executeTool(metTerm,metMap);
   }

◆ executeTool()

StatusCode met::METSoftTermsTool::executeTool	(	xAOD::MissingET *	metTerm,
		xAOD::MissingETComponentMap *	metMap
	)		const

overrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 167 of file METSoftTermsTool.cxx.

   {
  
     ATH_MSG_DEBUG ("In execute: " << name() << "...");
  
     vector<const IParticle*> signalList;
     if( m_st_objtype == xAOD::Type::CaloCluster ) {
       // Retrieve the calo container
       SG::ReadHandle<xAOD::CaloClusterContainer> caloClusCont(m_caloClusterKey);
       if (!caloClusCont.isValid()) {
         ATH_MSG_WARNING("Unable to retrieve input calo cluster container");
       }
  
       signalList.reserve(caloClusCont->size());
       //stateHelperList.reserve(caloClusCont->size());
  
       MissingETBase::Types::bitmask_t source = MissingETBase::Source::softEvent() | MissingETBase::Source::cluster();
       metTerm->setSource(source);
  
       MissingETComponentMap::iterator iter = MissingETComposition::find(metMap,metTerm);
       if(iter==metMap->end()) {
         ATH_MSG_WARNING("Could not find current METComponent in MET Map!");
         return StatusCode::SUCCESS;
       }
       MissingETComponent* newComp = *iter;
       newComp->setStatusWord(MissingETBase::Status::contributedSoftTerm());
  
       // Loop over all clusters
       for(const auto *iClus : *caloClusCont) {
         // Check if cluster satisfies the requirements
         if( this->accept(iClus)) {
           // Add the selected clusters to the list
           signalList.push_back(iClus);
         }
       } // end loop over clusters
  
       ATH_MSG_DEBUG("Selected " << signalList.size() << " topoclusters for soft MET");
  
     } // end if Clusters
     else if( m_st_objtype == xAOD::Type::TrackParticle ) {
  
       // Retrieve the track container
       SG::ReadHandle<xAOD::TrackParticleContainer> trackParCont(m_trackParticleKey);
       if (!trackParCont.isValid()) {
         ATH_MSG_WARNING("Unable to retrieve input track particle container");
       }
       signalList.reserve(trackParCont->size());
  
       MissingETBase::Types::bitmask_t source = MissingETBase::Source::Type::SoftEvent | MissingETBase::Source::idTrack();
       metTerm->setSource(source);
  
       MissingETComponentMap::iterator iter = MissingETComposition::find(metMap,metTerm);
       if(iter==metMap->end()) {
         ATH_MSG_WARNING("Could not find current METComponent in MET Map!");
         return StatusCode::SUCCESS;
       }
       MissingETComponent* newComp = *iter;
       newComp->setStatusWord(MissingETBase::Status::contributedSoftTerm());
  
       // Loop over all tracks
       for(const auto *iTrk : *trackParCont) {
         // Check if track satisfies the requirements
         if( this->accept(iTrk) ) {
           // Add the selected track particles to the list
           signalList.push_back(iTrk);
         }
       } // end loop over tracks
  
       ATH_MSG_DEBUG("Selected " << signalList.size() << " tracks for soft MET");
  
     }  // end if Tracks
  
     // Resolve overlap: signalList is accessed by reference and updated w/ content that is not
     // associated to any object. True if signalList size 0, i.e. nothing to add to MET
     if( this->resolveOverlap(metMap,signalList) ) return StatusCode::SUCCESS;
  
     // Loop over the content and add to MET 
     vector<const IParticle*> dummyList;
     MissingETBase::Types::weight_t unitWeight(1.,1.,1.);
  
     for(const IParticle* part : signalList) this->addToMET(part,dummyList,metTerm,metMap,unitWeight);
  
     ATH_MSG_DEBUG( "Map contains " << (*MissingETComposition::find(metMap,metTerm))->objects().size() << " soft signals" );
  
     return StatusCode::SUCCESS;
   }

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ getKey()

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

inherited

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

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

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

See also: asg::AsgTool::getName

Parameters

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

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

Definition at line 119 of file AsgTool.cxx.

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

◆ getName()

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

inherited

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

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

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

See also: asg::AsgTool::getKey

Parameters

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

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

Definition at line 106 of file AsgTool.cxx.

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

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode met::METSoftTermsTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

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

Reimplemented from met::METBuilderTool.

Definition at line 61 of file METSoftTermsTool.cxx.

   {
     ATH_CHECK(  METBuilderTool::initialize() );
     ATH_MSG_VERBOSE ("Initializing " << name() << "...");
  
     // use string property and convert to int?
     if(m_inputType.value() == "Clusters")    m_st_objtype = xAOD::Type::CaloCluster;
     else if(m_inputType.value() == "Tracks") m_st_objtype = xAOD::Type::TrackParticle;
     else {
       ATH_MSG_FATAL("Invalid input collection type " << m_inputType.value() << " supplied!");
     }
  
     // ReadHandleKey(s)
     ATH_CHECK( m_caloClusterKey.initialize(m_st_objtype==xAOD::Type::CaloCluster));
     ATH_CHECK( m_trackParticleKey.initialize(m_st_objtype==xAOD::Type::TrackParticle));
  
     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, 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;
    }

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

◆ resolveOverlap() [1/2]

bool met::METSoftTermsTool::resolveOverlap	(	const xAOD::IParticle *	object,
		xAOD::MissingETComponentMap *	metMap,
		std::vector< const xAOD::IParticle * > &	acceptedSignals,
		MissingETBase::Types::weight_t &	objWeight
	)		const

overrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 133 of file METSoftTermsTool.cxx.

   {
  
     // Check/Resolve overlap
     bool objsused = false;
     if( m_st_objtype == xAOD::Type::CaloCluster ) {
       ATH_MSG_DEBUG("Check for used clusters");
       objsused = metMap->checkUsage(acceptedSignals,MissingETBase::UsageHandler::OnlyCluster);
     }
     else if( m_st_objtype == xAOD::Type::TrackParticle ) { 
       ATH_MSG_DEBUG("Check for used tracks");
       objsused = metMap->checkUsage(acceptedSignals,MissingETBase::UsageHandler::OnlyTrack);
     }
     if(!objsused) {
       ATH_MSG_DEBUG("No objects used.");
     }
  
     ATH_MSG_DEBUG( acceptedSignals.size() << " retained after overlap removal");
  
     return acceptedSignals.empty(); 
   }

◆ resolveOverlap() [2/2]

bool met::METSoftTermsTool::resolveOverlap	(	xAOD::MissingETComponentMap *	metMap,
		std::vector< const xAOD::IParticle * > &	acceptedSignals
	)		const

protected

Definition at line 159 of file METSoftTermsTool.cxx.

   {
     const xAOD::IParticle* dummyObject = nullptr;                  // Just a dummy object
     MissingETBase::Types::weight_t dummyObjWeight(1.,1.,1.); // Currently use a default value
     return resolveOverlap(dummyObject, metMap, acceptedSignals, dummyObjWeight);
   }

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

SG::ReadHandleKey<xAOD::CaloClusterContainer> met::METSoftTermsTool::m_caloClusterKey {this, "CaloClusterKey", "", "Input calo cluster container name (not to be configured manually)"}

private

Definition at line 82 of file METSoftTermsTool.h.

◆ m_cl_onlyNegE

Gaudi::Property<bool> met::METSoftTermsTool::m_cl_onlyNegE {this, "OnlyNegEClus", false, ""}

private

Definition at line 81 of file METSoftTermsTool.h.

◆ m_cl_vetoNegE

Gaudi::Property<bool> met::METSoftTermsTool::m_cl_vetoNegE {this, "VetoNegEClus", true, ""}

private

Definition at line 80 of file METSoftTermsTool.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_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_inputType

Gaudi::Property<std::string> met::METSoftTermsTool::m_inputType {this, "InputComposition", "Clusters", ""}

private

Definition at line 77 of file METSoftTermsTool.h.

◆ m_mod_clus_key

Gaudi::Property<std::string> met::METBuilderTool::m_mod_clus_key {this, "ModifiedClusKey", "", "modified clusters key"}

protectedinherited

Definition at line 63 of file METBuilderTool.h.

◆ m_output_met_key

Gaudi::Property<std::string> met::METBuilderTool::m_output_met_key {this, "MissingETKey", "", "output MET key"}

protectedinherited

Definition at line 62 of file METBuilderTool.h.

◆ m_st_objtype

xAOD::Type::ObjectType met::METSoftTermsTool::m_st_objtype

private

Definition at line 78 of file METSoftTermsTool.h.

◆ m_trackParticleKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> met::METSoftTermsTool::m_trackParticleKey {this, "TrackKey", "", "Input track container name (not to be configured manually)"}

private

Definition at line 83 of file METSoftTermsTool.h.

◆ m_useModClus

bool met::METBuilderTool::m_useModClus {}

protectedinherited

Definition at line 65 of file METBuilderTool.h.

◆ m_useRapidity

Gaudi::Property<bool> met::METBuilderTool::m_useRapidity {this, "UseRapidity", false, }

protectedinherited

Definition at line 64 of file METBuilderTool.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

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ METSoftTermsTool() [1/2]

◆ ~METSoftTermsTool()

◆ METSoftTermsTool() [2/2]

Member Function Documentation

◆ accept() [1/3]

◆ accept() [2/3]

◆ accept() [3/3]

◆ addToMET()

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

◆ execute()

◆ executeTool()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ resolveOverlap() [1/2]

◆ resolveOverlap() [2/2]

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloClusterKey

◆ m_cl_onlyNegE

◆ m_cl_vetoNegE

◆ m_detStore

◆ m_evtStore

◆ m_inputType

◆ m_mod_clus_key

◆ m_output_met_key

◆ m_st_objtype

◆ m_trackParticleKey

◆ m_useModClus

◆ m_useRapidity

◆ m_varHandleArraysDeclared

◆ m_vhka