MCTruthClassifier Class Reference

#include <MCTruthClassifier.h>

Inheritance diagram for MCTruthClassifier:

Collaboration diagram for MCTruthClassifier:

Public Member Functions
	MCTruthClassifier (const std::string &type)
virtual	~MCTruthClassifier ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual const xAOD::TruthParticle *	getGenPart (const xAOD::TrackParticle *, IMCTruthClassifier::Info *info=nullptr) const override final
virtual const xAOD::TruthParticle *	egammaClusMatch (const xAOD::CaloCluster *, bool, IMCTruthClassifier::Info *info) const override final
std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::Jet *p, bool DR) const
template<typename T>
std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const T *p, std::optional< std::reference_wrapper< const EventContext > > ctx=std::nullopt) const
std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleHepMCTruthClassifier (const HepMcParticleLink &theLink) const
template<typename T>
std::tuple< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin, const xAOD::TruthParticle *, MCTruthPartClassifier::ParticleOutCome >	particleTruthClassifier_full (const T *p, std::optional< std::reference_wrapper< const EventContext > > ctx=std::nullopt) const
	Returns more info than the particleTruthClassifier.
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::TruthParticle *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleHepMCTruthClassifier (const HepMcParticleLink &theLink, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::TrackParticle *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::Electron *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::Photon *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::Muon *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::CaloCluster *, IMCTruthClassifier::Info *info) const override final
virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin >	particleTruthClassifier (const xAOD::Jet *, bool DR, IMCTruthClassifier::Info *info) const override final
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
MCTruthPartClassifier::ParticleOrigin	defOrigOfElectron (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *, bool &isPrompt, IMCTruthClassifier::Info &info) const
	namespace
MCTruthPartClassifier::ParticleOrigin	defOrigOfMuon (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *, bool &isPrompt, IMCTruthClassifier::Info &info) const
MCTruthPartClassifier::ParticleOrigin	defOrigOfTau (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *, int motherPDG, IMCTruthClassifier::Info &info) const
MCTruthPartClassifier::ParticleOrigin	defOrigOfPhoton (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *, bool &isPrompt, IMCTruthClassifier::Info &info) const
MCTruthPartClassifier::ParticleOrigin	defOrigOfNeutrino (const xAOD::TruthParticleContainer &xTruthParticleContainer, const xAOD::TruthParticle *, bool &isPrompt, IMCTruthClassifier::Info &info) const
bool	genPartToCalo (const EventContext &ctx, const xAOD::CaloCluster *clus, const xAOD::TruthParticle *thePart, bool isFwrdEle, double &dRmatch, bool &isNarrowCone, const CaloDetDescrManager &caloDDMgr) 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::TruthParticleContainer >	m_truthParticleContainerKey {this,"xAODTruthParticleContainerName","TruthParticles","ReadHandleKey for xAOD::TruthParticleContainer"}
ToolHandle< Trk::IParticleCaloExtensionTool >	m_caloExtensionTool {this,"ParticleCaloExtensionTool",""}
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager",""}
ToolHandle< xAOD::ITruthParticlesInConeTool >	m_truthInConeTool {this,"TruthInConeTool","xAOD::TruthParticlesInConeTool/TruthParticlesInConeTool"}
bool	m_FwdElectronUseG4Sel
float	m_FwdElectronTruthExtrEtaCut
float	m_FwdElectronTruthExtrEtaWindowCut
float	m_partExtrConeEta
float	m_partExtrConePhi
float	m_phtClasConePhi
float	m_phtClasConeEta
float	m_phtdRtoTrCut
float	m_fwrdEledRtoTrCut
bool	m_ROICone
float	m_pTChargePartCut
float	m_pTNeutralPartCut
bool	m_inclG4part
SG::ReadHandleKey< xAODTruthParticleLinkVector >	m_truthLinkVecReadHandleKey {this,"xAODTruthLinkVector","xAODTruthLinks", "ReadHandleKey for xAODTruthParticleLinkVector"}
float	m_deltaRMatchCut
float	m_deltaPhiMatchCut
int	m_NumOfSiHitsCut
float	m_jetPartDRMatch
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 55 of file MCTruthClassifier.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MCTruthClassifier()

MCTruthClassifier::MCTruthClassifier ( const std::string & type )

inline

Definition at line 60 of file MCTruthClassifier.h.

                                            : asg::AsgTool(type) {
#if !defined(XAOD_ANALYSIS) && !defined(GENERATIONBASE)
    declareProperty("FwdElectronUseG4Sel", m_FwdElectronUseG4Sel = true,
                    "Use Geant4 selection for forward electrons calo clusters");
    declareProperty("FwdElectronTruthExtrEtaCut",
                    m_FwdElectronTruthExtrEtaCut = 2.4,
                    "Cut on the eta of the truth Particles to be extrapolated "
                    "for Fwd electrons");
    declareProperty(
        "FwdElectronTruthExtrEtaWindowCut",
        m_FwdElectronTruthExtrEtaWindowCut = 0.15,
        "Cut on the delta eta of the truth Particles to be extrapolated for "
        "Fwd electrons and the current FwdElectron");
    declareProperty("partExtrConePhi", m_partExtrConePhi = 0.4);
    declareProperty("partExtrConeEta", m_partExtrConeEta = 0.2);
    declareProperty("phtClasConePhi", m_phtClasConePhi = 0.05);
    declareProperty("phtClasConeEta", m_phtClasConeEta = 0.025);
    declareProperty("phtdRtoTrCut", m_phtdRtoTrCut = 0.1);
    declareProperty("fwrdEledRtoTrCut", m_fwrdEledRtoTrCut = 0.15);
    declareProperty("ROICone", m_ROICone = false);
    //AV: those below are needed in egammaClusMatch
    declareProperty("pTChargePartCut", m_pTChargePartCut = 1.0);
    declareProperty("pTNeutralPartCut", m_pTNeutralPartCut = 0.);
    declareProperty("inclG4part", m_inclG4part = false);
#endif
#ifndef GENERATIONBASE
    declareProperty("deltaRMatchCut", m_deltaRMatchCut = 0.2);
    declareProperty("deltaPhiMatchCut", m_deltaPhiMatchCut = 0.2);
    declareProperty("NumOfSiHitsCut", m_NumOfSiHitsCut = 3);
    declareProperty("jetPartDRMatch", m_jetPartDRMatch = 0.4);
#endif
  }

~MCTruthClassifier()

virtual MCTruthClassifier::~MCTruthClassifier ( )

virtualdefault

Member Function Documentation

declareGaudiProperty()

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

defOrigOfElectron()

ParticleOrigin MCTruthClassifier::defOrigOfElectron ( const xAOD::TruthParticleContainer & xTruthParticleContainer, const xAOD::TruthParticle * thePart, bool & isPrompt, IMCTruthClassifier::Info & info ) const

private

namespace

Definition at line 254 of file MCTruthClassifierGen.cxx.

{
  ATH_MSG_DEBUG("Executing DefOrigOfElectron ");
 
  // Find the first copy of this particle stored in the xAOD::TruthParticleContainer (i.e. the particle prior to any interactions)
  const xAOD::TruthParticle* thePriPart = MC::findMatching(xTruthParticleContainer, thePart);
  if (!thePriPart) return NonDefined;
  if (!MC::isElectron(thePriPart)) return NonDefined;
 
  //-- to define electron outcome status
  info.particleOutCome = defOutComeOfElectron(thePriPart);
 
  const xAOD::TruthVertex* partProdVtx = thePriPart->hasProdVtx() ? thePriPart->prodVtx() : nullptr;
  if (!partProdVtx) return NonDefined;
 
  if (partProdVtx->nIncomingParticles() > 1) ATH_MSG_DEBUG("DefOrigOfElectron:: electron has more than one parent.");
 
  const xAOD::TruthParticle* ancestor = MC::findMother(thePriPart);
  info.setMotherProperties(ancestor);
  if (!ancestor) { return NonDefined; } // After this point "ancestor" cannot be nullptr
 
  // Start of method 1 of protecting against loops
  bool samePart = TruthLoopDetectionMethod1(partProdVtx, ancestor);
  // to resolve Sherpa loop
  // End of method 1 of protecting against loops
 
  if ((MC::isMuon(ancestor) || MC::isTau(ancestor) || MC::isW(ancestor)) && ancestor->hasProdVtx() && !samePart) {
    int pPDG(0);
    const xAOD::TruthParticle* ancestorParent{};
    do {
      pPDG = 0; // reset pPDG
      ancestorParent = MC::findMother(ancestor);
      // Start of method 2 of protecting against loops
      // to prevent Sherpa loop
      if (ancestor == ancestorParent) { break; }
      if (TruthLoopDetectionMethod2(ancestor,ancestorParent)) {
        ancestorParent = ancestor;
        break;
      }
      // End of method 2 of protecting against loops
      // FIXME why are slightly different criteria used in method 1 and method 2???
      if (ancestorParent) {
        pPDG = ancestorParent->pdgId(); // Only set pPDG in the case that we aren't in a loop.
        if (MC::isMuon(pPDG) || MC::isTau(pPDG) || MC::isW(pPDG)) { // There will be another iteration so set ancestor to ancestorParent
          ancestor = ancestorParent; // ancestorParent is not nullptr here
        }
      }
    } while ((MC::isMuon(pPDG) || MC::isTau(pPDG) || MC::isW(pPDG)));
 
    if (MC::isMuon(pPDG) || MC::isTau(pPDG) || MC::isW(pPDG) || MC::isZ(pPDG) || MC::isHiggs(pPDG) ||
        MC::isMSSMHiggs(pPDG) || MC::isHeavyBoson(pPDG) || MC::isTop(pPDG) || // MSSM Higgs bosons, Heavy bosons( Z', Z'', W'+)
        std::abs(pPDG) == MC::WBOSON_LRSM || MC::isNeutrinoRH(pPDG) || // Left-right symmetric model WBoson || Right-handed neutrino (Pythia-specific)
        MC::isSUSY(pPDG)) {
      ancestor = ancestorParent; // ancestorParent is not nullptr here
    }
  }
 
  info.setMotherProperties(ancestor);
  const int ancestorPDG = ancestor->pdgId();
  const xAOD::TruthVertex* ancestorProdVtx = ancestor->hasProdVtx() ? ancestor->prodVtx() : nullptr;
  partProdVtx = ancestor->decayVtx();
  const int numOfParents = partProdVtx->nIncomingParticles();
  const int numberOfChildren = partProdVtx->nOutgoingParticles();
 
  // Determine decay products
  auto DP = DecayProducts(partProdVtx);
  const int NumOfPhot = DP.pd(MC::PHOTON);
  const int NumOfEl = DP.pd(MC::ELECTRON);
  const int NumOfPos = DP.pd(MC::POSITRON);
  const int NumOfquark = DP.apd({MC::DQUARK,MC::UQUARK,MC::SQUARK,MC::CQUARK,MC::BQUARK,MC::TQUARK});
  const int NumOfgluon = DP.apd(MC::GLUON);
  const int NumOfElNeut = DP.apd(MC::NU_E);
  const int NumOfLQ = DP.apd(MC::LEPTOQUARK);
  const int NumOfMuPl = DP.pd(-MC::MUON);
  const int NumOfMuMin = DP.pd(MC::MUON);
  const int NumOfMuNeut = DP.apd(MC::NU_MU);
  const int NumOfTau = DP.apd(MC::TAU);
  const int NumOfTauNeut = DP.apd(MC::NU_TAU);
  
  samePart = false;
  int NumOfNucFr(0);
  const bool possibleNuclearFragment = (numOfParents == 1 && (MC::isPhoton(ancestorPDG) || MC::isElectron(ancestorPDG) || MC::isMuon(ancestorPDG) || std::abs(ancestorPDG) == MC::PIPLUS));
  for (const auto& aChild: partProdVtx->particles_out()) {
    if (!aChild) continue;
    const int childPDG = aChild->pdgId();
    if (std::abs(childPDG) == std::abs(ancestorPDG) && HepMC::is_same_generator_particle(aChild, ancestor )) samePart = true;
    if (possibleNuclearFragment &&
        (MC::isNucleus(childPDG) || childPDG == 0 || childPDG == MC::PROTON || childPDG == MC::NEUTRON || // FIXME Do we really expect particles with PDG_ID = 0 in the truth record?
         std::abs(childPDG) == MC::PIPLUS || std::abs(childPDG) == MC::PI0))
      NumOfNucFr++;
  }
  // End of section determining decay products
 
  if (MC::isPhoton(ancestorPDG) && ancestorProdVtx) {
    if (ancestorProdVtx->nIncomingParticles() > 1) { ATH_MSG_DEBUG("DefOrigOfElectron:: photon has more than one parent.");  }
    for (const auto& photonParent: ancestorProdVtx->particles_in()) {
      if (!photonParent) continue;
      info.photonMother = photonParent;  // FIXME Just taking the first valid particle...
    }
  }
 
  if ((MC::isPhoton(ancestorPDG) && numberOfChildren == 2 && NumOfEl == 1 && NumOfPos == 1) || (MC::isPhoton(ancestorPDG) && numberOfChildren == 1 && (NumOfEl == 1 || NumOfPos == 1))) return PhotonConv;
 
  // e,gamma,pi+Nuclear->NuclearFragments+nuclons+e
  if ((numOfParents == 1 && (MC::isPhoton(ancestorPDG) || MC::isElectron(ancestorPDG) || MC::isTau(ancestorPDG))) && numberOfChildren > 1 && NumOfNucFr != 0) return ElMagProc;
 
  if (numOfParents == 1 && std::abs(ancestorPDG) == MC::PIPLUS && numberOfChildren > 2 && NumOfNucFr != 0) return ElMagProc;
 
  // nuclear photo fission
  if (MC::isPhoton(ancestorPDG) && numberOfChildren > 4 && NumOfNucFr != 0) return ElMagProc;
 
  // unknown process el(pos)->el+pos??
  if (MC::isElectron(ancestorPDG) && numberOfChildren == 2 && NumOfEl == 1 && NumOfPos == 1) return ElMagProc;
 
  // unknown process el->el+el??
  if (ancestorPDG == MC::ELECTRON && numberOfChildren == 2 && NumOfEl == 2 && NumOfPos == 0) return ElMagProc;
 
  // unknown process pos->pos+pos??
  if (ancestorPDG == MC::POSITRON && numberOfChildren == 2 && NumOfEl == 0 && NumOfPos == 2) return ElMagProc;
 
  // unknown process pos/el->pos/el??
  if (MC::isElectron(ancestorPDG) && !MC::isDecayed(ancestor) && ancestorPDG == thePriPart->pdgId() && numberOfChildren == 1 && !samePart) return ElMagProc;
 
  // pi->pi+e+/e-; mu->mu+e+/e- ;
  // gamma+ atom->gamma(the same) + e (compton scattering)
  if (numberOfChildren == 2 && (NumOfEl == 1 || NumOfPos == 1) && !MC::isElectron(ancestorPDG) && samePart) return ElMagProc;
 
  if ((ancestorPDG == MC::PI0 && numberOfChildren == 3 && NumOfPhot == 1 && NumOfEl == 1 && NumOfPos == 1) ||
      (ancestorPDG == MC::PI0 && numberOfChildren == 4 && NumOfPhot == 0 && NumOfEl == 2 && NumOfPos == 2))
    return DalitzDec;
 
  // Quark weak decay
  if (MC::isSMQuark(ancestorPDG) && numOfParents == 1 && numberOfChildren == 3 && NumOfquark == 1 && NumOfElNeut == 1) return QuarkWeakDec;
 
  if (MC::isMuon(ancestorPDG) && NumOfNucFr != 0) return ElMagProc;
  
  if (MC::isTop(ancestorPDG)) return top;
 
  if (MC::isW(ancestorPDG) && ancestorProdVtx && ancestorProdVtx->nIncomingParticles() != 0) {
 
    const xAOD::TruthVertex* prodVert = ancestorProdVtx;
    const xAOD::TruthParticle* ptrPart{};
    do {
      ptrPart = prodVert->incomingParticle(0); // FIXME just taking the first one
      prodVert = ptrPart->hasProdVtx() ? ptrPart->prodVtx() : nullptr;
    } while (MC::isW(ptrPart) && prodVert);
 
    if (prodVert && prodVert->nIncomingParticles() == 1) {
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
    }
    return WBoson;
  }
  if (MC::isW(ancestorPDG)) return WBoson;
  if (MC::isZ(ancestorPDG)) return ZBoson;
 
  // MadGraphPythia ZWW*->lllnulnu
  if (numOfParents == 1 && numberOfChildren > 4 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG))) {
 
    const xAOD::TruthParticle* thePartToCheck = thePriPart;
    const xAOD::TruthParticle* theParent = thePriPart->hasProdVtx() ? thePriPart->prodVtx()->incomingParticle(0) : nullptr; // FIXME just taking the first one
    if (theParent && MC::isElectron(theParent) && MC::isDecayed(theParent)) { thePartToCheck = theParent; }
 
    bool isZboson = false;
    bool isWboson = false;
    bool skipnext = false;
 
    for (unsigned int ipOut = 0; ipOut + 1 < partProdVtx->nOutgoingParticles(); ++ipOut) {
      const xAOD::TruthParticle* aChild = partProdVtx->outgoingParticle(ipOut);
      if (!aChild) continue;
      const xAOD::TruthParticle* theNextChild = nullptr;
      for (unsigned int ipOut1 = ipOut + 1; ipOut1 < partProdVtx->nOutgoingParticles(); ipOut1++) {
        theNextChild = partProdVtx->outgoingParticle(ipOut1);
        if (theNextChild) break;
      }
      if (!theNextChild) continue;
      if (skipnext) {
        skipnext = false;
        continue;
      }
 
      if (MC::isElectron(aChild) && MC::isElectron(theNextChild)) {
        // Zboson
        if (thePartToCheck == aChild || thePartToCheck == theNextChild) {
          isZboson = true;
          break;
        }
        skipnext = true;
      } else if (MC::isElectron(aChild) && std::abs(theNextChild->pdgId()) == MC::NU_E) {
        // WBoson
        if (thePartToCheck == aChild || thePartToCheck == theNextChild) {
          isWboson = true;
          break;
        }
        skipnext = true;
      }
    }
    if (isWboson) return WBoson;
    if (isZboson) return ZBoson;
  }
  if (numOfParents == 2) {
    //--Sherpa Z->ee
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && NumOfEl == 1 && NumOfPos == 1) return ZBoson;
 
    //--Sherpa W->enu ??
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && (NumOfEl == 1 || NumOfPos == 1) && NumOfElNeut == 1) return WBoson;
    
    const int pdg1 = partProdVtx->incomingParticle(0)->pdgId();
    const int pdg2 = partProdVtx->incomingParticle(1)->pdgId();
    //--Sherpa ZZ,ZW
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 4 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 4) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return DiBoson;
    
    //--Sherpa VVV -- Note, have to allow for prompt photon radiation or these get lost
    if ((numberOfChildren - NumOfquark - NumOfgluon - NumOfPhot) == 6 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 6) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return MultiBoson;
 
    //--Sherpa tttt with all t->Wb; W->lnu
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 8 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 8) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) {
      ATH_MSG_VERBOSE("MultiBoson for 4topLep");
      return MultiBoson;
    }
    
    //--Sherpa Vgamma ( Z->ee+gamma or W->enu+gamma ) 
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && NumOfEl == 1 && NumOfPos == 1) {
        ATH_MSG_VERBOSE("Sherpa ee + gamma");
        return ZBoson;
    }
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && (NumOfEl == 1 || NumOfPos == 1) && NumOfElNeut == 1) {
        ATH_MSG_VERBOSE("Sherpa enu + gamma");
        return WBoson;
    }
  }
 
  // New Sherpa Z->ee
  if (partProdVtx == ancestorProdVtx) {
    int NumOfEleLoop = 0;
    int NumOfLepLoop = 0;
    int NumOfEleNeuLoop = 0;
    for (const auto *const pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      for (const auto *const pin: partProdVtx->particles_in()) {
        if (!pin) continue;
        if (!HepMC::is_same_particle(pout,pin)) continue;
        if (MC::isElectron(pout)) NumOfEleLoop++;
        if (std::abs(pout->pdgId()) == MC::NU_E) NumOfEleNeuLoop++;
        if (MC::isSMLepton(pout)) NumOfLepLoop++;
        break; // break out of inner loop after having found two matching particles
      }
    }
    if (NumOfEleLoop == 2 && NumOfEleNeuLoop == 0) return ZBoson;
    if (NumOfEleLoop == 1 && NumOfEleNeuLoop == 1) return WBoson;
    if ((NumOfEleLoop == 4 && NumOfEleNeuLoop == 0) || (NumOfEleLoop == 3 && NumOfEleNeuLoop == 1) ||
        (NumOfEleLoop == 2 && NumOfEleNeuLoop == 2)) return DiBoson;
    if (NumOfLepLoop == 4) return DiBoson;
  }
 
  //-- McAtNLo
 
  if (MC::isHiggs(ancestorPDG)) return Higgs;
 
  if (MC::isMSSMHiggs(ancestorPDG)) return HiggsMSSM; // MSSM Higgs bosons
 
  if (MC::isHeavyBoson(ancestorPDG)) return HeavyBoson;  // Heavy bosons( Z', Z'', W'+)
 
  if (MC::isMuon(ancestorPDG)) return Mu;
  if (MC::isTau(ancestorPDG)) {
    const ParticleOrigin tauOrig = defOrigOfTau(xTruthParticleContainer, ancestor, ancestorPDG, info);
    const ParticleType tautype = defTypeOfTau(tauOrig);
    return (tautype == IsoTau)?tauOrig:TauLep;
  }
 
  if (std::abs(ancestorPDG) == MC::WBOSON_LRSM) return WBosonLRSM; // Left-right symmetric model WBoson (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
  if (MC::isLeptoQuark(ancestorPDG) || NumOfLQ != 0) return LQ;
  if (MC::isSUSY(ancestorPDG)) return SUSY;
  if (MC::isBSM(ancestorPDG)) return OtherBSM;
 
  const ParticleType pType = defTypeOfHadron(ancestorPDG);
  if ((pType == BBbarMesonPart || pType == CCbarMesonPart) && ancestorProdVtx && MC::isHardScatteringVertex(ancestorProdVtx)) isPrompt = true;
  return convHadronTypeToOrig(pType, ancestorPDG);
}

defOrigOfMuon()

ParticleOrigin MCTruthClassifier::defOrigOfMuon ( const xAOD::TruthParticleContainer & xTruthParticleContainer, const xAOD::TruthParticle * thePart, bool & isPrompt, IMCTruthClassifier::Info & info ) const

private

Definition at line 548 of file MCTruthClassifierGen.cxx.

{
  ATH_MSG_DEBUG("Executing DefOrigOfMuon ");
 
  // Find the first copy of this particle stored in the xAOD::TruthParticleContainer (i.e. the particle prior to any interactions)
  const xAOD::TruthParticle* thePriPart = MC::findMatching(xTruthParticleContainer, thePart);
  if (!thePriPart) return NonDefined;
  if (!MC::isMuon(thePriPart)) return NonDefined;
 
  //-- to define muon  outcome status
  info.particleOutCome = defOutComeOfMuon(thePriPart);
 
  const xAOD::TruthVertex* partProdVtx = thePriPart->hasProdVtx() ? thePriPart->prodVtx() : nullptr;
  if (!partProdVtx) return NonDefined;
 
  if (partProdVtx->nIncomingParticles() > 1) ATH_MSG_DEBUG("DefOrigOfMuon:: muon has more than one parent.");
 
  const xAOD::TruthParticle* ancestor = MC::findMother(thePriPart);
  info.setMotherProperties(ancestor);
  if (!ancestor) { return NonDefined; } // ancestor is not a nullptr beyond this point
 
  // "method 1" for finding Sherpa loops from defOrigOfElectron not used here. Why?
 
  if ((MC::isTau(ancestor)|| MC::isW(ancestor)) && ancestor->hasProdVtx()) {
    int pPDG(0);
    const xAOD::TruthParticle* ancestorParent{};
    do {
      pPDG = 0;
      ancestorParent = MC::findMother(ancestor);
      // Start of method 2 of protecting against loops
      // to prevent Sherpa loop
      if (ancestor == ancestorParent) { break; }
      if (TruthLoopDetectionMethod2(ancestor,ancestorParent)) {
        ancestorParent = ancestor;
        break;
      }
      // End of method 2 of protecting against loops
 
      if (ancestorParent) {
        pPDG = ancestorParent->pdgId();// Only set pPDG in the case that we aren't in a loop.
        if (MC::isMuon(pPDG) || MC::isTau(pPDG) || MC::isW(pPDG)) { // FIXME should this be (MC::isTau(pPDG) || MC::isW(pPDG)) ???
          // There will be another iteration so set ancestor to ancestorParent
          ancestor = ancestorParent; // ancestorParent is not nullptr here
        }
      }
    } while ((MC::isMuon(pPDG) || MC::isTau(pPDG) || MC::isW(pPDG))); // FIXME should this be (MC::isTau(pPDG) || MC::isW(pPDG)) ???
 
    if (MC::isTau(pPDG) || MC::isW(pPDG) || MC::isZ(pPDG) || MC::isHiggs(pPDG) ||
        MC::isMSSMHiggs(pPDG) || MC::isHeavyBoson(pPDG) || MC::isTop(pPDG) || // MSSM Higgs bosons, Heavy bosons( Z', Z'', W'+)
        std::abs(pPDG) == MC::WBOSON_LRSM || MC::isNeutrinoRH(pPDG) ||  // Left-right symmetric model WBoson || Right-handed neutrino (Pythia-specific)
        MC::isSUSY(pPDG)) {
      ancestor = ancestorParent; // ancestorParent is not nullptr here
    }
  }
 
  info.setMotherProperties(ancestor);
  const int ancestorPDG = ancestor->pdgId();
  const xAOD::TruthVertex* ancestorProdVtx = ancestor->hasProdVtx() ? ancestor->prodVtx() : nullptr;
  partProdVtx = ancestor->decayVtx();
  const int numOfParents = partProdVtx->nIncomingParticles();
  const int numberOfChildren = partProdVtx->nOutgoingParticles();
 
  // Determine decay products
  auto DP = DecayProducts(partProdVtx);
  const int NumOfPhot = DP.pd(MC::PHOTON);
  const int NumOfEl = DP.pd(MC::ELECTRON);
  const int NumOfPos = DP.pd(MC::POSITRON);
  const int NumOfElNeut = DP.apd(MC::NU_E);
  const int NumOfMuNeut = DP.apd(MC::NU_MU);
  const int NumOfLQ = DP.apd(MC::LEPTOQUARK);
  const int NumOfquark = DP.apd({MC::DQUARK,MC::UQUARK,MC::SQUARK,MC::CQUARK,MC::BQUARK,MC::TQUARK});
  const int NumOfgluon = DP.apd(MC::GLUON);
  const int NumOfMuPl = DP.pd(-MC::MUON);
  const int NumOfMuMin = DP.pd(MC::MUON);
  const int NumOfTau = DP.apd(MC::TAU);
  const int NumOfTauNeut = DP.apd(MC::NU_TAU);
  // End of section determining decay products
 
  if (std::abs(ancestorPDG) == MC::PIPLUS && numberOfChildren == 2 && NumOfMuNeut == 1) return PionDecay;
  if (std::abs(ancestorPDG) == MC::KPLUS && numberOfChildren == 2 && NumOfMuNeut == 1) return KaonDecay;
  if (MC::isTau(ancestorPDG)) {
    const ParticleOrigin tauOrig = defOrigOfTau(xTruthParticleContainer, ancestor, ancestorPDG, info);
    const ParticleType tautype = defTypeOfTau(tauOrig);
    return  (tautype == IsoTau)?tauOrig:TauLep;
  }
 
  if (MC::isTop(ancestorPDG)) return top;
  // Quark weak decay
  if (MC::isSMQuark(ancestorPDG) && numOfParents == 1 && numberOfChildren == 3 && NumOfquark == 1 && NumOfMuNeut == 1) return QuarkWeakDec;
 
  if (MC::isW(ancestorPDG) && ancestorProdVtx && ancestorProdVtx->nIncomingParticles() != 0) {
    const xAOD::TruthVertex* prodVert = ancestorProdVtx;
    const xAOD::TruthParticle* itrP;
    do {
      itrP = prodVert->incomingParticle(0); // FIXME just taking the first one
      prodVert = itrP->hasProdVtx() ? itrP->prodVtx() : nullptr;
    } while (MC::isW(itrP) && prodVert);
 
    if (prodVert && prodVert->nIncomingParticles() == 1) {
      if (std::abs(itrP->pdgId()) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
      if (std::abs(itrP->pdgId()) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
      if (std::abs(itrP->pdgId()) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
    }
    return WBoson;
  }
  if (MC::isW(ancestorPDG)) return WBoson;
  if (MC::isZ(ancestorPDG)) return ZBoson;
  if (MC::isPhoton(ancestorPDG) && numberOfChildren == 2 && NumOfMuMin == 1 && NumOfMuPl == 1) return PhotonConv;
  //-- Exotics
 
  // MadGraphPythia ZWW*->lllnulnu
  if (numOfParents == 1 && numberOfChildren > 4 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG))) {
    bool isZboson = false;
    bool isWboson = false;
    bool skipnext = false;
    for (unsigned int ipOut = 0; ipOut + 1 < partProdVtx->nOutgoingParticles(); ipOut++) {
      if (skipnext) {
        skipnext = false;
        continue;
      }
      const xAOD::TruthParticle* aChild = partProdVtx->outgoingParticle(ipOut);
      if (!aChild) continue;
      const xAOD::TruthParticle* theNextChild{};
      for (unsigned int ipOut1 = ipOut + 1; ipOut1 < partProdVtx->nOutgoingParticles(); ipOut1++) {
        theNextChild = partProdVtx->outgoingParticle(ipOut1);
        if (theNextChild) break;
      }
      if (!theNextChild) continue;
      if (MC::isMuon(aChild) && MC::isMuon(theNextChild)) {
        // Zboson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isZboson = true;
          break;
        }
        skipnext = true;
      } else if (MC::isMuon(aChild) && std::abs(theNextChild->pdgId()) == MC::NU_MU) {
        // WBoson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isWboson = true;
          break;
        }
        skipnext = true;
      }
    }
    if (isWboson) return WBoson;
    if (isZboson) return ZBoson;
  }
  if (numOfParents == 2 ) {
    //--Sherpa Z->mumu
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && NumOfMuPl == 1 && NumOfMuMin == 1) return ZBoson;
 
    //--Sherpa W->munu ??
    // if(numOfParents==2&&(numberOfChildren-NumOfquark-NumOfgluon)==2&&(NumOfEl==1||NumOfPos==1)&&NumOfElNeut==1) return WBoson;
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && (NumOfMuPl == 1 || NumOfMuMin == 1) && NumOfMuNeut == 1) return WBoson;
 
    const int pdg1 = partProdVtx->incomingParticle(0)->pdgId();
    const int pdg2 = partProdVtx->incomingParticle(1)->pdgId();
    //--Sherpa ZZ,ZW
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 4 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 4) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return DiBoson;
 
    //--Sherpa VVV -- Note, have to allow for prompt photon radiation or these get lost
    if ((numberOfChildren - NumOfquark - NumOfgluon - NumOfPhot) == 6 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 6) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return MultiBoson;
 
    //--Sherpa tttt with all t->Wb; W->lnu
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 8 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 8) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) {
      ATH_MSG_VERBOSE("MultiBoson for 4topLep");
      return MultiBoson;
    }
    
    //--Sherpa Vgamma ( Z->ee+gamma or W->enu+gamma )
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && NumOfMuPl == 1 && NumOfMuMin == 1) {
            ATH_MSG_VERBOSE("Sherpa mumu + gamma");
            return ZBoson;
    }
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && (NumOfMuPl == 1 || NumOfMuMin == 1) && NumOfMuNeut == 1) {
            ATH_MSG_VERBOSE("Sherpa munu + gamma");
            return WBoson;
    }
    
  }
 
  //--New Sherpa Z->mumu
  if (partProdVtx == ancestorProdVtx) {
    int NumOfMuLoop = 0;
    int NumOfMuNeuLoop = 0;
    int NumOfLepLoop = 0;
    for (const auto & pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      for (const auto & pin: partProdVtx->particles_in()) {
        if (!pin) continue;
        if (HepMC::is_same_particle(pout,pin)) {
          if (MC::isMuon(pout)) NumOfMuLoop++;
          if (std::abs(pout->pdg_id()) == MC::NU_MU) NumOfMuNeuLoop++;
          if (MC::isSMLepton(pout)) NumOfLepLoop++;
          break; // break out of inner loop after having found two matching particles
        }
      }
    }
    if (NumOfMuLoop == 2 && NumOfMuNeuLoop == 0) return ZBoson;
    if (NumOfMuLoop == 1 && NumOfMuNeuLoop == 1) return WBoson;
    if ((NumOfMuLoop == 4 && NumOfMuNeuLoop == 0) || (NumOfMuLoop == 3 && NumOfMuNeuLoop == 1) ||
        (NumOfMuLoop == 2 && NumOfMuNeuLoop == 2)) return DiBoson;
    if (NumOfLepLoop == 4) return DiBoson;
  }
 
  //-- McAtNLo
 
  if (MC::isHiggs(ancestorPDG)) return Higgs;
 
  if (MC::isMSSMHiggs(ancestorPDG)) return HiggsMSSM; // MSSM Higgs bosons
 
  if (MC::isHeavyBoson(ancestorPDG))  return HeavyBoson;  // Heavy bosons( Z', Z'', W'+)
 
  if (std::abs(ancestorPDG) == MC::WBOSON_LRSM) return WBosonLRSM; // Left-right symmetric model WBoson (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
  if (MC::isLeptoQuark(ancestorPDG) || NumOfLQ != 0) return LQ;
  if (MC::isSUSY(ancestorPDG)) return SUSY;
  if (MC::isBSM(ancestorPDG)) return OtherBSM;
 
  const ParticleType pType = defTypeOfHadron(ancestorPDG);
  if ((pType == BBbarMesonPart || pType == CCbarMesonPart) && ancestorProdVtx && MC::isHardScatteringVertex(ancestorProdVtx)) isPrompt = true;
 
  return convHadronTypeToOrig(pType, ancestorPDG);
}

defOrigOfNeutrino()

ParticleOrigin MCTruthClassifier::defOrigOfNeutrino ( const xAOD::TruthParticleContainer & xTruthParticleContainer, const xAOD::TruthParticle * thePart, bool & isPrompt, IMCTruthClassifier::Info & info ) const

private

Definition at line 1239 of file MCTruthClassifierGen.cxx.

{
  ATH_MSG_DEBUG("Executing DefOrigOfNeutrino ");
 
  const int nuFlav = std::abs(thePart->pdgId());
  // Find the first copy of this particle stored in the xAOD::TruthParticleContainer (i.e. the particle prior to any interactions)
  const xAOD::TruthParticle* thePriPart = MC::findMatching(xTruthParticleContainer, thePart);
  if (!thePriPart) return NonDefined;
  if (std::abs(thePriPart->pdgId()) != nuFlav) return NonDefined; // FIXME should this be if (!MC::isSMNeutrino(thePriPart) || abs(thePriPart->pdgId()) != nuFlav) return NonDefined; // (Use MC::isNeutrino if 4th generation neutrinos OK)
 
  //-- to define neutrino outcome status
  info.particleOutCome = NonInteract;
 
  const xAOD::TruthVertex* partProdVtx = thePriPart->hasProdVtx() ? thePriPart->prodVtx() : nullptr;
  if (!partProdVtx) return NonDefined;
 
  if (partProdVtx->nIncomingParticles() > 1) ATH_MSG_DEBUG("DefOrigOfNeutrino:: neutrino has more than one parent.");
 
  const xAOD::TruthParticle* ancestor = MC::findMother(thePriPart);
  info.setMotherProperties(ancestor);
  if (!ancestor) { return NonDefined; } // ancestor is not a nullptr beyond this point
 
  // Start of method 3 of protecting against loops
  // to resolve Sherpa loop
  bool samePart = TruthLoopDetectionMethod1(partProdVtx, ancestor);
  // End of method 3 of protecting against loops
 
  if ((std::abs(ancestor->pdgId()) == nuFlav || MC::isTau(ancestor) || MC::isW(ancestor)) && ancestor->hasProdVtx() && !samePart) {
    int pPDG(0);
    const xAOD::TruthParticle* ancestorParent{};
    do {
      pPDG = 0;
      ancestorParent = MC::findMother(ancestor);
      // Start of method 2 of protecting against loops
      // to prevent Sherpa loop
      if (TruthLoopDetectionMethod2(ancestor,ancestorParent)) {
        ancestorParent = ancestor;
        break;
      }
      //
      if (ancestorParent) {
        pPDG = ancestorParent->pdgId(); // FIXME difference in behaviour compared to defOrigOfElectron/Muon pPDG set even if we are in a loop
      }
      // to prevent Sherpa loop
      if (ancestor == ancestorParent) { break; }
      // End of method 2 of protecting against Sherpa loops
      if (std::abs(pPDG) == nuFlav || MC::isTau(pPDG) || MC::isW(pPDG) ) {
        // There will be another iteration so set ancestor to ancestorParent
        ancestor = ancestorParent; // ancestorParent is not a nullptr
        info.setMotherProperties(ancestor); // FIXME difference in behaviour compared to MCTruthClassifier::defOrigOfElectron/Muon
      }
 
    } while ((std::abs(pPDG) == nuFlav || MC::isTau(pPDG) || MC::isW(pPDG)));
 
    if (std::abs(pPDG) == nuFlav || MC::isTau(pPDG) || MC::isW(pPDG) || MC::isZ(pPDG) || MC::isHiggs(pPDG) ||
        MC::isMSSMHiggs(pPDG) || MC::isHeavyBoson(pPDG) || MC::isTop(pPDG) ||  // MSSM Higgs bosons, Heavy bosons( Z', Z'', W'+)
        std::abs(pPDG) == MC::WBOSON_LRSM || MC::isNeutrinoRH(pPDG) || // Left-right symmetric model WBoson || Right-handed neutrino (Pythia-specific)
        MC::isSUSY(pPDG)) {
      ancestor = ancestorParent; // ancestorParent is not nullptr here
      info.setMotherProperties(ancestor);
    }
  }
  //if ancestor is still nullptr, we have a problem
  if (!ancestor) return NonDefined; // FIXME it should not be possible for ancestor to be nullptr at this point???
 
  info.setMotherProperties(ancestor);
  const int ancestorPDG = ancestor->pdgId();
  partProdVtx = ancestor->decayVtx();
  const xAOD::TruthVertex* ancestorProdVtx = ancestor->hasProdVtx() ? ancestor->prodVtx() : nullptr;
  const int numOfParents = partProdVtx->nIncomingParticles();
  const int numberOfChildren = partProdVtx->nOutgoingParticles();
 
  // Determine decay products
  auto DP = DecayProducts(partProdVtx);
  const int NumOfPhot = DP.pd(MC::PHOTON);
  const int NumOfquark = DP.apd({MC::DQUARK,MC::UQUARK,MC::SQUARK,MC::CQUARK,MC::BQUARK,MC::TQUARK});
  const int NumOfgluon = DP.apd(MC::GLUON);
  const int NumOfLQ = DP.apd(MC::LEPTOQUARK);
  const int NumOfElNeut = DP.apd(MC::NU_E);
  const int NumOfMuNeut = DP.apd(MC::NU_MU);
  const int NumOfTauNeut = DP.apd(MC::NU_TAU);
  const int NumOfEl = DP.apd(MC::ELECTRON);
  const int NumOfMu = DP.apd(MC::MUON);
  const int NumOfTau = DP.apd(MC::TAU);
 
  samePart = false;
  for (const auto& aChild: partProdVtx->particles_out()) {
    if (!aChild) continue;
    if (aChild->pdgId() == ancestorPDG && HepMC::is_same_generator_particle(aChild,ancestor)) {
      samePart = true;
      break;
    }
  }
  // End of section determining decay products
 
  // Quark weak decay
  if (MC::isQuark(ancestorPDG) && numOfParents == 1 && numberOfChildren == 3 && NumOfquark == 1 && (NumOfEl == 1 || NumOfMu == 1 || NumOfTau == 1)) return QuarkWeakDec;
  if (MC::isTop(ancestorPDG)) return top;
 
  if (MC::isW(ancestorPDG) && ancestorProdVtx && ancestorProdVtx->nIncomingParticles() != 0) {
    const xAOD::TruthVertex* prodVert = ancestorProdVtx;
    const xAOD::TruthParticle* ptrPart;
    do {
      ptrPart = prodVert->incomingParticle(0); // FIXME just taking the first one
      prodVert = ptrPart->hasProdVtx() ? ptrPart->prodVtx() : nullptr;
    } while (MC::isW(ptrPart) && prodVert);
 
    if (prodVert && prodVert->nIncomingParticles() == 1) {
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
      if (std::abs(ptrPart->pdgId()) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
    }
    return WBoson;
  }
  if (MC::isW(ancestorPDG)) return WBoson;
  if (MC::isZ(ancestorPDG)) return ZBoson;
 
  //-- Exotics
 
  // MadGraphPythia ZWW*->lllnulnu or ZWW*->nunulnulnu (don't even know if the latter is generated)
  if (numOfParents == 1 && numberOfChildren > 4 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG))) {
 
    const xAOD::TruthParticle* thePartToCheck = thePriPart;
    const xAOD::TruthParticle* theParent = thePriPart->hasProdVtx() ? thePriPart->prodVtx()->incomingParticle(0) : nullptr; // FIXME just taking the first one
 
    if (MC::isElectron(theParent) && MC::isDecayed(theParent)) { thePartToCheck = theParent; }
    bool isZboson = false;
    bool isWboson = false;
    bool skipnext = false;
 
    for (unsigned int ipOut = 0; ipOut + 1 < partProdVtx->nOutgoingParticles(); ++ipOut) {
      const xAOD::TruthParticle* aChild = partProdVtx->outgoingParticle(ipOut);
      if (!aChild) continue;
      const xAOD::TruthParticle* theNextChild{};
      for (unsigned int ipOut1 = ipOut + 1; ipOut1 < partProdVtx->nOutgoingParticles(); ipOut1++) {
        theNextChild = partProdVtx->outgoingParticle(ipOut1);
        if (theNextChild) break;
      }
      if (!theNextChild) continue;
 
      if (skipnext) {
        skipnext = false;
        continue;
      }
 
      const int apdgID1 = std::abs(aChild->pdgId());
      const int apdgID2 = std::abs(theNextChild->pdgId());
      if (apdgID1 == apdgID2 && MC::isSMNeutrino(apdgID1)) {
        // Zboson
        if (thePartToCheck == aChild || thePartToCheck == theNextChild) {
          isZboson = true;
          break;
        }
        skipnext = true;
      } else if ((apdgID1 == MC::ELECTRON && apdgID2 == MC::NU_E) ||
                 (apdgID1 == MC::NU_E && apdgID2 == MC::ELECTRON) ||
                 (apdgID1 == MC::MUON && apdgID2 == MC::NU_MU) ||
                 (apdgID1 == MC::NU_MU && apdgID2 == MC::MUON) ||
                 (apdgID1 == MC::TAU && apdgID2 == MC::NU_TAU) ||
                 (apdgID1 == MC::NU_TAU && apdgID2 == MC::TAU)
                 ) {
        // WBoson
        if (thePartToCheck == aChild || thePartToCheck == theNextChild) {
          isWboson = true;
          break;
        }
        skipnext = true;
      }
    }
    if (isWboson) return WBoson;
    if (isZboson) return ZBoson;
  }
 
  if (numOfParents == 2) {
    //--Sherpa Z->nunu
    if ( (numberOfChildren - NumOfquark - NumOfgluon) == 2 && (NumOfElNeut == 2 || NumOfMuNeut == 2 || NumOfTauNeut == 2)) return ZBoson;
 
    //--Sherpa W->enu ??
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && ((NumOfEl == 1 && NumOfElNeut == 1) || (NumOfMu == 1 && NumOfMuNeut == 1) || (NumOfTau == 1 && NumOfTauNeut == 1))) return WBoson;
 
    const int pdg1 = partProdVtx->incomingParticle(0)->pdgId();
    const int pdg2 = partProdVtx->incomingParticle(1)->pdgId();
    //--Sherpa ZZ,ZW
    if ( (numberOfChildren - NumOfquark - NumOfgluon) == 4 && (NumOfEl + NumOfMu + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 4) &&
         (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return DiBoson;
 
    //--Sherpa VVV -- Note, have to allow for prompt photon radiation or these get lost
    if ((numberOfChildren - NumOfquark - NumOfgluon - NumOfPhot) == 6 && (NumOfEl + NumOfMu + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 6) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return MultiBoson;
    
    //--Sherpa Vgamma ( Z->nunu+gamma )
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && (NumOfElNeut == 2 || NumOfMuNeut == 2 || NumOfTauNeut == 2)) {
        ATH_MSG_VERBOSE("Sherpa nunu + gamma");
        return ZBoson;
    }
  }
 
  // New Sherpa Z->nunu
  if (partProdVtx == ancestorProdVtx) {
    int NumOfLepLoop = 0;
    int NumOfNeuLoop = 0;
    for (const auto *const pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      for (const auto *const pin: partProdVtx->particles_in()) {
        if (!pin) continue;
        if (HepMC::is_same_particle(pin,pout)) continue;
        const int apdgid = std::abs(pout->pdgId());
        if (MC::isSMLepton(apdgid)) {
          if (MC::isSMNeutrino(apdgid)) { NumOfNeuLoop++; }
          else { NumOfLepLoop++; }
        }
        break; // break out of inner loop after having found two matching particles
      }
    }
    if (NumOfNeuLoop == 2 && NumOfLepLoop == 0) return ZBoson;
    if (NumOfNeuLoop == 1 && NumOfLepLoop == 1) return WBoson;
    if (NumOfNeuLoop + NumOfLepLoop == 4) return DiBoson;
  }
 
  //-- McAtNLo
 
  if (MC::isHiggs(ancestorPDG)) return Higgs;
  if (MC::isMSSMHiggs(ancestorPDG)) return HiggsMSSM; // MSSM Higgs bosons
  if (MC::isHeavyBoson(ancestorPDG)) return HeavyBoson; // Heavy bosons( Z', Z'', W'+)
 
  if (MC::isTau(ancestorPDG)) {
    const ParticleOrigin tauOrig = defOrigOfTau(xTruthParticleContainer, ancestor, ancestorPDG, info);
    const ParticleType tautype = defTypeOfTau(tauOrig);
    return (tautype == IsoTau)?tauOrig:TauLep;
  }
 
  if (std::abs(ancestorPDG) == MC::WBOSON_LRSM) return WBosonLRSM; // Left-right symmetric model WBoson (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
  if (MC::isLeptoQuark(ancestorPDG) || NumOfLQ != 0) return LQ;
  if (MC::isSUSY(ancestorPDG)) return SUSY;
  if (MC::isBSM(ancestorPDG)) return OtherBSM;
 
  const ParticleType pType = defTypeOfHadron(ancestorPDG);
  if ((pType == BBbarMesonPart || pType == CCbarMesonPart) && ancestorProdVtx && MC::isHardScatteringVertex(ancestorProdVtx)) isPrompt = true;
 
  return convHadronTypeToOrig(pType, ancestorPDG);
}

defOrigOfPhoton()

ParticleOrigin MCTruthClassifier::defOrigOfPhoton ( const xAOD::TruthParticleContainer & xTruthParticleContainer, const xAOD::TruthParticle * thePart, bool & isPrompt, IMCTruthClassifier::Info & info ) const

private

Definition at line 976 of file MCTruthClassifierGen.cxx.

{
  if (!thePart) return NonDefined; // FIXME Why is this extra protection needed for this function and not the others?
  ATH_MSG_DEBUG("Executing DefOrigOfPhoton ");
 
  info.resetMotherProperties();
  info.photonMother = nullptr;
 
  // Find the first copy of this particle stored in the xAOD::TruthParticleContainer (i.e. the particle prior to any interactions)
  const xAOD::TruthParticle* thePriPart = MC::findMatching(xTruthParticleContainer, thePart);
  if (!thePriPart) return NonDefined;
  if (!MC::isPhoton(thePriPart)) return NonDefined;
 
  const xAOD::TruthVertex* partProdVtx = thePriPart->hasProdVtx() ? thePriPart->prodVtx() : nullptr;
 
  //-- to define photon outcome status
  info.particleOutCome = defOutComeOfPhoton(thePriPart);
 
  if (!partProdVtx) return NonDefined;
 
  int numOfParents = partProdVtx->nIncomingParticles();
  if (partProdVtx->nIncomingParticles() > 1) ATH_MSG_DEBUG("DefOrigOfPhoton:: photon has more than one parent.");
 
  const xAOD::TruthParticle* ancestor = MC::findMother(thePriPart);
  info.setMotherProperties(ancestor);
  if (!ancestor) { return NonDefined; } // ancestor is not a nullptr beyond this point
 
  int ancestorPDG = ancestor->pdgId();
  // "method 1" for finding Sherpa loops from defOrigOfElectron not used here. Why?
  const xAOD::TruthVertex* ancestorProdVtx = ancestor->hasProdVtx() ? ancestor->prodVtx() : nullptr;
 
  partProdVtx = ancestor->decayVtx(); // FIXME how often does this line actually change the pointer???
  numOfParents = partProdVtx->nIncomingParticles();
 
  const int numberOfChildren = partProdVtx->nOutgoingParticles();
 
  // Determine decay products
  auto DP = DecayProducts(partProdVtx);
  const int NumOfEl = DP.pd(MC::ELECTRON);
  const int NumOfPos = DP.pd(MC::POSITRON);
  const int NumOfMu = DP.apd(MC::MUON);
  const int NumOfTau = DP.apd(MC::TAU);
  const int NumOfLQ = DP.apd(MC::LEPTOQUARK);
  const int NumOfLep = NumOfEl + NumOfPos + NumOfMu + NumOfTau;
  const int NumOfNeut = DP.apd({MC::NU_E,MC::NU_MU,MC::NU_TAU});
  const int NumOfPht = DP.pd(MC::PHOTON);
 
  int childPDG(0);
  int NumOfPartons(0);
  int NumOfNucFr(0);
  const bool possibleNuclearFragment = (numOfParents == 1 && (MC::isPhoton(ancestorPDG) || MC::isElectron(ancestorPDG) || std::abs(ancestorPDG) == MC::PIPLUS));
  const xAOD::TruthParticle* child{};
  for (const auto& pout: partProdVtx->particles_out()) {
    if (!pout) continue;
    childPDG = pout->pdg_id();
    if (possibleNuclearFragment &&
        (MC::isNucleus(childPDG) || childPDG == 0 || childPDG == MC::PROTON || childPDG == MC::NEUTRON)) { // FIXME Do we really expect particles with PDG_ID = 0 in the truth record?
      NumOfNucFr++;
    }
    if (std::abs(childPDG) < MC::ELECTRON ||
        (std::abs(childPDG) > MC::NU_TAU && std::abs(childPDG) < 43 && !MC::isPhoton(childPDG))) {
      // FIXME Too loose? This definition picks up 4th generation quarks and leptons as well as all gauge bosons and leptoquarks.
      // Suggest MC::isSMQuark(childPDG) || (MC::isBoson(childPDG) && !MC::isPhoton(childPDG))
      // or maybe even MC::isSMQuark(childPDG) || MC::isGluon(childPDG)
      // AKA const int NumOfPartons = DP.apd({MC::DQUARK,MC::UQUARK,MC::SQUARK,MC::CQUARK,MC::BQUARK,MC::TQUARK,MC::GLUON});
      NumOfPartons++;
    }
    if (childPDG == ancestorPDG) {
      child = pout;
    }
  }
  // End of section determining decay products
 
  bool foundISR = false;
  bool foundFSR = false;
  if (numOfParents == 1 && numberOfChildren == 2 &&  child && HepMC::is_same_generator_particle(child, ancestor)) return BremPhot;
  if (numOfParents == 1 && numberOfChildren == 2 && MC::isElectron(ancestorPDG) && NumOfPht == 2) return ElMagProc;
 
  // decay of W,Z and Higgs to lepton with FSR generated by Pythia
  if (numOfParents == 1 && numberOfChildren == 2 && (MC::isElectron(ancestorPDG) || MC::isMuon(ancestorPDG) || MC::isTau(ancestorPDG)) &&
      !(child && HepMC::is_same_generator_particle(child, ancestor)) && ancestorProdVtx &&
      ancestorProdVtx->nIncomingParticles() == 1) {
    int itr = 0;
    int PartPDG = 0;
    const xAOD::TruthVertex* prodVert = ancestorProdVtx;
    const xAOD::TruthVertex* Vert{};
    do {
      Vert = prodVert;
      for (const auto & pin: Vert->particles_in()) {
        if (!pin) continue;
        PartPDG = std::abs(pin->pdgId());
        prodVert = pin->prodVtx();
        if (MC::isZ(PartPDG) || MC::isW(PartPDG) || MC::isHiggs(PartPDG)) foundFSR = true;
      }
      itr++;
      if (itr > 100) { // FIXME Improve loop detection here?
        ATH_MSG_WARNING("DefOrigOfPhoton:: infinite while");
        break;
      }
    } while (prodVert && std::abs(ancestorPDG) == PartPDG);
 
    if (foundFSR) return FSRPhot;
  }
 
  // Nucl reaction
  // gamma+Nuclear=>gamma+Nucl.Fr+Nuclons+pions
  // e+Nuclear=>e+gamma+Nucl.Fr+Nuclons+pions
  // pi+Nuclear=>gamma+Nucl.Fr+Nuclons+pions
 
  if ((numOfParents == 1 && (MC::isPhoton(ancestorPDG) || MC::isElectron(ancestorPDG)) && numberOfChildren > 2 && NumOfNucFr != 0) ||
      (numOfParents == 1 && std::abs(ancestorPDG) == MC::PIPLUS && numberOfChildren > 10 && NumOfNucFr != 0) ||
      (numOfParents == 1 && MC::isPhoton(ancestorPDG) && numberOfChildren > 10 && MC::isStable(ancestor)) ||
      (numOfParents == 1 && MC::isNucleus(ancestorPDG) && std::abs(ancestorPDG) != MC::PROTON)) // FIXME vetoing protons here to preserve previous behaviour
    return NucReact;
 
  if (MC::isMuon(ancestorPDG) && NumOfMu == 0) return Mu;
  if (MC::isTau(ancestorPDG) && NumOfTau == 0) return TauLep;
 
  if (numOfParents == 1 && ancestor->status() == 3) return (foundISR)? ISRPhot:UndrPhot; // FIXME foundISR is always false at this point
 
  //-- to find initial and final state raiation and underline photons
  //-- SUSY
  if (numOfParents == 1 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG)) &&
      (numberOfChildren != NumOfPht + NumOfPartons || !MC::Pythia8::isConditionA(ancestor))) {
    for (const auto& pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      if (ancestorPDG != pout->pdgId()) continue;
      const xAOD::TruthVertex* Vrtx = pout->decayVtx();
      if (!Vrtx) continue;
      if (Vrtx->nOutgoingParticles() != 1 && Vrtx->nIncomingParticles() == 1) continue;
      if (!Vrtx->outgoingParticle(0)) continue;
      if (Vrtx->outgoingParticle(0)->pdgId() == 91) foundISR = true; // Herwig "cluster"
    }
    return (foundISR)?ISRPhot:UndrPhot;
  }
 
  //-- to find final  state radiation
  //-- Exotics
 
  // FSR  from Photos
  //-- Exotics- CompHep
  if (numOfParents == 2 && ((MC::isElectron(ancestorPDG) && NumOfEl == 1 && NumOfPos == 1) || (MC::isMuon(ancestorPDG) && NumOfMu == 2) || (MC::isTau(ancestorPDG) && NumOfTau == 2))) {
    if (std::abs(partProdVtx->incomingParticle(0)->pdgId()) == std::abs(partProdVtx->incomingParticle(1)->pdgId())) return FSRPhot;
  }
 
  if (numOfParents == 2 && NumOfLep == 1 && NumOfNeut == 1 && (MC::isElectron(ancestorPDG) || std::abs(ancestorPDG) == MC::NU_E)) return FSRPhot;
 
  //-- Exotics - CompHep
  if (MC::isElectron(ancestorPDG) && numOfParents == 1 && numberOfChildren == 2 && (NumOfEl == 1 || NumOfPos == 1) && NumOfPht == 1 &&
      !( child && HepMC::is_same_generator_particle(child, ancestor)) && !HepMC::is_simulation_particle(child) && !HepMC::is_simulation_particle(ancestor))
    return FSRPhot;
 
  // FSR  from Photos
  if (MC::isZ(ancestorPDG) && ((NumOfEl + NumOfPos == 2 || NumOfEl + NumOfPos == 4) || (NumOfMu == 2 || NumOfMu == 4) || (NumOfTau == 2 || NumOfTau == 4)) && NumOfPht > 0) return FSRPhot;
 
  if (NumOfPht > 0 && (std::abs(ancestorPDG) == MC::WBOSON_LRSM || MC::isNeutrinoRH(ancestorPDG))) return FSRPhot; // Left-right symmetric model WBoson || Right-handed neutrinos (Pythia-specific)
 
  if (numOfParents == 2 && NumOfLQ == 1) return FSRPhot;
 
  //--- other process
 
  if (MC::isZ(ancestorPDG)) return ZBoson;
  if (MC::isW(ancestorPDG)) {
 
    if (NumOfLep == 1 && NumOfNeut == 1 && numberOfChildren == NumOfLep + NumOfNeut + NumOfPht) return FSRPhot;
 
    if (ancestorProdVtx && ancestorProdVtx->nIncomingParticles() != 0) {
      const xAOD::TruthVertex* prodVert = ancestorProdVtx;
      const xAOD::TruthParticle* itrP;
      do {
        itrP = prodVert->incomingParticle(0); // FIXME just taking the first one
        prodVert = itrP->hasProdVtx() ? itrP->prodVtx() : nullptr;
      } while (MC::isW(itrP) && prodVert);
 
      if (prodVert && prodVert->nIncomingParticles() == 1 ) {
        if ( MC::isTau(itrP)) return TauLep;
        if ( MC::isMuon(itrP)) return Mu;
        if ( std::abs(itrP->pdgId()) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
        if ( std::abs(itrP->pdgId()) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
        if ( std::abs(itrP->pdgId()) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
      }
    } else
      return WBoson;
  }
 
  // MadGraphPythia ZWW*->lllnulnu
  if (numOfParents == 1 && numberOfChildren > 4 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG))) {
    bool isZboson = false;
    bool isWboson = false;
    bool skipnext = false;
    for (unsigned int ipOut = 0; ipOut + 1 < partProdVtx->nOutgoingParticles(); ipOut++) {
      if (skipnext) {
        skipnext = false;
        continue;
      }
      const xAOD::TruthParticle* aChild = partProdVtx->outgoingParticle(ipOut);
      if (!aChild) continue;
      const xAOD::TruthParticle* theNextChild{};
      for (unsigned int ipOut1 = ipOut + 1; ipOut1 < partProdVtx->nOutgoingParticles(); ipOut1++) {
        theNextChild = partProdVtx->outgoingParticle(ipOut1);
        if (theNextChild) break;
      }
      if (!theNextChild) continue;
      if (MC::isTau(aChild) && MC::isTau(theNextChild)) {
        // Zboson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isZboson = true;
          break;
        }
        skipnext = true;
      } else if (MC::isTau(aChild) && std::abs(theNextChild->pdgId()) == MC::NU_TAU) {
        // WBoson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isWboson = true;
          break;
        }
        skipnext = true;
      }
    }
    if (isWboson) return WBoson;
    if (isZboson) return ZBoson;
  }
 
  //--Sherpa ZZ,ZW+FSR
  if (numOfParents == 4 && (numberOfChildren - NumOfPht) == 4 && (NumOfLep + NumOfNeut == 4)) {
    if (MC::isSMLepton(partProdVtx->incomingParticle(0))&&MC::isSMLepton(partProdVtx->incomingParticle(1))
        && MC::isSMLepton(partProdVtx->incomingParticle(2))&&MC::isSMLepton(partProdVtx->incomingParticle(3)))
      return FSRPhot;
  }
 
  //--New Sherpa single photon
  if (partProdVtx == ancestorProdVtx) {
    for (const auto *const pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      for (const auto *const pin: partProdVtx->particles_in()) {
        if (!pin) continue;
        if (!HepMC::is_same_particle(pout,pin)) continue;
        if (MC::isPhoton(pout)) return SinglePhot;
        break; // break out of inner loop after having found two matching particles
      }
    }
  }
 
  if (MC::isHiggs(ancestorPDG)) return Higgs;
  if (std::abs(ancestorPDG) == MC::PI0) return PiZero;
  if (MC::isMSSMHiggs(ancestorPDG)) return HiggsMSSM; // MSSM Higgs bosons
  if (MC::isHeavyBoson(ancestorPDG) || std::abs(ancestorPDG) == 5100039 ) return HeavyBoson; // Heavy Bosons (Z' Z'' W'+) + KK excited graviton
 
  if (MC::isSUSY(ancestorPDG)) return SUSY;
  if (MC::isBSM(ancestorPDG)) return OtherBSM;
 
  // Pythia8 gamma+jet samples
  if (MC::Pythia8::isConditionA(ancestor) && MC::isStable(thePriPart) && NumOfPht == 1 && numberOfChildren == (NumOfPht + NumOfPartons))  return PromptPhot;
 
  const ParticleType pType = defTypeOfHadron(ancestorPDG);
  if ((pType == BBbarMesonPart || pType == CCbarMesonPart) && ancestorProdVtx && MC::isHardScatteringVertex(ancestorProdVtx)) isPrompt = true;
  return convHadronTypeToOrig(pType, ancestorPDG);
}

defOrigOfTau()

ParticleOrigin MCTruthClassifier::defOrigOfTau ( const xAOD::TruthParticleContainer & xTruthParticleContainer, const xAOD::TruthParticle * thePart, int motherPDG, IMCTruthClassifier::Info & info ) const

private

Definition at line 785 of file MCTruthClassifierGen.cxx.

{
  ATH_MSG_DEBUG("Executing DefOrigOfTau ");
 
  // Find the first copy of this particle stored in the xAOD::TruthParticleContainer (i.e. the particle prior to any interactions)
  const xAOD::TruthParticle* thePriPart = MC::findMatching(xTruthParticleContainer, thePart);
  if (!thePriPart) return NonDefined;
  if (!MC::isTau(thePriPart)) return NonDefined;
 
  //-- to define tau  outcome status
  if (MC::isPhysical(thePriPart)) info.particleOutCome = defOutComeOfTau(thePriPart); // FIXME why do we need the additional check on MC::isPhysical here c.f. defOrigOfElectron and defOrigOfMuon?
 
  const xAOD::TruthVertex* partProdVtx = thePriPart->hasProdVtx() ? thePriPart->prodVtx() : nullptr;
  if (!partProdVtx) return NonDefined;
 
  if (partProdVtx->nIncomingParticles() > 1) ATH_MSG_DEBUG("DefOrigOfTau:: tau has more than one parent.");
 
  const xAOD::TruthParticle* ancestor = MC::findMother(thePriPart);
  info.setMotherProperties(ancestor);
  if (!ancestor) { return NonDefined; } // ancestor is not a nullptr beyond this point
 
  // "method 1" for finding Sherpa loops from defOrigOfElectron not used here. Why?
 
  // Difference from defOrigOfElectron and defOrigOfMuon - no loop through ancestor particles
 
  if (MC::isW(ancestorPDGin) && ancestor->hasProdVtx()) { // FIXME ancestorPDGin here could in principle be inconsistent with ancestorProdVtx
    const xAOD::TruthParticle* ancestorParent = MC::findMother(ancestor);
    if (ancestorParent && MC::isTop(ancestorParent->pdgId())) {
      ancestor = ancestorParent; //...so ancestor cannot be nullptr
    }
  }
 
  const int ancestorPDG = ancestor->pdgId();
  info.setMotherProperties(ancestor);
  const xAOD::TruthVertex* ancestorProdVtx = ancestor->hasProdVtx() ? ancestor->prodVtx() : nullptr;
  partProdVtx = ancestor->decayVtx();
  if (!partProdVtx) return NonDefined; // FIXME not sure this could ever be true?
  const int numOfParents = partProdVtx->nIncomingParticles();
 
  // Determine decay products
  auto DP = DecayProducts(partProdVtx);
  const int numberOfChildren = DP.size();
  const int NumOfPhot = DP.pd(MC::PHOTON);
  const int NumOfEl = DP.pd(MC::ELECTRON);
  const int NumOfPos = DP.pd(MC::POSITRON);
  const int NumOfElNeut = DP.apd(MC::NU_E);
  const int NumOfMuNeut = DP.apd(MC::NU_MU);
  /* const int NumOfLQ = DP.apd(MC::LEPTOQUARK); */ // FIXME Leptoquarks not an option?
  const int NumOfquark = DP.apd({MC::DQUARK,MC::UQUARK,MC::SQUARK,MC::CQUARK,MC::BQUARK,MC::TQUARK});
  const int NumOfgluon = DP.apd(MC::GLUON);
  const int NumOfMuPl = DP.pd(-MC::MUON);
  const int NumOfMuMin = DP.pd(MC::MUON);
  const int NumOfTau = DP.apd(MC::TAU);
  const int NumOfTauNeut = DP.apd(MC::NU_TAU);
  // End of section determining decay products
 
  if (MC::isTop(ancestorPDG)) return top;
  if (MC::isW(ancestorPDG) && ancestorProdVtx && ancestorProdVtx->nIncomingParticles() != 0) {
    const xAOD::TruthVertex* prodVert = ancestorProdVtx;
    const xAOD::TruthParticle* itrP;
    do {
      itrP = prodVert->incomingParticle(0); // FIXME just taking the first one
      prodVert = itrP->hasProdVtx() ? itrP->prodVtx() : nullptr;
    } while (MC::isW(itrP) && prodVert);
 
    if (prodVert && prodVert->nIncomingParticles() == 1 ) {
      if (std::abs(itrP->pdgId()) == MC::RH_NU_E) return NuREle; // Right-handed NU_E (Pythia-specific)
      if (std::abs(itrP->pdgId()) == MC::RH_NU_MU) return NuRMu; // Right-handed NU_MU (Pythia-specific)
      if (std::abs(itrP->pdgId()) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
    }
    return WBoson;
  }
  if (MC::isW(ancestorPDG)) { return WBoson;}
  if (MC::isZ(ancestorPDG)) { return ZBoson;}
  if (numOfParents == 1 && numberOfChildren > 4 && (MC::isSMQuark(ancestorPDG) || MC::isGluon(ancestorPDG))) {
    bool isZboson = false;
    bool isWboson = false;
    bool skipnext = false;
    for (unsigned int ipOut = 0; ipOut + 1 < partProdVtx->nOutgoingParticles(); ipOut++) {
      if (skipnext) {
        skipnext = false;
        continue;
      }
      const xAOD::TruthParticle* aChild = partProdVtx->outgoingParticle(ipOut);
      if (!aChild) continue;
      const xAOD::TruthParticle* theNextChild{};
      for (unsigned int ipOut1 = ipOut + 1; ipOut1 < partProdVtx->nOutgoingParticles(); ipOut1++) {
        theNextChild = partProdVtx->outgoingParticle(ipOut1);
        if (theNextChild) break;
      }
      if (!theNextChild) {
        continue;
      }
      if (MC::isTau(aChild) && MC::isTau(theNextChild)) {
        // Zboson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isZboson = true;
          break;
        }
        skipnext = true;
      } else if (MC::isTau(aChild) && std::abs(theNextChild->pdgId()) == MC::NU_TAU) {
        // WBoson
        if (thePriPart == aChild || thePriPart == theNextChild) {
          isWboson = true;
          break;
        }
        skipnext = true;
      }
    }
    if (isWboson) return WBoson;
    if (isZboson) return ZBoson;
  }
  if (numOfParents == 2 ) {
    const int pdg1 = partProdVtx->incomingParticle(0)->pdgId();
    const int pdg2 = partProdVtx->incomingParticle(1)->pdgId();
    //--Sherpa Z->tautau
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && NumOfTau == 2  && (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return ZBoson; // FIXME Why the extra checks on incoming particles compared to Z->ee, Z->mumu and Z->nunu?
 
    //--Sherpa W->taunu  new
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 2 && NumOfTau == 1 && NumOfTauNeut == 1) return WBoson;
 
    //--Sherpa ZZ,ZW
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 4 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 4) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return DiBoson;
 
    //--Sherpa VVV -- Note, have to allow for prompt photon radiation or these get lost
    if ((numberOfChildren - NumOfquark - NumOfgluon - NumOfPhot) == 6 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 6) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) return MultiBoson;
 
    //--Sherpa tttt with all t->Wb; W->lnu
    if ((numberOfChildren - NumOfquark - NumOfgluon) == 8 &&
        (NumOfEl + NumOfPos + NumOfMuPl + NumOfMuMin + NumOfTau + NumOfElNeut + NumOfMuNeut + NumOfTauNeut == 8) &&
        (MC::isQuark(pdg1)||MC::isGluon(pdg1)) && (MC::isQuark(pdg2)||MC::isGluon(pdg2))) {
      ATH_MSG_VERBOSE("MultiBoson for 4topLep");
      return MultiBoson;
    }
    
    //--Sherpa Vgamma ( Z->tautau+gamma or W->taunu+gamma )
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && NumOfTau == 2) {
        ATH_MSG_VERBOSE("Sherpa tautau + gamma");
        return ZBoson;
    }
    if ((numberOfChildren - NumOfquark - NumOfgluon) >= 3 && NumOfPhot >= 1 && NumOfTau == 1 && NumOfTauNeut == 1) {
        ATH_MSG_VERBOSE("Sherpa taunu + gamma");
        return WBoson;
    }
  }
 
  // New Sherpa Z->tautau
  if (partProdVtx == ancestorProdVtx) {
    int NumOfTauLoop = 0;
    int NumOfTauNeuLoop = 0;
    int NumOfLepLoop = 0;
    for ( const auto *const pout: partProdVtx->particles_out()) {
      if (!pout) continue;
      for (const auto *const pin: partProdVtx->particles_in()) {
        if (!pin) continue;
        if (!HepMC::is_same_particle(pout,pin)) continue;
        if (MC::isTau(pout)) NumOfTauLoop++;
        if (std::abs(pout->pdgId()) == MC::NU_TAU) NumOfTauNeuLoop++;
        if (MC::isSMLepton(pout)) NumOfLepLoop++;
        break; // break out of inner loop after having found two matching particles
      }
    }
    if (NumOfTauLoop == 2 && NumOfTauNeuLoop == 0) return ZBoson;
    if (NumOfTauLoop == 1 && NumOfTauNeuLoop == 1) return WBoson;
    if ((NumOfTauLoop == 4 && NumOfTauNeuLoop == 0) || (NumOfTauLoop == 3 && NumOfTauNeuLoop == 1) || (NumOfTauLoop == 2 && NumOfTauNeuLoop == 2)) return DiBoson;
    if (NumOfLepLoop == 4) return DiBoson;
  }
 
  //-- McAtNLo
 
  if (MC::isHiggs(ancestorPDG)) return Higgs;
  if (MC::isMSSMHiggs(ancestorPDG)) return HiggsMSSM; // MSSM Higgs bosons
  if (MC::isHeavyBoson(ancestorPDG)) return HeavyBoson; // Heavy bosons( Z', Z'', W'+)
  if (std::abs(ancestorPDG) == MC::WBOSON_LRSM) return WBosonLRSM; // Left-right symmetric model WBoson (Pythia-specific)
  if (std::abs(ancestorPDG) == MC::RH_NU_TAU) return NuRTau; // Right-handed NU_TAU (Pythia-specific)
  if (MC::isSUSY(ancestorPDG)) return SUSY;
  if (MC::isBSM(ancestorPDG)) return OtherBSM;
  if (std::abs(ancestorPDG) == MC::JPSI) return JPsi;
 
  const ParticleType pType = defTypeOfHadron(ancestorPDG);
  return convHadronTypeToOrig(pType, ancestorPDG);
}

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

egammaClusMatch()

const xAOD::TruthParticle * MCTruthClassifier::egammaClusMatch ( const xAOD::CaloCluster * clus, bool isFwrdEle, IMCTruthClassifier::Info * info ) const

finaloverridevirtual

Implements IMCTruthClassifier.

Definition at line 44 of file MCTruthClassifierAthena.cxx.

{
  ATH_MSG_DEBUG("Executing egammaClusMatch ");
  const xAOD::TruthParticle* theMatchPart = nullptr;
  const EventContext& ctx = info ? info->eventContext : Gaudi::Hive::currentContext();
  // retrieve collection and get a pointer
  SG::ReadHandle<xAOD::TruthParticleContainer> truthParticleContainerReadHandle(m_truthParticleContainerKey, ctx);
 
  if (!truthParticleContainerReadHandle.isValid()) {
    ATH_MSG_WARNING( " Invalid ReadHandle for xAOD::TruthParticleContainer with key: " << truthParticleContainerReadHandle.key());
    return theMatchPart;
  }
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{ m_caloMgrKey, ctx };
  if (!caloMgrHandle.isValid()) {
    ATH_MSG_WARNING(" Invalid ReadCondHandle for CaloDetDescrManager with key: " << m_caloMgrKey.key());
    return theMatchPart;
  }
 
  const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
  const xAOD::TruthParticle* theEgamma(nullptr);
  const xAOD::TruthParticle* theLeadingPartInCone(nullptr);
  const xAOD::TruthParticle* theBestPartOutCone(nullptr);
  const xAOD::TruthParticle* theBestPartdR(nullptr);
  double LeadingPhtPT(0);
  double LeadingPartPT(0);
  double LeadingPhtdR(999.);
  double LeadingPartdR(999.);
  double BestPartdR(999.);
  double etaClus = clus->etaBE(2);
  double phiClus = clus->phiBE(2);
  if (etaClus < -900) {
    etaClus = clus->eta();
  }
  if (phiClus < -900) {
    phiClus = clus->phi();
  }
  std::vector<const xAOD::TruthParticle*> tps;
  if (!m_truthInConeTool->particlesInCone(ctx, etaClus, phiClus, 0.5, tps)) {
    ATH_MSG_WARNING("Truth Particle in Cone failed");
    return theMatchPart;
  }
 
  for (const auto* const thePart : tps) {
    if (!thePart)[[unlikely]] continue;
    // loop over the stable particle
    if (!MC::isStable(thePart)) continue;
    // excluding G4 particle
    if ((!isFwrdEle || (isFwrdEle && m_FwdElectronUseG4Sel)) && HepMC::is_simulation_particle(thePart)) continue;
    long iParticlePDG = thePart->pdgId();
    // excluding neutrino
    if (std::abs(iParticlePDG) == 12 || std::abs(iParticlePDG) == 14 || std::abs(iParticlePDG) == 16) continue;
    double pt = thePart->pt() / Athena::Units::GeV;
    double q = thePart->charge();
    // exclude charged particles with pT<1 GeV
    if (q != 0 && pt < m_pTChargePartCut) continue;
    if (q == 0 && pt < m_pTNeutralPartCut) continue;
    float deltaPhi = std::abs(std::remainder(phiClus - thePart->phi(), 2*std::numbers::pi));
    float deteta = std::abs(etaClus - thePart->eta());
    // eleptical cone  for extrapolations m_partExtrConePhi X m_partExtrConeEta
    if (!isFwrdEle && m_ROICone && std::hypot( deltaPhi/m_partExtrConePhi, deteta/m_partExtrConeEta) > 1.0) {
      continue;
    }
    // Also check if the clus and true have different sign , i they need both to be <0 or >0
    if (isFwrdEle && // It is forward and
        (((etaClus < 0) - (thePart->eta() < 0) != 0)
         // The truth eta has different sign wrt to the fwd electron
         || (std::fabs(thePart->eta()) < m_FwdElectronTruthExtrEtaCut) // or the truth is less than 2.4 (default cut)
         || (std::fabs(thePart->eta() - etaClus) > m_FwdElectronTruthExtrEtaWindowCut) // or if the delta Eta between el and truth is  > 0.15
         ) // then do no extrapolate this truth Particle for this fwd electron
    ) {
      continue;
    }
    double dR(-999.);
    bool isNCone = false;
    bool isExt = genPartToCalo(ctx, clus, thePart, isFwrdEle, dR, isNCone, *caloDDMgr);
    if (!isExt) continue;
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(), thePart);
    if (info) {
      info->egPartPtr.push_back(thePart);
      info->egPartdR.push_back(dR);
      info->egPartClas.push_back(particleTruthClassifier(theMatchPart, info));
    }
    // Gen particles Not forward
    if (!isFwrdEle) {
      // the leading photon or electron  inside narrow eleptical cone
      // m_phtClasConePhi  X m_phtClasConeEta
      if ((iParticlePDG == 22 || std::abs(iParticlePDG) == 11) && isNCone && pt > LeadingPhtPT) {
        theEgamma = thePart;
        LeadingPhtPT = pt;
        LeadingPhtdR = dR;
      }
      // leading particle (excluding photon and electron) inside narrow eleptic
      // cone m_phtClasConePhi  X m_phtClasConeEta
      if ((iParticlePDG != 22 && std::abs(iParticlePDG) != 11) && isNCone && pt > LeadingPartPT) {
        theLeadingPartInCone = thePart;
        LeadingPartPT = pt;
        LeadingPartdR = dR;
      };
      // the best dR matched particle outside  narrow eleptic cone cone
      // m_phtClasConePhi  X m_phtClasConeEta
      if (!isNCone && dR < BestPartdR) {
        theBestPartOutCone = thePart;
        BestPartdR = dR;
      };
    } else {
      if (dR < BestPartdR) {
        theBestPartdR = thePart;
        BestPartdR = dR;
      };
    }
  }
 
  if (theEgamma != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(), theEgamma);
    if (info) info->deltaRMatch = LeadingPhtdR;
  } else if (theLeadingPartInCone != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theLeadingPartInCone);
    if (info) info->deltaRMatch = LeadingPartdR;
  } else if (theBestPartOutCone != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theBestPartOutCone);
    if (info) info->deltaRMatch = BestPartdR;
  } else if (isFwrdEle && theBestPartdR != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theBestPartdR );
    if (info) info->deltaRMatch = BestPartdR;
  } else {
    theMatchPart = nullptr;
  }
  if (isFwrdEle || theMatchPart != nullptr || !m_inclG4part) return theMatchPart;
 
  // additional loop over G4 particles,
  for (const auto* const thePart : tps) {
    if (!MC::isStable(thePart)) continue;
    if (!HepMC::is_simulation_particle(thePart)) continue;
    long iParticlePDG = thePart->pdgId();
    // exclude neutrino
    if (std::abs(iParticlePDG) == 12 || std::abs(iParticlePDG) == 14 || std::abs(iParticlePDG) == 16) continue;
    if (thePart->decayVtx() != nullptr) continue;
    const double dPhi = std::abs(std::remainder(phiClus - thePart->phi(), 2*std::numbers::pi));
    const double dEta = std::abs(etaClus - thePart->eta());
    if (std::hypot( dPhi/m_partExtrConePhi, dEta/m_partExtrConeEta ) > 1.0) continue;
 
    double pt = thePart->pt() / Athena::Units::GeV;
    double q = thePart->charge();
    // exclude charged particles with pT<1 GeV
    if (q != 0 && pt < m_pTChargePartCut) continue;
    if (q == 0 && pt < m_pTNeutralPartCut) continue;
 
    double dR(-999.);
    bool isNCone = false;
    bool isExt = genPartToCalo(ctx, clus, thePart, isFwrdEle, dR, isNCone, *caloDDMgr);
    if (!isExt) continue;
 
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),thePart);
    if (info) {
      info->egPartPtr.push_back(thePart);
      info->egPartdR.push_back(dR);
      info->egPartClas.push_back(particleTruthClassifier(theMatchPart, info));
    }
    // the leading photon or electron  inside narrow eleptical cone
    // m_phtClasConePhi  X m_phtClasConeEta
    if ((iParticlePDG == 22 || std::abs(iParticlePDG) == 11) && isNCone && pt > LeadingPhtPT) {
      theEgamma = thePart;
      LeadingPhtPT = pt;
      LeadingPhtdR = dR;
    }
    // leading particle (excluding photon or electron) inside narrow eleptic
    // cone m_phtClasConePhi  X m_phtClasConeEta
    if ((iParticlePDG != 22 && std::abs(iParticlePDG) != 11) && isNCone && pt > LeadingPartPT) {
      theLeadingPartInCone = thePart;
      LeadingPartPT = pt;
      LeadingPartdR = dR;
    }
    // the best dR matched particle outside  narrow eleptic cone cone
    // m_phtClasConePhi  X m_phtClasConeEta
    if (!isNCone && dR < BestPartdR) {
      theBestPartOutCone = thePart;
      BestPartdR = dR;
    }
  }
 
  if (theEgamma != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theEgamma);
    if (info) info->deltaRMatch = LeadingPhtdR;
  } else if (theLeadingPartInCone != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theLeadingPartInCone);
    if (info)  info->deltaRMatch = LeadingPartdR;
  } else if (theBestPartOutCone != nullptr) {
    theMatchPart = MC::findMatching(truthParticleContainerReadHandle.ptr(),theBestPartOutCone);
    if (info) info->deltaRMatch = BestPartdR;
  } else {
    theMatchPart = nullptr;
  }
  ATH_MSG_DEBUG("succeeded  egammaClusMatch ");
  return theMatchPart;
}

evtStore()

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

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

genPartToCalo()

bool MCTruthClassifier::genPartToCalo ( const EventContext & ctx, const xAOD::CaloCluster * clus, const xAOD::TruthParticle * thePart, bool isFwrdEle, double & dRmatch, bool & isNarrowCone, const CaloDetDescrManager & caloDDMgr ) const

private

Definition at line 241 of file MCTruthClassifierAthena.cxx.

{
  dRmatch = -999.;
  isNarrowCone = false;
  if (thePart == nullptr) return false;
  double phiClus = clus->phiBE(2);
  double etaClus = clus->etaBE(2);
  if (etaClus < -900) {
    etaClus = clus->eta();
  }
  if (phiClus < -900) {
    phiClus = clus->phi();
  }
  //--FixMe
  if (isFwrdEle || (etaClus == 0. && phiClus == 0.)) {
    phiClus = clus->phi();
    etaClus = clus->eta();
  }
  // define calo sample
  CaloSampling::CaloSample sample = CaloSampling::EMB2;
  if ((clus->inBarrel() && !clus->inEndcap()) ||
      (clus->inBarrel() && clus->inEndcap() && clus->eSample(CaloSampling::EMB2) >= clus->eSample(CaloSampling::EME2))) {
    // Barrel
    sample = CaloSampling::EMB2;
  } else if ((!clus->inBarrel() && clus->inEndcap() && !isFwrdEle) ||
             (clus->inBarrel() && clus->inEndcap() && clus->eSample(CaloSampling::EME2) > clus->eSample(CaloSampling::EMB2))) {
    // End-cap
    sample = CaloSampling::EME2;
  } else if (isFwrdEle && clus->inEndcap()) {
    // FCAL
    sample = CaloSampling::FCAL2;
  } else {
    return false;
  }
  std::unique_ptr<Trk::CurvilinearParameters> params = extractParamFromTruth(*thePart);
  if (!params) return false;
  // create extension to sample
  std::vector<CaloSampling::CaloSample> samples = { sample };
  auto  extension = m_caloExtensionTool->layersCaloExtension(ctx, *params, samples, etaClus, caloDDMgr);
  bool extensionOK = (!extension.empty());
  if (!extensionOK) {
    ATH_MSG_WARNING("extrapolation of Truth Particle with eta  " << thePart->eta() << " , charge " << thePart->charge() << " , Pt " << thePart->pt() << " to calo failed");
    return false;
  }
  double etaCalo = extension[0].second->position().eta();
  double phiCalo = extension[0].second->position().phi();
 
  const double dPhi = std::abs(std::remainder(phiCalo - phiClus, 2*std::numbers::pi));
  const double dEta = std::abs(etaCalo - etaClus);
  dRmatch = std::hypot(dPhi, dEta);
 
  if ((!isFwrdEle && dRmatch > m_phtdRtoTrCut) || (isFwrdEle && dRmatch > m_fwrdEledRtoTrCut)) return false;
  if (!isFwrdEle && std::hypot( dPhi/m_phtClasConePhi, dEta/m_phtClasConeEta ) <= 1.0) isNarrowCone = true;
  return true;
}

getGenPart()

const xAOD::TruthParticle * MCTruthClassifier::getGenPart ( const xAOD::TrackParticle * trk, IMCTruthClassifier::Info * info = nullptr ) const

finaloverridevirtual

Implements IMCTruthClassifier.

Definition at line 204 of file MCRecoToTruth.cxx.

{
  // return GenParticle corresponding to given TrackParticle
  ATH_MSG_DEBUG("Executing getGenPart ");
  if (!trk) return nullptr;
  if (info) {
    info->deltaRMatch = -999.;
    info->deltaPhi = -999.;
    info->probTrkToTruth = 0;
    info->numOfSiHits = 0;
  }
 
  uint8_t NumOfPixHits = 0;
  uint8_t NumOfSCTHits = 0;
  typedef ElementLink<xAOD::TruthParticleContainer> TruthLink_t;
 
  static const SG::Accessor<TruthLink_t> tPL("truthParticleLink");
  if (!tPL.isAvailable(*trk)) {
    ATH_MSG_DEBUG("Track particle is not associated to truth particle");
    return nullptr;
  }
 
  const auto& truthLink = tPL(*trk);
  if (!truthLink.isValid()) {
    ATH_MSG_DEBUG("Invalid link to truth particle");
    return nullptr;
  }
 
  const xAOD::TruthParticle* theGenParticle = (*truthLink);
  if (!theGenParticle) {
    ATH_MSG_DEBUG("Could not find truth matching for track");
    return nullptr;
  }
 
  if (info) {
    static const SG::Accessor<float> tMP("truthMatchProbability");
    if (tMP.isAvailable(*trk)) {
      info->probTrkToTruth = tMP(*trk);
    } else {
      ATH_MSG_DEBUG("Truth match probability not available");
    }
  }
 
  if (theGenParticle->status() == 3) {
    ATH_MSG_WARNING("track matched to the truth with status " << theGenParticle->status());
  }
  else if (MC::isDecayed(theGenParticle)) {
    // Matching to status == 2 particles is to be expected if
    // quasi-stable particle simulation was used.
    ATH_MSG_DEBUG("track matched to the truth with status " << theGenParticle->status());
  }
 
  if (MC::isDecayed(theGenParticle) && (MC::isElectron(theGenParticle) || MC::isMuon(theGenParticle))) {
    const xAOD::TruthVertex* EndVrtx = theGenParticle->decayVtx();
    const xAOD::TruthParticle* theGenPartTmp(nullptr);
 
    if (EndVrtx != nullptr) {
      int itr = 0;
      do {
        theGenPartTmp = nullptr;
        for (const auto & theDaugt: EndVrtx->particles_out()) {
          if (!theDaugt) continue;
          if (theDaugt->pdgId() == theGenParticle->pdgId()) theGenPartTmp = theDaugt;
          if (theDaugt->pdgId() != theGenParticle->pdgId() && !MC::isPhoton(theDaugt)) theGenPartTmp = nullptr;
        }
        itr++;
        if (itr > 100) {
          ATH_MSG_WARNING("getGenPart infinite while");
          break;
        }
        EndVrtx = theGenPartTmp ? theGenPartTmp->decayVtx() : nullptr;
      } while (theGenPartTmp && theGenPartTmp->pdgId() == theGenParticle->pdgId() && MC::isDecayed(theGenPartTmp) && EndVrtx != nullptr);
 
      if (theGenPartTmp && theGenPartTmp->pdgId() == theGenParticle->pdgId()) theGenParticle = theGenPartTmp;
    }
  }
 
  if (!trk->summaryValue(NumOfSCTHits, xAOD::numberOfSCTHits)) ATH_MSG_DEBUG("Could not retrieve number of SCT hits");
  if (!trk->summaryValue(NumOfPixHits, xAOD::numberOfPixelHits))  ATH_MSG_DEBUG("Could not retrieve number of Pixel hits");
 
  uint8_t NumOfSiHits = NumOfSCTHits + NumOfPixHits;
 
  float deltaPhi = std::abs(std::remainder(theGenParticle->phi() - trk->phi(), 2*std::numbers::pi));
  float deteta = std::abs(theGenParticle->eta() - trk->eta());
  float deltaRMatch = std::hypot(deltaPhi, deteta);
  if ((NumOfSiHits > m_NumOfSiHitsCut && deltaRMatch > m_deltaRMatchCut) ||
      (NumOfSiHits <= m_NumOfSiHitsCut && deltaPhi > m_deltaPhiMatchCut)) theGenParticle = nullptr;
 
  if (info) {
    info->deltaRMatch = deltaRMatch;
    info->deltaPhi = deltaPhi;
    info->numOfSiHits = NumOfSiHits;
  }
  ATH_MSG_DEBUG("getGenPart  succeeded ");
  return (theGenParticle);
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

virtual StatusCode MCTruthClassifier::initialize ( void )

inlineoverridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 95 of file MCTruthClassifier.h.

                                           {
    ATH_MSG_INFO(" Initializing MCTruthClassifier");
#ifndef XAOD_ANALYSIS
    // Only needed for GenParticle interface
    ATH_CHECK(m_truthLinkVecReadHandleKey.initialize(!m_truthLinkVecReadHandleKey.key().empty()));
#endif
    ATH_CHECK(m_truthParticleContainerKey.initialize());
 
#if !defined(XAOD_ANALYSIS) && !defined(GENERATIONBASE)
    if (!m_caloExtensionTool.empty()) {
      ATH_CHECK(m_caloExtensionTool.retrieve());
    } else {
      m_caloExtensionTool.disable();
    }
 
    ATH_CHECK(m_caloMgrKey.initialize(SG::AllowEmpty));
 
    if (!m_truthInConeTool.empty()) {
      ATH_CHECK(m_truthInConeTool.retrieve());
    } else {
      m_truthInConeTool.disable();
    }
#endif
    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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

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.

particleHepMCTruthClassifier() [1/2]

std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin > IMCTruthClassifier::particleHepMCTruthClassifier ( const HepMcParticleLink & theLink ) const

inlineinherited

Definition at line 120 of file IMCTruthClassifier.h.

{return particleHepMCTruthClassifier(theLink, nullptr); }

particleHepMCTruthClassifier() [2/2]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleHepMCTruthClassifier ( const HepMcParticleLink & theLink, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Definition at line 25 of file MCTruthClassifierGen.cxx.

                                                                                                                      {
  // Retrieve the links between HepMC and xAOD::TruthParticle
  const EventContext& ctx = info ? info->eventContext : Gaudi::Hive::currentContext();
  SG::ReadHandle<xAODTruthParticleLinkVector> truthParticleLinkVecReadHandle(m_truthLinkVecReadHandleKey, ctx);
  if (!truthParticleLinkVecReadHandle.isValid()) {
    ATH_MSG_WARNING(" Invalid ReadHandle for xAODTruthParticleLinkVector with key: " << truthParticleLinkVecReadHandle.key());
    return std::make_pair(Unknown, NonDefined);
  }
  ElementLink<xAOD::TruthParticleContainer> tplink = truthParticleLinkVecReadHandle->find (theLink);
  if (tplink.isValid()) {
    return particleTruthClassifier (*tplink, info);
  }
  return std::make_pair(Unknown, NonDefined);
}

particleTruthClassifier() [1/9]

template<typename T>

std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin > IMCTruthClassifier::particleTruthClassifier ( const T * p, std::optional< std::reference_wrapper< const EventContext > > ctx = std::nullopt ) const

inline

Definition at line 162 of file IMCTruthClassifier.h.

  {
      if (!ctx) return particleTruthClassifier(p, nullptr);
      IMCTruthClassifier::Info info(ctx->get());
      return particleTruthClassifier(p, &info);
  }

particleTruthClassifier() [2/9]

virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::CaloCluster * , IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

particleTruthClassifier() [3/9]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::Electron * elec, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 24 of file MCRecoToTruth.cxx.

{
  ATH_MSG_DEBUG("Executing egamma electron Classifier");
  ParticleType parttype = Unknown;
  ParticleOrigin partorig = NonDefined;
  const xAOD::TruthParticle* genPart = nullptr;
  const xAOD::TrackParticle* trkPtr = elec->trackParticle();
  if (elec->author() != xAOD::EgammaParameters::AuthorFwdElectron ||trkPtr) {
    // Central electron or forward electron with track (when reco
    // implemented in the future)
    if (!trkPtr){
      return std::make_pair(parttype, partorig);
    }
    genPart = getGenPart(trkPtr);
  } else {
#ifndef XAOD_ANALYSIS // cluster matching available only in Athena
    const xAOD::CaloCluster* clus = elec->caloCluster();
    genPart = egammaClusMatch(clus, true, info);
#else
    ATH_MSG_WARNING("Forward Electron classification using extrapolation to Calo is available only in Athena , check your enviroment. ");
#endif
  }
 
  if (info)  info->genPart = genPart;
  if (!genPart) return std::make_pair(parttype, partorig);
  ATH_MSG_DEBUG("egamma electron Classifier  succeeded ");
  return particleTruthClassifier(genPart, info);
}

particleTruthClassifier() [4/9]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::Jet * jet, bool DR, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 130 of file MCRecoToTruth.cxx.

{
  ATH_MSG_DEBUG("Executing Classifier with jet Input");
  ParticleType parttype = UnknownJet;
  ParticleOrigin partorig = NonDefined;
  ParticleType tempparttype = UnknownJet;
  std::set<const xAOD::TruthParticle*> allJetMothers;
  std::set<const xAOD::TruthParticle*> constituents;
  if (!jet) return std::make_pair(parttype, partorig);
  allJetMothers.clear();
  constituents.clear();
  if (DR) {
    // use a DR matching scheme (default)
    // retrieve collection and get a pointer
    SG::ReadHandle<xAOD::TruthParticleContainer> truthParticleContainerReadHandle(m_truthParticleContainerKey);
 
    if (!truthParticleContainerReadHandle.isValid()) {
      ATH_MSG_WARNING(" Invalid ReadHandle for xAOD::TruthParticleContainer with key: " << truthParticleContainerReadHandle.key());
     
    } else {
    ATH_MSG_DEBUG("xAODTruthParticleContainer with key  " << truthParticleContainerReadHandle.key() << " has valid ReadHandle ");
    // find the matching truth particles
    for (const auto *const thePart : *truthParticleContainerReadHandle) {
      // match truth particles to the jet
      if (MC::isStable(thePart) && thePart->p4().DeltaR(jet->p4()) < m_jetPartDRMatch) {
        constituents.insert(thePart);
      }
    }
   }
  }
  else {
    xAOD::JetConstituentVector vec = jet->getConstituents();
    for (const auto *particle0 : vec) {
      const xAOD::TruthParticle* thePart = static_cast<const xAOD::TruthParticle*>(particle0->rawConstituent());
      if (MC::isStable(thePart)) {
        constituents.insert(thePart);
      }
    }
  }
  // AV: Jet type is the type of hadron with "heaviest" flavour among the jet constituents.
  // AV: No hadrons in the jet -- the flavour is unknown.
  // AV: The algorithm will fail on 4/5 quark hadrons and probably on nonBSM hadrons. To be fixed.
  for (const auto& thePart: constituents) {
    MC::findParticleAncestors(thePart, allJetMothers);
    //AV: probably skip ME particles
    if (!MC::isPhysical(thePart)) continue;
    // determine if hadron and its type
    tempparttype = particleTruthClassifier(thePart, info).first;
    if (tempparttype != Hadron) continue;
    tempparttype = defTypeOfHadron(thePart->pdgId());
    // classify the jet
    if (tempparttype == BBbarMesonPart || tempparttype == BottomMesonPart || tempparttype == BottomBaryonPart) {
      parttype = BJet;
      continue;
    }
    if (tempparttype == CCbarMesonPart || tempparttype == CharmedMesonPart || tempparttype == CharmedBaryonPart) {
      if (parttype != BJet) parttype = CJet;
      continue;
    }
    if (tempparttype == StrangeBaryonPart || tempparttype == LightBaryonPart || tempparttype == StrangeMesonPart || tempparttype == LightMesonPart) {
      if (parttype != BJet && parttype != CJet) parttype = LJet;
      continue;
    }
  }
 
  // clasify the jet origin
  partorig = defJetOrig(allJetMothers);
  allJetMothers.clear();
  constituents.clear();
  ATH_MSG_DEBUG(" jet Classifier succeeded");
  return std::make_pair(parttype, partorig);
}

particleTruthClassifier() [5/9]

std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin > IMCTruthClassifier::particleTruthClassifier ( const xAOD::Jet * p, bool DR ) const

inline

Definition at line 147 of file IMCTruthClassifier.h.

{return particleTruthClassifier(p, DR, nullptr); }

particleTruthClassifier() [6/9]

virtual std::pair< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::Muon * , IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

particleTruthClassifier() [7/9]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::Photon * phot, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 54 of file MCRecoToTruth.cxx.

{
  ATH_MSG_DEBUG("Executing egamma photon Classifier");
  ParticleType parttype = Unknown;
  ParticleOrigin partorig = NonDefined;
  const xAOD::CaloCluster* clus = phot->caloCluster();
  if (!clus) return std::make_pair(parttype, partorig);
  if (std::fabs(clus->eta()) > 10.0 || std::fabs(clus->phi()) > 6.28 || (clus->et()) <= 0.)  return std::make_pair(parttype, partorig);
 
  const xAOD::Vertex* VxCvPtr = phot->vertex();
  if (VxCvPtr != nullptr) {
    for (int itrk = 0; itrk < (int)VxCvPtr->nTrackParticles(); itrk++) {
      if (itrk > 1) continue;
      const xAOD::TrackParticle* trkPtr = VxCvPtr->trackParticle(itrk);
      if (!trkPtr) continue;
      const xAOD::TruthParticle* thePart = getGenPart(trkPtr);
      std::pair<ParticleType, ParticleOrigin> classif = particleTruthClassifier(thePart, info);
      if (info) {
        info->cnvPhotTrkPtr.push_back(trkPtr);
        info->cnvPhotTrkToTruthPart.push_back(thePart);
        info->cnvPhotPartType.push_back(classif.first);
        info->cnvPhotPartOrig.push_back(classif.second);
      }
    }
  }
 
  const xAOD::TruthParticle* genPart = nullptr;
#ifndef XAOD_ANALYSIS // Fwd electron available only in Athena
  genPart = egammaClusMatch(clus, false, info);
#else
  ATH_MSG_WARNING("Photon  Classification using extrapolation to Calo is  available only in Athena , check your enviroment. ");
#endif
  if (!genPart) return std::make_pair(parttype, partorig);
  if (info) info->genPart = genPart;
  ATH_MSG_DEBUG("egamma photon  Classifier  succeeded ");
  return particleTruthClassifier(genPart, info);
}

particleTruthClassifier() [8/9]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::TrackParticle * trkPtr, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 11 of file MCRecoToTruth.cxx.

{
  ATH_MSG_DEBUG("Executing trackClassifier");
  ParticleType parttype = Unknown;
  ParticleOrigin partorig = NonDefined;
  const xAOD::TruthParticle* genPart = getGenPart(trkPtr);
  if (info) info->genPart = genPart;
  if (!genPart) return std::make_pair(parttype, partorig);
  ATH_MSG_DEBUG("trackClassifier  succeeded ");
  return particleTruthClassifier(genPart, info);
}

particleTruthClassifier() [9/9]

std::pair< ParticleType, ParticleOrigin > MCTruthClassifier::particleTruthClassifier ( const xAOD::TruthParticle * thePart, IMCTruthClassifier::Info * info ) const

finaloverrideprotectedvirtual

Implements IMCTruthClassifier.

Reimplemented in D3PD::D3PDMCTruthClassifier.

Definition at line 42 of file MCTruthClassifierGen.cxx.

                                                                                                                   {
  IMCTruthClassifier::Info tmpinfo;
  IMCTruthClassifier::Info& info = (infoin) ? *infoin : tmpinfo;
 
  ATH_MSG_DEBUG("Executing particleTruthClassifier");
 
  ParticleType partType = Unknown;
  ParticleOrigin partOrig = NonDefined;
  if (!thePart) {
    return std::make_pair(partType, partOrig);
  }
  info.genPart = thePart;
 
  // retrieve collection and get a pointer
  SG::ReadHandle<xAOD::TruthParticleContainer> truthParticleContainerReadHandle(m_truthParticleContainerKey,info.eventContext);
  if (!truthParticleContainerReadHandle.isValid()) {
    ATH_MSG_WARNING( " Invalid ReadHandle for xAOD::TruthParticleContainer with key: " << truthParticleContainerReadHandle.key());
    return std::make_pair(partType, partOrig);
  }
 
  ATH_MSG_DEBUG("xAODTruthParticleContainer with key  " << truthParticleContainerReadHandle.key() << " has valid ReadHandle ");
 
  if (!MC::isStable(thePart) && !MC::isDecayed(thePart)) {
    return std::make_pair(GenParticle, partOrig);
  }
  const bool isPartHadr = MC::isHadron(thePart) && !MC::isBeam(thePart);
  if (MC::isDecayed(thePart) && (!MC::isTau(thePart) && !isPartHadr)) return std::make_pair(GenParticle, partOrig);
 
  // SUSY datasets: tau(status==2)->tau(status==2)
  if (MC::isDecayed(thePart) && MC::isTau(thePart)) {
    const xAOD::TruthVertex* endVert = thePart->decayVtx();
    if (endVert) {
      if (endVert->nOutgoingParticles() == 1 && MC::isTau(endVert->outgoingParticle(0))) {
        return std::make_pair(GenParticle, partOrig);
      }
    }
  }
 
  if (MC::isStable(thePart) && MC::isSUSY(thePart)) return std::make_pair(SUSYParticle, partOrig);
 
  if (MC::isStable(thePart) && MC::isBSM(thePart)) return std::make_pair(OtherBSMParticle, partOrig);
 
  if (MC::isDecayed(thePart) &&
      (!MC::isElectron(thePart) && !MC::isMuon(thePart) &&
       !MC::isTau(thePart) && !MC::isPhoton(thePart)) &&
      !isPartHadr)
    return std::make_pair(GenParticle, partOrig);
 
  // FIXME vetoing protons here to preserve previous behaviour
  if (MC::isNucleus(thePart) && std::abs(thePart->pdgId()) != MC::PROTON) return std::make_pair(NuclFrag, partOrig);
 
  if ( !MC::isSMLepton(thePart) && !MC::isPhoton(thePart)  && !isPartHadr) return std::make_pair(partType, partOrig);
  // don't consider generator particles
 
  const xAOD::TruthVertex* partProdVtx = thePart->hasProdVtx() ? thePart->prodVtx() : nullptr;
 
  const xAOD::TruthParticle* parent{};
  if (partProdVtx) {
    for (const auto& temp: partProdVtx->particles_in()) {if (temp)  parent = temp;}
  }
  const int parentPDG = parent?parent->pdg_id():0;
  info.setMotherProperties(parent);
 
  if (!partProdVtx && HepMC::is_simulation_particle(thePart)) {
    return std::make_pair(NonPrimary, partOrig);
  }
  if (!partProdVtx && MC::isElectron(thePart)) {
    // to define electron outcome status
    bool isPrompt = false; // updated by defOrigOfElectron
    partOrig = defOrigOfElectron(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    return std::make_pair(UnknownElectron, partOrig);
  }
  if (!partProdVtx && MC::isMuon(thePart)) {
    // to define electron outcome status
    bool isPrompt = false; // updated by defOrigOfMuon
    partOrig = defOrigOfMuon(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    return std::make_pair(UnknownMuon, partOrig);
  }
  if (!partProdVtx && MC::isTau(thePart)) {
    // to define electron outcome status
    partOrig = defOrigOfTau(*truthParticleContainerReadHandle, thePart, parentPDG, info);
    return std::make_pair(UnknownTau, partOrig);
  }
  if (!partProdVtx && MC::isPhoton(thePart)) {
    // to define photon outcome
    bool isPrompt = false; // updated by defOrigOfPhoton
    partOrig = defOrigOfPhoton(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    return std::make_pair(UnknownPhoton, partOrig);
  }
  if (!partProdVtx && MC::isNeutrino(thePart)) {
    // to define neutrino outcome
    info.particleOutCome = NonInteract;
    return std::make_pair(Neutrino, partOrig);
  }
 
  if (thePart && info.Mother() && HepMC::is_same_generator_particle(thePart,info.Mother()))
    return std::make_pair(NonPrimary, partOrig);
 
  if (isPartHadr) return std::make_pair(Hadron, partOrig);
 
  if (partProdVtx && parentPDG == 0 && partProdVtx->nOutgoingParticles() == 1 &&
      partProdVtx->nIncomingParticles() == 0) {
    if (MC::isElectron(thePart)) {
      info.particleOutCome = defOutComeOfElectron(thePart);
      return std::make_pair(IsoElectron, SingleElec);
    }
    if (MC::isMuon(thePart)) {
      info.particleOutCome = defOutComeOfMuon(thePart);
      return std::make_pair(IsoMuon, SingleMuon);
    }
    if (MC::isTau(thePart)) {
      info.particleOutCome = defOutComeOfTau(thePart);
      return std::make_pair(IsoTau, SingleTau);
    }
    if (MC::isPhoton(thePart)) {
      info.particleOutCome = defOutComeOfPhoton(thePart);
      return std::make_pair(IsoPhoton, SinglePhot);
    }
  }
 
  if (parentPDG == thePart->pdg_id() && parent && parent->status() == 3 && MC::isDecayed(thePart)) return std::make_pair(GenParticle, partOrig);
 
  if (MC::isElectron(thePart)) {
    bool isPrompt = false; // updated by defOrigOfElectron
    partOrig = defOrigOfElectron(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    partType = defTypeOfElectron(partOrig, isPrompt);
  } else if (MC::isMuon(thePart)) {
    bool isPrompt = false; // updated by defOrigOfMuon
    partOrig = defOrigOfMuon(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    partType = defTypeOfMuon(partOrig, isPrompt);
  } else if (MC::isTau(thePart)) {
    partOrig = defOrigOfTau(*truthParticleContainerReadHandle, thePart, parentPDG, info);
    partType = defTypeOfTau(partOrig);
  } else if (MC::isPhoton(thePart)) {
    bool isPrompt = false; // updated by defOrigOfPhoton
    partOrig = defOrigOfPhoton(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    partType = defTypeOfPhoton(partOrig);
  } else if (MC::isNeutrino(thePart)) {
    bool isPrompt = false; // updated by defOrigOfNeutrino
    partOrig = defOrigOfNeutrino(*truthParticleContainerReadHandle, thePart, isPrompt, info);
    partType = Neutrino;
  }
 
  ATH_MSG_DEBUG("particleTruthClassifier  succeeded ");
  return std::make_pair(partType, partOrig);
}

particleTruthClassifier_full()

template<typename T>

std::tuple< MCTruthPartClassifier::ParticleType, MCTruthPartClassifier::ParticleOrigin, const xAOD::TruthParticle *, MCTruthPartClassifier::ParticleOutCome > IMCTruthClassifier::particleTruthClassifier_full ( const T * p, std::optional< std::reference_wrapper< const EventContext > > ctx = std::nullopt ) const

inlineinherited

Returns more info than the particleTruthClassifier.

Definition at line 155 of file IMCTruthClassifier.h.

                                                                                                                        {
    IMCTruthClassifier::Info info = ctx ? IMCTruthClassifier::Info(ctx->get()) : IMCTruthClassifier::Info();
    auto classification = particleTruthClassifier(p, &info);
    return {classification.first,classification.second,info.genPart,info.particleOutCome};
  }

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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

                                                          {
    handlesArray.renounce();
  }

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

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 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_caloExtensionTool

ToolHandle<Trk::IParticleCaloExtensionTool> MCTruthClassifier::m_caloExtensionTool {this,"ParticleCaloExtensionTool",""}

private

Definition at line 205 of file MCTruthClassifier.h.

{this,"ParticleCaloExtensionTool",""};

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> MCTruthClassifier::m_caloMgrKey {this,"CaloDetDescrManager",""}

private

Definition at line 206 of file MCTruthClassifier.h.

{this,"CaloDetDescrManager",""};

m_deltaPhiMatchCut

float MCTruthClassifier::m_deltaPhiMatchCut

private

Definition at line 232 of file MCTruthClassifier.h.

m_deltaRMatchCut

float MCTruthClassifier::m_deltaRMatchCut

private

Definition at line 231 of file MCTruthClassifier.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

m_FwdElectronTruthExtrEtaCut

float MCTruthClassifier::m_FwdElectronTruthExtrEtaCut

private

Definition at line 211 of file MCTruthClassifier.h.

m_FwdElectronTruthExtrEtaWindowCut

float MCTruthClassifier::m_FwdElectronTruthExtrEtaWindowCut

private

Definition at line 212 of file MCTruthClassifier.h.

m_FwdElectronUseG4Sel

bool MCTruthClassifier::m_FwdElectronUseG4Sel

private

Definition at line 210 of file MCTruthClassifier.h.

m_fwrdEledRtoTrCut

float MCTruthClassifier::m_fwrdEledRtoTrCut

private

Definition at line 218 of file MCTruthClassifier.h.

m_inclG4part

bool MCTruthClassifier::m_inclG4part

private

Definition at line 223 of file MCTruthClassifier.h.

m_jetPartDRMatch

float MCTruthClassifier::m_jetPartDRMatch

private

Definition at line 234 of file MCTruthClassifier.h.

m_NumOfSiHitsCut

int MCTruthClassifier::m_NumOfSiHitsCut

private

Definition at line 233 of file MCTruthClassifier.h.

m_partExtrConeEta

float MCTruthClassifier::m_partExtrConeEta

private

Definition at line 213 of file MCTruthClassifier.h.

m_partExtrConePhi

float MCTruthClassifier::m_partExtrConePhi

private

Definition at line 214 of file MCTruthClassifier.h.

m_phtClasConeEta

float MCTruthClassifier::m_phtClasConeEta

private

Definition at line 216 of file MCTruthClassifier.h.

m_phtClasConePhi

float MCTruthClassifier::m_phtClasConePhi

private

Definition at line 215 of file MCTruthClassifier.h.

m_phtdRtoTrCut

float MCTruthClassifier::m_phtdRtoTrCut

private

Definition at line 217 of file MCTruthClassifier.h.

m_pTChargePartCut

float MCTruthClassifier::m_pTChargePartCut

private

Definition at line 221 of file MCTruthClassifier.h.

m_pTNeutralPartCut

float MCTruthClassifier::m_pTNeutralPartCut

private

Definition at line 222 of file MCTruthClassifier.h.

m_ROICone

bool MCTruthClassifier::m_ROICone

private

Definition at line 219 of file MCTruthClassifier.h.

m_truthInConeTool

ToolHandle<xAOD::ITruthParticlesInConeTool> MCTruthClassifier::m_truthInConeTool {this,"TruthInConeTool","xAOD::TruthParticlesInConeTool/TruthParticlesInConeTool"}

private

Definition at line 208 of file MCTruthClassifier.h.

{this,"TruthInConeTool","xAOD::TruthParticlesInConeTool/TruthParticlesInConeTool"};

m_truthLinkVecReadHandleKey

SG::ReadHandleKey<xAODTruthParticleLinkVector> MCTruthClassifier::m_truthLinkVecReadHandleKey {this,"xAODTruthLinkVector","xAODTruthLinks", "ReadHandleKey for xAODTruthParticleLinkVector"}

private

Definition at line 228 of file MCTruthClassifier.h.

{this,"xAODTruthLinkVector","xAODTruthLinks", "ReadHandleKey for xAODTruthParticleLinkVector"};

m_truthParticleContainerKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> MCTruthClassifier::m_truthParticleContainerKey {this,"xAODTruthParticleContainerName","TruthParticles","ReadHandleKey for xAOD::TruthParticleContainer"}

private

Definition at line 202 of file MCTruthClassifier.h.

{this,"xAODTruthParticleContainerName","TruthParticles","ReadHandleKey for xAOD::TruthParticleContainer"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

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

• MCTruthClassifier.h
• MCRecoToTruth.cxx
• MCTruthClassifierGen.cxx
• MCTruthClassifierAthena.cxx