DerivationFramework::BkgElectronClassification Class Reference

#include <BkgElectronClassification.h>

Inheritance diagram for DerivationFramework::BkgElectronClassification:

Collaboration diagram for DerivationFramework::BkgElectronClassification:

Public Member Functions
virtual StatusCode	initialize () override final
virtual StatusCode	addBranches (const EventContext &ctx) const override final

Private Attributes
ToolHandle< IMCTruthClassifier >	m_mcTruthClassifier
	MCTruthClassifier.
SG::ReadHandleKey< xAOD::ElectronContainer >	m_electronContainer
	input electron container
SG::ReadDecorHandleKey< xAOD::ElectronContainer >	m_electronTruthParticleLink
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthContainer
	Input truth particle container.
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_truthPdgId { this, "DoNotSet_truthPdgId", m_electronContainer, "truthPdgId", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_firstEgMotherTruthType { this, "firstEgMotherTruthType", m_electronContainer, "firstEgMotherTruthType", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_firstEgMotherTruthOrigin { this, "firstEgMotherTruthOrigin", m_electronContainer, "firstEgMotherTruthOrigin", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_firstEgMotherTruthClassification
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_firstEgMotherTruthParticleLink
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_firstEgMotherPdgId { this, "firstEgMotherPdgId", m_electronContainer, "firstEgMotherPdgId", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_lastEgMotherTruthType { this, "lastEgMotherTruthType", m_electronContainer, "lastEgMotherTruthType", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_lastEgMotherTruthOrigin { this, "lastEgMotherTruthOrigin", m_electronContainer, "lastEgMotherTruthOrigin", "" }
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_lastEgMotherTruthClassification
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_lastEgMotherTruthParticleLink
SG::WriteDecorHandleKey< xAOD::ElectronContainer >	m_lastEgMotherPdgId { this, "lastEgMotherPdgId", m_electronContainer, "lastEgMotherPdgId", "" }

Detailed Description

Definition at line 23 of file BkgElectronClassification.h.

Member Function Documentation

addBranches()

StatusCode DerivationFramework::BkgElectronClassification::addBranches ( const EventContext & ctx ) const

finaloverridevirtual

Definition at line 48 of file BkgElectronClassification.cxx.

{
 
  SG::ReadHandle<xAOD::ElectronContainer> electrons{ m_electronContainer, ctx };
  SG::ReadHandle<xAOD::TruthParticleContainer> truthContainer{ m_truthContainer,
                                                               ctx };
 
  // Access for the pre-existing decoration
  SG::ReadDecorHandle<xAOD::ElectronContainer,
                      ElementLink<xAOD::TruthParticleContainer>>
    tPL{ m_electronTruthParticleLink, ctx };
 
  // pdg iD
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> tPdgID(m_truthPdgId, ctx);
  // first mother decorations
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> firstEgMotherTT(
    m_firstEgMotherTruthType, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> firstEgMotherTO(
    m_firstEgMotherTruthOrigin, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, unsigned int> firstEgMotherTC(
    m_firstEgMotherTruthClassification, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> firstEgMotherPdgID(
    m_firstEgMotherPdgId, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer,
                       ElementLink<xAOD::TruthParticleContainer>>
    firstEgMotherTPL(m_firstEgMotherTruthParticleLink, ctx);
 
  // last mother decorations
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> lastEgMotherTT(
    m_lastEgMotherTruthType, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> lastEgMotherTO(
    m_lastEgMotherTruthOrigin, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, unsigned int> lastEgMotherTC(
    m_lastEgMotherTruthClassification, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer, int> lastEgMotherPdgID(
    m_lastEgMotherPdgId, ctx);
  SG::WriteDecorHandle<xAOD::ElectronContainer,
                       ElementLink<xAOD::TruthParticleContainer>>
    lastEgMotherTPL(m_lastEgMotherTruthParticleLink, ctx);
  //
 
  for (const xAOD::Electron* el : *electrons) {
    tPdgID(*el) = 0;
    if (tPL.isPresent() && tPL(*el).isValid()) {
      const xAOD::TruthParticle* truthEl = *tPL(*el);
      tPdgID(*el) = truthEl->pdgId();
      // Parents can be removed by truth thinning in e.g cases of Geant4 produced LRT electrons
      // throw a warning in these cases so this is transparent
      if (MC::isElectron(truthEl)) {
        for (size_t p = 0; p < truthEl->nParents(); ++p) {
          if (!truthEl->parent(p)) {
            ATH_MSG_WARNING("Unresolvable truth parent link (ancestry removed by "
                            << "truth thinning) for truth electron with pt "
                            << truthEl->pt() << " MeV");
            break;
          }
        }
      }
    }
    // Use the Helpers for electron from electron or photon
    // Add Extra Decoration from Egamma helpers in case of BkgElectron (Electron
    // coming for a photon) Go back to the first/last electron/photon Generator
    // mother and classify this one
    // First the one entering the Geant4, the first we meet on the way back
    firstEgMotherTT(*el) = 0;
    firstEgMotherTO(*el) = 0;
    firstEgMotherTC(*el) = 0;
    firstEgMotherTPL(*el) = ElementLink<xAOD::TruthParticleContainer>();
    firstEgMotherPdgID(*el) = 0;
    const xAOD::TruthParticle* firstElTruth =
      xAOD::EgammaHelpers::getBkgElectronMother(el, false);
 
    if (firstElTruth) {
      auto res = m_mcTruthClassifier->particleTruthClassifier(firstElTruth, ctx);
      firstEgMotherTT(*el) = res.first;
      firstEgMotherTO(*el) = res.second;
      firstEgMotherTC(*el) = std::get<0>(MCTruthPartClassifier::defOrigOfParticle(firstElTruth)); // See AGENE-2351
      firstEgMotherPdgID(*el) = firstElTruth->pdgId();
      ElementLink<xAOD::TruthParticleContainer> link(
        firstElTruth, *truthContainer, ctx);
      firstEgMotherTPL(*el) = link;
    }
 
    // The last electron / photon we meet on the way back towards the Generator
    // vertex
    lastEgMotherTT(*el) = 0;
    lastEgMotherTO(*el) = 0;
    lastEgMotherTC(*el) = 0;
    lastEgMotherTPL(*el) = ElementLink<xAOD::TruthParticleContainer>();
    lastEgMotherPdgID(*el) = 0;
    const xAOD::TruthParticle* lastElTruth =
      xAOD::EgammaHelpers::getBkgElectronMother(el);
 
    if (lastElTruth) {
      auto res = m_mcTruthClassifier->particleTruthClassifier(lastElTruth, ctx);
      lastEgMotherTT(*el) = res.first;
      lastEgMotherTO(*el) = res.second;
      lastEgMotherTC(*el) = std::get<0>(MCTruthPartClassifier::defOrigOfParticle(lastElTruth)); // See AGENE-2351
      lastEgMotherPdgID(*el) = lastElTruth->pdgId();
      ElementLink<xAOD::TruthParticleContainer> link(
        lastElTruth, *truthContainer, ctx);
      lastEgMotherTPL(*el) = link;
    }
  }
  return StatusCode::SUCCESS;
}

initialize()

StatusCode DerivationFramework::BkgElectronClassification::initialize ( )

finaloverridevirtual

Definition at line 18 of file BkgElectronClassification.cxx.

{
 
  ATH_MSG_DEBUG("Initializing " << name() << "...");
  ATH_CHECK(m_mcTruthClassifier.retrieve());
  ATH_MSG_DEBUG("Retrieved tool " << m_mcTruthClassifier);
 
  ATH_CHECK(m_electronContainer.initialize());
  ATH_CHECK(m_truthContainer.initialize());
  ATH_CHECK(m_electronTruthParticleLink.initialize());
  ATH_CHECK(m_truthPdgId.initialize());
  //
  ATH_CHECK(m_firstEgMotherTruthType.initialize());
  ATH_CHECK(m_firstEgMotherTruthOrigin.initialize());
  ATH_CHECK(m_firstEgMotherTruthClassification.initialize());
  ATH_CHECK(m_firstEgMotherTruthParticleLink.initialize());
  ATH_CHECK(m_firstEgMotherPdgId.initialize());
  //
  ATH_CHECK(m_lastEgMotherTruthType.initialize());
  ATH_CHECK(m_lastEgMotherTruthOrigin.initialize());
  ATH_CHECK(m_lastEgMotherTruthClassification.initialize());
  ATH_CHECK(m_lastEgMotherTruthParticleLink.initialize());
  ATH_CHECK(m_lastEgMotherPdgId.initialize());
 
  ATH_MSG_DEBUG("Initialization successful");
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_electronContainer

SG::ReadHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_electronContainer

private

Initial value:

{
      this,
      "ElectronContainerName",
      "Electrons",
      "Input Electrons"
    }

input electron container

Definition at line 42 of file BkgElectronClassification.h.

                                                              {
      this,
      "ElectronContainerName",
      "Electrons",
      "Input Electrons"
    };

m_electronTruthParticleLink

SG::ReadDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_electronTruthParticleLink

private

Initial value:

{ this, "electronTruthParticleLink",
    m_electronContainer, "truthParticleLink", "" }

Definition at line 49 of file BkgElectronClassification.h.

                               { this, "electronTruthParticleLink",
    m_electronContainer, "truthParticleLink", "" }; // Decoration applied in egammaTruthAssociationAlg

m_firstEgMotherPdgId

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_firstEgMotherPdgId { this, "firstEgMotherPdgId", m_electronContainer, "firstEgMotherPdgId", "" }

private

Definition at line 76 of file BkgElectronClassification.h.

{ this, "firstEgMotherPdgId", m_electronContainer, "firstEgMotherPdgId", "" };

m_firstEgMotherTruthClassification

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_firstEgMotherTruthClassification

private

Initial value:

{ this, "firstEgMotherTruthClassification",
      m_electronContainer, "firstEgMotherTruthClassification", "" }

Definition at line 68 of file BkgElectronClassification.h.

                                      { this, "firstEgMotherTruthClassification",
      m_electronContainer, "firstEgMotherTruthClassification", "" };

m_firstEgMotherTruthOrigin

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_firstEgMotherTruthOrigin { this, "firstEgMotherTruthOrigin", m_electronContainer, "firstEgMotherTruthOrigin", "" }

private

Definition at line 66 of file BkgElectronClassification.h.

{ this, "firstEgMotherTruthOrigin", m_electronContainer, "firstEgMotherTruthOrigin", "" };

m_firstEgMotherTruthParticleLink

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_firstEgMotherTruthParticleLink

private

Initial value:

{ this,
      "firstEgMotherTruthParticleLink",
      m_electronContainer, "firstEgMotherTruthParticleLink",
      "" }

Definition at line 71 of file BkgElectronClassification.h.

                                    { this,
      "firstEgMotherTruthParticleLink",
      m_electronContainer, "firstEgMotherTruthParticleLink",
      "" };

m_firstEgMotherTruthType

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_firstEgMotherTruthType { this, "firstEgMotherTruthType", m_electronContainer, "firstEgMotherTruthType", "" }

private

Definition at line 64 of file BkgElectronClassification.h.

{ this, "firstEgMotherTruthType", m_electronContainer, "firstEgMotherTruthType", "" };

m_lastEgMotherPdgId

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_lastEgMotherPdgId { this, "lastEgMotherPdgId", m_electronContainer, "lastEgMotherPdgId", "" }

private

Definition at line 90 of file BkgElectronClassification.h.

{ this, "lastEgMotherPdgId", m_electronContainer, "lastEgMotherPdgId", "" };

m_lastEgMotherTruthClassification

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_lastEgMotherTruthClassification

private

Initial value:

{ this, "lastEgMotherTruthClassification",
      m_electronContainer, "lastEgMotherTruthClassification", "" }

Definition at line 82 of file BkgElectronClassification.h.

                                     { this, "lastEgMotherTruthClassification",
      m_electronContainer, "lastEgMotherTruthClassification", "" };

m_lastEgMotherTruthOrigin

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_lastEgMotherTruthOrigin { this, "lastEgMotherTruthOrigin", m_electronContainer, "lastEgMotherTruthOrigin", "" }

private

Definition at line 80 of file BkgElectronClassification.h.

{ this, "lastEgMotherTruthOrigin", m_electronContainer, "lastEgMotherTruthOrigin", "" };

m_lastEgMotherTruthParticleLink

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_lastEgMotherTruthParticleLink

private

Initial value:

{ this,
      "lastEgMotherTruthParticleLink",
      m_electronContainer, "lastEgMotherTruthParticleLink",
      "" }

Definition at line 85 of file BkgElectronClassification.h.

                                   { this,
      "lastEgMotherTruthParticleLink",
      m_electronContainer, "lastEgMotherTruthParticleLink",
      "" };

m_lastEgMotherTruthType

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_lastEgMotherTruthType { this, "lastEgMotherTruthType", m_electronContainer, "lastEgMotherTruthType", "" }

private

Definition at line 78 of file BkgElectronClassification.h.

{ this, "lastEgMotherTruthType", m_electronContainer, "lastEgMotherTruthType", "" };

m_mcTruthClassifier

ToolHandle<IMCTruthClassifier> DerivationFramework::BkgElectronClassification::m_mcTruthClassifier

private

Initial value:

{
      this,
        "MCTruthClassifierTool",
        "",
        "Handle to the MCTruthClassifier"
        }

MCTruthClassifier.

Definition at line 34 of file BkgElectronClassification.h.

                                                      {
      this,
        "MCTruthClassifierTool",
        "",
        "Handle to the MCTruthClassifier"
        };

m_truthContainer

SG::ReadHandleKey<xAOD::TruthParticleContainer> DerivationFramework::BkgElectronClassification::m_truthContainer

private

Initial value:

{
      this,
      "TruthParticleContainerName",
      "TruthParticles",
      "Input Truth Particles"
    }

Input truth particle container.

Definition at line 53 of file BkgElectronClassification.h.

                                                                {
      this,
      "TruthParticleContainerName",
      "TruthParticles",
      "Input Truth Particles"
    };

m_truthPdgId

SG::WriteDecorHandleKey<xAOD::ElectronContainer> DerivationFramework::BkgElectronClassification::m_truthPdgId { this, "DoNotSet_truthPdgId", m_electronContainer, "truthPdgId", "" }

private

Definition at line 62 of file BkgElectronClassification.h.

{ this, "DoNotSet_truthPdgId", m_electronContainer, "truthPdgId", "" };

---

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

• BkgElectronClassification.h
• BkgElectronClassification.cxx