CP::ParticleLevelOverlapRemovalAlg Class Reference

#include <ParticleLevelOverlapRemovalAlg.h>

Inheritance diagram for CP::ParticleLevelOverlapRemovalAlg:

Collaboration diagram for CP::ParticleLevelOverlapRemovalAlg:

Public Member Functions
virtual StatusCode	initialize () final
virtual StatusCode	execute (const EventContext &ctx) const final
	AnaReentrantAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	constructor with parameters
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
virtual::StatusCode	finalize ()
	finalize this algorithm
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
float	dressedDeltaR (const xAOD::Jet *jet, double rapidityOrEta, double phi) const
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::JetContainer >	m_jetsKey
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_electronsKey
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_muonsKey
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_photonsKey
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_decORjet
SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decORelectron
SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decORmuon
SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decORphoton
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_ptDressedElectronKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_etaDressedElectronKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_phiDressedElectronKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_eDressedElectronKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_ptDressedMuonKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_etaDressedMuonKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_phiDressedMuonKey
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_eDressedMuonKey
CP::SelectionReadHandle	m_jetSelection
CP::SelectionReadHandle	m_electronSelection
CP::SelectionReadHandle	m_muonSelection
CP::SelectionReadHandle	m_photonSelection
Gaudi::Property< bool >	m_useRapidity
Gaudi::Property< bool >	m_useDressedProperties
Gaudi::Property< bool >	m_doJetElectronOR
Gaudi::Property< bool >	m_doJetMuonOR
Gaudi::Property< bool >	m_doJetPhotonOR
Gaudi::Property< std::string >	m_decLabelOR
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

Definition at line 20 of file ParticleLevelOverlapRemovalAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Member Function Documentation

AnaReentrantAlgorithm()

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

constructor with parameters

This matches the Athena algorithm constructor (for dual-use purposes). Within EventLoop the pSvcLocator will always be nullptr (unless we ever have dual-use services).

Guarantee

strong

Failures

out of memory II

Definition at line 67 of file AnaReentrantAlgorithm.cxx.

    : AsgComponent (name)
#else
    : AthReentrantAlgorithm (name, pSvcLocator)
#endif
  {
    ANA_MSG_DEBUG ("AnaReentrantAlgorithm: " << name);
  }

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

dressedDeltaR()

float CP::ParticleLevelOverlapRemovalAlg::dressedDeltaR ( const xAOD::Jet * jet, double rapidityOrEta, double phi ) const

private

Definition at line 74 of file ParticleLevelOverlapRemovalAlg.cxx.

                                                                      {
  if (m_useRapidity)
    return xAOD::P4Helpers::deltaR(jet->rapidity(), jet->phi(), rapidityOrEta,
                                   phi);
  else
    return xAOD::P4Helpers::deltaR(jet->eta(), jet->phi(), rapidityOrEta, phi);
}

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode CP::ParticleLevelOverlapRemovalAlg::execute ( const EventContext & ctx ) const

finalvirtual

Definition at line 84 of file ParticleLevelOverlapRemovalAlg.cxx.

                                                                                {
  SG::ReadHandle<xAOD::TruthParticleContainer> electrons, muons, photons;
  if (m_doJetElectronOR)
    electrons = SG::makeHandle(m_electronsKey, ctx);
  if (m_doJetMuonOR)
    muons = SG::makeHandle(m_muonsKey, ctx);
  if (m_doJetPhotonOR)
    photons = SG::makeHandle(m_photonsKey, ctx);
  SG::ReadHandle<xAOD::JetContainer> jets(m_jetsKey, ctx);
 
  // the lepton/photon decoration handles only exist if the respective OR is
  // enabled (their keys are empty otherwise)
  std::optional<SG::WriteDecorHandle<xAOD::TruthParticleContainer, char>>
      dec_electrons_OR, dec_muons_OR, dec_photons_OR;
  if (m_doJetElectronOR)
    dec_electrons_OR.emplace(m_decORelectron, ctx);
  if (m_doJetMuonOR)
    dec_muons_OR.emplace(m_decORmuon, ctx);
  if (m_doJetPhotonOR)
    dec_photons_OR.emplace(m_decORphoton, ctx);
  SG::WriteDecorHandle<xAOD::JetContainer, char> dec_jets_OR(m_decORjet, ctx);
 
  // accessors for the dressed lepton kinematics (only bound when needed)
  std::optional<SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>>
      acc_pt_dressed_e, acc_eta_dressed_e, acc_phi_dressed_e, acc_e_dressed_e;
  if (m_doJetElectronOR && m_useDressedProperties) {
    acc_pt_dressed_e.emplace(m_ptDressedElectronKey, ctx);
    acc_eta_dressed_e.emplace(m_etaDressedElectronKey, ctx);
    acc_phi_dressed_e.emplace(m_phiDressedElectronKey, ctx);
    acc_e_dressed_e.emplace(m_eDressedElectronKey, ctx);
  }
  std::optional<SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>>
      acc_pt_dressed_m, acc_eta_dressed_m, acc_phi_dressed_m, acc_e_dressed_m;
  if (m_doJetMuonOR && m_useDressedProperties) {
    acc_pt_dressed_m.emplace(m_ptDressedMuonKey, ctx);
    acc_eta_dressed_m.emplace(m_etaDressedMuonKey, ctx);
    acc_phi_dressed_m.emplace(m_phiDressedMuonKey, ctx);
    acc_e_dressed_m.emplace(m_eDressedMuonKey, ctx);
  }
 
  // dressed (rapidity or eta, phi) of a lepton, used for the DeltaR
  auto dressedRapidityOrEtaPhi =
      [&](const xAOD::TruthParticle& lepton,
          const SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>& acc_pt,
          const SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>& acc_eta,
          const SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>& acc_phi,
          const SG::ReadDecorHandle<xAOD::TruthParticleContainer, float>& acc_e) {
        TLorentzVector dressed;
        dressed.SetPtEtaPhiE(acc_pt(lepton), acc_eta(lepton), acc_phi(lepton),
                             acc_e(lepton));
        return std::pair<double, double>{
            m_useRapidity ? dressed.Rapidity() : dressed.Eta(), dressed.Phi()};
      };
  // per-lepton dressed kinematics, indexed by position in the container
  // (only filled for selected leptons when using dressed properties)
  std::vector<std::pair<double, double>> dressed_electrons, dressed_muons;
 
  // Default decorations: all objects pass!
  for (const auto* jet : *jets) {
    if (m_jetSelection)
      dec_jets_OR(*jet) = m_jetSelection.getBool(*jet);
    else
      dec_jets_OR(*jet) = true;
  }
  if (m_doJetElectronOR) {
    dressed_electrons.resize(electrons->size());
    for (std::size_t i = 0; i < electrons->size(); ++i) {
      const auto* electron = (*electrons)[i];
      if (m_electronSelection)
        (*dec_electrons_OR)(*electron) = m_electronSelection.getBool(*electron);
      else
        (*dec_electrons_OR)(*electron) = true;
      if (m_useDressedProperties && (*dec_electrons_OR)(*electron))
        dressed_electrons[i] = dressedRapidityOrEtaPhi(
            *electron, *acc_pt_dressed_e, *acc_eta_dressed_e,
            *acc_phi_dressed_e, *acc_e_dressed_e);
    }
  }
  if (m_doJetMuonOR) {
    dressed_muons.resize(muons->size());
    for (std::size_t i = 0; i < muons->size(); ++i) {
      const auto* muon = (*muons)[i];
      if (m_muonSelection)
        (*dec_muons_OR)(*muon) = m_muonSelection.getBool(*muon);
      else
        (*dec_muons_OR)(*muon) = true;
      if (m_useDressedProperties && (*dec_muons_OR)(*muon))
        dressed_muons[i] = dressedRapidityOrEtaPhi(
            *muon, *acc_pt_dressed_m, *acc_eta_dressed_m, *acc_phi_dressed_m,
            *acc_e_dressed_m);
    }
  }
  if (m_doJetPhotonOR) {
    for (const auto* photon : *photons) {
      if (m_photonSelection)
        (*dec_photons_OR)(*photon) = m_photonSelection.getBool(*photon);
      else
        (*dec_photons_OR)(*photon) = true;
    }
  }
 
  // ----------------------
  // OVERLAP REMOVAL
  // ----------------------
  // Removal Steps:
  //   1. Jets & Muons:
  //      Remove Muons with dR < 0.4
  //   2. Jets & Electrons:
  //      Remove Electrons with dR < 0.4
  //   3. Photons & Jets:
  //      Remove Jets with dR < 0.4
  // The steps are interleaved per jet (not run sequentially over all jets),
  // and the lepton removal uses all selected jets, regardless of whether
  // the jet itself is removed by the photon-jet overlap removal.
 
  for (const auto* jet : *jets) {
    if (m_jetSelection && !m_jetSelection.getBool(*jet))
      continue;
    if (m_doJetMuonOR) {
      for (std::size_t i = 0; i < muons->size(); ++i) {
        const auto* muon = (*muons)[i];
        if ((*dec_muons_OR)(*muon)) {
          if (m_useDressedProperties) {
            const auto& [rapidityOrEta, phi] = dressed_muons[i];
            if (dressedDeltaR(jet, rapidityOrEta, phi) < 0.4)
              (*dec_muons_OR)(*muon) = false;
          } else {
            if (xAOD::P4Helpers::deltaR(jet, muon, m_useRapidity) < 0.4)
              (*dec_muons_OR)(*muon) = false;
          }
        }
      }
    }
    if (m_doJetElectronOR) {
      for (std::size_t i = 0; i < electrons->size(); ++i) {
        const auto* electron = (*electrons)[i];
        if ((*dec_electrons_OR)(*electron)) {
          if (m_useDressedProperties) {
            const auto& [rapidityOrEta, phi] = dressed_electrons[i];
            if (dressedDeltaR(jet, rapidityOrEta, phi) < 0.4)
              (*dec_electrons_OR)(*electron) = false;
          } else {
            if (xAOD::P4Helpers::deltaR(jet, electron, m_useRapidity) < 0.4)
              (*dec_electrons_OR)(*electron) = false;
          }
        }
      }
    }
    if (m_doJetPhotonOR) {
      for (const auto* photon : *photons) {
        if ((*dec_photons_OR)(*photon)) {
          if (xAOD::P4Helpers::deltaR(jet, photon, m_useRapidity) < 0.4) {
            dec_jets_OR(*jet) = false;
            break;
          }
        }
      }
    }
  }
 
  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 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 96 of file AnaReentrantAlgorithm.cxx.

  {
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode CP::ParticleLevelOverlapRemovalAlg::initialize ( )

finalvirtual

Definition at line 21 of file ParticleLevelOverlapRemovalAlg.cxx.

                                                      {
 
  if (m_doJetElectronOR.value() == m_electronsKey.empty()) {
    ANA_MSG_ERROR("doJetElectronOR is " << (m_doJetElectronOR.value() ? "true" : "false")
                  << " but the input container is "
                  << (m_electronsKey.empty() ? "empty" : "set"));
    return StatusCode::FAILURE;
  }
  if (m_doJetMuonOR.value() == m_muonsKey.empty()) {
    ANA_MSG_ERROR("doJetMuonOR is " << (m_doJetMuonOR.value() ? "true" : "false")
                  << " but the input container is "
                  << (m_muonsKey.empty() ? "empty" : "set"));
    return StatusCode::FAILURE;
  }
  if (m_doJetPhotonOR.value() == m_photonsKey.empty()) {
    ANA_MSG_ERROR("doJetPhotonOR is " << (m_doJetPhotonOR.value() ? "true" : "false")
                  << " but the input container is "
                  << (m_photonsKey.empty() ? "empty" : "set"));
    return StatusCode::FAILURE;
  }
 
  ANA_CHECK(m_jetsKey.initialize());
  ANA_CHECK(m_electronsKey.initialize(SG::AllowEmpty));
  ANA_CHECK(m_muonsKey.initialize(SG::AllowEmpty));
  ANA_CHECK(m_photonsKey.initialize(SG::AllowEmpty));
 
  ANA_CHECK(m_decORelectron.initialize(SG::AllowEmpty));
  ANA_CHECK(m_decORmuon.initialize(SG::AllowEmpty));
  ANA_CHECK(m_decORphoton.initialize(SG::AllowEmpty));
  ANA_CHECK(m_decORjet.initialize());
 
  ANA_CHECK(m_ptDressedElectronKey.initialize(m_doJetElectronOR && m_useDressedProperties));
  ANA_CHECK(m_etaDressedElectronKey.initialize(m_doJetElectronOR && m_useDressedProperties));
  ANA_CHECK(m_phiDressedElectronKey.initialize(m_doJetElectronOR && m_useDressedProperties));
  ANA_CHECK(m_eDressedElectronKey.initialize(m_doJetElectronOR && m_useDressedProperties));
 
  ANA_CHECK(m_ptDressedMuonKey.initialize(m_doJetMuonOR && m_useDressedProperties));
  ANA_CHECK(m_etaDressedMuonKey.initialize(m_doJetMuonOR && m_useDressedProperties));
  ANA_CHECK(m_phiDressedMuonKey.initialize(m_doJetMuonOR && m_useDressedProperties));
  ANA_CHECK(m_eDressedMuonKey.initialize(m_doJetMuonOR && m_useDressedProperties));
 
  if (!m_jetSelection.empty())
    ANA_CHECK(m_jetSelection.initialize());
  if (!m_electronSelection.empty())
    ANA_CHECK(m_electronSelection.initialize());
  if (!m_muonSelection.empty())
    ANA_CHECK(m_muonSelection.initialize());
  if (!m_photonSelection.empty())
    ANA_CHECK(m_photonSelection.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()

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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

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

inlinevirtualinherited

Set filter decision:

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, 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 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_decLabelOR

Gaudi::Property<std::string> CP::ParticleLevelOverlapRemovalAlg::m_decLabelOR

private

Initial value:

{
      this, "labelOR", "passesOR",
      "decoration to apply to all particles for overlap removal"}

Definition at line 114 of file ParticleLevelOverlapRemovalAlg.h.

                                       {
      this, "labelOR", "passesOR",
      "decoration to apply to all particles for overlap removal"};

m_decORelectron

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_decORelectron

private

Initial value:

{
      this, "decORelectron", "",
      "the electron overlap-removal decoration; set by the config block "
      "from the electron container name and labelOR, do not set directly"}

Definition at line 39 of file ParticleLevelOverlapRemovalAlg.h.

                                                                   {
      this, "decORelectron", "",
      "the electron overlap-removal decoration; set by the config block "
      "from the electron container name and labelOR, do not set directly"};

m_decORjet

SG::WriteDecorHandleKey<xAOD::JetContainer> CP::ParticleLevelOverlapRemovalAlg::m_decORjet

private

Initial value:

{
      this, "decORjet", "",
      "the jet overlap-removal decoration; set by the config block from the "
      "jet container name and labelOR, do not set directly"}

Definition at line 35 of file ParticleLevelOverlapRemovalAlg.h.

                                                    {
      this, "decORjet", "",
      "the jet overlap-removal decoration; set by the config block from the "
      "jet container name and labelOR, do not set directly"};

m_decORmuon

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_decORmuon

private

Initial value:

{
      this, "decORmuon", "",
      "the muon overlap-removal decoration; set by the config block from "
      "the muon container name and labelOR, do not set directly"}

Definition at line 43 of file ParticleLevelOverlapRemovalAlg.h.

                                                               {
      this, "decORmuon", "",
      "the muon overlap-removal decoration; set by the config block from "
      "the muon container name and labelOR, do not set directly"};

m_decORphoton

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_decORphoton

private

Initial value:

{
      this, "decORphoton", "",
      "the photon overlap-removal decoration; set by the config block from "
      "the photon container name and labelOR, do not set directly"}

Definition at line 47 of file ParticleLevelOverlapRemovalAlg.h.

                                                                 {
      this, "decORphoton", "",
      "the photon overlap-removal decoration; set by the config block from "
      "the photon container name and labelOR, do not set directly"};

m_detStore

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

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_doJetElectronOR

Gaudi::Property<bool> CP::ParticleLevelOverlapRemovalAlg::m_doJetElectronOR

private

Initial value:

{
      this, "doJetElectronOR", false,
      "whether to perform jet-electron overlap removal"}

Definition at line 105 of file ParticleLevelOverlapRemovalAlg.h.

                                       {
      this, "doJetElectronOR", false,
      "whether to perform jet-electron overlap removal"};

m_doJetMuonOR

Gaudi::Property<bool> CP::ParticleLevelOverlapRemovalAlg::m_doJetMuonOR

private

Initial value:

{
      this, "doJetMuonOR", false,
      "whether to perform jet-muon overlap removal"}

Definition at line 108 of file ParticleLevelOverlapRemovalAlg.h.

                                   {
      this, "doJetMuonOR", false,
      "whether to perform jet-muon overlap removal"};

m_doJetPhotonOR

Gaudi::Property<bool> CP::ParticleLevelOverlapRemovalAlg::m_doJetPhotonOR

private

Initial value:

{
      this, "doJetPhotonOR", false,
      "whether to perform jet-photon overlap removal"}

Definition at line 111 of file ParticleLevelOverlapRemovalAlg.h.

                                     {
      this, "doJetPhotonOR", false,
      "whether to perform jet-photon overlap removal"};

m_eDressedElectronKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_eDressedElectronKey

private

Initial value:

{
      this, "eDressedElectron", "",
      "dressed electron energy decoration used for the DeltaR calculation; "
      "set by the config block from the electron container name, do not "
      "set directly"}

Definition at line 66 of file ParticleLevelOverlapRemovalAlg.h.

                                                                        {
      this, "eDressedElectron", "",
      "dressed electron energy decoration used for the DeltaR calculation; "
      "set by the config block from the electron container name, do not "
      "set directly"};

m_eDressedMuonKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_eDressedMuonKey

private

Initial value:

{
      this, "eDressedMuon", "",
      "dressed muon energy decoration used for the DeltaR calculation; set "
      "by the config block from the muon container name, do not set "
      "directly"}

Definition at line 83 of file ParticleLevelOverlapRemovalAlg.h.

                                                                    {
      this, "eDressedMuon", "",
      "dressed muon energy decoration used for the DeltaR calculation; set "
      "by the config block from the muon container name, do not set "
      "directly"};

m_electronSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_electronSelection

private

Initial value:

{
      this, "electronSelection", "",
      "the selection on the input truth electrons"}

Definition at line 90 of file ParticleLevelOverlapRemovalAlg.h.

                                           {
      this, "electronSelection", "",
      "the selection on the input truth electrons"};

m_electronsKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_electronsKey

private

Initial value:

{
      this, "electrons", "", "the name of the input truth electrons container"}

Definition at line 29 of file ParticleLevelOverlapRemovalAlg.h.

                                                            {
      this, "electrons", "", "the name of the input truth electrons container"};

m_etaDressedElectronKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_etaDressedElectronKey

private

Initial value:

{
      this, "etaDressedElectron", "",
      "dressed electron eta decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"}

Definition at line 56 of file ParticleLevelOverlapRemovalAlg.h.

                                                                          {
      this, "etaDressedElectron", "",
      "dressed electron eta decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"};

m_etaDressedMuonKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_etaDressedMuonKey

private

Initial value:

{
      this, "etaDressedMuon", "",
      "dressed muon eta decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"}

Definition at line 75 of file ParticleLevelOverlapRemovalAlg.h.

                                                                      {
      this, "etaDressedMuon", "",
      "dressed muon eta decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"};

m_evtStore

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

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 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_jetSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_jetSelection

private

Initial value:

{
      this, "jetSelection", "", "the selection on the input truth jets"}

Definition at line 88 of file ParticleLevelOverlapRemovalAlg.h.

                                      {
      this, "jetSelection", "", "the selection on the input truth jets"};

m_jetsKey

SG::ReadHandleKey<xAOD::JetContainer> CP::ParticleLevelOverlapRemovalAlg::m_jetsKey

private

Initial value:

{
      this, "jets", "", "the name of the input truth jet container"}

Definition at line 27 of file ParticleLevelOverlapRemovalAlg.h.

                                             {
      this, "jets", "", "the name of the input truth jet container"};

m_muonSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_muonSelection

private

Initial value:

{
      this, "muonSelection", "", "the selection on the input truth muons"}

Definition at line 93 of file ParticleLevelOverlapRemovalAlg.h.

                                       {
      this, "muonSelection", "", "the selection on the input truth muons"};

m_muonsKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_muonsKey

private

Initial value:

{
      this, "muons", "", "the name of the input truth muons container"}

Definition at line 31 of file ParticleLevelOverlapRemovalAlg.h.

                                                        {
      this, "muons", "", "the name of the input truth muons container"};

m_phiDressedElectronKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_phiDressedElectronKey

private

Initial value:

{
      this, "phiDressedElectron", "",
      "dressed electron phi decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"}

Definition at line 61 of file ParticleLevelOverlapRemovalAlg.h.

                                                                          {
      this, "phiDressedElectron", "",
      "dressed electron phi decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"};

m_phiDressedMuonKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_phiDressedMuonKey

private

Initial value:

{
      this, "phiDressedMuon", "",
      "dressed muon phi decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"}

Definition at line 79 of file ParticleLevelOverlapRemovalAlg.h.

                                                                      {
      this, "phiDressedMuon", "",
      "dressed muon phi decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"};

m_photonSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_photonSelection

private

Initial value:

{
      this, "photonSelection", "", "the selection on the input truth photons"}

Definition at line 95 of file ParticleLevelOverlapRemovalAlg.h.

                                         {
      this, "photonSelection", "", "the selection on the input truth photons"};

m_photonsKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_photonsKey

private

Initial value:

{
      this, "photons", "", "the name of the input truth photons container"}

Definition at line 33 of file ParticleLevelOverlapRemovalAlg.h.

                                                          {
      this, "photons", "", "the name of the input truth photons container"};

m_ptDressedElectronKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_ptDressedElectronKey

private

Initial value:

{
      this, "ptDressedElectron", "",
      "dressed electron pt decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"}

Definition at line 51 of file ParticleLevelOverlapRemovalAlg.h.

                                                                         {
      this, "ptDressedElectron", "",
      "dressed electron pt decoration used for the DeltaR calculation; set "
      "by the config block from the electron container name, do not set "
      "directly"};

m_ptDressedMuonKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> CP::ParticleLevelOverlapRemovalAlg::m_ptDressedMuonKey

private

Initial value:

{
      this, "ptDressedMuon", "",
      "dressed muon pt decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"}

Definition at line 71 of file ParticleLevelOverlapRemovalAlg.h.

                                                                     {
      this, "ptDressedMuon", "",
      "dressed muon pt decoration used for the DeltaR calculation; set by "
      "the config block from the muon container name, do not set directly"};

m_useDressedProperties

Gaudi::Property<bool> CP::ParticleLevelOverlapRemovalAlg::m_useDressedProperties

private

Initial value:

{
      this, "useDressedProperties", true,
      "whether to use dressed electron and muon kinematics rather than simple "
      "P4 kinematics"}

Definition at line 101 of file ParticleLevelOverlapRemovalAlg.h.

                                            {
      this, "useDressedProperties", true,
      "whether to use dressed electron and muon kinematics rather than simple "
      "P4 kinematics"};

m_useRapidity

Gaudi::Property<bool> CP::ParticleLevelOverlapRemovalAlg::m_useRapidity

private

Initial value:

{
      this, "useRapidityForDeltaR", true,
      "whether to use rapidity instead of pseudo-rapidity for the calculation "
      "of DeltaR"}

Definition at line 97 of file ParticleLevelOverlapRemovalAlg.h.

                                   {
      this, "useRapidityForDeltaR", true,
      "whether to use rapidity instead of pseudo-rapidity for the calculation "
      "of DeltaR"};

m_varHandleArraysDeclared

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

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

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

• ParticleLevelOverlapRemovalAlg.h
• ParticleLevelOverlapRemovalAlg.cxx