xAODEgammaBuilder Class Reference

#include <xAODEgammaBuilder.h>

Inheritance diagram for xAODEgammaBuilder:

Collaboration diagram for xAODEgammaBuilder:

Public Member Functions
	xAODEgammaBuilder (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize () override final
StatusCode	finalize () override final
StatusCode	execute (const EventContext &ctx) const override final
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
bool	getElectron (const egammaRec *egRec, xAOD::ElectronContainer *electronContainer, const unsigned int author, const uint8_t type) const
	Given an egammaRec object, a pointer to the electron container and the author, create and dress an electron, pushing it back to the container and calling the relevant tools. More...
bool	getPhoton (const egammaRec *egRec, xAOD::PhotonContainer *photonContainer, const unsigned int author, uint8_t type) const
	Given an egammaRec object, a pointer to the photon container and the author, create and dress a photon, pushing it back to the container and calling the relevant tools. More...
template<typename T >
StatusCode	CallTool (const EventContext &ctx, const ToolHandle< IegammaBaseTool > &tool, DataVector< T > *container) const
	Call a tool using contExecute and an electron or photon container. 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
ToolHandleArray< IegammaBaseTool >	m_electronTools
	Vector of tools for dressing ONLY electrons. More...
ToolHandleArray< IegammaBaseTool >	m_photonTools
	Vector of tools for dressing ONLY photons. More...
ToolHandle< IEMClusterTool >	m_clusterTool
	Tool to do the final electron/photon cluster building. More...
ToolHandle< IEMShowerBuilder >	m_ShowerTool
	Tool to compute shower shapes. More...
ToolHandle< IEGammaAmbiguityTool >	m_ambiguityTool
	Tool to resolve electron/photon ambiguity. More...
ToolHandle< IegammaOQFlagsBuilder >	m_egammaOQTool
	Tool to add electron/photon Object Quality info. More...
SG::WriteHandleKey< xAOD::ElectronContainer >	m_electronOutputKey
	Name of the electron output collection. More...
SG::WriteHandleKey< xAOD::PhotonContainer >	m_photonOutputKey
	Name of the photon output collection. More...
SG::ReadHandleKey< EgammaRecContainer >	m_electronClusterRecContainerKey
	Name of input super cluster electron egammaRec container. More...
SG::ReadHandleKey< EgammaRecContainer >	m_photonClusterRecContainerKey
	Name of input super cluster photon egammaRec container. More...
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey
SG::WriteHandleKey< xAOD::ElectronContainer >	m_dummyElectronOutputKey
	Name of the dummy electron output collection. More...
Gaudi::Property< bool >	m_isTruth {this, "isTruth", false, "is truth"}
	Option to do truth. More...
Gaudi::Property< bool >	m_doPhotons {this, "doPhotons", true, "Run the Photon reconstruction"}
Gaudi::Property< bool >	m_doElectrons {this, "doElectrons", true, "Run the Electron reconstruction"}
std::unique_ptr< electronPearShapeAlignmentCorrection >	m_deltaEta1Pear
bool	m_doAmbiguity {}
bool	m_doOQ {}
bool	m_doDummyElectrons = false
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

The last step of the electron and photon reconstruction algorithm. The algorithm builds physics objects (xAOD::Electron, xAOD::Photon) from the egammaRec containers built by the previous algorithms. In the step of the chain electron and photon reconstruction are merged again and the ambiguity resolution is applied.

Input collections:

• InputElectronRecCollectionName: default=ElectronSuperRecCollection. A container of egammaRec for electrons
• InputPhotonRecCollectionName: default=PhotonSuperRecCollection. A container of egammaRec for photons

Output collections:

• ElectronOutputName: default=ElectronContainer. A container of xAOD::Electron.
• PhotonOutputName: default=PhotonContainer. A container of xAOD::Photon

If the algorithm runs on both electrons and photons, which is the default (see doPhotons and doElectrons properties), the ambiguity resolution is applied. If there are two egammaRec, one coming from the electron input container, one coming from the photon input container, with the same eta and phi of the hottest cells then the ambiguity tool decides if to save only one or both. The author and the ambiguityType are set accordingly to that decision. If both particles are saved a link between them is saved (ambiguityLink). All the properties of electrons are set:

• cluster links
• track links
• charge
• TrackCaloMatchValues for all the layers, e.g. xAOD::EgammaParameters::deltaEta0, xAOD::EgammaParameters::deltaPhi0, xAOD::EgammaParameters::deltaPhiRescaled0
• xAOD::EgammaParameters::deltaPhiFromLastMeasurement

All the properties of photons are set:

• cluster links
• vertex links
• xAOD::EgammaParameters::convMatchDeltaEta1, xAOD::EgammaParameters::convMatchDeltaPhi1

Several tools are then applied to the particle:

• Shower shapes are computed thanks to the tool configured by EMShowerTool property, implementing the interface IEMShowerBuilder, by default EMShowerBuilder.
• Object quality is filled by the tool specified by the property ObjectQualityTool (no default). If the property is not set object quality is skipped.
• finalize the cluster with the tool specified by the property EMClusterTool (default=EMClusterTool), for example applying energy calibration
• tools specified by the properties egammaTools, ElectronTools, PhotonTools are executed (default: none)

Definition at line 87 of file xAODEgammaBuilder.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

xAODEgammaBuilder()

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

Definition at line 76 of file xAODEgammaBuilder.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator)
{}

Member Function Documentation

CallTool()

template<typename T >

StatusCode xAODEgammaBuilder::CallTool ( const EventContext &  ctx, const ToolHandle< IegammaBaseTool > &  tool, DataVector< T > *  container  ) const

private

Call a tool using contExecute and an electron or photon container.

Definition at line 322 of file xAODEgammaBuilder.cxx.

{
  if (container) {
    for (T *egamma : *container) {
      ATH_CHECK(tool->execute(ctx, egamma));
    }
  }
 
  return StatusCode::SUCCESS;
}

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 xAODEgammaBuilder::execute ( const EventContext &  ctx ) const

finaloverride

Definition at line 128 of file xAODEgammaBuilder.cxx.

{
 
  const EgammaRecContainer* inputElRecs = nullptr;
  const EgammaRecContainer* inputPhRecs = nullptr;
  xAOD::ElectronContainer* electrons = nullptr;
  xAOD::PhotonContainer* photons = nullptr;
  /*
   * From here on if a Read/Write handle
   * is retrieved the above will be !=
   * nullptr for electron or photons or both
   */
  std::optional<SG::WriteHandle<xAOD::ElectronContainer>> electronContainer;
  std::optional<SG::WriteHandle<xAOD::PhotonContainer>> photonContainer;
 
  if (m_doElectrons) {
    SG::ReadHandle<EgammaRecContainer> electronSuperRecs(
      m_electronClusterRecContainerKey, ctx);
    inputElRecs = electronSuperRecs.ptr();
 
    electronContainer.emplace(m_electronOutputKey, ctx);
    ATH_CHECK(electronContainer->record(
      std::make_unique<xAOD::ElectronContainer>(),
      std::make_unique<xAOD::ElectronAuxContainer>()));
 
    electrons = electronContainer->ptr();
    electrons->reserve(inputElRecs->size());
  }
  if (m_doPhotons) {
    SG::ReadHandle<EgammaRecContainer> photonSuperRecs(
      m_photonClusterRecContainerKey, ctx);
    inputPhRecs = photonSuperRecs.ptr();
 
    photonContainer.emplace(m_photonOutputKey, ctx);
    ATH_CHECK(
      photonContainer->record(std::make_unique<xAOD::PhotonContainer>(),
                              std::make_unique<xAOD::PhotonAuxContainer>()));
 
    photons = photonContainer->ptr();
    photons->reserve(inputPhRecs->size());
  }
 
  /*
   * Now fill the electrons and photons
   */
  if (m_doElectrons) {
    for (const egammaRec* electronRec : *inputElRecs) {
      // in case for some reasons we reach here with no trackparticles
      if (electronRec->getNumberOfTrackParticles() == 0) {
        continue;
      }
      unsigned int author = xAOD::EgammaParameters::AuthorElectron;
      xAOD::AmbiguityTool::AmbiguityType type = xAOD::AmbiguityTool::electron;
      if (m_doPhotons) {
        // get the hottest cell
        const xAOD::CaloCluster* const elClus = electronRec->caloCluster();
        const double elEta0 = elClus->eta0();
        const double elPhi0 = elClus->phi0();
        for (const egammaRec* photonRec : *inputPhRecs) {
          const xAOD::CaloCluster* const phClus = photonRec->caloCluster();
          // See if they have the same hottest cell
          if (elEta0 == phClus->eta0() && elPhi0 == phClus->phi0()) {
            if (m_doAmbiguity) { // should be the default
              author =
                m_ambiguityTool->ambiguityResolve(elClus,
                                                  photonRec->vertex(),
                                                  electronRec->trackParticle(),
                                                  type);
            } else { // in case the ambiguity tool is not set ambiguity is not
                     // resolved
              author = xAOD::EgammaParameters::AuthorAmbiguous;
            }
            break;
          }
        }
      }
      // Create Electron xAOD objects
      if (author == xAOD::EgammaParameters::AuthorElectron ||
          author == xAOD::EgammaParameters::AuthorAmbiguous) {
        if (!getElectron(electronRec, electrons, author, type)) {
          return StatusCode::FAILURE;
        }
      }
    }
  }
 
  if (m_doPhotons) {
    for (const egammaRec* photonRec : *inputPhRecs) {
      unsigned int author = xAOD::EgammaParameters::AuthorPhoton;
      xAOD::AmbiguityTool::AmbiguityType type = xAOD::AmbiguityTool::photon;
      if (m_doElectrons) {
        // get the hottest cell
        const xAOD::CaloCluster* const phClus = photonRec->caloCluster();
        const double phEta0 = phClus->eta0();
        const double phPhi0 = phClus->phi0();
        for (const egammaRec* electronRec : *inputElRecs) {
          const xAOD::CaloCluster* const elClus = electronRec->caloCluster();
          // See if they have the same hottest cell
          if (phEta0 == elClus->eta0() && phPhi0 == elClus->phi0()) {
            if (m_doAmbiguity) { // should be the default
              author =
                m_ambiguityTool->ambiguityResolve(elClus,
                                                  photonRec->vertex(),
                                                  electronRec->trackParticle(),
                                                  type);
            } else { // in case the ambiguity tool is not set ambiguity is not
                     // resolved
              author = xAOD::EgammaParameters::AuthorAmbiguous;
            }
            break;
          }
        }
      }
      // Create Photon xAOD objects
      if (author == xAOD::EgammaParameters::AuthorPhoton ||
          author == xAOD::EgammaParameters::AuthorAmbiguous) {
        if (!getPhoton(photonRec, photons, author, type)) {
          return StatusCode::FAILURE;
        }
      }
    }
  }
 
  SG::ReadCondHandle<CaloDetDescrManager> caloDetDescrMgrHandle{
    m_caloDetDescrMgrKey, ctx
  };
  ATH_CHECK(caloDetDescrMgrHandle.isValid());
  const CaloDetDescrManager* calodetdescrmgr = *caloDetDescrMgrHandle;
 
  // Shower Shapes
  if (electrons) {
    for (xAOD::Electron* electron : *electrons) {
      ATH_CHECK(m_ShowerTool->execute(ctx, *calodetdescrmgr, electron));
    }
  }
  if (photons) {
    for (xAOD::Photon* photon : *photons) {
      ATH_CHECK(m_ShowerTool->execute(ctx, *calodetdescrmgr, photon));
    }
  }
 
  // Object Quality
  if (m_doOQ) {
    if (electrons) {
      for (xAOD::Electron* electron : *electrons) {
        ATH_CHECK(m_egammaOQTool->execute(ctx, *electron));
      }
    }
    if (photons) {
      for (xAOD::Photon* photon : *photons) {
        ATH_CHECK(m_egammaOQTool->execute(ctx, *photon));
      }
    }
  }
 
  // Energy calibration
  ATH_CHECK(m_clusterTool->contExecute(ctx, electrons, photons));
 
  //Followed by 4-Mom Building
  EMFourMomBuilder::calculate(electrons);
  EMFourMomBuilder::calculate(photons);
  //Additional tools fpr electrons/photons
  //e.g identification
  if (m_doElectrons) {
    for (const auto& tool : m_electronTools) {
      ATH_CHECK(CallTool(ctx, tool, electrons));
    }
  }
  if (m_doPhotons) {
    for (const auto& tool : m_photonTools) {
      ATH_CHECK(CallTool(ctx, tool, photons));
    }
  }
  // Do the ambiguity Links
  if (m_doElectrons && m_doPhotons) {
    doAmbiguityLinks(ctx, electrons, photons);
    doAmbiguityLinks(ctx, photons, electrons);
  }
 
  if (m_doDummyElectrons) {
    SG::WriteHandle<xAOD::ElectronContainer> dummyElectronContainer(
      m_dummyElectronOutputKey, ctx);
    ATH_CHECK(dummyElectronContainer.record(
      std::make_unique<xAOD::ElectronContainer>(),
      std::make_unique<xAOD::ElectronAuxContainer>()));
 
    dummyElectronContainer->push_back(std::unique_ptr<xAOD::Electron>());
  }
 
  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 xAODEgammaBuilder::finalize ( )

finaloverride

Definition at line 122 of file xAODEgammaBuilder.cxx.

{
  return StatusCode::SUCCESS;
}

getElectron()

bool xAODEgammaBuilder::getElectron ( const egammaRec *  egRec, xAOD::ElectronContainer *  electronContainer, const unsigned int  author, const uint8_t  type  ) const

private

Given an egammaRec object, a pointer to the electron container and the author, create and dress an electron, pushing it back to the container and calling the relevant tools.

Definition at line 337 of file xAODEgammaBuilder.cxx.

{
  if (!egRec || !electronContainer) {
    return false;
  }
 
  xAOD::Electron* electron = electronContainer->push_back(std::make_unique<xAOD::Electron>());
  electron->setAuthor(author);
 
  static const SG::AuxElement::Accessor<uint8_t> acc("ambiguityType");
  acc(*electron) = type;
 
  electron->setCaloClusterLinks(egRec->caloClusterElementLinks());
  electron->setTrackParticleLinks(egRec->trackParticleElementLinks());
 
  const xAOD::TrackParticle* trackParticle = electron->trackParticle();
  if (trackParticle) {
    electron->setCharge(trackParticle->charge());
  }
  // Set DeltaEta, DeltaPhi , DeltaPhiRescaled
  electron->setTrackCaloMatchValues(
    egRec->deltaEta(),
    egRec->deltaPhi(),
    egRec->deltaPhiRescaled(),
    egRec->deltaPhiLast()
  );
 
  static const SG::AuxElement::Accessor<float> pear("deltaEta1PearDistortion");
  pear(*electron) = m_isTruth ?  0.0 : m_deltaEta1Pear->getDeltaEtaDistortion(
    electron->caloCluster()->etaBE(2),
    electron->caloCluster()->phiBE(2)
  );
 
  return true;
}

getPhoton()

bool xAODEgammaBuilder::getPhoton ( const egammaRec *  egRec, xAOD::PhotonContainer *  photonContainer, const unsigned int  author, uint8_t  type  ) const

private

Given an egammaRec object, a pointer to the photon container and the author, create and dress a photon, pushing it back to the container and calling the relevant tools.

Definition at line 377 of file xAODEgammaBuilder.cxx.

{
  if (!egRec || !photonContainer) {
    return false;
  }
 
  xAOD::Photon* photon = photonContainer->push_back(std::make_unique<xAOD::Photon>());
  photon->setAuthor(author);
  static const SG::AuxElement::Accessor<uint8_t> acc("ambiguityType");
  acc(*photon) = type;
 
  photon->setCaloClusterLinks(egRec->caloClusterElementLinks());
  photon->setVertexLinks(egRec->vertexElementLinks());
 
  // Transfer deltaEta/Phi info
  float deltaEta = egRec->deltaEtaVtx();
  float deltaPhi = egRec->deltaPhiVtx();
  if (!photon->setVertexCaloMatchValue(
        deltaEta, xAOD::EgammaParameters::convMatchDeltaEta1)) {
    return false;
  }
 
  if (!photon->setVertexCaloMatchValue(
        deltaPhi, xAOD::EgammaParameters::convMatchDeltaPhi1)) {
    return false;
  }
  return true;
}

initialize()

StatusCode xAODEgammaBuilder::initialize ( )

finaloverride

Definition at line 82 of file xAODEgammaBuilder.cxx.

{
  m_deltaEta1Pear = std::make_unique<electronPearShapeAlignmentCorrection>();
  // the data handle keys
  ATH_CHECK(m_electronClusterRecContainerKey.initialize(m_doElectrons));
  ATH_CHECK(m_photonClusterRecContainerKey.initialize(m_doPhotons));
  ATH_CHECK(m_electronOutputKey.initialize(m_doElectrons));
  ATH_CHECK(m_photonOutputKey.initialize(m_doPhotons));
  ATH_CHECK(m_caloDetDescrMgrKey.initialize());
 
  // retrieve tools
  ATH_CHECK(m_clusterTool.retrieve());
  ATH_CHECK(m_ShowerTool.retrieve());
 
  if (m_doElectrons) {
    ATH_CHECK(m_electronTools.retrieve());
  }
  if (m_doPhotons) {
    ATH_CHECK(m_photonTools.retrieve());
  }
  m_doOQ = !m_egammaOQTool.empty();
  if (m_doOQ) {
    ATH_CHECK(m_egammaOQTool.retrieve());
  } else {
    m_egammaOQTool.disable();
  }
 
  // do we actually do ambiguity
  m_doAmbiguity = !m_ambiguityTool.empty();
  if (m_doElectrons && m_doPhotons && m_doAmbiguity) {
    ATH_CHECK(m_ambiguityTool.retrieve());
  } else {
    m_ambiguityTool.disable();
  }
  m_doDummyElectrons = !(m_dummyElectronOutputKey.empty());
  ATH_CHECK(m_dummyElectronOutputKey.initialize(m_doDummyElectrons));
  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;
}

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.

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_ambiguityTool

ToolHandle<IEGammaAmbiguityTool> xAODEgammaBuilder::m_ambiguityTool

private

Initial value:

{this,
        "AmbiguityTool", "EGammaAmbiguityTool/egammaambiguitytool",
        "Tool that does electron/photon ambiguity resolution"}

Tool to resolve electron/photon ambiguity.

Definition at line 135 of file xAODEgammaBuilder.h.

m_caloDetDescrMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> xAODEgammaBuilder::m_caloDetDescrMgrKey

private

Initial value:

{
        this,
        "CaloDetDescrManager",
        "CaloDetDescrManager",
        "SG Key for CaloDetDescrManager in the Condition Store"
    }

Definition at line 168 of file xAODEgammaBuilder.h.

m_clusterTool

ToolHandle<IEMClusterTool> xAODEgammaBuilder::m_clusterTool

private

Initial value:

{this,
        "EMClusterTool", "egammaTools/EMClusterTool",
        "Tool that does electron/photon final cluster building"}

Tool to do the final electron/photon cluster building.

Definition at line 125 of file xAODEgammaBuilder.h.

m_deltaEta1Pear

std::unique_ptr<electronPearShapeAlignmentCorrection> xAODEgammaBuilder::m_deltaEta1Pear

private

Definition at line 186 of file xAODEgammaBuilder.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_doAmbiguity

bool xAODEgammaBuilder::m_doAmbiguity {}

private

Definition at line 187 of file xAODEgammaBuilder.h.

m_doDummyElectrons

bool xAODEgammaBuilder::m_doDummyElectrons = false

private

Definition at line 189 of file xAODEgammaBuilder.h.

m_doElectrons

Gaudi::Property<bool> xAODEgammaBuilder::m_doElectrons {this, "doElectrons", true, "Run the Electron reconstruction"}

private

Definition at line 185 of file xAODEgammaBuilder.h.

m_doOQ

bool xAODEgammaBuilder::m_doOQ {}

private

Definition at line 188 of file xAODEgammaBuilder.h.

m_doPhotons

Gaudi::Property<bool> xAODEgammaBuilder::m_doPhotons {this, "doPhotons", true, "Run the Photon reconstruction"}

private

Definition at line 184 of file xAODEgammaBuilder.h.

m_dummyElectronOutputKey

SG::WriteHandleKey<xAOD::ElectronContainer> xAODEgammaBuilder::m_dummyElectronOutputKey

private

Initial value:

{this,
        "DummyElectronOutputName", "",
        "Name of Dummy Electron Container to be created"}

Name of the dummy electron output collection.

Definition at line 176 of file xAODEgammaBuilder.h.

m_egammaOQTool

ToolHandle<IegammaOQFlagsBuilder> xAODEgammaBuilder::m_egammaOQTool

private

Initial value:

{this,
      "ObjectQualityTool", {},
      "Tool that adds electron/photon Object Quality info"}

Tool to add electron/photon Object Quality info.

Definition at line 140 of file xAODEgammaBuilder.h.

m_electronClusterRecContainerKey

SG::ReadHandleKey<EgammaRecContainer> xAODEgammaBuilder::m_electronClusterRecContainerKey

private

Initial value:

{this,
        "InputElectronRecCollectionName",
        "ElectronSuperRecCollection",
        "Input container for electron  Super Cluster  egammaRec objects"}

Name of input super cluster electron egammaRec container.

Definition at line 157 of file xAODEgammaBuilder.h.

m_electronOutputKey

SG::WriteHandleKey<xAOD::ElectronContainer> xAODEgammaBuilder::m_electronOutputKey

private

Initial value:

{this,
        "ElectronOutputName", "ElectronContainer",
        "Name of Electron Container to be created"}

Name of the electron output collection.

Definition at line 147 of file xAODEgammaBuilder.h.

m_electronTools

ToolHandleArray<IegammaBaseTool> xAODEgammaBuilder::m_electronTools

private

Initial value:

{this,
        "ElectronTools", {}, "Tools for dressing ONLY electrons"}

Vector of tools for dressing ONLY electrons.

Definition at line 117 of file xAODEgammaBuilder.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_isTruth

Gaudi::Property<bool> xAODEgammaBuilder::m_isTruth {this, "isTruth", false, "is truth"}

private

Option to do truth.

Definition at line 183 of file xAODEgammaBuilder.h.

m_photonClusterRecContainerKey

SG::ReadHandleKey<EgammaRecContainer> xAODEgammaBuilder::m_photonClusterRecContainerKey

private

Initial value:

{this,
        "InputPhotonRecCollectionName",
        "PhotonSuperRecCollection",
        "Input container for electron  Super Cluster  egammaRec objects"}

Name of input super cluster photon egammaRec container.

Definition at line 163 of file xAODEgammaBuilder.h.

m_photonOutputKey

SG::WriteHandleKey<xAOD::PhotonContainer> xAODEgammaBuilder::m_photonOutputKey

private

Initial value:

{this,
        "PhotonOutputName", "PhotonContainer",
        "Name of Photon Container to be created"}

Name of the photon output collection.

Definition at line 152 of file xAODEgammaBuilder.h.

m_photonTools

ToolHandleArray<IegammaBaseTool> xAODEgammaBuilder::m_photonTools

private

Initial value:

{this,
        "PhotonTools", {}, "Tools for dressing ONLY photons"}

Vector of tools for dressing ONLY photons.

Definition at line 121 of file xAODEgammaBuilder.h.

m_ShowerTool

ToolHandle<IEMShowerBuilder> xAODEgammaBuilder::m_ShowerTool

private

Initial value:

{this,
        "EMShowerTool", "egammaTools/EMShowerBuilder",
        "Tool that does electron/photon shower shape building"}

Tool to compute shower shapes.

Definition at line 130 of file xAODEgammaBuilder.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:

• xAODEgammaBuilder.h
• xAODEgammaBuilder.cxx