egammaForwardBuilder Class Reference

Algorithm which makes a egammaObjectCollection for forward electrons. More...

#include <egammaForwardBuilder.h>

Inheritance diagram for egammaForwardBuilder:

Public Member Functions
	egammaForwardBuilder (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
	~egammaForwardBuilder ()=default
	Destructor.
virtual StatusCode	initialize () override final
	Initialize method.
virtual StatusCode	finalize () override final
	Finalize method.
virtual StatusCode	execute (const EventContext &ctx) const override final
	Execute method.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
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
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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.

Protected Attributes
ToolHandleArray< IAsgForwardElectronIsEMSelector >	m_forwardElectronIsEMSelectors
	Handle to the selectors.
ToolHandleArray< IAsgElectronLikelihoodTool >	m_forwardElectronNNSelectors
ToolHandle< IForwardElectronCalib >	m_forwardElectronpTCalib
Gaudi::Property< std::vector< std::string > >	m_forwardElectronIsEMSelectorResultNames
Gaudi::Property< std::vector< std::string > >	m_forwardElectronNNSelectorResultNames

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	RetrieveEMTrackMatchBuilder ()
StatusCode	ExecObjectQualityTool (const EventContext &ctx, xAOD::Egamma *eg) const
std::pair< unsigned int, float >	getnPVmu (const EventContext &ctx) const
void	setAllTrackCaloMatchValues (xAOD::Electron *el, const std::array< xAOD::EgammaParameters::TrackCaloMatchType, 4 > &match_parameters, const std::array< double, 4 > &match_values) const
	Convinience wrapper to set track match values in all samplings.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IegammaOQFlagsBuilder >	m_objectQualityTool
	Tool to perform object quality.
ToolHandle< IEMTrackMatchBuilder >	m_trackMatchBuilder
	Tool to perform track-cluster matching.
Gaudi::Property< bool >	m_doEnergyCal
	Private member flag to do energy calibration.
Gaudi::Property< bool >	m_dopTCal
	Private member flag to do pT calibration.
Gaudi::Property< bool >	m_fwdDNN
SG::ReadHandleKey< xAOD::VertexContainer >	m_pVtxKey
	Input primary vertices for fwd energy calibration.
SG::ReadHandleKey< xAOD::EventInfo >	m_eiKey
	Input EventInfo for fwd energy calibration.
ServiceHandle< IegammaMVASvc >	m_MVACalibSvc
	Handle to the MVA calibration service.
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_topoClusterKey
	Input topo cluster type.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloDetDescrMgrKey
	Calorimeter description.
SG::WriteHandleKey< xAOD::ElectronContainer >	m_electronOutputKey
	Output electron container.
SG::WriteHandleKey< xAOD::CaloClusterContainer >	m_outClusterContainerKey
	Output cluster container.
SG::WriteHandleKey< CaloClusterCellLinkContainer >	m_outClusterContainerCellLinkKey
	Output cluster container cell links: name taken from containter name.
Gaudi::Property< bool >	m_doTrackMatching
	Private member flag to do the track matching.
Gaudi::Property< bool >	m_doCookieCutting
	Private member flag to do cookie cutting.
Gaudi::Property< int >	m_maxDelEtaCells
	Size of maximum search window in eta.
Gaudi::Property< int >	m_maxDelPhiCells
	Size of maximum search window in phi.
Gaudi::Property< float >	m_maxDelR
	Size of cone to cookie cut on FCal.
Gaudi::Accumulators::Counter	m_AllClusters {}
Gaudi::Accumulators::Counter	m_MatchedClusters {}
egammaClusterCookieCut::CookieCutPars	m_CookieCutPars {}
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 which makes a egammaObjectCollection for forward electrons.

egammaForwardBuilder, is dedicated to the reconstruction and identification of electrons in the forward region of ATLAS (2.5<|eta|<4.9). In contrast to the softe and egamma builders the algorithm can use only the information from the calorimeters, as the tracking system is limited to |eta|<2.5, and the topological clusters (instead of SW clusters). The pre-selection and ID are done in the same algorithm. The variables used to discriminant between electron and hadrons are defined as the topo cluster moments or combination of them. This is done separately in two eta bins: the EMEC IW and the FCal using a cut based technic. The forward electron AUTHOR is 8.

Definition at line 65 of file egammaForwardBuilder.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

egammaForwardBuilder()

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

Constructor.

Definition at line 29 of file egammaForwardBuilder.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator)
{}

~egammaForwardBuilder()

egammaForwardBuilder::~egammaForwardBuilder ( )

default

Destructor.

Member Function Documentation

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

ExecObjectQualityTool()

StatusCode egammaForwardBuilder::ExecObjectQualityTool ( const EventContext & ctx, xAOD::Egamma * eg ) const

private

Definition at line 330 of file egammaForwardBuilder.cxx.

        {
  // Protection in case tool is not available return success as algorithm can run without it.
  if (!m_objectQualityTool.isEnabled()) { return StatusCode::SUCCESS; }
 
  return m_objectQualityTool->execute(ctx,*eg);
}

execute()

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

finaloverridevirtual

Execute method.

Definition at line 116 of file egammaForwardBuilder.cxx.

{
  // Create an egamma container and register it.
  SG::WriteHandle<xAOD::ElectronContainer> xaodFrwd(m_electronOutputKey, ctx);
  ATH_CHECK(xaodFrwd.record(
    std::make_unique<xAOD::ElectronContainer>(),
    std::make_unique<xAOD::ElectronAuxContainer>())
  );
 
  // Create the relevant cluster output and register it.
  SG::WriteHandle<xAOD::CaloClusterContainer> outClusterContainer(
    m_outClusterContainerKey,
    ctx
  );
 
  ATH_CHECK(CaloClusterStoreHelper::AddContainerWriteHandle(outClusterContainer));
  SG::WriteHandle<CaloClusterCellLinkContainer> outClusterContainerCellLink(
    m_outClusterContainerCellLinkKey,
    ctx
  );
 
  ATH_CHECK(outClusterContainerCellLink.record(
    std::make_unique<CaloClusterCellLinkContainer>())
  );
 
  // Topo cluster container.
  SG::ReadHandle<xAOD::CaloClusterContainer> inputClusters(m_topoClusterKey, ctx);
 
  // Check is only used for serial running, remove when MT scheduler used.
  ATH_CHECK(inputClusters.isValid());
 
  // Calorimeter description.
  SG::ReadCondHandle<CaloDetDescrManager> caloDetDescrMgrHandle{
    m_caloDetDescrMgrKey, ctx
  };
  ATH_CHECK(caloDetDescrMgrHandle.isValid());
  const CaloDetDescrManager* calodetdescrmgr = *caloDetDescrMgrHandle;
 
  static const SG::AuxElement::Accessor<
    std::vector<ElementLink<xAOD::CaloClusterContainer>>
  > caloClusterLinks("constituentClusterLinks");
 
  // Prepare to create clusters.
  EgammaRecContainer egammaRecsFwd;
  size_t origClusterIndex = 0;
 
  egammaMVACalib::GlobalEventInfo gei;
  if (m_doEnergyCal) {
    std::pair<float,float> nPVmu = this->getnPVmu(ctx);
    gei.nPV = nPVmu.first;
    gei.acmu = nPVmu.second;
    ATH_MSG_DEBUG("Retrieved nPV = " << gei.nPV << " and mu = " << gei.acmu);
  }
 
  // Loop over input cluster container and create egRecs to store the electrons.
  ATH_MSG_VERBOSE("Will run on " << inputClusters->size() << " input clusters, doing cookie cut ? " << m_doCookieCutting);
  for (const xAOD::CaloCluster* cluster : *inputClusters) {
 
    // Create links back to the original clusters.
    std::vector<ElementLink<xAOD::CaloClusterContainer>> constituentLinks;
 
    // The constituent links should contain a CaloCal cluster. When not running
    // in ITk mode this is the default for the forward clusters used by egamma
    // so no sister link is needed to get the CaloCal. When running in ITk mode
    // the clusters used are CaloTopoClusters so need to access the sister
    // cluster to maintain consistency.
    if (m_doTrackMatching) {
      ElementLink<xAOD::CaloClusterContainer> sisterCluster =
        cluster->getSisterClusterLink();
 
      if (sisterCluster) {
        constituentLinks.push_back(sisterCluster);
      } else {
        ATH_MSG_WARNING("No sister Link available");
      }
    } else {
      constituentLinks.emplace_back(*inputClusters, origClusterIndex, ctx);
    }
 
    const DataLink<CaloCellContainer>& cellCont =
      cluster->getCellLinks()->getCellContainerLink();
 
    // Create the new cluster.
    std::unique_ptr<xAOD::CaloCluster> newCluster =
      m_doCookieCutting ?
      egammaClusterCookieCut::cookieCut(*cluster, *calodetdescrmgr,
                    cellCont, m_CookieCutPars) :
        std::make_unique<xAOD::CaloCluster>(*cluster);
 
    if (!newCluster || newCluster->size() == 0) {
      ATH_MSG_DEBUG("Could not build a new cluster, or has 0 cell");
      continue;
    }
 
    if (m_doEnergyCal &&
    m_MVACalibSvc->execute(*newCluster, xAOD::EgammaParameters::forwardelectron, gei).isFailure())
      { ATH_MSG_ERROR("Problem executing MVA cluster tool for fwd electron"); }
 
    caloClusterLinks(*newCluster) = constituentLinks;
    outClusterContainer->push_back(std::move(newCluster));
 
    size_t index = outClusterContainer->size() - 1;
    const ElementLink<xAOD::CaloClusterContainer> clusterLink(*outClusterContainer, index, ctx);
    const std::vector<ElementLink<xAOD::CaloClusterContainer>> clusterLinkVector{clusterLink};
 
    // Now create the egamma Rec
    egammaRecsFwd.push_back(std::make_unique<egammaRec>(clusterLinkVector));
 
    ++origClusterIndex;
  }
 
  // Add track-cluster matching information if requested.
  if (m_doTrackMatching) {
    ATH_CHECK(m_trackMatchBuilder->executeRec(ctx, &egammaRecsFwd));
  }
 
  auto buff_AllClusters = m_AllClusters.buffer();
  auto buff_MatchedClusters = m_MatchedClusters.buffer();
 
  //Loop over the egamma Rec creating electrons
  for (const egammaRec* egRec : egammaRecsFwd) {
    if (!egRec) {
      return StatusCode::FAILURE;
    }
 
    ++buff_AllClusters;
 
    if (m_doTrackMatching && egRec->getNumberOfTrackParticles() == 0) {
      // Later we may want to use these for so called forward photons.
      ATH_MSG_DEBUG("EgammaRec without track particle");
      continue;
    }
 
    //common part
    xAOD::Electron* el = xaodFrwd->push_back(std::make_unique<xAOD::Electron>());
    el->setAuthor(xAOD::EgammaParameters::AuthorFwdElectron);
    el->setCaloClusterLinks(egRec->caloClusterElementLinks());
 
    // from here one, we need both track matching and
    // having tracks .
    if (m_doTrackMatching) {
 
      ++buff_MatchedClusters;
      el->setTrackParticleLinks(egRec->trackParticleElementLinks());
 
      const xAOD::TrackParticle* trackParticle = el->trackParticle();
      if (trackParticle) {
        el->setCharge(trackParticle->charge());
      } else {
        ATH_MSG_WARNING("Forward electron without track particle, whereas"
                        " corresponding egammaRec has at least one");
      }
 
      // Set DeltaEta, DeltaPhi, DeltaPhiRescaled.
      el->setTrackCaloMatchValues(
        egRec->deltaEta(),
        egRec->deltaPhi(),
        egRec->deltaPhiRescaled(),
        egRec->deltaPhiLast()
      );
    }
 
    EMFourMomBuilder::calculate(*el);
    ATH_CHECK(ExecObjectQualityTool(ctx, el));
 
    if (m_dopTCal)
      {
    double DNN_pT=m_forwardElectronpTCalib->calibrate(ctx,el);
    el->setPt(DNN_pT);
      }
    
    // Apply the Forward Electron selectors.
    for (size_t i = 0; i < m_forwardElectronIsEMSelectors.size(); ++i) {
      const auto selector = m_forwardElectronIsEMSelectors[i];
      const auto name = m_forwardElectronIsEMSelectorResultNames[i];
 
      // Save the bool result.
      const asg::AcceptData accept = selector->accept(ctx, el);
      el->setPassSelection(static_cast<bool>(accept), name);
 
      // Save the isem.
      el->setSelectionisEM(accept.getCutResultInverted(), "isEM" + name);
    }
 
    
 
    if (m_fwdDNN) { 
      // Apply the Forward Electron selectors.
      for (size_t i = 0; i < m_forwardElectronNNSelectors.size(); ++i) {
    const auto selector = m_forwardElectronNNSelectors[i];
    const auto name = m_forwardElectronNNSelectorResultNames[i];
    
    
    // Save the bool result.
    const asg::AcceptData accept = selector->accept(ctx, el);
    el->setPassSelection(static_cast<bool>(accept), "DNN"+name);
      }
      std::string LikeliHoodName = "DNN_Score";
      const auto selector = m_forwardElectronNNSelectors[0];
      float val=selector->calculate(ctx,el);
      el->setLikelihoodValue(val,LikeliHoodName);
    }
    
  }//end of loop over egammaRecs
  
  CaloClusterStoreHelper::finalizeClusters(
    ctx,
    outClusterContainer,
    outClusterContainerCellLink);
 
  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 & AthCommonAlgorithm< 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 89 of file AthCommonAlgorithm.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 AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

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

finalize()

StatusCode egammaForwardBuilder::finalize ( )

finaloverridevirtual

Finalize method.

Definition at line 105 of file egammaForwardBuilder.cxx.

{
 
  ATH_MSG_INFO("====> Forward Egamma Statistics =============");
  ATH_MSG_INFO(" All Clusters " << m_AllClusters);
  ATH_MSG_INFO(" Matched Clusters " << m_MatchedClusters);
  ATH_MSG_INFO("=============================================");
 
  return StatusCode::SUCCESS;
}

getnPVmu()

std::pair< unsigned int, float > egammaForwardBuilder::getnPVmu ( const EventContext & ctx ) const

private

Definition at line 361 of file egammaForwardBuilder.cxx.

                                 {
  unsigned int npv(0);
  float mu(0);
 
  SG::ReadHandle<xAOD::VertexContainer> vtxCont(m_pVtxKey, ctx);
  if (!vtxCont.isValid()) {
    ATH_MSG_WARNING("Cannot find " << m_pVtxKey.key()
            << " container, returning nPV = 0");
  } else {
    for (const auto *vtx : *vtxCont) {
      if (vtx->vertexType() == xAOD::VxType::PriVtx ||
      vtx->vertexType() == xAOD::VxType::PileUp) { ++npv; }
    }
  }
 
  SG::ReadHandle<xAOD::EventInfo> eiCont(m_eiKey, ctx);
  if (!eiCont.isValid()) {
    ATH_MSG_WARNING("Cannot find " << m_eiKey.key() << " returning mu = 0");
  } else {
    mu = eiCont.get()->actualInteractionsPerCrossing();
  }
 
  return std::make_pair(npv,mu);
}

initialize()

StatusCode egammaForwardBuilder::initialize ( )

finaloverridevirtual

Initialize method.

Definition at line 34 of file egammaForwardBuilder.cxx.

{
  m_CookieCutPars.maxDelEta = m_maxDelEtaCells * cellEtaSize * 0.5;
  m_CookieCutPars.maxDelPhi = m_maxDelPhiCells * cellPhiSize * 0.5;
  m_CookieCutPars.maxDelR2  = m_maxDelR * m_maxDelR; // Square now to avoid a slow sqrt later.
 
  // The data handle keys.
  ATH_CHECK(m_topoClusterKey.initialize());
  ATH_CHECK(m_caloDetDescrMgrKey.initialize());
  ATH_CHECK(m_electronOutputKey.initialize());
  ATH_CHECK(m_outClusterContainerKey.initialize());
  if (m_outClusterContainerCellLinkKey.key().empty()) {
    m_outClusterContainerCellLinkKey = m_outClusterContainerKey.key() + "_links";
  }
  ATH_CHECK(m_outClusterContainerCellLinkKey.initialize());
 
  // Retrieve object quality tool.
  if (!m_objectQualityTool.empty()) {
    ATH_CHECK(m_objectQualityTool.retrieve());
  }
 
  else {
    m_objectQualityTool.disable();
  }
 
  ATH_CHECK(m_forwardElectronIsEMSelectors.retrieve());
  
  if (
      m_forwardElectronIsEMSelectors.size() !=
      m_forwardElectronIsEMSelectorResultNames.size()
      ) {
    ATH_MSG_ERROR(
          "Number of selectors doesn't match number of given fwd-electron selector names"
          );
    
    return StatusCode::FAILURE;
  }
  if (m_fwdDNN) {
    ATH_CHECK(m_forwardElectronNNSelectors.retrieve());
    
    if (
    m_forwardElectronNNSelectors.size() !=
    m_forwardElectronNNSelectorResultNames.size()
    ) {
      ATH_MSG_ERROR(
            "Number of selectors doesn't match number of given fwd-electron NN selector names"
            );
      
      return StatusCode::FAILURE;
    }
  }
 
  // Retrieve track match builder.
  ATH_CHECK(RetrieveEMTrackMatchBuilder());
 
  // Retrive MVA energy calibration
  if (m_doEnergyCal) {
    ATH_CHECK(m_pVtxKey.initialize());
    ATH_CHECK(m_eiKey.initialize());
    ATH_CHECK(m_MVACalibSvc.retrieve());
  }
 
  if (m_dopTCal) {
    ATH_CHECK(m_forwardElectronpTCalib.retrieve());
  }
  
  ATH_MSG_DEBUG("Initialization completed successfully");
 
  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()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, 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, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

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

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

RetrieveEMTrackMatchBuilder()

StatusCode egammaForwardBuilder::RetrieveEMTrackMatchBuilder ( )

private

Definition at line 341 of file egammaForwardBuilder.cxx.

{
  if (!m_doTrackMatching) {
    m_trackMatchBuilder.disable();
    return StatusCode::SUCCESS;
  }
 
  if (m_trackMatchBuilder.empty()) {
    ATH_MSG_ERROR("EMTrackMatchBuilder is empty, but track matching is enabled");
    return StatusCode::FAILURE;
  }
 
  if (m_trackMatchBuilder.retrieve().isFailure()) {
    ATH_MSG_ERROR("Unable to retrieve " << m_trackMatchBuilder);
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

setAllTrackCaloMatchValues()

void egammaForwardBuilder::setAllTrackCaloMatchValues ( xAOD::Electron * el, const std::array< xAOD::EgammaParameters::TrackCaloMatchType, 4 > & match_parameters, const std::array< double, 4 > & match_values ) const

private

Convinience wrapper to set track match values in all samplings.

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

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

sysExecute()

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

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< 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 AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.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_AllClusters

Gaudi::Accumulators::Counter egammaForwardBuilder::m_AllClusters {}

mutableprivate

Definition at line 236 of file egammaForwardBuilder.h.

{};

m_caloDetDescrMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> egammaForwardBuilder::m_caloDetDescrMgrKey

private

Initial value:

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

Calorimeter description.

Definition at line 167 of file egammaForwardBuilder.h.

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

m_CookieCutPars

egammaClusterCookieCut::CookieCutPars egammaForwardBuilder::m_CookieCutPars {}

private

Definition at line 239 of file egammaForwardBuilder.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_doCookieCutting

Gaudi::Property<bool> egammaForwardBuilder::m_doCookieCutting

private

Initial value:

{
    this,
    "doCookieCutting",
    false,
    "Boolean to do cookie cutting"
  }

Private member flag to do cookie cutting.

Definition at line 205 of file egammaForwardBuilder.h.

                                        {
    this,
    "doCookieCutting",
    false,
    "Boolean to do cookie cutting"
  };

m_doEnergyCal

Gaudi::Property<bool> egammaForwardBuilder::m_doEnergyCal

private

Initial value:

{
    this,
    "doEnergyCal",
    false,
    "Boolean to do energy calibration"
  }

Private member flag to do energy calibration.

Definition at line 113 of file egammaForwardBuilder.h.

                                    {
    this,
    "doEnergyCal",
    false,
    "Boolean to do energy calibration"
  };

m_dopTCal

Gaudi::Property<bool> egammaForwardBuilder::m_dopTCal

private

Initial value:

{
    this,
    "dopTCal",
    false,
    "Boolean to do pT calibration"
  }

Private member flag to do pT calibration.

Definition at line 122 of file egammaForwardBuilder.h.

                                {
    this,
    "dopTCal",
    false,
    "Boolean to do pT calibration"
  };

m_doTrackMatching

Gaudi::Property<bool> egammaForwardBuilder::m_doTrackMatching

private

Initial value:

{
    this,
    "doTrackMatching",
    false,
    "Boolean to do track matching"
  }

Private member flag to do the track matching.

Definition at line 197 of file egammaForwardBuilder.h.

                                        {
    this,
    "doTrackMatching",
    false,
    "Boolean to do track matching"
  };

m_eiKey

SG::ReadHandleKey<xAOD::EventInfo> egammaForwardBuilder::m_eiKey

private

Initial value:

{
    this,
    "EventInfoKey",
    "",
    "Name of the EventInfo object" }

Input EventInfo for fwd energy calibration.

Definition at line 145 of file egammaForwardBuilder.h.

                                        {
    this,
    "EventInfoKey",
    "",
    "Name of the EventInfo object" };

m_electronOutputKey

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

private

Initial value:

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

Output electron container.

Definition at line 175 of file egammaForwardBuilder.h.

                                                             {
    this,
    "ElectronOutputName",
    "",
    "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 AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_forwardElectronIsEMSelectorResultNames

Gaudi::Property<std::vector<std::string> > egammaForwardBuilder::m_forwardElectronIsEMSelectorResultNames

protected

Initial value:

{
    this,
    "forwardelectronIsEMselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 266 of file egammaForwardBuilder.h.

                                                                               {
    this,
    "forwardelectronIsEMselectorResultNames",
    {},
    "The selector result names"
  };

m_forwardElectronIsEMSelectors

ToolHandleArray<IAsgForwardElectronIsEMSelector> egammaForwardBuilder::m_forwardElectronIsEMSelectors

protected

Initial value:

{
    this,
    "forwardelectronIsEMselectors",
    {},
    "The selectors that we need to apply to the FwdElectron object"
  }

Handle to the selectors.

Definition at line 243 of file egammaForwardBuilder.h.

                                                                                  {
    this,
    "forwardelectronIsEMselectors",
    {},
    "The selectors that we need to apply to the FwdElectron object"
  };

m_forwardElectronNNSelectorResultNames

Gaudi::Property<std::vector<std::string> > egammaForwardBuilder::m_forwardElectronNNSelectorResultNames

protected

Initial value:

{
    this,
    "forwardelectronNNselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 273 of file egammaForwardBuilder.h.

                                                                             {
    this,
    "forwardelectronNNselectorResultNames",
    {},
    "The selector result names"
  };

m_forwardElectronNNSelectors

ToolHandleArray<IAsgElectronLikelihoodTool> egammaForwardBuilder::m_forwardElectronNNSelectors

protected

Initial value:

{
    this,
    "forwardelectronNNselectors",
    {},
    "The selectors that we need to apply to the FwdElectron object"
  }

Definition at line 250 of file egammaForwardBuilder.h.

                                                                           {
    this,
    "forwardelectronNNselectors",
    {},
    "The selectors that we need to apply to the FwdElectron object"
  };

m_forwardElectronpTCalib

ToolHandle<IForwardElectronCalib> egammaForwardBuilder::m_forwardElectronpTCalib

protected

Initial value:

{
    this,
    "forwardelectronNNCalib",
    {},
    "The tool that we need to calibrate the pT of the FwdElectron object"
  }

Definition at line 258 of file egammaForwardBuilder.h.

                                                             {
    this,
    "forwardelectronNNCalib",
    {},
    "The tool that we need to calibrate the pT of the FwdElectron object"
  };

m_fwdDNN

Gaudi::Property<bool> egammaForwardBuilder::m_fwdDNN

private

Initial value:

{
    this,
    "dofwdDNN",
    false,
    "Boolean to do forward DNN identification"
  }

Definition at line 129 of file egammaForwardBuilder.h.

                               {
    this,
    "dofwdDNN",
    false,
    "Boolean to do forward DNN identification"
  };

m_MatchedClusters

Gaudi::Accumulators::Counter egammaForwardBuilder::m_MatchedClusters {}

mutableprivate

Definition at line 237 of file egammaForwardBuilder.h.

{};

m_maxDelEtaCells

Gaudi::Property<int> egammaForwardBuilder::m_maxDelEtaCells

private

Initial value:

{
    this,
    "MaxWindowDelEtaCells",
    3,
    "Size of maximum search window in eta"
  }

Size of maximum search window in eta.

Definition at line 213 of file egammaForwardBuilder.h.

                                     {
    this,
    "MaxWindowDelEtaCells",
    3,
    "Size of maximum search window in eta"
  };

m_maxDelPhiCells

Gaudi::Property<int> egammaForwardBuilder::m_maxDelPhiCells

private

Initial value:

{
    this,
    "MaxWindowDelPhiCells",
    3,
    "Size of maximum search window in phi"
  }

Size of maximum search window in phi.

Definition at line 221 of file egammaForwardBuilder.h.

                                     {
    this,
    "MaxWindowDelPhiCells",
    3,
    "Size of maximum search window in phi"
  };

m_maxDelR

Gaudi::Property<float> egammaForwardBuilder::m_maxDelR

private

Initial value:

{
    this,
    "MaxWindowDelR",
    0.3,
    "Cone size to collect cells around hottest-cell FCAL"
  }

Size of cone to cookie cut on FCal.

Definition at line 229 of file egammaForwardBuilder.h.

                                {
    this,
    "MaxWindowDelR",
    0.3,
    "Cone size to collect cells around hottest-cell FCAL"
  };

m_MVACalibSvc

ServiceHandle<IegammaMVASvc> egammaForwardBuilder::m_MVACalibSvc

private

Initial value:

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

Handle to the MVA calibration service.

Definition at line 152 of file egammaForwardBuilder.h.

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

m_objectQualityTool

ToolHandle<IegammaOQFlagsBuilder> egammaForwardBuilder::m_objectQualityTool

private

Initial value:

{
    this,
    "ObjectQualityTool",
    "",
    "Name of the object quality tool (empty tool name ignored)"
  }

Tool to perform object quality.

Definition at line 97 of file egammaForwardBuilder.h.

                                                       {
    this,
    "ObjectQualityTool",
    "",
    "Name of the object quality tool (empty tool name ignored)"
  };

m_outClusterContainerCellLinkKey

SG::WriteHandleKey<CaloClusterCellLinkContainer> egammaForwardBuilder::m_outClusterContainerCellLinkKey

private

Initial value:

{
    this,
    "ClusterContainerLinks", "",
    "Key of the output cluster container cell links; Taken from associated container"}

Output cluster container cell links: name taken from containter name.

Definition at line 191 of file egammaForwardBuilder.h.

                                                                                 {
    this,
    "ClusterContainerLinks", "",
    "Key of the output cluster container cell links; Taken from associated container"};

m_outClusterContainerKey

SG::WriteHandleKey<xAOD::CaloClusterContainer> egammaForwardBuilder::m_outClusterContainerKey

private

Initial value:

{
    this,
    "ClusterContainerName",
    ""
    "Name of the output EM cluster container"
  }

Output cluster container.

Definition at line 183 of file egammaForwardBuilder.h.

                                                                     {
    this,
    "ClusterContainerName",
    ""
    "Name of the output EM cluster container"
  };

m_pVtxKey

SG::ReadHandleKey<xAOD::VertexContainer> egammaForwardBuilder::m_pVtxKey

private

Initial value:

{
    this,
    "PrimaryVerticesContainerKey",
    "",
    "Name of the primary vertex container" }

Input primary vertices for fwd energy calibration.

Definition at line 138 of file egammaForwardBuilder.h.

                                                {
    this,
    "PrimaryVerticesContainerKey",
    "",
    "Name of the primary vertex container" };

m_topoClusterKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> egammaForwardBuilder::m_topoClusterKey

private

Initial value:

{
    this,
    "TopoClusterName",
    "",
    "Name of the input cluster collection"
  }

Input topo cluster type.

Definition at line 159 of file egammaForwardBuilder.h.

                                                            {
    this,
    "TopoClusterName",
    "",
    "Name of the input cluster collection"
  };

m_trackMatchBuilder

ToolHandle<IEMTrackMatchBuilder> egammaForwardBuilder::m_trackMatchBuilder

private

Initial value:

{
    this,
    "TrackMatchBuilderTool",
    "EMTrackMatchBuilder",
    "Tool that matches tracks to egammaRecs (Fwd)"
  }

Tool to perform track-cluster matching.

Definition at line 105 of file egammaForwardBuilder.h.

                                                      {
    this,
    "TrackMatchBuilderTool",
    "EMTrackMatchBuilder",
    "Tool that matches tracks to egammaRecs (Fwd)"
  };

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:

• egammaForwardBuilder.h
• egammaForwardBuilder.cxx