This is the algorithm, which inherits from AthReentrantAlgorithm, that adds element links between particle flow objects (Flow Elements) and Egamma objects. More...

#include <PFEGamFlowElementAssoc.h>

Inheritance diagram for PFEGamFlowElementAssoc:

Collaboration diagram for PFEGamFlowElementAssoc:

Public Member Functions
	PFEGamFlowElementAssoc (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~PFEGamFlowElementAssoc ()
virtual StatusCode	initialize ()
virtual StatusCode	execute (const EventContext &ctx) const
	This algorithm does the following: 1) Read the Input containers for Flow Elements, Electrons and Photons 2) Match the Clusters in the flow elements to the relevant E/Photon clusters (Neutral) or match tracks to relevant Electron/Photon tracks (Charged) 3) Link them 4) output the Electron/Photon containers with the linkers to the Flow element containers.
virtual StatusCode	finalize ()
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::ElectronContainer >	m_electronReadHandleKey {this,"ElectronContainer","Electrons","ReadHandleKey for ElectronContainer"}
SG::ReadHandleKey< xAOD::PhotonContainer >	m_photonReadHandleKey {this,"PhotonContainer","Photons","ReadHandleKey for PhotonContainer"}
SG::ReadHandleKey< xAOD::FlowElementContainer >	m_neutralFEReadHandleKey {this,"JetEtMissNeutralFlowElementContainer","JetETMissNeutralParticleFlowObjects","ReadHandleKey for neutral FlowElements"}
SG::ReadHandleKey< xAOD::FlowElementContainer >	m_chargedFEReadHandleKey {this,"JetEtMissChargedFlowElementContainer","JetETMissChargedParticleFlowObjects","ReadHandleKey for charged FlowElements"}
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_electronNeutralFEWriteDecorKey {this,"ElectronNeutralFEDecorKey",m_electronReadHandleKey,"neutralFELinks","Output key for electron link to neutral FE"}
	The write key for adding Neutral Flow Element element link decorations to electrons.
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_electronChargedFEWriteDecorKey {this,"ElectronChargedFEDecorKey",m_electronReadHandleKey,"chargedFELinks","Output key for electron link to charged FE"}
	The write key for adding Charged Flow Element element link decorations to electrons.
SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_neutralFEElectronWriteDecorKey {this,"NeutralFEElectronDecorKey",m_neutralFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"}
	The write key for adding electron element link decorations to Neutral Flow Elements.
SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_chargedFEElectronWriteDecorKey {this,"ChargedFEElectronDecorKey",m_chargedFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"}
	The write key for adding electron element link decorations to Charged Flow Elements.
SG::WriteDecorHandleKey< xAOD::PhotonContainer >	m_photonNeutralFEWriteDecorKey {this,"PhotonNeutralFEDecorKey",m_photonReadHandleKey,"neutralFELinks","Output key for photon link to neutral FE"}
	The write key for adding Neutral Flow Element element link decorations to photons.
SG::WriteDecorHandleKey< xAOD::PhotonContainer >	m_photonChargedFEWriteDecorKey {this,"PhotonChargedFEDecorKey",m_photonReadHandleKey,"chargedFELinks","Output key for photon link to charged FE"}
	The write key for adding Charged Flow Element element link decorations to photons.
SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_neutralFEPhotonWriteDecorKey {this,"NeutralFEPhotonDecorKey",m_neutralFEReadHandleKey,"FE_PhotonLinks","Output key for link from neutral FE to photon"}
	The write key for adding photon element link decorations to Neutral Flow Elements.
SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_chargedFEPhotonWriteDecorKey {this,"ChargedFEPhotonDecorKey",m_chargedFEReadHandleKey,"FE_PhotonLinks","Output key for link from charged FE to photon"}
	The write key for adding photon element link decorations to Charged Flow Elements.
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

This is the algorithm, which inherits from AthReentrantAlgorithm, that adds element links between particle flow objects (Flow Elements) and Egamma objects.

The algorithm associates charged (c) Flow Elements to all electron and converted photon tracks, and neutral (n) Flow Elements to all electron and photon clusters.

This is done by adding decorations to the "Electron" and "Photon" container, for charged Charged Flow Elements and Neutral Flow Elements separately, in the form of vectors of element links to the associated Flow Elements. The algorithm also adds decorations to the "JetETMissNeutralFlowElements" and "JetETMissChargedParticleFlowElements" containers, in the form of vectors of element links to the associated electrons and photons.

Definition at line 34 of file PFEGamFlowElementAssoc.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

◆ PFEGamFlowElementAssoc()

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

Definition at line 23 of file PFEGamFlowElementAssoc.cxx.

                            :
  AthReentrantAlgorithm(name,pSvcLocator)
{
}

◆ ~PFEGamFlowElementAssoc()

PFEGamFlowElementAssoc::~PFEGamFlowElementAssoc ( )

virtualdefault

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.

95{ return m_detStore; }

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

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

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

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

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

virtual

This algorithm does the following: 1) Read the Input containers for Flow Elements, Electrons and Photons 2) Match the Clusters in the flow elements to the relevant E/Photon clusters (Neutral) or match tracks to relevant Electron/Photon tracks (Charged) 3) Link them 4) output the Electron/Photon containers with the linkers to the Flow element containers.

Definition at line 68 of file PFEGamFlowElementAssoc.cxx.

{
  // write decoration handles for the electron, photon and FE containers -- these are the OUTPUT handles
  //Electron Write Handle
  ATH_MSG_VERBOSE("Exec start");  
  SG::WriteDecorHandle<xAOD::ElectronContainer, std::vector<FlowElementLink_t> > electronNeutralFEWriteDecorHandle (m_electronNeutralFEWriteDecorKey,ctx);   
  SG::WriteDecorHandle<xAOD::ElectronContainer, std::vector<FlowElementLink_t> > electronChargedFEWriteDecorHandle (m_electronChargedFEWriteDecorKey,ctx);   
  SG::WriteDecorHandle<xAOD::FlowElementContainer, std::vector<ElectronLink_t> > neutralFEElectronWriteDecorHandle (m_neutralFEElectronWriteDecorKey,ctx);   
  SG::WriteDecorHandle<xAOD::FlowElementContainer, std::vector<ElectronLink_t> > chargedFEElectronWriteDecorHandle (m_chargedFEElectronWriteDecorKey,ctx); 
  ATH_MSG_VERBOSE("Defined Electron writehandles");
  //Photon Write Handle
  SG::WriteDecorHandle<xAOD::PhotonContainer, std::vector<FlowElementLink_t> > photonNeutralFEWriteDecorHandle (m_photonNeutralFEWriteDecorKey,ctx);
  SG::WriteDecorHandle<xAOD::PhotonContainer, std::vector<FlowElementLink_t> > photonChargedFEWriteDecorHandle (m_photonChargedFEWriteDecorKey,ctx);
  SG::WriteDecorHandle<xAOD::FlowElementContainer, std::vector<PhotonLink_t> > neutralFEPhotonWriteDecorHandle (m_neutralFEPhotonWriteDecorKey,ctx);
  SG::WriteDecorHandle<xAOD::FlowElementContainer, std::vector<PhotonLink_t> > chargedFEPhotonWriteDecorHandle (m_chargedFEPhotonWriteDecorKey,ctx);  
  ATH_MSG_VERBOSE("Defined Photon WriteHandles");
  
  // This is the READ handles (so the input containers for electron, photon, FE)
  
  SG::ReadHandle<xAOD::ElectronContainer>electronReadHandle (m_electronReadHandleKey,ctx);
  SG::ReadHandle<xAOD::PhotonContainer> photonReadHandle (m_photonReadHandleKey,ctx);
  
  // Charged and Neutral PFlow "Flow elements"
  SG::ReadHandle<xAOD::FlowElementContainer> neutralFEReadHandle (m_neutralFEReadHandleKey,ctx);   
  SG::ReadHandle<xAOD::FlowElementContainer> chargedFEReadHandle (m_chargedFEReadHandleKey,ctx);   
  ATH_MSG_VERBOSE("Defined ReadHandles");
  // now initialise some Flow element link containers
  std::vector<std::vector<FlowElementLink_t>> electronNeutralFEVec(electronReadHandle->size());
  std::vector<std::vector<FlowElementLink_t>> electronChargedFEVec(electronReadHandle->size());
  
  std::vector<std::vector<FlowElementLink_t>> photonNeutralFEVec(photonReadHandle->size());
  std::vector<std::vector<FlowElementLink_t>> photonChargedFEVec(photonReadHandle->size());
  ATH_MSG_VERBOSE("Finished runtime init");
  
  // Loop over neutral flow elements (FEs)
  for (const xAOD::FlowElement* FE: *neutralFEElectronWriteDecorHandle){
    // init the links
    std::vector<ElectronLink_t> FEElectronLinks;
    std::vector<PhotonLink_t> FEPhotonLinks;
 
    //nullptr catch for removed NFE clusters - only comes up if using AOD where the alg might have some skimmed components
    if(FE->otherObjects().empty() || FE->otherObjects().at(0)==nullptr){
      neutralFEElectronWriteDecorHandle(*FE)=FEElectronLinks;
      neutralFEPhotonWriteDecorHandle(*FE)=FEPhotonLinks;
      continue;
    }  
 
    //Obtain the index of the FE calo-cluster    
    size_t FEClusterIndex=FE->otherObjects().at(0)->index();
    double FE_cluster_E=FE->otherObjects().at(0)->p4().E();
    bool neg_E_cluster=(FE_cluster_E<0);
    
    //Loop over electrons:
 
    for (const xAOD::Electron* electron: *electronNeutralFEWriteDecorHandle){
      // get the calo clusters from the electron
      ATH_MSG_VERBOSE("NFE: start el loop");
      const std::vector<const xAOD::CaloCluster*> electronTopoClusters = xAOD::EgammaHelpers::getAssociatedTopoClusters(electron->caloCluster());
      ATH_MSG_VERBOSE("NFE: got calo clusters");
      
      for(const xAOD::CaloCluster* cluster : electronTopoClusters){
    // obtain the index of the electron seed topocluster
    size_t electronClusterIndex=cluster->index();   
    //match the indices: Cluster match between Flow Element (FE) and electron
    if(electronClusterIndex==FEClusterIndex){
      FEElectronLinks.emplace_back(*electronReadHandle,electron->index() );
      //Add Flow Element (FE) link to a vector
      //index() is the unique index of the Flow Element in the container
      electronNeutralFEVec.at(electron->index()).emplace_back(*neutralFEReadHandle, FE->index() );
      if(neg_E_cluster){
        ATH_MSG_ERROR("Negative energy cluster found and matched to electron");
        ATH_MSG_ERROR("Cluster Energy: "<<FE_cluster_E<<"");
      }
    }// end of matching block
 
      } // end loop over cluster
      
    } // end Electron loop
    ATH_MSG_VERBOSE("NFE: Electron loop finished");
    // now loop over photons
    for (const xAOD::Photon* photon: *photonNeutralFEWriteDecorHandle){
      // retrieve clusters from the photon container
      const std::vector<const xAOD::CaloCluster*> photonTopoClusters = xAOD::EgammaHelpers::getAssociatedTopoClusters(photon->caloCluster());
      //loop over clusters, and do the matching
      for (const xAOD::CaloCluster* cluster: photonTopoClusters){
    //retrieve index of the cluster
    size_t photonClusterIndex=cluster->index();
    //do the matching
    if(photonClusterIndex==FEClusterIndex){
      // Add flow element (FE) links to photon
      FEPhotonLinks.emplace_back(*photonReadHandle,photon->index() );
      //Add Flow Element (FE) link to a vector
      //index() is the unique index of the Flow Element in the container
      photonNeutralFEVec.at(photon->index()).emplace_back(*neutralFEReadHandle, FE->index() );      
 
      if(neg_E_cluster){
        ATH_MSG_ERROR("Negative energy cluster found and matched to photon");
        ATH_MSG_ERROR("Cluster Energy: "<<FE_cluster_E<<"");
      }
    }// end of matching block
      } // end of neutral loop
 
 
    }// end of photon loop
    ATH_MSG_VERBOSE("NFE: Photon Loop complete");      
    //Add vector of electron element links as decoration to FlowElement container
    neutralFEElectronWriteDecorHandle(*FE)=FEElectronLinks;
    neutralFEPhotonWriteDecorHandle(*FE)=FEPhotonLinks;
    ATH_MSG_VERBOSE("NFE::WriteHandle mapping");
  } // end neutral FE loop
  ATH_MSG_VERBOSE("NFE: Loop finished");
  //             Loop over charged Flow Elements (FEs)
  for (const xAOD::FlowElement* FE: *chargedFEElectronWriteDecorHandle){
    // Initialise a vector of element links to electrons/Photons
    std::vector<ElectronLink_t> FEElectronLinks;
    std::vector<PhotonLink_t> FEPhotonLinks;
 
    // Charged Flow Element catch for a case where there are removed tracks - should only apply if running from AOD
    if(FE->chargedObjects().empty() || FE->chargedObjects().at(0)==nullptr){
      chargedFEElectronWriteDecorHandle (*FE) = FEElectronLinks;  
      chargedFEPhotonWriteDecorHandle (*FE) = FEPhotonLinks;
      continue;
    }
    // retrieve the track from the Flow element
    size_t FETrackIndex=FE->chargedObjects().at(0)->index();
 
    //loop over electrons
    for (const xAOD::Electron* electron: *electronChargedFEWriteDecorHandle){
      //obtain the clusters
      const std::vector<const xAOD::TrackParticle*> electronTrackParticles = xAOD::EgammaHelpers::getTrackParticlesVec(electron, true, true); // useBremAssoc = true (get original non-GSF track), allParticles = true (include all track particles)
      // loop over tracks
      for (const xAOD::TrackParticle* electronTrack: electronTrackParticles){
    size_t electronTrackIndex = electronTrack->index();
 
    //link to FE if track indices match
    if(electronTrackIndex==FETrackIndex){
      // Add electron element link to a vector 
      // index() is the unique index of the electron in the electron container 
      FEElectronLinks.emplace_back(*electronReadHandle, electron->index() );
      // Add FE element link to a vector 
      // index() is the unique index of the cFE in the cFE container 
      electronChargedFEVec.at(electron->index()).emplace_back(*chargedFEReadHandle, FE->index() );
    }//end of matching block
     
      }//end of loop on clusters
    } // end of loop on electrons
    
    for(const xAOD::Photon* photon: *photonChargedFEWriteDecorHandle){
      //obtain indices of the converted photon's original tracks
      const std::set<const xAOD::TrackParticle*> photonTrackParticles = xAOD::EgammaHelpers::getTrackParticles(photon, true);
      // loop over the tracks
      for (const xAOD::TrackParticle* photonTrack: photonTrackParticles){
    size_t photonTrackIndex=photonTrack->index();
    
    // Link the photon to the Flow Element (FE) if the track indices match
    if (photonTrackIndex==FETrackIndex){
      // Add photon element link to a vector
          // index() is the unique index of the photon in the photon container
          FEPhotonLinks.emplace_back(*photonReadHandle, photon->index() );
          // Add FE element link to a vector
          // index() is the unique index of the cFE in the cFE container
          photonChargedFEVec.at(photon->index()).emplace_back(*chargedFEReadHandle, FE->index() );
    }// end of matching block
 
      }// end of loop on tracks
      
    }//end of loop on photons
 
 
    // Add vector of electron element links as decoration to FE container     
    chargedFEElectronWriteDecorHandle (*FE) = FEElectronLinks;  
    // Add vector of photon element links as decoration to FE container
    chargedFEPhotonWriteDecorHandle (*FE) = FEPhotonLinks;
 
  } // end of charged FE loop
  
 
  //   WRITE OUTPUT: ADD HANDLES TO EL/PHOT CONTAINERS
  // Add the vectors of the Flow Element (FE) Links as decorations to the electron container
  for (const xAOD::Electron* electron : *electronNeutralFEWriteDecorHandle){
    electronNeutralFEWriteDecorHandle (*electron) = electronNeutralFEVec.at(electron->index());
    electronChargedFEWriteDecorHandle (*electron) = electronChargedFEVec.at(electron->index());
  } //end of photon loop
  // Add the vectors of the Flow Element (FE) Links as decorations to the photon container
  for (const xAOD::Photon* photon: *photonNeutralFEWriteDecorHandle){
    photonNeutralFEWriteDecorHandle (*photon) = photonNeutralFEVec.at(photon->index());
    photonChargedFEWriteDecorHandle (*photon) = photonChargedFEVec.at(photon->index());
  } // end of loop on photons
 
  ATH_MSG_VERBOSE("Execute completed successfully");
 
  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();
  }

◆ finalize()

StatusCode PFEGamFlowElementAssoc::finalize ( )

virtual

Definition at line 58 of file PFEGamFlowElementAssoc.cxx.

                                           {
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode PFEGamFlowElementAssoc::initialize ( )

virtual

Definition at line 34 of file PFEGamFlowElementAssoc.cxx.

{
  ATH_MSG_VERBOSE("Initializing "<<name() << "...");
  ATH_CHECK(m_electronNeutralFEWriteDecorKey.initialize());   
  ATH_CHECK(m_electronChargedFEWriteDecorKey.initialize());   
  ATH_CHECK(m_neutralFEElectronWriteDecorKey.initialize());   
  ATH_CHECK(m_chargedFEElectronWriteDecorKey.initialize());  
  
  ATH_CHECK(m_photonNeutralFEWriteDecorKey.initialize());
  ATH_CHECK(m_photonChargedFEWriteDecorKey.initialize());
  ATH_CHECK(m_neutralFEPhotonWriteDecorKey.initialize());
  ATH_CHECK(m_chargedFEPhotonWriteDecorKey.initialize());
  
  //Init ReadHandleKeys
  ATH_CHECK(m_photonReadHandleKey.initialize());
  ATH_CHECK(m_electronReadHandleKey.initialize());
  ATH_CHECK(m_chargedFEReadHandleKey.initialize());
  ATH_CHECK(m_neutralFEReadHandleKey.initialize());
  
  ATH_MSG_VERBOSE("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()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

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

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_chargedFEElectronWriteDecorKey {this,"ChargedFEElectronDecorKey",m_chargedFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"}

private

The write key for adding electron element link decorations to Charged Flow Elements.

Definition at line 69 of file PFEGamFlowElementAssoc.h.

69{this,"ChargedFEElectronDecorKey",m_chargedFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"};

◆ m_chargedFEPhotonWriteDecorKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_chargedFEPhotonWriteDecorKey {this,"ChargedFEPhotonDecorKey",m_chargedFEReadHandleKey,"FE_PhotonLinks","Output key for link from charged FE to photon"}

private

The write key for adding photon element link decorations to Charged Flow Elements.

Definition at line 79 of file PFEGamFlowElementAssoc.h.

79{this,"ChargedFEPhotonDecorKey",m_chargedFEReadHandleKey,"FE_PhotonLinks","Output key for link from charged FE to photon"};

◆ m_chargedFEReadHandleKey

SG::ReadHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_chargedFEReadHandleKey {this,"JetEtMissChargedFlowElementContainer","JetETMissChargedParticleFlowObjects","ReadHandleKey for charged FlowElements"}

private

Definition at line 56 of file PFEGamFlowElementAssoc.h.

56{this,"JetEtMissChargedFlowElementContainer","JetETMissChargedParticleFlowObjects","ReadHandleKey for charged FlowElements"};

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

SG::WriteDecorHandleKey<xAOD::ElectronContainer> PFEGamFlowElementAssoc::m_electronChargedFEWriteDecorKey {this,"ElectronChargedFEDecorKey",m_electronReadHandleKey,"chargedFELinks","Output key for electron link to charged FE"}

private

The write key for adding Charged Flow Element element link decorations to electrons.

Definition at line 62 of file PFEGamFlowElementAssoc.h.

62{this,"ElectronChargedFEDecorKey",m_electronReadHandleKey,"chargedFELinks","Output key for electron link to charged FE"};

◆ m_electronNeutralFEWriteDecorKey

SG::WriteDecorHandleKey<xAOD::ElectronContainer> PFEGamFlowElementAssoc::m_electronNeutralFEWriteDecorKey {this,"ElectronNeutralFEDecorKey",m_electronReadHandleKey,"neutralFELinks","Output key for electron link to neutral FE"}

private

The write key for adding Neutral Flow Element element link decorations to electrons.

Definition at line 60 of file PFEGamFlowElementAssoc.h.

60{this,"ElectronNeutralFEDecorKey",m_electronReadHandleKey,"neutralFELinks","Output key for electron link to neutral FE"};

◆ m_electronReadHandleKey

SG::ReadHandleKey<xAOD::ElectronContainer> PFEGamFlowElementAssoc::m_electronReadHandleKey {this,"ElectronContainer","Electrons","ReadHandleKey for ElectronContainer"}

private

Definition at line 49 of file PFEGamFlowElementAssoc.h.

49{this,"ElectronContainer","Electrons","ReadHandleKey for ElectronContainer"};

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

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_neutralFEElectronWriteDecorKey {this,"NeutralFEElectronDecorKey",m_neutralFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"}

private

The write key for adding electron element link decorations to Neutral Flow Elements.

Definition at line 66 of file PFEGamFlowElementAssoc.h.

66{this,"NeutralFEElectronDecorKey",m_neutralFEReadHandleKey,"FE_ElectronLinks","Output key for link from charged FE to electron"};

◆ m_neutralFEPhotonWriteDecorKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_neutralFEPhotonWriteDecorKey {this,"NeutralFEPhotonDecorKey",m_neutralFEReadHandleKey,"FE_PhotonLinks","Output key for link from neutral FE to photon"}

private

The write key for adding photon element link decorations to Neutral Flow Elements.

Definition at line 77 of file PFEGamFlowElementAssoc.h.

77{this,"NeutralFEPhotonDecorKey",m_neutralFEReadHandleKey,"FE_PhotonLinks","Output key for link from neutral FE to photon"};

◆ m_neutralFEReadHandleKey

SG::ReadHandleKey<xAOD::FlowElementContainer> PFEGamFlowElementAssoc::m_neutralFEReadHandleKey {this,"JetEtMissNeutralFlowElementContainer","JetETMissNeutralParticleFlowObjects","ReadHandleKey for neutral FlowElements"}

private

Definition at line 54 of file PFEGamFlowElementAssoc.h.

54{this,"JetEtMissNeutralFlowElementContainer","JetETMissNeutralParticleFlowObjects","ReadHandleKey for neutral FlowElements"};

◆ m_photonChargedFEWriteDecorKey

SG::WriteDecorHandleKey<xAOD::PhotonContainer> PFEGamFlowElementAssoc::m_photonChargedFEWriteDecorKey {this,"PhotonChargedFEDecorKey",m_photonReadHandleKey,"chargedFELinks","Output key for photon link to charged FE"}

private

The write key for adding Charged Flow Element element link decorations to photons.

Definition at line 75 of file PFEGamFlowElementAssoc.h.

75{this,"PhotonChargedFEDecorKey",m_photonReadHandleKey,"chargedFELinks","Output key for photon link to charged FE"};

◆ m_photonNeutralFEWriteDecorKey

SG::WriteDecorHandleKey<xAOD::PhotonContainer> PFEGamFlowElementAssoc::m_photonNeutralFEWriteDecorKey {this,"PhotonNeutralFEDecorKey",m_photonReadHandleKey,"neutralFELinks","Output key for photon link to neutral FE"}

private

The write key for adding Neutral Flow Element element link decorations to photons.

Definition at line 73 of file PFEGamFlowElementAssoc.h.

73{this,"PhotonNeutralFEDecorKey",m_photonReadHandleKey,"neutralFELinks","Output key for photon link to neutral FE"};

◆ m_photonReadHandleKey

SG::ReadHandleKey<xAOD::PhotonContainer> PFEGamFlowElementAssoc::m_photonReadHandleKey {this,"PhotonContainer","Photons","ReadHandleKey for PhotonContainer"}

private

Definition at line 51 of file PFEGamFlowElementAssoc.h.

51{this,"PhotonContainer","Photons","ReadHandleKey for PhotonContainer"};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PFEGamFlowElementAssoc()

◆ ~PFEGamFlowElementAssoc()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chargedFEElectronWriteDecorKey

◆ m_chargedFEPhotonWriteDecorKey

◆ m_chargedFEReadHandleKey

◆ m_detStore

◆ m_electronChargedFEWriteDecorKey

◆ m_electronNeutralFEWriteDecorKey

◆ m_electronReadHandleKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_neutralFEElectronWriteDecorKey

◆ m_neutralFEPhotonWriteDecorKey

◆ m_neutralFEReadHandleKey

◆ m_photonChargedFEWriteDecorKey

◆ m_photonNeutralFEWriteDecorKey

◆ m_photonReadHandleKey

◆ m_varHandleArraysDeclared

◆ m_vhka