egammaTruthAssociationAlg Class Reference

#include <egammaTruthAssociationAlg.h>

Inheritance diagram for egammaTruthAssociationAlg:

Collaboration diagram for egammaTruthAssociationAlg:

Classes
struct	MCTruthInfo_t
struct	writeDecorHandles
	helper class to contain write decoration handles More...

Public Member Functions
	egammaTruthAssociationAlg (const std::string &name, ISvcLocator *pSvcLocator)
	constructor More...
virtual	~egammaTruthAssociationAlg ()=default
	destructor More...
virtual StatusCode	initialize () override final
	initialize method More...
virtual StatusCode	finalize () override final
	finalize method More...
virtual StatusCode	execute (const EventContext &ctx) const override final
	execute on container More...
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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
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
template<class T >
StatusCode	initializeDecorKeys (SG::WriteDecorHandleKeyArray< T > &keys, const std::string &name)
	A function that initializes the decor handles, but also checks the naming convention. More...
template<class T , class L >
StatusCode	match (const EventContext &ctx, const xAOD::TruthParticleContainer &truthParticles, const SG::WriteDecorHandleKeyArray< T > &hkeys, const SG::AuxElement::Accessor< L > &linkAccess, xAOD::TruthParticleContainer *egammaTruthContainer) const
	Loop over elements in the reco container, decorate them with truth info and decorate the truth particles with links to the reco ones (reco<typeName>Link) More...
template<class T >
MCTruthInfo_t	particleTruthClassifier (const EventContext &ctx, const T *) const
	return the result of MCTruthClassifier::particleTruthClassifier or do a second pass for electrons based on the cluster to find true photons More...
void	getNewTruthParticle (const EventContext &ctx, xAOD::TruthParticleContainer &egammaTruthContainer, const xAOD::TruthParticle *truth, const xAOD::TruthParticleContainer *oldContainer) const
	Create a copy a truth particle, add it to the new getNewTruthParticle container and decorate it with a link to the original particle. More...
bool	isPromptEgammaParticle (const EventContext &ctx, const xAOD::TruthParticle *truth) const
	Return true if the truth particle is a prompt electron or photon. More...
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< bool >	m_doEgammaTruthContainer
	Create egamma truth container? More...
Gaudi::Property< bool >	m_matchElectrons
	Match electrons? More...
Gaudi::Property< bool >	m_matchPhotons
	Match photons? More...
Gaudi::Property< bool >	m_matchForwardElectrons
	Match fwd electrons? More...
Gaudi::Property< bool >	m_matchClusters
	Match clusters? More...
SG::WriteDecorHandleKeyArray< xAOD::CaloClusterContainer >	m_clusterDecKeys
	The egamma cluster decor handle key array. More...
Gaudi::Property< std::string >	m_clusterDecName
	The egamma cluster name property used to initialize the WriteDecorHandleKeyArray. More...
SG::WriteDecorHandleKeyArray< xAOD::ElectronContainer >	m_electronDecKeys
	The electron container decor handle key array. More...
Gaudi::Property< std::string >	m_electronDecName
	The electron container name property used to initialize the WriteDecorHandleKeyArray. More...
SG::WriteDecorHandleKeyArray< xAOD::ElectronContainer >	m_fwdElectronDecKeys
	The fwd electron container decor handle key array. More...
Gaudi::Property< std::string >	m_fwdElectronDecName
	The fwd electron name property used to initialize the WriteDecorHandleKeyArray. More...
SG::WriteDecorHandleKeyArray< xAOD::PhotonContainer >	m_photonDecKeys
	The photon container decor handle key array. More...
Gaudi::Property< std::string >	m_photonDecName
	The photon container name property used to initialize the WriteDecorHandleKeyArray. More...
SG::ReadHandleKey< xAOD::TruthEventContainer >	m_truthEventContainerKey
	Name of the truth event container. More...
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthParticleContainerKey
	Name of the truth particle container. More...
SG::WriteHandleKey< xAOD::TruthParticleContainer >	m_egammaTruthParticleContainerKey
	Name of the output egamma truth container. More...
Gaudi::Property< float >	m_minPt
	Minimum Pt to enter egamma truth particle container. More...
Gaudi::Property< float >	m_minPtFSR
	Minimum Pt for FSR to enter egamma truth particle container. More...
ToolHandle< IMCTruthClassifier >	m_mcTruthClassifier
	MCTruthClassifier. More...
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
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

Decorate egamma objects with truth information Creates egammaTruthParticles collection with links to reco objects

Author

B. Lenzi J. Mitrevski C. Anastopoulos

Definition at line 40 of file egammaTruthAssociationAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

egammaTruthAssociationAlg()

egammaTruthAssociationAlg::egammaTruthAssociationAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

constructor

Definition at line 57 of file egammaTruthAssociationAlg.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator)
{}

~egammaTruthAssociationAlg()

virtual egammaTruthAssociationAlg::~egammaTruthAssociationAlg ( )

virtualdefault

destructor

Member Function Documentation

cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode egammaTruthAssociationAlg::execute ( const EventContext &  ctx ) const

finaloverridevirtual

execute on container

Definition at line 112 of file egammaTruthAssociationAlg.cxx.

{
 
  SG::WriteHandle<xAOD::TruthParticleContainer> egammaTruthContainer;
 
  if (m_doEgammaTruthContainer) {
 
    egammaTruthContainer = SG::WriteHandle<xAOD::TruthParticleContainer>(
      m_egammaTruthParticleContainerKey, ctx);
    ATH_CHECK(egammaTruthContainer.record(
      std::make_unique<xAOD::TruthParticleContainer>(),
      std::make_unique<xAOD::TruthParticleAuxContainer>()));
 
    // Add a copy of electrons and photons to the truth egamma container
    SG::ReadHandle<xAOD::TruthEventContainer> truthEvtContainer(
      m_truthEventContainerKey, ctx);
 
    // only for serial running. Can remove check later
    if (!truthEvtContainer.isValid() || truthEvtContainer->empty()) {
      ATH_MSG_WARNING("Could not retrieve "
                      << m_truthEventContainerKey.key()
                      << " or container empty, returning");
      return StatusCode::SUCCESS;
    }
 
    for (const auto& truthParticleLink :
         truthEvtContainer->front()->truthParticleLinks()) {
      if (!truthParticleLink.isValid())
        continue;
      const xAOD::TruthParticle* truthParticle = *truthParticleLink;
      if (!isPromptEgammaParticle(ctx, truthParticle))
        continue;
      getNewTruthParticle(ctx,
                          *egammaTruthContainer,
                          truthParticle,
                          truthParticleLink.getDataPtr());
    }
  }
  // Decorate containers with truth info, including links to truth particles
  // Decorate the truth particles with links to the reco ones
 
  // note that in multithreading this must be valid; can't just fail with
  // success.
  SG::ReadHandle<xAOD::TruthParticleContainer> truthParticles(
    m_truthParticleContainerKey, ctx);
 
  // accessors
  static const SG::AuxElement::Accessor<ClusterLink_t> accClusLink(
    "recoClusterLink");
  static const SG::AuxElement::Accessor<ElectronLink_t> accElLink(
    "recoElectronLink");
  static const SG::AuxElement::Accessor<PhotonLink_t> accPhLink(
    "recoPhotonLink");
 
  if (m_matchElectrons) {
    ATH_MSG_DEBUG("About to match electrons");
    ATH_CHECK(match(ctx,
                    *truthParticles,
                    m_electronDecKeys,
                    accElLink,
                    egammaTruthContainer.ptr()));
  }
 
  if (m_matchPhotons) {
    ATH_MSG_DEBUG("About to match photons");
    ATH_CHECK(match(ctx,
                    *truthParticles,
                    m_photonDecKeys,
                    accPhLink,
                    egammaTruthContainer.ptr()));
  }
 
  if (m_matchClusters) {
    ATH_MSG_DEBUG("About to match clusters");
    ATH_CHECK(match(ctx,
                    *truthParticles,
                    m_clusterDecKeys,
                    accClusLink,
                    egammaTruthContainer.ptr()));
  }
 
  if (m_matchForwardElectrons) {
    ATH_MSG_DEBUG("About to match fwd electrons");
    ATH_CHECK(match(ctx,
                    *truthParticles,
                    m_fwdElectronDecKeys,
                    accElLink,
                    egammaTruthContainer.ptr()));
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 79 of file AthReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode egammaTruthAssociationAlg::finalize ( )

finaloverridevirtual

finalize method

Definition at line 106 of file egammaTruthAssociationAlg.cxx.

{
  return StatusCode::SUCCESS;
}

getNewTruthParticle()

void egammaTruthAssociationAlg::getNewTruthParticle ( const EventContext &  ctx, xAOD::TruthParticleContainer &  egammaTruthContainer, const xAOD::TruthParticle *  truth, const xAOD::TruthParticleContainer *  oldContainer  ) const

private

Create a copy a truth particle, add it to the new getNewTruthParticle container and decorate it with a link to the original particle.

Definition at line 236 of file egammaTruthAssociationAlg.cxx.

{
  auto *truthParticle = egammaTruthContainer.push_back(std::make_unique<xAOD::TruthParticle>());
  truthParticle->setPdgId(truth->pdgId());
  truthParticle->setBarcode(HepMC::barcode(truth)); // FIXME barcode-based
  truthParticle->setStatus(truth->status());
  truthParticle->setPx(truth->px());
  truthParticle->setPy(truth->py());
  truthParticle->setPz(truth->pz());
  truthParticle->setE(truth->e());
  truthParticle->setM(truth->m());
  truthParticle->setProdVtxLink(truth->prodVtxLink());
  truthParticle->setDecayVtxLink(truth->decayVtxLink());
 
  static const SG::AuxElement::Accessor<ClusterLink_t> accClusLink(
    "recoClusterLink");
  static const SG::AuxElement::Accessor<ElectronLink_t> accElLink(
    "recoElectronLink");
  static const SG::AuxElement::Accessor<PhotonLink_t> accPhLink(
    "recoPhotonLink");
  static const SG::AuxElement::Accessor<TruthLink_t> accTruthLink(
    "truthParticleLink");
  static const SG::AuxElement::Accessor<int> accType("truthType");
  static const SG::AuxElement::Accessor<int> accOrigin("truthOrigin");
 
  if (m_matchClusters) {
    accClusLink(*truthParticle) = ClusterLink_t();
  }
  accElLink(*truthParticle) = ElectronLink_t();
  accPhLink(*truthParticle) = PhotonLink_t();
  accTruthLink(*truthParticle) = TruthLink_t(truth, *oldContainer, ctx);
  accTruthLink(*truthParticle).toPersistent();
  // MCTruthClassifier info
  MCTruthPartClassifier::Info mcinfo(ctx);
  auto info = m_mcTruthClassifier->particleTruthClassifier(truth, &mcinfo);
  accType(*truthParticle) = static_cast<int>(info.first);
  accOrigin(*truthParticle) = static_cast<int>(info.second);
}

initialize()

StatusCode egammaTruthAssociationAlg::initialize ( )

finaloverridevirtual

initialize method

Definition at line 63 of file egammaTruthAssociationAlg.cxx.

{
 
  ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  // initialize the data handles
  ATH_CHECK(m_truthEventContainerKey.initialize(m_doEgammaTruthContainer));
  ATH_CHECK(
    m_egammaTruthParticleContainerKey.initialize(m_doEgammaTruthContainer));
  ATH_CHECK(m_truthParticleContainerKey.initialize());
 
  // Now the standard decoration handles
  if (m_matchElectrons) {
    ATH_CHECK(initializeDecorKeys(m_electronDecKeys, m_electronDecName));
  } else {
    m_electronDecKeys.clear();
  }
 
  if (m_matchPhotons) {
    ATH_CHECK(initializeDecorKeys(m_photonDecKeys, m_photonDecName));
  } else {
    m_photonDecKeys.clear();
  }
 
  if (m_matchClusters) {
    ATH_CHECK(initializeDecorKeys(m_clusterDecKeys, m_clusterDecName));
  } else {
    m_clusterDecKeys.clear();
  }
 
  if (m_matchForwardElectrons) {
    ATH_CHECK(initializeDecorKeys(m_fwdElectronDecKeys, m_fwdElectronDecName));
  } else {
    m_fwdElectronDecKeys.clear();
  }
 
  CHECK(m_mcTruthClassifier.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_mcTruthClassifier);
  ATH_MSG_DEBUG("Initialization successful");
  return StatusCode::SUCCESS;
}

initializeDecorKeys()

template<class T >

StatusCode egammaTruthAssociationAlg::initializeDecorKeys ( SG::WriteDecorHandleKeyArray< T > &  keys, const std::string &  name  )

private

A function that initializes the decor handles, but also checks the naming convention.

Definition at line 282 of file egammaTruthAssociationAlg.cxx.

{
  if (!keys.empty()) {
    ATH_MSG_FATAL("The WriteDecorHandle should not be configured directly.");
    return StatusCode::FAILURE;
  }
 
  keys.emplace_back(name + ".truthParticleLink");
  keys.emplace_back(name + ".truthType");
  keys.emplace_back(name + ".truthOrigin");
  ATH_CHECK(keys.initialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, InDet::SiSPGNNTrackMaker, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

isPromptEgammaParticle()

bool egammaTruthAssociationAlg::isPromptEgammaParticle ( const EventContext &  ctx, const xAOD::TruthParticle *  truth  ) const

private

Return true if the truth particle is a prompt electron or photon.

Definition at line 206 of file egammaTruthAssociationAlg.cxx.

{
 
  if ((truth->pdgId() != 22 && abs(truth->pdgId()) != 11) ||
      MC::isDecayed(truth) || !MC::isPhysical(truth) ||
      HepMC::is_simulation_particle(truth) || truth->pt() < m_minPt) {
    return false;
  }
  MCTruthPartClassifier::Info mcinfo(ctx);
  auto type = m_mcTruthClassifier->particleTruthClassifier(truth, &mcinfo);
 
  // Isolated electron or photon
  if (type.first == MCTruthPartClassifier::IsoElectron ||
      type.first == MCTruthPartClassifier::IsoPhoton) {
    return true;
  }
 
  // FSR photon
  if (type.first == MCTruthPartClassifier::NonIsoPhoton &&
      type.second == MCTruthPartClassifier::FSRPhot &&
      truth->pt() > m_minPtFSR) {
    return true;
  }
 
  return false;
}

match()

template<class T , class L >

StatusCode egammaTruthAssociationAlg::match ( const EventContext &  ctx, const xAOD::TruthParticleContainer &  truthParticles, const SG::WriteDecorHandleKeyArray< T > &  hkeys, const SG::AuxElement::Accessor< L > &  linkAccess, xAOD::TruthParticleContainer *  egammaTruthContainer  ) const

private

Loop over elements in the reco container, decorate them with truth info and decorate the truth particles with links to the reco ones (reco<typeName>Link)

Definition at line 348 of file egammaTruthAssociationAlg.cxx.

{
 
  writeDecorHandles<T> decoHandles(hkeys, ctx);
 
 
  for (auto particle : *decoHandles.readHandle()) {
 
    MCTruthInfo_t info =
      particleTruthClassifier(ctx, particle);
 
    const xAOD::TruthParticle* truthParticle = info.genPart;
    if (truthParticle) {
      ElementLink<xAOD::TruthParticleContainer> link(
        truthParticle, truthParticles, ctx);
      ATH_MSG_DEBUG(
        "Decorating object with link to truth, index = " << link.index());
      decoHandles.el(*particle) = link;
    } else {
      decoHandles.el(*particle) = ElementLink<xAOD::TruthParticleContainer>();
    }
    decoHandles.el(*particle).toPersistent();
    ATH_MSG_DEBUG("truthType = " << info.first
                                 << " truthOrigin = " << info.second);
    decoHandles.type(*particle) = static_cast<int>(info.first);
    decoHandles.origin(*particle) = static_cast<int>(info.second);
 
    // Decorate the corresponding truth particle with the link to the reco
    if (m_doEgammaTruthContainer) {
      if (!egammaTruthContainer) {
        ATH_MSG_ERROR("The egammaTruthContainer needs to be valid");
        return StatusCode::FAILURE;
      }
      const xAOD::TruthParticle* truth =
        xAOD::TruthHelpers::getTruthParticle(*particle);
      if (truth) {
        xAOD::TruthParticle* truthEgamma =
          getEgammaTruthParticle(truth, *egammaTruthContainer);
        if (truthEgamma) {
          // we found a truthEgamma object we should annotate if this is the
          // best link
          bool annotateLink = true;                   // by default we annotate
          const auto link = linkAccess(*truthEgamma); // what already exists
          if (link.isValid()) {
            auto oldPart = *link;
            if (oldPart && truthEgamma->e() > 0 &&
                std::abs(oldPart->e() / truthEgamma->e() - 1) <
                  std::abs(particle->e() / truthEgamma->e() - 1)) {
              ATH_MSG_DEBUG(truthEgamma
                            << ": "
                            << " already set to a better matched particle: "
                            << particle);
              annotateLink = false;
            }
          }
 
          if (annotateLink) {
            L link(particle, *decoHandles.readHandle(), ctx);
            linkAccess(*truthEgamma) = link;
            linkAccess(*truthEgamma).toPersistent();
          }
        }
      }
    }
  }
  return StatusCode::SUCCESS;
}

msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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.

particleTruthClassifier()

template<class T >

egammaTruthAssociationAlg::MCTruthInfo_t egammaTruthAssociationAlg::particleTruthClassifier ( const EventContext &  ctx, const T *  particle  ) const

private

return the result of MCTruthClassifier::particleTruthClassifier or do a second pass for electrons based on the cluster to find true photons

Definition at line 310 of file egammaTruthAssociationAlg.cxx.

{
  MCTruthInfo_t info{};
  MCTruthPartClassifier::Info mcinfo(ctx);
  auto ret = m_mcTruthClassifier->particleTruthClassifier(particle, &mcinfo);
  info.genPart = mcinfo.genPart;
  info.first = ret.first;
  info.second = ret.second;
  return info;
}

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< Gaudi::Algorithm > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext &  ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

{
  return Gaudi::Algorithm::sysExecute (ctx);
}

sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_clusterDecKeys

SG::WriteDecorHandleKeyArray<xAOD::CaloClusterContainer> egammaTruthAssociationAlg::m_clusterDecKeys

private

Initial value:

{
    this,
    "DoNotSet_ClusterContainerName",
    {},
    "Do not set; configuration via the string property"
  }

The egamma cluster decor handle key array.

Definition at line 151 of file egammaTruthAssociationAlg.h.

m_clusterDecName

Gaudi::Property<std::string> egammaTruthAssociationAlg::m_clusterDecName

private

Initial value:

{
    this,
    "ClusterContainerName",
    "",
    "Name of the egamma cluster container"
  }

The egamma cluster name property used to initialize the WriteDecorHandleKeyArray.

Definition at line 160 of file egammaTruthAssociationAlg.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doEgammaTruthContainer

Gaudi::Property<bool> egammaTruthAssociationAlg::m_doEgammaTruthContainer

private

Initial value:

{
    this,
    "CreateEgammaTruthContainer",
    true,
    "Create egammaTruthContainer?"
  }

Create egamma truth container?

Definition at line 119 of file egammaTruthAssociationAlg.h.

m_egammaTruthParticleContainerKey

SG::WriteHandleKey<xAOD::TruthParticleContainer> egammaTruthAssociationAlg::m_egammaTruthParticleContainerKey

private

Initial value:

{
      this,
      "EgammaTruthContainerName",
      "",
      "Name of the output egamma truth particle container"
    }

Name of the output egamma truth container.

Definition at line 236 of file egammaTruthAssociationAlg.h.

m_electronDecKeys

SG::WriteDecorHandleKeyArray<xAOD::ElectronContainer> egammaTruthAssociationAlg::m_electronDecKeys

private

Initial value:

{
    this,
    "DoNotSet_ElectronContainerName",
    {},
    "Do not set; configuration via the string property"
  }

The electron container decor handle key array.

Definition at line 168 of file egammaTruthAssociationAlg.h.

m_electronDecName

Gaudi::Property<std::string> egammaTruthAssociationAlg::m_electronDecName

private

Initial value:

{
    this,
    "ElectronContainerName",
    "",
    "Name of the input electron container"
  }

The electron container name property used to initialize the WriteDecorHandleKeyArray.

Definition at line 177 of file egammaTruthAssociationAlg.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

m_fwdElectronDecKeys

SG::WriteDecorHandleKeyArray<xAOD::ElectronContainer> egammaTruthAssociationAlg::m_fwdElectronDecKeys

private

Initial value:

{
    this,
    "DoNotSet_FwdElectronContainerName",
    {},
    "Do not set; configuration via the string property"
  }

The fwd electron container decor handle key array.

Definition at line 185 of file egammaTruthAssociationAlg.h.

m_fwdElectronDecName

Gaudi::Property<std::string> egammaTruthAssociationAlg::m_fwdElectronDecName

private

Initial value:

{
    this,
    "FwdElectronContainerName",
    "",
    "Name of the input fwd electron container"
  }

The fwd electron name property used to initialize the WriteDecorHandleKeyArray.

Definition at line 194 of file egammaTruthAssociationAlg.h.

m_matchClusters

Gaudi::Property<bool> egammaTruthAssociationAlg::m_matchClusters

private

Initial value:

{ this,
                                         "MatchClusters",
                                         false,
                                         "Match clusters?" }

Match clusters?

Definition at line 145 of file egammaTruthAssociationAlg.h.

m_matchElectrons

Gaudi::Property<bool> egammaTruthAssociationAlg::m_matchElectrons

private

Initial value:

{ this,
                                          "MatchElectrons",
                                          true,
                                          "Match (central) electrons?" }

Match electrons?

Definition at line 127 of file egammaTruthAssociationAlg.h.

m_matchForwardElectrons

Gaudi::Property<bool> egammaTruthAssociationAlg::m_matchForwardElectrons

private

Initial value:

{ this,
                                                 "MatchForwardElectrons",
                                                 true,
                                                 "Match forward electrons?" }

Match fwd electrons?

Definition at line 139 of file egammaTruthAssociationAlg.h.

m_matchPhotons

Gaudi::Property<bool> egammaTruthAssociationAlg::m_matchPhotons

private

Initial value:

{ this,
                                        "MatchPhotons",
                                        true,
                                        "Match photons?" }

Match photons?

Definition at line 133 of file egammaTruthAssociationAlg.h.

m_mcTruthClassifier

ToolHandle<IMCTruthClassifier> egammaTruthAssociationAlg::m_mcTruthClassifier

private

Initial value:

{
    this,
    "MCTruthClassifier",
    "EMMCTruthClassifier",
    "Handle of MCTruthClassifier"
  }

MCTruthClassifier.

Definition at line 260 of file egammaTruthAssociationAlg.h.

m_minPt

Gaudi::Property<float> egammaTruthAssociationAlg::m_minPt

private

Initial value:

{
    this,
    "MinPtEgammaTruth",
    10,
    "Minimum Pt to enter egamma truth particle container"
  }

Minimum Pt to enter egamma truth particle container.

Definition at line 244 of file egammaTruthAssociationAlg.h.

m_minPtFSR

Gaudi::Property<float> egammaTruthAssociationAlg::m_minPtFSR

private

Initial value:

{
    this,
    "MinPtEgammaTruthFSR",
    1e3,
    "Minimum Pt for FSR to enter egamma truth particle container"
  }

Minimum Pt for FSR to enter egamma truth particle container.

Definition at line 252 of file egammaTruthAssociationAlg.h.

m_photonDecKeys

SG::WriteDecorHandleKeyArray<xAOD::PhotonContainer> egammaTruthAssociationAlg::m_photonDecKeys

private

Initial value:

{
    this,
    "DoNotSet_PhotonContainerName",
    {},
    "Do not set; configuration via the string property"
  }

The photon container decor handle key array.

Definition at line 202 of file egammaTruthAssociationAlg.h.

m_photonDecName

Gaudi::Property<std::string> egammaTruthAssociationAlg::m_photonDecName

private

Initial value:

{
    this,
    "PhotonContainerName",
    "",
    "Name of the input photon container"
  }

The photon container name property used to initialize the WriteDecorHandleKeyArray.

Definition at line 211 of file egammaTruthAssociationAlg.h.

m_truthEventContainerKey

SG::ReadHandleKey<xAOD::TruthEventContainer> egammaTruthAssociationAlg::m_truthEventContainerKey

private

Initial value:

{
    this,
    "TruthEventContainerName",
    "",
    "Name of the truth event container"
  }

Name of the truth event container.

Definition at line 219 of file egammaTruthAssociationAlg.h.

m_truthParticleContainerKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> egammaTruthAssociationAlg::m_truthParticleContainerKey

private

Initial value:

{
    this,
    "TruthParticleContainerName",
    "",
    "Name of the truth particle container"
  }

Name of the truth particle container.

Definition at line 227 of file egammaTruthAssociationAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• egammaTruthAssociationAlg.h
• egammaTruthAssociationAlg.cxx