#include <JetPFlowSelectionAlg.h>

Inheritance diagram for JetPFlowSelectionAlg:

Collaboration diagram for JetPFlowSelectionAlg:

Public Member Functions
	JetPFlowSelectionAlg (const std::string &n, ISvcLocator *l)

StatusCode	initialize () override
	Athena algorithm's Hooks. More...

StatusCode	execute (const EventContext &ctx) const override

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

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

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
virtual ::StatusCode	finalize ()
	finalize this algorithm More...

void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< std::string >	m_electronID {this,"electronID","LHMedium","Select electron ID"}

Gaudi::Property< bool >	m_removeNeutralElectronFE {this,"removeNeutralElectronFE",false,"Remove neutral FE matched to electrons"}

Gaudi::Property< std::string >	m_muonID {this,"muonID","Medium","Select muon ID"}

Gaudi::Property< bool >	m_removeNeutralMuonFE {this,"removeNeutralMuonFE",false,"Remove neutral FE matched to muons"}

SG::ReadHandleKey< xAOD::FlowElementContainer >	m_ChargedPFlowContainerKey = {this, "ChargedPFlowInputContainer", "", "The input Charged PFlow Objects"}

SG::ReadHandleKey< xAOD::FlowElementContainer >	m_NeutralPFlowContainerKey = {this, "NeutralPFlowInputContainer", "", "The input Neutral PFlow Objects"}

SG::ReadHandleKey< xAOD::ElectronContainer >	m_electronContainerKey = {this, "ElectronInputContainer", "", "The input electron container"}

SG::WriteHandleKey< xAOD::FlowElementContainer >	m_outputChargedPFlowHandleKey = {this, "ChargedPFlowOutputContainer", "GlobalPFlowChargedParticleFlowObjects", "The output filtered Charged PFlow Objects"}

SG::WriteHandleKey< xAOD::FlowElementContainer >	m_outputNeutralPFlowHandleKey = {this, "NeutralPFlowOutputContainer", "GlobalPFlowNeutralParticleFlowObjects", "The output filtered Neutral PFlow Objects"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_chargedFEElectronsReadDecorKey {this, "ChargedFEElectronsReadDecorKey", "JetETMissChargedParticleFlowObjects.FE_ElectronLinks", "Key for links from charged FE to electrons"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_chargedFEMuonsReadDecorKey {this, "ChargedFEMuonsReadDecorKey", "JetETMissChargedParticleFlowObjects.FE_MuonLinks", "Key for links from charged FE to muons"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_neutralFEElectronsReadDecorKey {this, "NeutralFEElectronsReadDecorKey", "JetETMissNeutralParticleFlowObjects.FE_ElectronLinks", "Key for links from neutral FE to electrons"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_neutralFEMuonsReadDecorKey {this, "NeutralFEMuonsReadDecorKey","JetETMissNeutralParticleFlowObjects.FE_MuonLinks", "Key for links from neutral FE to muons"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_neutralFEMuons_efrac_match_DecorKey {this,"FlowElementContainer_FE_efrac_matched_muon","JetETMissNeutralParticleFlowObjects.FE_efrac_matched_muon","ReadDecorHandleKey for the fraction of neutral FlowElements cluster energy used to match to Muons"}

SG::ReadDecorHandleKey< xAOD::FlowElementContainer >	m_chargedFE_energy_match_muonReadHandleKey {this,"FlowElementContainer_ChargedFE_energy_matched_muon","JetETMissChargedParticleFlowObjects.FE_efrac_matched_muon","ReadHandleKey for the fraction of neutral FlowElements cluster energy used to match to Muons"}

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

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Algorithm creates a filtered collection of PFlow Objects not matched to electrons/muons.

Definition at line 24 of file JetPFlowSelectionAlg.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

◆ JetPFlowSelectionAlg()

JetPFlowSelectionAlg::JetPFlowSelectionAlg	(	const std::string &	n,
		ISvcLocator *	l
	)

inline

Definition at line 28 of file JetPFlowSelectionAlg.h.

28 : EL::AnaReentrantAlgorithm(n,l) {}

Member Function Documentation

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

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

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

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

override

Definition at line 41 of file JetPFlowSelectionAlg.cxx.

                                                                       {
   ATH_MSG_DEBUG(" execute() ... ");
  
   SG::ReadHandle<xAOD::FlowElementContainer> ChargedPFlowObjects(m_ChargedPFlowContainerKey, ctx);
   if (! ChargedPFlowObjects.isValid()){
     ATH_MSG_ERROR("Can't retrieve input container "<< m_ChargedPFlowContainerKey);                  
     return StatusCode::FAILURE;
   }
  
   SG::ReadHandle<xAOD::FlowElementContainer> NeutralPFlowObjects(m_NeutralPFlowContainerKey, ctx);
   if (! NeutralPFlowObjects.isValid()){
     ATH_MSG_ERROR("Can't retrieve input container "<< m_NeutralPFlowContainerKey);                  
     return StatusCode::FAILURE;
   }
  
   SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector< ElementLink<xAOD::ElectronContainer> > > chargedFE_ElectronLinks(m_chargedFEElectronsReadDecorKey,ctx);
   if (!chargedFE_ElectronLinks.isValid()){
     ATH_MSG_ERROR("Can't retrieve input decoration " << chargedFE_ElectronLinks.key());                  
     return StatusCode::FAILURE;
   }
  
   SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector< ElementLink<xAOD::MuonContainer> > > chargedFE_MuonLinks(m_chargedFEMuonsReadDecorKey,ctx);
   if (!chargedFE_MuonLinks.isValid()){
     ATH_MSG_ERROR("Can't retrieve input decoration "<< chargedFE_MuonLinks.key());                  
     return StatusCode::FAILURE;
   }
  
   SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector< ElementLink<xAOD::ElectronContainer> > > neutralFE_ElectronLinks(m_neutralFEElectronsReadDecorKey,ctx);
   if (!neutralFE_ElectronLinks.isValid()){
     ATH_MSG_ERROR("Can't retrieve input decoration "<< neutralFE_ElectronLinks.key());                  
     return StatusCode::FAILURE;
   }
  
   SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector< ElementLink<xAOD::MuonContainer> > > neutralFE_MuonLinks(m_neutralFEMuonsReadDecorKey,ctx);
   if (!neutralFE_MuonLinks.isValid()){
     ATH_MSG_ERROR("Can't retrieve input decoration "<< neutralFE_MuonLinks.key());                  
     return StatusCode::FAILURE;
   }
  
   auto selectedChargedPFlowObjects = std::make_unique<xAOD::FlowElementContainer>(); // SG::VIEW_ELEMENTS
   auto selectedChargedPFlowObjectsAux = std::make_unique<xAOD::FlowElementAuxContainer>();
   selectedChargedPFlowObjects->setStore(selectedChargedPFlowObjectsAux.get());
  
   auto selectedNeutralPFlowObjects = std::make_unique<xAOD::FlowElementContainer>();
   auto selectedNeutralPFlowObjectsAux = std::make_unique<xAOD::FlowElementAuxContainer>();
   selectedNeutralPFlowObjects->setStore(selectedNeutralPFlowObjectsAux.get());
  
   // To store the charged FE objects matched to an electron/muon
   std::vector< const xAOD::FlowElement* > ChargedPFlowObjects_matched;
  
   FEMuonHelper muonHelper;
   FEElectronHelper electronHelper;
  
   // Loop over Charged FE objects
   for ( const xAOD::FlowElement* fe : *ChargedPFlowObjects ) {
  
     // Select FE object if not matched to an electron or muon via links
     if ( !electronHelper.checkElectronLinks(chargedFE_ElectronLinks(*fe),m_electronID) && !muonHelper.checkMuonLinks(chargedFE_MuonLinks(*fe),m_muonID) ){
       xAOD::FlowElement* selectedFE = new xAOD::FlowElement();
       selectedChargedPFlowObjects->push_back(selectedFE);
       *selectedFE = *fe; // copies auxdata
     }
     else { // Use the matched object to put back its energy later
       ChargedPFlowObjects_matched.push_back(fe);
     }
  
   } // End loop over Charged FE Objects
  
  
   // Loop over Neutral FE objects
   for ( const xAOD::FlowElement* fe : *NeutralPFlowObjects ) {
  
     //if links to an electron, then we veto entire neutral FE    
     if (m_removeNeutralElectronFE){
       if (electronHelper.checkElectronLinks(neutralFE_ElectronLinks(*fe),m_electronID)) continue;
     }
  
     xAOD::FlowElement* selectedFE = new xAOD::FlowElement();
     selectedNeutralPFlowObjects->push_back(selectedFE);
     *selectedFE = *fe;
  
     //if links to a muon, then we need to subtract off the muon energy in 
     //this calorimeter cluster
  
     if (m_removeNeutralMuonFE && muonHelper.checkMuonLinks(neutralFE_MuonLinks(*fe),m_muonID)){
         SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector<double> > clusterMuonEnergyFracs(m_neutralFEMuons_efrac_match_DecorKey,ctx); 
         selectedFE->setP4(muonHelper.adjustNeutralCaloEnergy(clusterMuonEnergyFracs(*fe),*fe));
     }
  
  
   } // End loop over Neutral FE Objects
  
   // Add the energy from removed charged FE clusters to neutral FE object 
   // if shared clusters exist, create the new neutral FE object otherwise
   for ( const xAOD::FlowElement* chargedFE : ChargedPFlowObjects_matched ){
       
     // Get charged FE topoclusters and weights
     std::vector<std::pair<const xAOD::IParticle*,float> > theOtherPairs_charged = chargedFE->otherObjectsAndWeights();
     std::vector<ElementLink<xAOD::IParticleContainer>> theOtherLinks_charged = chargedFE->otherObjectLinks();
  
     // Loop over charged FE topoclusters
     for (unsigned int iCluster = 0; iCluster < chargedFE->nOtherObjects(); ++iCluster){
  
       bool thisCluster_matched = false;
  
       std::pair<const xAOD::IParticle*,float> theOtherPair_charged = theOtherPairs_charged[iCluster];
       const xAOD::IParticle* theCluster_charged = theOtherPair_charged.first;
       float theClusterWeight_charged = theOtherPair_charged.second;
  
       // Loop over neutral FE objects
       for ( xAOD::FlowElement* neutralFE : *selectedNeutralPFlowObjects ) {
         if (thisCluster_matched) continue;
  
         // Loop over neutral FE topoclusters
         std::vector<std::pair<const xAOD::IParticle*,float> > theOtherPairs_neutral = neutralFE->otherObjectsAndWeights();
         for (auto& [theCluster_neutral, theClusterWeight_neutral] : theOtherPairs_neutral){
  
           // If topoclusters are matched, add the energy to the neutral FE object
           if (theCluster_charged == theCluster_neutral){
  
             // Add the energy to the neutral FE object
             float newEnergy = neutralFE->e() + theClusterWeight_charged;
             neutralFE->setP4(newEnergy/cosh(neutralFE->eta()), 
                             neutralFE->eta(),
                             neutralFE->phi(),
                             neutralFE->m());            
  
             ATH_MSG_DEBUG("Updated neutral FlowElement with E, pt, eta and phi: "
                     << neutralFE->e() << ", " << neutralFE->pt() << ", "
                     << neutralFE->eta() << " and " << neutralFE->phi());
  
             thisCluster_matched = true;
           }
  
         } // End loop over neutral FE clusters
       } // End loop over neutral FE objects
  
       // If a topocluster is left unmatched, create a neutral FE object.
       // Ignore topoclusters with nullptr
       if ( !thisCluster_matched && theCluster_charged ){
  
         //check if charged cluster belongs to an electron, before we put it back as neutral        
         bool belongsToElectron = false;
         if (m_removeNeutralElectronFE){
  
           //get container index of charged cluster and compare to indices of electron topoclusters
           unsigned int chargedClusterIndex = theCluster_charged->index();
  
           SG::ReadHandle<xAOD::ElectronContainer> electronReadHandle(m_electronContainerKey,ctx);
           if (!electronReadHandle.isValid()){
             ATH_MSG_ERROR("Can't retrieve electron container "<< m_electronContainerKey.key());                  
             return StatusCode::FAILURE;
           }
  
           for (auto thisElectron : *electronReadHandle){
             const std::vector<const xAOD::CaloCluster*> electronTopoClusters = xAOD::EgammaHelpers::getAssociatedTopoClusters(thisElectron->caloCluster());
             for (auto thisElectronTopoCluster : electronTopoClusters){
               if (thisElectronTopoCluster->index() == chargedClusterIndex){
                 belongsToElectron = true;                
                 break;
               }
             }
           }
         }
  
         if (belongsToElectron) continue;
  
         bool belongsToMuon = false;
         double muonCaloEnergy = 0.0;
         if (m_removeNeutralMuonFE){          
           SG::ReadDecorHandle<xAOD::FlowElementContainer, std::vector<double> > chargedFE_energy_match_muonReadHandle(m_chargedFE_energy_match_muonReadHandleKey,ctx);
           std::vector<double> muonCaloEnergies = chargedFE_energy_match_muonReadHandle(*chargedFE);
           muonCaloEnergy = muonCaloEnergies[iCluster];
         }
  
         if (belongsToMuon) continue;
  
         xAOD::FlowElement* newFE = new xAOD::FlowElement();
         selectedNeutralPFlowObjects->push_back(newFE);
  
         newFE->setP4((theClusterWeight_charged - muonCaloEnergy) / cosh(theCluster_charged->eta()),  // using energy from charged FE weight, not cluster->e()
                     theCluster_charged->eta(),
                     theCluster_charged->phi(),
                     theCluster_charged->m());
         newFE->setCharge(0);
         newFE->setSignalType(xAOD::FlowElement::SignalType::NeutralPFlow);
  
         ATH_MSG_DEBUG("Created neutral FlowElement with E, pt, eta and phi: "
                   << newFE->e() << ", " << newFE->pt() << ", "
                   << newFE->eta() << " and " << newFE->phi());
  
         std::vector<ElementLink<xAOD::IParticleContainer>> theClusters;
         ElementLink< xAOD::IParticleContainer > theIParticleLink;
         theIParticleLink.resetWithKeyAndIndex(theOtherLinks_charged[iCluster].persKey(), theOtherLinks_charged[iCluster].persIndex()); 
  
         theClusters.push_back(theIParticleLink);
         newFE->setOtherObjectLinks(theClusters);
  
         //Add Standard data to these new FlowElements
         FEHelpers::FillNeutralFlowElements FEFiller;
         const xAOD::CaloCluster* castCluster_charged = dynamic_cast<const xAOD::CaloCluster*>(theCluster_charged);
         FEFiller.addStandardMoments(*newFE,*castCluster_charged);        
         FEFiller.addStandardSamplingEnergies(*newFE,*castCluster_charged);    
  
         float layerEnergy_TileBar0 = castCluster_charged->eSample(xAOD::CaloCluster::CaloSample::TileBar0);
         float layerEnergy_TileExt0 = castCluster_charged->eSample(xAOD::CaloCluster::CaloSample::TileExt0);
         const static SG::AuxElement::Accessor<float> accFloatTIle0E("LAYERENERGY_TILE0");
         accFloatTIle0E(*newFE) = layerEnergy_TileBar0 + layerEnergy_TileExt0;
  
         const static SG::AuxElement::Accessor<float> accFloatTiming("TIMING");
         accFloatTiming(*newFE) = castCluster_charged->time();
       }
         
     } // End loop over topoclusters of removed charged FE objects
   } // End loop over removed charged FE objects
  
  
   auto handle_ChargedPFlow_out =  SG::makeHandle(m_outputChargedPFlowHandleKey, ctx);
   if (!handle_ChargedPFlow_out.record(std::move(selectedChargedPFlowObjects), std::move(selectedChargedPFlowObjectsAux)) ){
     ATH_MSG_ERROR("Can't record output PFlow container "<< m_outputChargedPFlowHandleKey);
     return StatusCode::FAILURE;
   }
  
   auto handle_NeutralPFlow_out =  SG::makeHandle(m_outputNeutralPFlowHandleKey, ctx);
   if (!handle_NeutralPFlow_out.record(std::move(selectedNeutralPFlowObjects), std::move(selectedNeutralPFlowObjectsAux)) ){
     ATH_MSG_ERROR("Can't record output PFlow container "<< m_outputNeutralPFlowHandleKey);
     return StatusCode::FAILURE;
   }
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.cxx.

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

◆ filterPassed()

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

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

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

◆ finalize()

StatusCode EL::AnaReentrantAlgorithm::finalize ( )

protectedinherited

finalize this algorithm

This gets called after event processing has finished. The last event may no longer be in memory, and the code should not try to access it.

Definition at line 102 of file AnaReentrantAlgorithm.cxx.

   {
     return StatusCode::SUCCESS;
   }

◆ initialize()

StatusCode JetPFlowSelectionAlg::initialize ( )

override

Athena algorithm's Hooks.

Definition at line 20 of file JetPFlowSelectionAlg.cxx.

                                             {
   ATH_MSG_DEBUG("Initializing  " );
  
   ATH_CHECK(m_ChargedPFlowContainerKey.initialize());
   ATH_CHECK(m_NeutralPFlowContainerKey.initialize());
   if (!m_electronContainerKey.empty()) {
     ATH_CHECK(m_electronContainerKey.initialize());
   }
   ATH_CHECK(m_outputChargedPFlowHandleKey.initialize());
   ATH_CHECK(m_outputNeutralPFlowHandleKey.initialize());
   ATH_CHECK(m_chargedFEElectronsReadDecorKey.initialize());
   ATH_CHECK(m_chargedFEMuonsReadDecorKey.initialize());
   ATH_CHECK(m_neutralFEMuons_efrac_match_DecorKey.initialize());
   ATH_CHECK(m_neutralFEElectronsReadDecorKey.initialize());
   ATH_CHECK(m_neutralFEMuonsReadDecorKey.initialize());
   ATH_CHECK(m_chargedFE_energy_match_muonReadHandleKey.initialize());
  
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

Definition at line 44 of file AthReentrantAlgorithm.cxx.

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

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

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

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

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

◆ sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

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

Definition at line 67 of file AthReentrantAlgorithm.cxx.

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

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

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

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

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

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

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

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_chargedFE_energy_match_muonReadHandleKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_chargedFE_energy_match_muonReadHandleKey {this,"FlowElementContainer_ChargedFE_energy_matched_muon","JetETMissChargedParticleFlowObjects.FE_efrac_matched_muon","ReadHandleKey for the fraction of neutral FlowElements cluster energy used to match to Muons"}

private

Definition at line 61 of file JetPFlowSelectionAlg.h.

◆ m_chargedFEElectronsReadDecorKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_chargedFEElectronsReadDecorKey {this, "ChargedFEElectronsReadDecorKey", "JetETMissChargedParticleFlowObjects.FE_ElectronLinks", "Key for links from charged FE to electrons"}

private

Definition at line 51 of file JetPFlowSelectionAlg.h.

◆ m_chargedFEMuonsReadDecorKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_chargedFEMuonsReadDecorKey {this, "ChargedFEMuonsReadDecorKey", "JetETMissChargedParticleFlowObjects.FE_MuonLinks", "Key for links from charged FE to muons"}

private

Definition at line 52 of file JetPFlowSelectionAlg.h.

◆ m_ChargedPFlowContainerKey

SG::ReadHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_ChargedPFlowContainerKey = {this, "ChargedPFlowInputContainer", "", "The input Charged PFlow Objects"}

private

Definition at line 43 of file JetPFlowSelectionAlg.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_electronContainerKey

SG::ReadHandleKey<xAOD::ElectronContainer> JetPFlowSelectionAlg::m_electronContainerKey = {this, "ElectronInputContainer", "", "The input electron container"}

private

Definition at line 45 of file JetPFlowSelectionAlg.h.

◆ m_electronID

Gaudi::Property<std::string> JetPFlowSelectionAlg::m_electronID {this,"electronID","LHMedium","Select electron ID"}

private

Definition at line 37 of file JetPFlowSelectionAlg.h.

◆ m_evtStore

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

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_muonID

Gaudi::Property<std::string> JetPFlowSelectionAlg::m_muonID {this,"muonID","Medium","Select muon ID"}

private

Definition at line 40 of file JetPFlowSelectionAlg.h.

◆ m_neutralFEElectronsReadDecorKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_neutralFEElectronsReadDecorKey {this, "NeutralFEElectronsReadDecorKey", "JetETMissNeutralParticleFlowObjects.FE_ElectronLinks", "Key for links from neutral FE to electrons"}

private

Definition at line 54 of file JetPFlowSelectionAlg.h.

◆ m_neutralFEMuons_efrac_match_DecorKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_neutralFEMuons_efrac_match_DecorKey {this,"FlowElementContainer_FE_efrac_matched_muon","JetETMissNeutralParticleFlowObjects.FE_efrac_matched_muon","ReadDecorHandleKey for the fraction of neutral FlowElements cluster energy used to match to Muons"}

private

Definition at line 59 of file JetPFlowSelectionAlg.h.

◆ m_neutralFEMuonsReadDecorKey

SG::ReadDecorHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_neutralFEMuonsReadDecorKey {this, "NeutralFEMuonsReadDecorKey","JetETMissNeutralParticleFlowObjects.FE_MuonLinks", "Key for links from neutral FE to muons"}

private

Definition at line 56 of file JetPFlowSelectionAlg.h.

◆ m_NeutralPFlowContainerKey

SG::ReadHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_NeutralPFlowContainerKey = {this, "NeutralPFlowInputContainer", "", "The input Neutral PFlow Objects"}

private

Definition at line 44 of file JetPFlowSelectionAlg.h.

◆ m_outputChargedPFlowHandleKey

SG::WriteHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_outputChargedPFlowHandleKey = {this, "ChargedPFlowOutputContainer", "GlobalPFlowChargedParticleFlowObjects", "The output filtered Charged PFlow Objects"}

private

Definition at line 48 of file JetPFlowSelectionAlg.h.

◆ m_outputNeutralPFlowHandleKey

SG::WriteHandleKey<xAOD::FlowElementContainer> JetPFlowSelectionAlg::m_outputNeutralPFlowHandleKey = {this, "NeutralPFlowOutputContainer", "GlobalPFlowNeutralParticleFlowObjects", "The output filtered Neutral PFlow Objects"}

private

Definition at line 49 of file JetPFlowSelectionAlg.h.

◆ m_removeNeutralElectronFE

Gaudi::Property<bool> JetPFlowSelectionAlg::m_removeNeutralElectronFE {this,"removeNeutralElectronFE",false,"Remove neutral FE matched to electrons"}

private

Definition at line 38 of file JetPFlowSelectionAlg.h.

◆ m_removeNeutralMuonFE

Gaudi::Property<bool> JetPFlowSelectionAlg::m_removeNeutralMuonFE {this,"removeNeutralMuonFE",false,"Remove neutral FE matched to muons"}

private

Definition at line 41 of file JetPFlowSelectionAlg.h.

◆ m_varHandleArraysDeclared

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

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetPFlowSelectionAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chargedFE_energy_match_muonReadHandleKey

◆ m_chargedFEElectronsReadDecorKey

◆ m_chargedFEMuonsReadDecorKey

◆ m_ChargedPFlowContainerKey

◆ m_detStore

◆ m_electronContainerKey

◆ m_electronID

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_muonID

◆ m_neutralFEElectronsReadDecorKey

◆ m_neutralFEMuons_efrac_match_DecorKey

◆ m_neutralFEMuonsReadDecorKey

◆ m_NeutralPFlowContainerKey

◆ m_outputChargedPFlowHandleKey

◆ m_outputNeutralPFlowHandleKey

◆ m_removeNeutralElectronFE

◆ m_removeNeutralMuonFE

◆ m_varHandleArraysDeclared

◆ m_vhka