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
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
float	dressedDeltaR (const xAOD::Jet *p1, TLorentzVector &p2, bool useRapidity) const
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
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
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. 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

Definition at line 19 of file ParticleLevelOverlapRemovalAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

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.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.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.

{ return m_detStore; }

dressedDeltaR()

float CP::ParticleLevelOverlapRemovalAlg::dressedDeltaR ( const xAOD::Jet *  p1, TLorentzVector &  p2, bool  useRapidity  ) const

private

Definition at line 47 of file ParticleLevelOverlapRemovalAlg.cxx.

                                                                            {
  if (useRapidity)
    return xAOD::P4Helpers::deltaR(p1->rapidity(), p1->phi(), p2.Rapidity(),
                                   p2.Phi());
  else
    return xAOD::P4Helpers::deltaR(p1->eta(), p1->phi(), p2.Eta(), p2.Phi());
}

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.

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

{ return m_evtStore; }

execute()

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

finalvirtual

Definition at line 57 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);
 
  SG::WriteDecorHandle<xAOD::TruthParticleContainer, char> dec_electrons_OR(
      m_decORelectron, ctx);
  SG::WriteDecorHandle<xAOD::TruthParticleContainer, char> dec_muons_OR(
      m_decORmuon, ctx);
  SG::WriteDecorHandle<xAOD::TruthParticleContainer, char> dec_photons_OR(
      m_decORphoton, ctx);
  SG::WriteDecorHandle<xAOD::JetContainer, char> dec_jets_OR(m_decORjet, ctx);
 
  // accessors
  static const SG::AuxElement::ConstAccessor<float> acc_pt_dressed(
      "pt_dressed");
  static const SG::AuxElement::ConstAccessor<float> acc_eta_dressed(
      "eta_dressed");
  static const SG::AuxElement::ConstAccessor<float> acc_phi_dressed(
      "phi_dressed");
  static const SG::AuxElement::ConstAccessor<float> acc_e_dressed("e_dressed");
 
  // 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) {
    for (const auto* electron : *electrons) {
      if (m_electronSelection)
        dec_electrons_OR(*electron) = m_electronSelection.getBool(*electron);
      else
        dec_electrons_OR(*electron) = true;
    }
  }
  if (m_doJetMuonOR) {
    for (const auto* muon : *muons) {
      if (m_muonSelection)
        dec_muons_OR(*muon) = m_muonSelection.getBool(*muon);
      else
        dec_muons_OR(*muon) = true;
    }
  }
  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
 
  for (const auto* jet : *jets) {
    if (m_jetSelection && !m_jetSelection.getBool(*jet))
      continue;
    if (m_doJetMuonOR) {
      for (const auto* muon : *muons) {
        if (m_muonSelection && !m_muonSelection.getBool(*muon))
          continue;
        if (dec_muons_OR(*muon)) {
          if (m_useDressedProperties) {
            TLorentzVector dressed_muon;
            dressed_muon.SetPtEtaPhiE(
                acc_pt_dressed(*muon), acc_eta_dressed(*muon),
                acc_phi_dressed(*muon), acc_e_dressed(*muon));
            if (dressedDeltaR(jet, dressed_muon, m_useRapidity) < 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 (const auto* electron : *electrons) {
        if (m_electronSelection && !m_electronSelection.getBool(*electron))
          continue;
        if (dec_electrons_OR(*electron)) {
          if (m_useDressedProperties) {
            TLorentzVector dressed_electron;
            dressed_electron.SetPtEtaPhiE(
                acc_pt_dressed(*electron), acc_eta_dressed(*electron),
                acc_phi_dressed(*electron), acc_e_dressed(*electron));
            if (dressedDeltaR(jet, dressed_electron, m_useRapidity) < 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 (m_photonSelection && !m_photonSelection.getBool(*photon))
          continue;
        if (dec_photons_OR(*photon)) {
          if (xAOD::P4Helpers::deltaR(jet, photon) < 0.4)
            dec_jets_OR(*jet) = false;
        }
      }
    }
  }
 
  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

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 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 CP::ParticleLevelOverlapRemovalAlg::initialize ( )

finalvirtual

Definition at line 15 of file ParticleLevelOverlapRemovalAlg.cxx.

                                                      {
 
  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));
 
  if (!m_electronsKey.empty())
    m_decORelectron = m_electronsKey.key() + "." + m_decLabelOR.value();
  if (!m_muonsKey.empty())
    m_decORmuon = m_muonsKey.key() + "." + m_decLabelOR.value();
  if (!m_photonsKey.empty())
    m_decORphoton = m_photonsKey.key() + "." + m_decLabelOR.value();
  m_decORjet = m_jetsKey.key() + "." + m_decLabelOR.value();
 
  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());
 
  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()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.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 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 InputMakerBase, and HypoBase.

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_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 68 of file ParticleLevelOverlapRemovalAlg.h.

m_decORelectron

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

private

Initial value:

{
      this, "decORelectron", "TruthElectrons.passesOR", ""}

Definition at line 36 of file ParticleLevelOverlapRemovalAlg.h.

m_decORjet

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

private

Initial value:

{
      this, "decORjet", "SetMe", ""}

Definition at line 34 of file ParticleLevelOverlapRemovalAlg.h.

m_decORmuon

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

private

Initial value:

{
      this, "decORmuon", "TruthMuons.passesOR", ""}

Definition at line 38 of file ParticleLevelOverlapRemovalAlg.h.

m_decORphoton

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

private

Initial value:

{
      this, "decORphoton", "TruthPhotons.passesOR", ""}

Definition at line 40 of file ParticleLevelOverlapRemovalAlg.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_doJetElectronOR

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

private

Initial value:

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

Definition at line 59 of file ParticleLevelOverlapRemovalAlg.h.

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 62 of file ParticleLevelOverlapRemovalAlg.h.

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 65 of file ParticleLevelOverlapRemovalAlg.h.

m_electronSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_electronSelection

private

Initial value:

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

Definition at line 44 of file ParticleLevelOverlapRemovalAlg.h.

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 28 of file ParticleLevelOverlapRemovalAlg.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 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_jetSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_jetSelection

private

Initial value:

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

Definition at line 42 of file ParticleLevelOverlapRemovalAlg.h.

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 26 of file ParticleLevelOverlapRemovalAlg.h.

m_muonSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_muonSelection

private

Initial value:

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

Definition at line 47 of file ParticleLevelOverlapRemovalAlg.h.

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 30 of file ParticleLevelOverlapRemovalAlg.h.

m_photonSelection

CP::SelectionReadHandle CP::ParticleLevelOverlapRemovalAlg::m_photonSelection

private

Initial value:

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

Definition at line 49 of file ParticleLevelOverlapRemovalAlg.h.

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 32 of file ParticleLevelOverlapRemovalAlg.h.

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 55 of file ParticleLevelOverlapRemovalAlg.h.

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 51 of file ParticleLevelOverlapRemovalAlg.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:

• ParticleLevelOverlapRemovalAlg.h
• ParticleLevelOverlapRemovalAlg.cxx