#include <METTruthTool.h>

Inheritance diagram for met::METTruthTool:

Collaboration diagram for met::METTruthTool:

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

	~METTruthTool ()=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_nonint (const xAOD::TruthParticle *truth) const

bool	accept_int (const xAOD::TruthParticle *truth) const

bool	accept_intout (const xAOD::TruthParticle *truth) const

bool	accept_intmuons (const xAOD::TruthParticle *truth) const

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

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

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

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", "NonInt", "truth type"}

MissingETBase::Source::TruthType	m_truth_type {}

Gaudi::Property< double >	m_det_maxEta {this, "MaxEtaDet", 5., "nominal max detector eta"}

Gaudi::Property< double >	m_truthmu_minPt {this, "MinPtMu", 6e3, "nominal min muon pt"}

Gaudi::Property< double >	m_truthmu_maxEta {this, "MaxEtaMu", 2.7, "nominal max MS eta"}

SG::ReadHandleKey< xAOD::TruthEventContainer >	m_truthEventKey {this, "InputCollection", "TruthEvents", "truth events input collection"}

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 33 of file METTruthTool.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

◆ METTruthTool() [1/2]

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

Definition at line 56 of file METTruthTool.cxx.

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

◆ ~METTruthTool()

met::METTruthTool::~METTruthTool ( )

default

◆ METTruthTool() [2/2]

met::METTruthTool::METTruthTool ( )

private

Member Function Documentation

◆ accept()

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

overrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 91 of file METTruthTool.cxx.

   {
     // Apply cuts 
     ATH_MSG_VERBOSE("Check if truth particle is accepted");
     if(!object){return false;}
     if(object->type() != xAOD::Type::TruthParticle) { 
       ATH_MSG_WARNING("METTruthTool::accept given an object of type" << object->type());
       return false;
     }
     const xAOD::TruthParticle* truth = static_cast<const xAOD::TruthParticle*>(object);
  
     if(truth->pt()<1e-9) return false; // reject particles with no pt
     ATH_MSG_VERBOSE("My truth type: " << static_cast<MissingETBase::Types::bitmask_t>(m_truth_type));
     switch(m_truth_type) {
     case MissingETBase::Source::TruthType::NonInt:
       return accept_nonint(truth);
     case MissingETBase::Source::TruthType::Int:
       return accept_int(truth);
     case MissingETBase::Source::TruthType::IntOut:
       return accept_intout(truth);
     case MissingETBase::Source::TruthType::TruthMuons:
       return accept_intmuons(truth);
     default:
       return false;
     }
     // should not get here
     return false;
   }

◆ accept_int()

bool met::METTruthTool::accept_int ( const xAOD::TruthParticle * truth ) const

protected

Definition at line 127 of file METTruthTool.cxx.

   {
     ATH_MSG_VERBOSE("Check int");
     // not muon
     if(truth->isMuon()) return false;
     // stable
     if(!truth->isGenStable()) return false;
     // interacting
     if(!MC::isInteracting(truth->pdgId())) return false;
     // in acceptance
     if(fabs(truth->eta())>m_det_maxEta) return false;
  
     return true;
   }

◆ accept_intmuons()

bool met::METTruthTool::accept_intmuons ( const xAOD::TruthParticle * truth ) const

protected

Definition at line 160 of file METTruthTool.cxx.

   {
     ATH_MSG_VERBOSE("Check intmuon");
     // muon
     if(!truth->isMuon()) return false;
     // stable
     if(!truth->isGenStable()) return false;
     // in acceptance
     if(truth->pt()<m_truthmu_minPt || fabs(truth->eta())>m_truthmu_maxEta) return false;
  
     return true;
   }

◆ accept_intout()

bool met::METTruthTool::accept_intout ( const xAOD::TruthParticle * truth ) const

protected

Definition at line 142 of file METTruthTool.cxx.

   {
     ATH_MSG_VERBOSE("Check intout");
     // muon outside MS acceptance
     if( truth->isMuon() ) {
       if( fabs(truth->eta())<m_truthmu_maxEta) return false;
     } else {
       // other particle outside calo acceptance
       if( (fabs(truth->eta())<m_det_maxEta) ) return false;
     }
     // stable
     if(!truth->isGenStable()) return false;
     // interacting
     if(!MC::isInteracting(truth->pdgId())) return false;
  
     return true;
   }

◆ accept_nonint()

bool met::METTruthTool::accept_nonint ( const xAOD::TruthParticle * truth ) const

protected

Definition at line 120 of file METTruthTool.cxx.

   {
     ATH_MSG_VERBOSE("Check nonint");
     // stable and non-interacting
     return truth->isGenStable() && !MC::isInteracting(truth->pdgId());
   }

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

overrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 173 of file METTruthTool.cxx.

                                                                                                       {
  
     ATH_MSG_DEBUG ("In execute: " << name() << "...");
  
     metTerm->setSource(static_cast<MissingETBase::Types::bitmask_t>(m_truth_type));
  
     // Retrieve the truth container
     SG::ReadHandle<xAOD::TruthEventContainer> truthEvents(m_truthEventKey);
  
     if (!truthEvents.isValid()) {
       ATH_MSG_WARNING("Unable to retrieve input truth event container ");
       return StatusCode::SUCCESS;
     }
  
     // First truth event is the hard scatter
     const TruthEvent* hsevent = truthEvents->front();
     ConstDataVector<TruthParticleContainer> truthCont(SG::VIEW_ELEMENTS);
     for(size_t itp=0; itp<hsevent->nTruthParticles(); ++itp) {
       truthCont.push_back(hsevent->truthParticle(itp));
       ATH_MSG_VERBOSE("Extracted truth particle with index " << hsevent->truthParticle(itp)->index());
     }
  
     vector<const IParticle*> signalList;
     signalList.reserve(truthCont.size());
     // Loop over all truth particles
     for( const auto truthp : truthCont ) {
       // Check if truth particles satisfies the requirements
       if( this->accept(truthp) ) {
     // Add the selected truth particles to the list
     signalList.push_back(truthp);
       }
     } // end loop over truth particles
  
     // Loop over the content and add to MET 
     MissingETBase::Types::weight_t unitWeight(1.,1.,1.);
     MissingETBase::Types::weight_t minusWeight(-1.,-1.,1.);
     vector<const IParticle*> dummyList;
     for(const auto *iPart : signalList) {
       if(m_truth_type==MissingETBase::Source::TruthType::NonInt) {
     // flip direction for nonint
     this->addToMET(iPart,dummyList,metTerm,metMap,minusWeight);
       } else {
     this->addToMET(iPart,dummyList,metTerm,metMap,unitWeight);
       }
     }
  
     ATH_MSG_DEBUG( "Map contains " << (*MissingETComposition::find(metMap,metTerm))->objects().size() << " truth particles" );
  
     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::METTruthTool::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 64 of file METTruthTool.cxx.

   {
     ATH_CHECK( METBuilderTool::initialize() );
     ATH_MSG_VERBOSE ("Initializing " << name() << "...");
  
     if(m_inputType=="NonInt") {
       m_truth_type = MissingETBase::Source::TruthType::NonInt;
     } else if(m_inputType=="Int") {
       m_truth_type = MissingETBase::Source::TruthType::Int;
     } else if(m_inputType=="IntOut") {
       m_truth_type = MissingETBase::Source::TruthType::IntOut;
     } else if(m_inputType=="IntMuons") {
       m_truth_type = MissingETBase::Source::TruthType::TruthMuons;
     } else {
       ATH_MSG_FATAL("Invalid input type provided");
       return StatusCode::FAILURE;
     }
  
     ATH_CHECK( m_truthEventKey.initialize());
  
     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()

virtual bool met::METTruthTool::resolveOverlap	(	const xAOD::IParticle *	,
		xAOD::MissingETComponentMap *	,
		std::vector< const xAOD::IParticle * > &	,
		MissingETBase::Types::weight_t &
	)		const

inlineoverrideprotectedvirtual

Implements met::METBuilderTool.

Definition at line 69 of file METTruthTool.h.

72 { return true;};

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

Gaudi::Property<double> met::METTruthTool::m_det_maxEta {this, "MaxEtaDet", 5., "nominal max detector eta"}

private

Definition at line 81 of file METTruthTool.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::METTruthTool::m_inputType {this, "InputComposition", "NonInt", "truth type"}

private

Definition at line 78 of file METTruthTool.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_truth_type

MissingETBase::Source::TruthType met::METTruthTool::m_truth_type {}

private

Definition at line 79 of file METTruthTool.h.

◆ m_truthEventKey

SG::ReadHandleKey<xAOD::TruthEventContainer> met::METTruthTool::m_truthEventKey {this, "InputCollection", "TruthEvents", "truth events input collection"}

private

Definition at line 84 of file METTruthTool.h.

◆ m_truthmu_maxEta

Gaudi::Property<double> met::METTruthTool::m_truthmu_maxEta {this, "MaxEtaMu", 2.7, "nominal max MS eta"}

private

Definition at line 83 of file METTruthTool.h.

◆ m_truthmu_minPt

Gaudi::Property<double> met::METTruthTool::m_truthmu_minPt {this, "MinPtMu", 6e3, "nominal min muon pt"}

private

Definition at line 82 of file METTruthTool.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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ METTruthTool() [1/2]

◆ ~METTruthTool()

◆ METTruthTool() [2/2]

Member Function Documentation

◆ accept()

◆ accept_int()

◆ accept_intmuons()

◆ accept_intout()

◆ accept_nonint()

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

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_det_maxEta

◆ m_detStore

◆ m_evtStore

◆ m_inputType

◆ m_mod_clus_key

◆ m_output_met_key

◆ m_truth_type

◆ m_truthEventKey

◆ m_truthmu_maxEta

◆ m_truthmu_minPt

◆ m_useModClus

◆ m_useRapidity

◆ m_varHandleArraysDeclared

◆ m_vhka