TruthIsolationTool Class Reference

#include <TruthIsolationTool.h>

Inheritance diagram for TruthIsolationTool:

Collaboration diagram for TruthIsolationTool:

Public Types
enum	ParticleSelect { UseChargedOnly = 0, UseAll }
	enumerator to decide which strategy to apply in the selection of particles during the Et-isolation computation More...

Public Member Functions
	TruthIsolationTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~TruthIsolationTool ()
StatusCode	initialize ()
const std::string &	etIsolationsName (const std::string &mcEvtName) const
	Return the name of the TruthEtIsolations container (ie: its StoreGate location) given the StoreGate location of a McEventCollection. More...
StatusCode	buildEtIsolations (const std::string &mcEvtName, ITruthIsolationTool::ParticleSelect sel)
	Computes the isolation energies for each of the HepMC::GenEvent contained into the McEventCollection. More...
StatusCode	registerAlias (const std::string &originalMcEvtColl, const std::string &aliasMcEvtColl)
	Make an alias in the map of isolation energies. More...
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	sysInitialize () override
	Perform system initialization for an algorithm. 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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Inline methods: More...

Protected Member Functions
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 std::unordered_map< std::string, std::string >	EtIsolMap_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	buildEtIsolations (const std::string &mcEvtName, const HepMC::GenEvent *genEvt, const std::size_t genIdx, TruthEtIsolations &etIsols, ITruthIsolationTool::ParticleSelect sel)
	Computes the isolation energies for a given HepMC::GenEvent contained into the McEventCollection. More...
void	computeIso (const std::list< HepMC::ConstGenParticlePtr > &parts, const HepMC::ConstGenParticlePtr &p, TruthEtIsolations &etIsolations, ITruthIsolationTool::ParticleSelect sel)
	Computes and stores the list of transverse isolation energies for various cone sizes into the TruthEtIsolations container. More...
void	setupTruthEtIsolationsPrefix (Gaudi::Details::PropertyBase &truthEtIsolationsPrefix)
	Callback method to ensure consistency of the TruthEtIsolations prefix key. More...
void	setupMcEventsOutput (Gaudi::Details::PropertyBase &mcEventsOutputName)
	Callback method to ensure consistency of output McEventCollection key. More...
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
const HepPDT::ParticleDataTable *	m_pdt
	Particle Property service. More...
StringProperty	m_prefix
	Prefix for the TruthEtIsolations container. More...
StringProperty	m_mcEventsOutputName
	Name of the McEventCollection we should attach isolations to. More...
DoubleProperty	m_ptGamMin
	Minimum transverse energy of gammas to be taken into account into the isolation computation. More...
EtIsolMap_t	m_etIsolMap
	A map of McEventCollection StoreGate locations to the according StoreGate location of TruthEtIsolations. 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 32 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

Member Typedef Documentation

EtIsolMap_t

typedef std::unordered_map<std::string, std::string> TruthIsolationTool::EtIsolMap_t

private

Definition at line 136 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

ParticleSelect

enum ITruthIsolationTool::ParticleSelect

inherited

enumerator to decide which strategy to apply in the selection of particles during the Et-isolation computation

Enumerator
UseChargedOnly
UseAll

Definition at line 43 of file ITruthIsolationTool.h.

                      {
    UseChargedOnly = 0,
    UseAll
  };

Constructor & Destructor Documentation

TruthIsolationTool()

TruthIsolationTool::TruthIsolationTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 41 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

                                               : 
  AthAlgTool ( type, name,   parent ),
  m_pdt      ( nullptr )
{
  //
  // Property declaration
  // 
 
  declareProperty( "ptGammaMin", 
           m_ptGamMin = 0.5*GeV,
           "Minimum transverse energy of gammas to be taken into "
           "account into the isolation computation." );
 
  declareProperty( "TruthEtIsolationsPrefix",
           m_prefix = "TruthEtIsol",
           "Prefix for the TruthEtIsolations container. This is the "
           "string which will be prepended to the key of the "
           "McEventCollection to build the (StoreGate) output "
           "location for the TruthEtIsolations.\nie: \"GEN_EVENT\" "
           "--> \"<prefix>_GEN_EVENT\"" );
  m_prefix.declareUpdateHandler
    ( &TruthIsolationTool::setupTruthEtIsolationsPrefix,
      this );
 
  declareProperty( "McEventsOutput",
           m_mcEventsOutputName = "GEN_AOD",
           "Name of the McEventCollection we should attach "
           "isolations to" );
  m_mcEventsOutputName.declareUpdateHandler
    ( &TruthIsolationTool::setupMcEventsOutput,
      this );
 
  declareInterface<ITruthIsolationTool>(this);
}

~TruthIsolationTool()

TruthIsolationTool::~TruthIsolationTool ( )

virtualdefault

Member Function Documentation

buildEtIsolations() [1/2]

StatusCode TruthIsolationTool::buildEtIsolations ( const std::string &  mcEvtName, const HepMC::GenEvent *  genEvt, const std::size_t  genIdx, TruthEtIsolations &  etIsols, ITruthIsolationTool::ParticleSelect  sel  )

private

Computes the isolation energies for a given HepMC::GenEvent contained into the McEventCollection.

Definition at line 179 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  if ( nullptr == genEvt ) {
    msg(MSG::WARNING)
      << "Null pointer to GenEvent (idx = [" << genIdx << "] from "
      << "McEventCollection [" << mcEvtName << "]) !!"
      << endmsg;
    return StatusCode::RECOVERABLE;
  }
 
  // create a reduced list of particles
  GenParticles_t particles;
  for ( const auto& i: *genEvt) {
    if ( MC::isGenStable(i) && MC::isSimInteracting(i) ) {
      particles.push_back( i );
    }
  }
 
  for ( const auto& i: *genEvt) {
    const HepMC::FourVector hlv = i->momentum();
    const int    ida = std::abs(i->pdg_id());
    const double pt  = hlv.perp();
 
    // Compute isolation only for photon, electron, muon or tau. 
    // Not for documentation particle
    const bool doComputeIso = ( ( ida == 22 && pt > m_ptGamMin ) ||
                                ida == 11 || ida == 13 || ida == 15 ) &&
                                 MC::isPhysical(i) && MC::isSimInteracting(i);
    if ( doComputeIso ) {
      computeIso( particles, i, etIsols, partSel );
    }
  }
  
  return StatusCode::SUCCESS;
}

buildEtIsolations() [2/2]

StatusCode TruthIsolationTool::buildEtIsolations ( const std::string &  mcEvtName, ITruthIsolationTool::ParticleSelect  sel  )

virtual

Computes the isolation energies for each of the HepMC::GenEvent contained into the McEventCollection.

One can switch b/w using all particles or only the charged ones. Default (from interface) is to use all.

Implements ITruthIsolationTool.

Definition at line 121 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  // retrieve collection
  const McEventCollection* mcEvts = nullptr;
  if ( !evtStore()->retrieve( mcEvts, mcEvtName ).isSuccess() ) {
    ATH_MSG_WARNING("Could not retrieve a McEventCollection at ["
            << mcEvtName << "] !!" << endmsg
            << "No Et-isolations will be computed !");
    return StatusCode::RECOVERABLE;
  }
 
  // the name of the output (filtered) McEventCollection we want to attach
  // the Et-isolations to
  const std::string& outMcEvtName = m_mcEventsOutputName.value();
 
  // create the container of TruthEtIsolations
  std::ostringstream truthEtIsolName;
  truthEtIsolName << m_prefix.value() 
          << (partSel == ITruthIsolationTool::UseChargedOnly 
              ? "Charged"
              : "") 
          << "_" << outMcEvtName;
 
  TruthEtIsolationsContainer * etIsolations = new TruthEtIsolationsContainer;
  if ( !evtStore()->record( etIsolations, 
                 truthEtIsolName.str() ).isSuccess() ) {
    delete etIsolations;
    etIsolations = nullptr;
    ATH_MSG_WARNING("Could not record a TruthEtIsolations container at ["
            << truthEtIsolName.str() << "] !!");
    return StatusCode::RECOVERABLE;
  }
  if ( !evtStore()->setConst( etIsolations ).isSuccess() ) {
    ATH_MSG_WARNING("Could not setConst the TruthEtIsolations container at ["
            << truthEtIsolName.str() << "] !!");
  }
 
  // update our registry of EtIsol StoreGate locations
  m_etIsolMap[outMcEvtName] = truthEtIsolName.str();
 
  bool allGood = true;
  for ( std::size_t iMc = 0, iMax = mcEvts->size(); iMc != iMax; ++iMc ) {
    TruthEtIsolations * etIsols = new TruthEtIsolations( outMcEvtName, iMc );
    etIsolations->push_back( etIsols );
    if ( !buildEtIsolations( mcEvtName, (*mcEvts)[iMc], iMc,
                 *etIsols, partSel ).isSuccess() ) {
      msg(MSG::WARNING)
    << "Problem encountered while computing Et-isolations for idx=["
    << iMc << "] of McEventCollection [" << mcEvtName << "] !!"
    << endmsg;
      allGood = false;
    }
  }
  return allGood ? StatusCode::SUCCESS : StatusCode::RECOVERABLE;
}

computeIso()

void TruthIsolationTool::computeIso ( const std::list< HepMC::ConstGenParticlePtr > &  parts, const HepMC::ConstGenParticlePtr &  p, TruthEtIsolations &  etIsolations, ITruthIsolationTool::ParticleSelect  sel  )

private

Computes and stores the list of transverse isolation energies for various cone sizes into the TruthEtIsolations container.

Definition at line 220 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  const HepLorentzVector hlv = ::svToLv(part->momentum());
  const int ida = std::abs(part->pdg_id());
 
  McAod::EtIsolations etIsol = { {0.*GeV, 0.*GeV, 0.*GeV, 0.*GeV,
                  0.*GeV, 0.*GeV, 0.*GeV, 0.*GeV} };
  McAod::EtIsolations pxi = etIsol;
  McAod::EtIsolations pyi = etIsol;
 
  int barcodepart = HepMC::barcode(part);
  for (const auto & particle : particles) {
    if ( HepMC::barcode(particle) == barcodepart ) {
      continue;
    }
    if( partSel == ITruthIsolationTool::UseChargedOnly ) {
      double particleCharge = MC::charge(particle->pdg_id());
      if( std::abs(particleCharge)<1.e-2 )
    continue;
    }
    const HepLorentzVector itrHlv = ::svToLv(particle->momentum());
    const double r = hlv.deltaR(itrHlv);
    for ( std::size_t iCone = 0; 
      iCone != TruthParticleParameters::NbrOfCones; 
      ++iCone ) {
      if ( r < TruthParticleParameters::coneCut(static_cast<TruthParticleParameters::ConeSize>(iCone) ) ) {
    pxi[iCone] += itrHlv.px();
    pyi[iCone] += itrHlv.py();
      }
    }
  }
 
  //
  // Correction for tau (as was done in the old tool for the time being)
  double pxv = 0.*GeV;
  double pyv = 0.*GeV;
  auto decVtx = part->end_vertex();
  if (ida == 15 && decVtx) {
    for (const auto& child:  *decVtx) {
      if ( MC::isSimInteracting(child) ) {
    if( partSel == ITruthIsolationTool::UseChargedOnly ) {
      double particleCharge = MC::charge(child->pdg_id());
      if( std::abs(particleCharge)<1.e-2 )
        continue;
    }
    const HepMC::FourVector childHlv = child->momentum();
    pxv += childHlv.px();
    pyv += childHlv.py();
      }
    }
  }
 
  for ( std::size_t i = 0; 
        i != static_cast<std::size_t>(TruthParticleParameters::NbrOfCones);
        ++i ) {
    pxi[i] -= pxv;
    pyi[i] -= pyv;
    etIsol[i] = std::sqrt(pxi[i]*pxi[i]+pyi[i]*pyi[i]);
  }
 
  etIsolations.setEtIsol( part, etIsol );
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

etIsolationsName()

const std::string & TruthIsolationTool::etIsolationsName ( const std::string &  mcEvtName ) const

virtual

Return the name of the TruthEtIsolations container (ie: its StoreGate location) given the StoreGate location of a McEventCollection.

It returns an empty string if no TruthEtIsolations container has been processed by the isolation tool.

Implements ITruthIsolationTool.

Definition at line 109 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  static const std::string s_emptyString = "";
  const EtIsolMap_t::const_iterator i = m_etIsolMap.find(mcEvtName);
  if ( i != m_etIsolMap.end() ) {
    return i->second;
  }
 
  return s_emptyString;
}

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

initialize()

StatusCode TruthIsolationTool::initialize ( )

virtual

Implements ITruthIsolationTool.

Definition at line 81 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  // retrieve StoreGate
  if ( !evtStore().retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Could not get a handle on StoreGateSvc !!");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO(" McEventsOutput: [" << m_mcEventsOutputName.value() << "]");
 
  // Get the Particle Properties Service
  ServiceHandle<IPartPropSvc> partPropSvc("PartPropSvc", name());
  if ( !partPropSvc.retrieve().isSuccess() ) {
    ATH_MSG_ERROR(" Could not initialize Particle Properties Service");
    return StatusCode::FAILURE;
  }      
 
  m_pdt = partPropSvc->PDT();
  if ( nullptr == m_pdt ) {
    ATH_MSG_ERROR("Could not retrieve HepPDT::ParticleDataTable from "\
          "ParticleProperties Service !!");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

interfaceID()

const InterfaceID & ITruthIsolationTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 100 of file ITruthIsolationTool.h.

{ 
   return IID_ITruthIsolationTool; 
}

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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.

registerAlias()

StatusCode TruthIsolationTool::registerAlias ( const std::string &  originalMcEvtColl, const std::string &  aliasMcEvtColl  )

virtual

Make an alias in the map of isolation energies.

Implements ITruthIsolationTool.

Definition at line 299 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  m_etIsolMap[aliasMcEvtColl] = m_etIsolMap[originalMcEvtColl];
  return StatusCode::SUCCESS;
}

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< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setupMcEventsOutput()

void TruthIsolationTool::setupMcEventsOutput ( Gaudi::Details::PropertyBase &  mcEventsOutputName )

private

Callback method to ensure consistency of output McEventCollection key.

Definition at line 293 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  // no-op for now
}

setupTruthEtIsolationsPrefix()

void TruthIsolationTool::setupTruthEtIsolationsPrefix ( Gaudi::Details::PropertyBase &  truthEtIsolationsPrefix )

private

Callback method to ensure consistency of the TruthEtIsolations prefix key.

Definition at line 287 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx.

{
  // no-op for now
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_etIsolMap

EtIsolMap_t TruthIsolationTool::m_etIsolMap

private

A map of McEventCollection StoreGate locations to the according StoreGate location of TruthEtIsolations.

Definition at line 139 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_mcEventsOutputName

StringProperty TruthIsolationTool::m_mcEventsOutputName

private

Name of the McEventCollection we should attach isolations to.

Definition at line 128 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

m_pdt

const HepPDT::ParticleDataTable* TruthIsolationTool::m_pdt

private

Particle Property service.

Definition at line 118 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

m_prefix

StringProperty TruthIsolationTool::m_prefix

private

Prefix for the TruthEtIsolations container.

This is the string which will be prepended to the key of the McEventCollection to build the (StoreGate) output location for the TruthEtIsolations. ie: "GEN_EVENT" --> "<prefix>_GEN_EVENT"

Definition at line 124 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

m_ptGamMin

DoubleProperty TruthIsolationTool::m_ptGamMin

private

Minimum transverse energy of gammas to be taken into account into the isolation computation.

Default is ptMin = 0.5*GeV

Definition at line 134 of file TruthParticleID/McParticleTools/src/TruthIsolationTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TruthParticleID/McParticleTools/src/TruthIsolationTool.h
• TruthParticleID/McParticleTools/src/TruthIsolationTool.cxx