egammaAODFixes Class Reference

Algorithm to handle various AOD fixes : More...

#include <egammaAODFixes.h>

Inheritance diagram for egammaAODFixes:

Public Member Functions
	egammaAODFixes (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize () override final
StatusCode	execute (const EventContext &ctx) const override final
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	getLayerE (std::vector< const CaloCell * > &cells, std::vector< float > &lE) const
StatusCode	getCorrection (const xAOD::Egamma *eg, float &aET, std::vector< float > &lECl) const
StatusCode	getCorrectionC (const xAOD::Egamma *eg, float &aET, IegammaCellRecoveryTool::Info &info) const
void	rebuildLink (xAOD::EgammaContainer *egC, xAOD::CaloClusterContainer *egclC, const EventContext &ctx) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::WriteHandleKey< xAOD::ElectronContainer >	m_electronOutputKey
	Name of the electron output collection.
SG::ReadHandleKey< xAOD::ElectronContainer >	m_electronInputKey
	Name of the electron input collection.
SG::WriteHandleKey< xAOD::PhotonContainer >	m_photonOutputKey
	Name of the photon output collection.
SG::ReadHandleKey< xAOD::PhotonContainer >	m_photonInputKey
	Name of the photon input collection.
SG::ReadHandleKey< CaloCellContainer >	m_CaloCellsKey
	Name of the calo cell container.
SG::WriteHandleKey< xAOD::CaloClusterContainer >	m_egClusOutputKey
	Name of the egamma cluster output collection.
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_egClusInputKey
	Name of the egamma cluster input collection.
SG::WriteHandleKey< CaloClusterCellLinkContainer >	m_egClusCellLinkOutputKey
	Key of the output cluster container cell links: name taken from containter name; only dummy configurable.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey
	Key for calo detector description manager.
ToolHandle< IegammaCellRecoveryTool >	m_egammaCellRecoveryTool
	Pointer to the egammaCellRecoveryTool.
Gaudi::Property< bool >	m_correctCluster
	correct also layer energies ?
Gaudi::Property< bool >	m_ambiguityFix
	correct ambiguity links ?
Gaudi::Property< bool >	m_tpetcFix
	correct topoetcone isolation ?
ToolHandle< IegammaSwTool >	m_clusterCorrectionTool
	Tool to handle cluster corrections.
ServiceHandle< IegammaMVASvc >	m_MVACalibSvc
	Handle to the MVA calibration service.
ToolHandle< CP::IIsolationCorrectionTool >	m_IsoLeakCorrectionTool
	Handle to the isolation leakage correction tool.
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Algorithm to handle various AOD fixes :

• ambiguity relinking for electrons and photons
• the consequence of the timing cut in egamma

This class is responsible for reading input electron and photon containers, processing them to in order to link ambiguous candidates, and to correct the topoetcone isolation variables and the cluster layer 2 and 3 energies and writing to the output containers. It is used in the context of an AODFix to correct an ambiguityLink association bug in the Athena Rel24 up to 24.0.83, and to mitigate the impact of the timing cut for topocluster building in egamma reconstruction, in Athena Rel24.

• Input electron container: specified by ElectronInputName.
• Output electron container: specified by ElectronOutputName.
• Input photon container: specified by PhotonInputName.
• Output photon container: specified by PhotonOutputName.

Definition at line 49 of file egammaAODFixes.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

egammaAODFixes()

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

Definition at line 26 of file egammaAODFixes.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator)
{}

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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()

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

execute()

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

finaloverride

Definition at line 62 of file egammaAODFixes.cxx.

                                                     {
 
  static const SG::AuxElement::Accessor<float> acce2("Eadded_Lr2");
  static const SG::AuxElement::Accessor<float> acce3("Eadded_Lr3");
  static const SG::AuxElement::Accessor<float> acce2b("Eadded_Lr2b");
  static const SG::AuxElement::Accessor<float> acce3b("Eadded_Lr3b");
  static const SG::AuxElement::Accessor<float> acce2e("Eadded_Lr2e");
  static const SG::AuxElement::Accessor<float> acce3e("Eadded_Lr3e");
 
  SG::ReadHandle<xAOD::ElectronContainer> el_inputContainer(m_electronInputKey,ctx);
  SG::WriteHandle<xAOD::ElectronContainer> el_outputContainer(m_electronOutputKey,ctx);
  SG::ReadHandle<xAOD::PhotonContainer> ph_inputContainer(m_photonInputKey,ctx);
  SG::WriteHandle<xAOD::PhotonContainer> ph_outputContainer(m_photonOutputKey,ctx);
 
  ATH_CHECK(el_outputContainer.record(std::make_unique<xAOD::ElectronContainer>(),
                      std::make_unique<xAOD::ElectronAuxContainer>()));
 
  ATH_CHECK(ph_outputContainer.record(std::make_unique<xAOD::PhotonContainer>(),
                      std::make_unique<xAOD::PhotonAuxContainer>()));
 
  xAOD::ElectronContainer* electrons = el_outputContainer.ptr();
  xAOD::PhotonContainer* photons = ph_outputContainer.ptr();
  electrons->reserve(el_inputContainer->size());
  photons->reserve(ph_inputContainer->size());
 
  ATH_MSG_VERBOSE("Running on " << el_inputContainer->size() << " electrons"
          " and " << ph_inputContainer->size() << " photons");
 
  std::map<size_t,std::pair<const xAOD::Egamma*,IegammaCellRecoveryTool::Info>>
    icegRecoveryInfo;
 
  // Whatever the fix : copy old container content into a new one
  for (const xAOD::Electron* old_el : *el_inputContainer) {
    xAOD::Electron* electron = electrons->push_back(std::make_unique<xAOD::Electron>());
    *electron=*old_el;
 
    if (m_tpetcFix) {
      float aET = 0;
      IegammaCellRecoveryTool::Info info{};
      if (getCorrectionC(old_el,aET,info).isFailure()) {
    ATH_MSG_WARNING("Failed to recover energies for electron "
            << old_el->index() << " pT = " << old_el->pt());
      }
      for (auto t : { xAOD::Iso::topoetcone20, xAOD::Iso::topoetcone30,
        xAOD::Iso::topoetcone40 }) {
    float oiso = 9e9;
    if (!old_el->isolation(oiso,t)) {
      ATH_MSG_WARNING("Electron " << old_el->index() << " has no "
              << xAOD::Iso::toCString(t) << " isolation");
    }
    electron->setIsolation(oiso+aET, t);
      }
      std::vector<float> layerEnergies(4);
      getLayerE(info.addedCells,layerEnergies);
      // Legacy info
      acce2(*electron) = layerEnergies[0]+layerEnergies[2];
      acce3(*electron) = layerEnergies[1]+layerEnergies[3];
      // more granular for debug
      acce2b(*electron) = layerEnergies[0];
      acce3b(*electron) = layerEnergies[1];
      acce2e(*electron) = layerEnergies[2];
      acce3e(*electron) = layerEnergies[3];
 
      if (m_correctCluster) {
    icegRecoveryInfo[old_el->caloCluster()->index()] =
      std::make_pair(old_el,info);
      }
    }
  }
  
  for (const xAOD::Photon* old_ph : *ph_inputContainer) {
    xAOD::Photon* photon = photons->push_back(std::make_unique<xAOD::Photon>());
    *photon=*old_ph;
 
    if (m_tpetcFix) {
      float aET = 0;
      IegammaCellRecoveryTool::Info info{};
      if (getCorrectionC(old_ph,aET,info).isFailure()) {
    ATH_MSG_WARNING("Failed to recover energies for photon "
            << old_ph->index() << " pT = " << old_ph->pt());
      }
      for (auto t : { xAOD::Iso::topoetcone20, xAOD::Iso::topoetcone30,
        xAOD::Iso::topoetcone40 }) {
    float oiso = 9e9;
    if (!old_ph->isolation(oiso,t)) {
      ATH_MSG_WARNING("Photon " << old_ph->index() << " has no "
              << xAOD::Iso::toCString(t) << " isolation");
    }
    photon->setIsolation(oiso+aET, t);
      }
      std::vector<float> layerEnergies(4);
      getLayerE(info.addedCells,layerEnergies);
      // legacy info
      acce2(*photon) = layerEnergies[0]+layerEnergies[2];
      acce3(*photon) = layerEnergies[1]+layerEnergies[3];
      // more granular for debug
      acce2b(*photon) = layerEnergies[0];
      acce3b(*photon) = layerEnergies[1];
      acce2e(*photon) = layerEnergies[2];
      acce3e(*photon) = layerEnergies[3];
 
      if (m_correctCluster) {
    icegRecoveryInfo[old_ph->caloCluster()->index()] =
      std::make_pair(old_ph,info);
      }
    }
  }
 
  // Ambiguity link fix
  if (m_ambiguityFix) {
    egAmbLinkHelper::doAmbiguityLinks(ctx, electrons, photons);
    egAmbLinkHelper::doAmbiguityLinks(ctx, photons, electrons);
  }
 
  // Correct also layer energies (L2 and L3) and in addition the corresponding
  // cluster energy (raw, alt, cal)
  if (m_correctCluster) {
 
    // The calo Det Descr manager
    SG::ReadCondHandle<CaloDetDescrManager> caloDetDescrMgrHandle{
      m_caloDetDescrMgrKey, ctx
    };
    ATH_CHECK(caloDetDescrMgrHandle.isValid());
    const CaloDetDescrManager* mgr = *caloDetDescrMgrHandle;
 
    static const std::vector<xAOD::CaloCluster::CaloSample> caloSam{
      CaloSampling::EMB2, CaloSampling::EMB3,
      CaloSampling::EME2, CaloSampling::EME3 };
 
    SG::ReadHandle<xAOD::CaloClusterContainer> egcl_inputContainer(m_egClusInputKey,ctx);
 
    SG::WriteHandle<CaloClusterCellLinkContainer> egcl_CellLinkContainer(
       m_egClusCellLinkOutputKey, ctx);
    ATH_CHECK(egcl_CellLinkContainer.record(
       std::make_unique<CaloClusterCellLinkContainer>()));
 
    SG::WriteHandle<xAOD::CaloClusterContainer> egcl_outputContainer(m_egClusOutputKey,ctx);
    ATH_CHECK(egcl_outputContainer.record(std::make_unique<xAOD::CaloClusterContainer>(),
                      std::make_unique<xAOD::CaloClusterAuxContainer>()));
 
    xAOD::CaloClusterContainer* egClusters = egcl_outputContainer.ptr();
    egClusters->reserve(egcl_inputContainer->size());
 
    for (const xAOD::CaloCluster* old_egcl : *egcl_inputContainer) {
      xAOD::CaloCluster* cluster =
    egClusters->push_back(std::make_unique<xAOD::CaloCluster>());
      *cluster=*old_egcl;
 
      ATH_MSG_VERBOSE("cluster ptrs old " << old_egcl << " new " << cluster
              << " indices " << old_egcl->index() << " " << cluster->index()); 
 
      size_t index = old_egcl->index();
      std::vector<const CaloCell*> cc;
      if (icegRecoveryInfo.find(index) != icegRecoveryInfo.end()) {
    cc = icegRecoveryInfo[index].second.addedCells;
      } else {
    ATH_MSG_WARNING("Could not find added calo cells"
            " for cluster with index " << index);
    return StatusCode::FAILURE;
      }
 
      bool doAddCell_condition1 = cc.size() > 0;
      const xAOD::Egamma* eg = icegRecoveryInfo[index].first;
      float addedE2 = icegRecoveryInfo[index].second.eCells[0];
      bool doAddCell_condition2 = addedE2 > 0 ||
    addedE2 + old_egcl->energyBE(2) > 0;
      if (!doAddCell_condition2) {
    ATH_MSG_VERBOSE(
      "Cluster should be corrected, but the additional energy in S2 "
      << addedE2 << " is too negative w.r.t. original one " <<
      old_egcl->energyBE(2));
      }
      if (doAddCell_condition1 && doAddCell_condition2) {
    ATH_MSG_VERBOSE("Number of cells " << old_egcl->getCellLinks()->size()
            << " " << cluster->getCellLinks()->size());
 
    const CaloClusterCellLink* cellLinks = cluster->getOwnCellLinks();
    CaloClusterCellLink::const_iterator cellItr = cellLinks->begin();
    CaloClusterCellLink::const_iterator cellEnd = cellLinks->end();
    for (; cellItr != cellEnd; ++cellItr) {
      ATH_MSG_VERBOSE("A cell in the new cluster w = " << cellItr.weight()
              << " e = " << cellItr->e());
    }
    const CaloClusterCellLink* ocellLinks = old_egcl->getCellLinks();
    cellItr = ocellLinks->begin();
    cellEnd = ocellLinks->end();
    for (; cellItr != cellEnd; ++cellItr) {
      ATH_MSG_VERBOSE("A cell in the old cluster w = " << cellItr.weight()
              << " e = " << cellItr->e());
    }
 
    const CaloCellContainer* inputcells =
      cluster->getCellLinks()->getCellContainer();
    for (const auto *cell : cc) {
      int cindex = inputcells->findIndex(cell->caloDDE()->calo_hash());
      cluster->addCell(cindex,1.);
    }
    ATH_MSG_VERBOSE("After adding the cells, number of cells "
            << cellLinks->size());
    cellItr = cellLinks->begin();
    cellEnd = cellLinks->end();
    for (; cellItr != cellEnd; ++cellItr) {
      ATH_MSG_VERBOSE("After addding a cell in the new cluster w = "
              << cellItr.weight()
              << " e = " << cellItr->e());
    }
    CaloClusterKineHelper::calculateKine(cluster, true, true);
 
    egammaClusterHelpers::refineEta1Position(cluster, *mgr);
    // Save the state before the corrections
    cluster->setAltE(cluster->e());
    cluster->setAltEta(cluster->eta());
    cluster->setAltPhi(cluster->phi());
 
    xAOD::EgammaParameters::EgammaType egType =
      xAOD::EgammaParameters::electron;
    if (xAOD::EgammaHelpers::isConvertedPhoton(eg)) {
      egType = xAOD::EgammaParameters::convertedPhoton;
    } else if (xAOD::EgammaHelpers::isPhoton(eg)) {
      egType = xAOD::EgammaParameters::unconvertedPhoton;
    }
    ATH_CHECK(m_clusterCorrectionTool->execute(
     ctx, cluster, egType, xAOD::EgammaHelpers::isBarrel(cluster)));
    cluster->setRawE(cluster->e());
    cluster->setRawEta(cluster->eta());
    cluster->setRawPhi(cluster->phi());
    //
    egammaClusterHelpers::fillPositionsInCalo(cluster, *mgr);
    //
    if (m_MVACalibSvc->execute(*cluster,
                   *eg).isFailure()) {
      ATH_MSG_ERROR("Problem executing MVA cluster tool");
    }
      }
    }
    CaloClusterStoreHelper::finalizeClusters(
      ctx,
      egcl_outputContainer,
      egcl_CellLinkContainer);
    rebuildLink(photons, egClusters, ctx);
    rebuildLink(electrons, egClusters, ctx);
    EMFourMomBuilder::calculate(electrons);
    EMFourMomBuilder::calculate(photons);
  }
 
  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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

getCorrection()

StatusCode egammaAODFixes::getCorrection ( const xAOD::Egamma * eg, float & aET, std::vector< float > & lECl ) const

private

Definition at line 310 of file egammaAODFixes.cxx.

                              {
 
  const xAOD::CaloCluster *clus = eg->caloCluster();
  egammaCellUtils::MaxECell maxECell(clus);
  if (maxECell.sc == StatusCode::FAILURE) {
    ATH_MSG_WARNING("Issues in finding maximum energy cell");
    return maxECell.sc;
  }
  IegammaCellRecoveryTool::Info info{};
  info.etamax = maxECell.etaCell;
  info.phimax = maxECell.phiCell;
  if (m_egammaCellRecoveryTool->execute(*clus,info).isFailure()) {
    ATH_MSG_WARNING("Issue trying to recover cells");
  }
  double aE2 = info.eCells[0];
  double aE3 = info.eCells[1];
  std::string type = (eg->type() == xAODType::Photon) ? "Photon " :
    ((eg->type() == xAODType::Electron) ? "Electron " : "Unknown ");
  ATH_MSG_VERBOSE(type << eg->index()
          << " added Energies in Layer 2 " << aE2 << " and 3 " << aE3
          << " cluster index = " << clus->index());
  double iceta = 1./std::cosh(clus->etaBE(2));
  aET = (aE2+aE3)*iceta;
  if (m_correctCluster) {
    getLayerE(info.addedCells, lE);
    ATH_MSG_VERBOSE("Per layer "
            << lE[0] << " " << lE[1] << " "
            << lE[2] << " " << lE[3]);
  }
  return StatusCode::SUCCESS;
}

getCorrectionC()

StatusCode egammaAODFixes::getCorrectionC ( const xAOD::Egamma * eg, float & aET, IegammaCellRecoveryTool::Info & info ) const

private

Definition at line 345 of file egammaAODFixes.cxx.

                                           {
 
  const xAOD::CaloCluster *clus = eg->caloCluster();
  egammaCellUtils::MaxECell maxECell(clus);
  if (maxECell.sc == StatusCode::FAILURE) {
    ATH_MSG_WARNING("Issues in finding maximum energy cell");
    return maxECell.sc;
  }
  info.etamax = maxECell.etaCell;
  info.phimax = maxECell.phiCell;
  if (m_egammaCellRecoveryTool->execute(*clus,info).isFailure()) {
    ATH_MSG_WARNING("Issue trying to recover cells");
  }
  double aE2 = info.eCells[0];
  double aE3 = info.eCells[1];
  std::string type = (eg->type() == xAODType::Photon) ? "Photon " :
    ((eg->type() == xAODType::Electron) ? "Electron " : "Unknown ");
  ATH_MSG_VERBOSE(type << eg->index()
          << " added Energies in Layer 2 " << aE2 << " and 3 " << aE3
          << " cluster index = " << clus->index());
  double iceta = 1./std::cosh(clus->etaBE(2));
  aET = (aE2+aE3)*iceta;
  return StatusCode::SUCCESS;
}

getLayerE()

void egammaAODFixes::getLayerE ( std::vector< const CaloCell * > & cells, std::vector< float > & lE ) const

private

Definition at line 374 of file egammaAODFixes.cxx.

{
  if (lE.size() != 4) {
    ATH_MSG_WARNING("The passed layer energies should have a size 4");
    lE.resize(4);
  }
  for (auto *cell : cells) {
    int layer = cell->caloDDE()->getSampling();
    if (layer == CaloSampling::EMB2)
      lE[0] += cell->e();
    else if (layer == CaloSampling::EMB3)
      lE[1] += cell->e();
    else if (layer == CaloSampling::EME2)
      lE[2] += cell->e();
    else if (layer == CaloSampling::EME3)
      lE[3] += cell->e();
  }
}

initialize()

StatusCode egammaAODFixes::initialize ( )

finaloverride

Definition at line 32 of file egammaAODFixes.cxx.

{
  // The main tool
  if (m_tpetcFix) {
    ATH_CHECK(m_egammaCellRecoveryTool.retrieve());
    // The calo cell need to be there
    ATH_CHECK(m_CaloCellsKey.initialize());
    if (m_correctCluster) {
      ATH_CHECK(m_egClusOutputKey.initialize());
      ATH_CHECK(m_egClusInputKey.initialize());
      ATH_CHECK(m_caloDetDescrMgrKey.initialize());
      ATH_CHECK(m_clusterCorrectionTool.retrieve());
      ATH_CHECK(m_MVACalibSvc.retrieve());
      ATH_CHECK(m_IsoLeakCorrectionTool.retrieve());
      m_egClusCellLinkOutputKey =
    m_egClusOutputKey.key() + "_links";
      ATH_CHECK(m_egClusCellLinkOutputKey.initialize());
    }
  }
 
  // the data handle keys
  ATH_CHECK(m_electronOutputKey.initialize());
  ATH_CHECK(m_electronInputKey.initialize());
  ATH_CHECK(m_photonOutputKey.initialize());
  ATH_CHECK(m_photonInputKey.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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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.

rebuildLink()

void egammaAODFixes::rebuildLink ( xAOD::EgammaContainer * egC, xAOD::CaloClusterContainer * egclC, const EventContext & ctx ) const

private

Definition at line 395 of file egammaAODFixes.cxx.

                                 {
 
  for (xAOD::Egamma *eg : *egContainer) {
 
    // link the new eg object (update for isolation)
    // to the new cluster (update for layer energies)
    ElementLink<xAOD::CaloClusterContainer> clusterLink(
      *egclContainer, eg->caloCluster()->index(), ctx);
    std::vector<ElementLink<xAOD::CaloClusterContainer>> egClustersLink{
      clusterLink };
    eg->setCaloClusterLinks(egClustersLink);
 
    // Also update the leakage correction
    // as it depends on the cluster LAr+PS energy
    for (auto t : { xAOD::Iso::topoetcone20, xAOD::Iso::topoetcone30,
                xAOD::Iso::topoetcone40 }) {
      if (!eg->setIsolationCaloCorrection(
          m_IsoLeakCorrectionTool->GetPtCorrection(*eg,t),
          t,xAOD::Iso::ptCorrection)) {
    ATH_MSG_WARNING("could not set leakage correction for isolation type"
            << xAOD::Iso::toCString(t) << " and object pT, eta = "
            << eg->pt() << "  " << eg->eta());
      }
    }
  }
 
}

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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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_ambiguityFix

Gaudi::Property<bool> egammaAODFixes::m_ambiguityFix

private

Initial value:

{this,
    "FixAmbiguityLinks", true,
    "Whether or not to fix the ambiguity links"}

correct ambiguity links ?

Definition at line 128 of file egammaAODFixes.h.

                                       {this,
    "FixAmbiguityLinks", true,
    "Whether or not to fix the ambiguity links"};

m_CaloCellsKey

SG::ReadHandleKey<CaloCellContainer> egammaAODFixes::m_CaloCellsKey

private

Initial value:

{this,
    "CaloCellsName", "AllCalo", "Name of calo cell container"}

Name of the calo cell container.

Definition at line 83 of file egammaAODFixes.h.

                                                      {this,
    "CaloCellsName", "AllCalo", "Name of calo cell container"};

m_caloDetDescrMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> egammaAODFixes::m_caloDetDescrMgrKey

private

Initial value:

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

Key for calo detector description manager.

Definition at line 107 of file egammaAODFixes.h.

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

m_clusterCorrectionTool

ToolHandle<IegammaSwTool> egammaAODFixes::m_clusterCorrectionTool

private

Initial value:

{ this,
    "ClusterCorrectionTool",
    "",
    "tool that applies cluster corrections" }

Tool to handle cluster corrections.

Definition at line 138 of file egammaAODFixes.h.

                                                     { this,
    "ClusterCorrectionTool",
    "",
    "tool that applies cluster corrections" };

m_correctCluster

Gaudi::Property<bool> egammaAODFixes::m_correctCluster

private

Initial value:

{this,
    "CorrectCluster", false,
    "Whether or not to correct the cluster"}

correct also layer energies ?

Definition at line 123 of file egammaAODFixes.h.

                                         {this,
    "CorrectCluster", false,
    "Whether or not to correct the cluster"};

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_egammaCellRecoveryTool

ToolHandle<IegammaCellRecoveryTool> egammaAODFixes::m_egammaCellRecoveryTool

private

Initial value:

{
      this,
    "egammaCellRecoveryTool",
    "egammaCellRecoveryTool/egammaCellRecoveryTool",
    "Tool that adds cells in L2 or L3 "
    "that could have been rejected by timing cut"
    }

Pointer to the egammaCellRecoveryTool.

Definition at line 114 of file egammaAODFixes.h.

                                                                {
      this,
    "egammaCellRecoveryTool",
    "egammaCellRecoveryTool/egammaCellRecoveryTool",
    "Tool that adds cells in L2 or L3 "
    "that could have been rejected by timing cut"
    };

m_egClusCellLinkOutputKey

SG::WriteHandleKey<CaloClusterCellLinkContainer> egammaAODFixes::m_egClusCellLinkOutputKey

private

Initial value:

{this,
       "DoNotSet_OutputClusterContainerLinks",
       "",
       "Key of the output cluster container cell links; Do not set! Name taken "
       "from associated container"
     }

Key of the output cluster container cell links: name taken from containter name; only dummy configurable.

Definition at line 99 of file egammaAODFixes.h.

                              {this,
       "DoNotSet_OutputClusterContainerLinks",
       "",
       "Key of the output cluster container cell links; Do not set! Name taken "
       "from associated container"
     };

m_egClusInputKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> egammaAODFixes::m_egClusInputKey

private

Initial value:

{this,
        "EGammaClustersInputName", "",
        "Name of egamma cluster container to be read in"}

Name of the egamma cluster input collection.

Definition at line 92 of file egammaAODFixes.h.

                                                               {this,
        "EGammaClustersInputName", "",
        "Name of egamma cluster container to be read in"};

m_egClusOutputKey

SG::WriteHandleKey<xAOD::CaloClusterContainer> egammaAODFixes::m_egClusOutputKey

private

Initial value:

{this,
        "EGammaClustersOutputName", "",
        "Name of egamma cluster container to be created"}

Name of the egamma cluster output collection.

Definition at line 87 of file egammaAODFixes.h.

                                                                 {this,
        "EGammaClustersOutputName", "",
        "Name of egamma cluster container to be created"};

m_electronInputKey

SG::ReadHandleKey<xAOD::ElectronContainer> egammaAODFixes::m_electronInputKey

private

Initial value:

{this,
        "ElectronInputName", "old_Electrons",
        "Name of electron container to be read in"}

Name of the electron input collection.

Definition at line 68 of file egammaAODFixes.h.

                                                              {this,
        "ElectronInputName", "old_Electrons",
        "Name of electron container to be read in"};

m_electronOutputKey

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

private

Initial value:

{this,
        "ElectronOutputName", "Electrons",
        "Name of electron container to be created"}

Name of the electron output collection.

Definition at line 63 of file egammaAODFixes.h.

                                                                {this,
        "ElectronOutputName", "Electrons",
        "Name of electron container to be created"};

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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_IsoLeakCorrectionTool

ToolHandle<CP::IIsolationCorrectionTool> egammaAODFixes::m_IsoLeakCorrectionTool

private

Initial value:

{this,
    "IsoLeakCorrectionTool", "",
    "Handle on the leakage correction tool"}

Handle to the isolation leakage correction tool.

Definition at line 150 of file egammaAODFixes.h.

                                                                   {this,
    "IsoLeakCorrectionTool", "",
    "Handle on the leakage correction tool"};

m_MVACalibSvc

ServiceHandle<IegammaMVASvc> egammaAODFixes::m_MVACalibSvc

private

Initial value:

{ this,
    "MVACalibSvc",
    "",
    "calibration service" }

Handle to the MVA calibration service.

Definition at line 144 of file egammaAODFixes.h.

                                              { this,
    "MVACalibSvc",
    "",
    "calibration service" };

m_photonInputKey

SG::ReadHandleKey<xAOD::PhotonContainer> egammaAODFixes::m_photonInputKey

private

Initial value:

{this,
        "PhotonInputName", "old_Photons",
        "Name of photon container to be read in"}

Name of the photon input collection.

Definition at line 78 of file egammaAODFixes.h.

                                                          {this,
        "PhotonInputName", "old_Photons",
        "Name of photon container to be read in"};

m_photonOutputKey

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

private

Initial value:

{this,
        "PhotonOutputName", "Photons",
        "Name of photon container to be created"}

Name of the photon output collection.

Definition at line 73 of file egammaAODFixes.h.

                                                            {this,
        "PhotonOutputName", "Photons",
        "Name of photon container to be created"};

m_tpetcFix

Gaudi::Property<bool> egammaAODFixes::m_tpetcFix

private

Initial value:

{this,
    "FixEGTopoetcone", true,
    "Whether or not to fix topoetcone variables"}

correct topoetcone isolation ?

Definition at line 133 of file egammaAODFixes.h.

                                   {this,
    "FixEGTopoetcone", true,
    "Whether or not to fix topoetcone variables"};

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:

• egammaAODFixes.h
• egammaAODFixes.cxx