DerivationFramework::TruthIsolationTool Class Reference

#include <TruthIsolationTool.h>

Inheritance diagram for DerivationFramework::TruthIsolationTool:

Collaboration diagram for DerivationFramework::TruthIsolationTool:

Public Member Functions
	TruthIsolationTool (const std::string &t, const std::string &n, const IInterface *p)
	~TruthIsolationTool ()
virtual StatusCode	initialize () override
virtual StatusCode	addBranches () const override

Private Member Functions
void	calcIsos (const xAOD::TruthParticle *particle, const std::vector< const xAOD::TruthParticle * > &, std::vector< float > &) const

Static Private Member Functions
static float	calculateDeltaR2 (const xAOD::IParticle *p1, float eta2, float phi2)

Private Attributes
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_isoParticlesKey {this, "isoParticlesKey", "TruthParticles", "Name of TruthParticle key for input"}
	Parameter: input collection key. More...
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_allParticlesKey {this, "allParticlesKey", "TruthParticles", "Name of Truthparticle key to find in iso cone"}
	Parameter: input collection key for particles used in calculation. More...
SG::WriteDecorHandleKeyArray< xAOD::TruthParticleContainer, float >	m_isoDecorKeys {this, "DoNotSet_isoDecorKeys", {}, "WriteDecorHandleKeyArray - set internally but must be property"}
	Decor handle key array. More...
Gaudi::Property< std::vector< float > >	m_coneSizes {this, "IsolationConeSizes", {0.2}, "Vector of sizes of dR cone in which to include particles"}
	Parameter: Cone size for Isolation. More...
Gaudi::Property< bool >	m_chargedOnly {this, "ChargedParticlesOnly", false, "Only keep charged particles in isolation cone"}
	Parameter: only use charged particles for iso? More...
Gaudi::Property< std::vector< int > >	m_listOfPIDs {this, "particleIDsToCalculate", {11,13,22}, "List of the pdgIDs of particles for which to calculate isolation"}
	Parameter: List of pdgIDs of particles to dress. More...
Gaudi::Property< std::vector< int > >	m_excludeFromCone {this, "excludeIDsFromCone", {}, "List of the pdgIDs of particles to exclude from the cone when calculating isolation"}
	Parameter: List of pdgIDs to exclude from cone calculation. More...
Gaudi::Property< std::string >	m_isoVarNamePrefix {this, "IsolationVarNamePrefix", "", "Prefix of name of the variable to add to output xAOD"}
	Parameter: name of output variable. More...
Gaudi::Property< bool >	m_includeNonInteracting {this, "IncludeNonInteracting", false, "Include non-interacting particles in the isolation definition"}
	Parameter: Include non-interacting particles? More...
Gaudi::Property< bool >	m_variableR {this, "VariableR", false, "Use radius that shrinks with pT in isolation"}
	Parameter: Use variable radius? More...
std::vector< float >	m_coneSizesSort

Detailed Description

Definition at line 21 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

Constructor & Destructor Documentation

TruthIsolationTool()

TruthIsolationTool::TruthIsolationTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 17 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

                              :
  base_class(t,n,p)
{
}

~TruthIsolationTool()

TruthIsolationTool::~TruthIsolationTool

(

)

Definition at line 25 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

                                                           {
}

Member Function Documentation

addBranches()

StatusCode TruthIsolationTool::addBranches ( ) const

overridevirtual

Even if this is with some dummy value

Definition at line 53 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

{
    // Event context 
    const EventContext& ctx = Gaudi::Hive::currentContext(); 
 
    // Retrieve the truth collections
    SG::ReadHandle<xAOD::TruthParticleContainer> isoTruthParticles(m_isoParticlesKey, ctx);
    if (!isoTruthParticles.isValid()) {
      ATH_MSG_ERROR("Couldn't retrieve collection with name " << m_isoParticlesKey);
      return StatusCode::FAILURE;
    }
  
    SG::ReadHandle<xAOD::TruthParticleContainer> allTruthParticles(m_allParticlesKey, ctx);
    if (!allTruthParticles.isValid()) {
      ATH_MSG_ERROR("Couldn't retrieve collection with name " << m_allParticlesKey);
      return StatusCode::FAILURE;
    }
 
    //get struct of helper functions
    DerivationFramework::DecayGraphHelper decayHelper;
 
    // Isolation is applied to selected particles only
    std::vector<const xAOD::TruthParticle*> listOfParticlesForIso;
    decayHelper.constructListOfFinalParticles(isoTruthParticles.ptr(), listOfParticlesForIso, m_listOfPIDs);
 
    // Vectors to store particles which will be dressed
    std::vector<const xAOD::TruthParticle*>  candidateParticlesList;
 
    std::vector<int> emptyList;
    //make a list of all candidate particles that could fall inside the cone of the particle of interest from listOfParticlesForIso
    decayHelper.constructListOfFinalParticles(allTruthParticles.ptr(), candidateParticlesList, emptyList, true, m_chargedOnly);
 
    std::vector<SG::WriteDecorHandle< xAOD::TruthParticleContainer, float > >
      decorator_iso = m_isoDecorKeys.makeHandles (ctx);
 
    //All isolation must filled for all Particles. 
    for ( unsigned int icone = 0; icone < m_coneSizesSort.size(); ++icone ) {
      for (const auto part : *isoTruthParticles) {
        decorator_iso.at(icone)(*part) = -1;
      }
    }
 
    // Standard particle loop over final state particles of interest
    for (const auto& part : listOfParticlesForIso) {
      std::vector<float> isolationsCalcs(m_coneSizesSort.size(), 0.0);
      calcIsos(part, candidateParticlesList, isolationsCalcs);
      for ( unsigned int icone = 0; icone < m_coneSizesSort.size(); ++icone ) {
        decorator_iso.at(icone)(*part) = isolationsCalcs.at(icone);
      }
    }
 
    return StatusCode::SUCCESS;
}

calcIsos()

void TruthIsolationTool::calcIsos ( const xAOD::TruthParticle *  particle, const std::vector< const xAOD::TruthParticle * > &  candidateParticlesList, std::vector< float > &  isoCalcs  ) const

private

Definition at line 108 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

{
    //given a bare TruthParticle particle, calculate the isolation(s) using the
    //particles in candidateParticlesList, filling isoCalcs in order corresponding
    //to the sorted cone sizes
 
    float part_eta = particle->eta();
    float part_phi = particle->phi();
    for (const auto& cand_part : candidateParticlesList) {
      if (find(m_excludeFromCone.begin(), m_excludeFromCone.end(), cand_part->pdgId()) != m_excludeFromCone.end()) {
        //skip if we find a particle in the exclude list
        continue;
      }
      if (!m_includeNonInteracting && !MC::isInteracting(cand_part->pdgId())){
        // Do not include non-interacting particles, and this particle is non-interacting
        continue;
      }
      if (!HepMC::is_same_particle(cand_part,particle)) {
        //iteration over sorted cone sizes
        for ( unsigned int icone = 0; icone < m_coneSizesSort.size(); ++icone ) {
          const float dr2 = calculateDeltaR2(cand_part, part_eta, part_phi);
          const float coneSize = m_coneSizesSort.at(icone);
          if (dr2 < coneSize*coneSize &&
              (!m_variableR || dr2*particle->pt()*particle->pt() < 100000000.)) {
            //sum the transverse momenta
            isoCalcs.at(icone) = isoCalcs.at(icone) + cand_part->pt();
          } else {
            //break out of the loop safely since the cone sizes are sorted descending
            break;
          }
        }
      }
    }
    return;
}

calculateDeltaR2()

float TruthIsolationTool::calculateDeltaR2 ( const xAOD::IParticle *  p1, float  eta2, float  phi2  )

staticprivate

Definition at line 146 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

{
  //calculate dR^2 this way to hopefully do fewer sqrt and TVector3::Pseudorapidity calls
  float phi1 = p1->phi();
  float eta1 = p1->eta();
  float deltaPhi = fabs(phi1-phi2);
  if (deltaPhi>TMath::Pi()) deltaPhi = 2.0*TMath::Pi() - deltaPhi;
  float deltaPhiSq = deltaPhi * deltaPhi;
  float deltaEtaSq = (eta1-eta2)*(eta1-eta2);
  return deltaPhiSq+deltaEtaSq;
}

initialize()

StatusCode TruthIsolationTool::initialize ( )

overridevirtual

Definition at line 29 of file DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx.

{
 
    // Initialise input keys
    ATH_CHECK(m_isoParticlesKey.initialize());
    ATH_CHECK(m_allParticlesKey.initialize());
 
    //sort (descsending) the cone sizes vector to optimize calculation
    m_coneSizesSort = m_coneSizes;
    std::sort(m_coneSizesSort.begin(), m_coneSizesSort.end(), [](float a, float b){return a>b;});
 
    // Decorations depend on the list of cone sizes
    for ( auto csize_itr : m_coneSizesSort ) { 
      std::ostringstream sizess;
      if (m_variableR) sizess << "var";
      sizess << m_isoVarNamePrefix.value() << (int)((csize_itr)*100.);
      m_isoDecorKeys.emplace_back(m_isoParticlesKey.key()+"."+sizess.str());
    }
    ATH_CHECK(m_isoDecorKeys.initialize());
 
    return StatusCode::SUCCESS;
}

Member Data Documentation

m_allParticlesKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthIsolationTool::m_allParticlesKey {this, "allParticlesKey", "TruthParticles", "Name of Truthparticle key to find in iso cone"}

private

Parameter: input collection key for particles used in calculation.

Definition at line 33 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_chargedOnly

Gaudi::Property<bool> DerivationFramework::TruthIsolationTool::m_chargedOnly {this, "ChargedParticlesOnly", false, "Only keep charged particles in isolation cone"}

private

Parameter: only use charged particles for iso?

Definition at line 42 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_coneSizes

Gaudi::Property<std::vector<float> > DerivationFramework::TruthIsolationTool::m_coneSizes {this, "IsolationConeSizes", {0.2}, "Vector of sizes of dR cone in which to include particles"}

private

Parameter: Cone size for Isolation.

Definition at line 39 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_coneSizesSort

std::vector<float> DerivationFramework::TruthIsolationTool::m_coneSizesSort

private

Definition at line 60 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_excludeFromCone

Gaudi::Property<std::vector<int> > DerivationFramework::TruthIsolationTool::m_excludeFromCone {this, "excludeIDsFromCone", {}, "List of the pdgIDs of particles to exclude from the cone when calculating isolation"}

private

Parameter: List of pdgIDs to exclude from cone calculation.

Definition at line 48 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_includeNonInteracting

Gaudi::Property<bool> DerivationFramework::TruthIsolationTool::m_includeNonInteracting {this, "IncludeNonInteracting", false, "Include non-interacting particles in the isolation definition"}

private

Parameter: Include non-interacting particles?

Definition at line 54 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_isoDecorKeys

SG::WriteDecorHandleKeyArray<xAOD::TruthParticleContainer, float> DerivationFramework::TruthIsolationTool::m_isoDecorKeys {this, "DoNotSet_isoDecorKeys", {}, "WriteDecorHandleKeyArray - set internally but must be property"}

private

Decor handle key array.

Definition at line 36 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_isoParticlesKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthIsolationTool::m_isoParticlesKey {this, "isoParticlesKey", "TruthParticles", "Name of TruthParticle key for input"}

private

Parameter: input collection key.

Definition at line 30 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_isoVarNamePrefix

Gaudi::Property<std::string> DerivationFramework::TruthIsolationTool::m_isoVarNamePrefix {this, "IsolationVarNamePrefix", "", "Prefix of name of the variable to add to output xAOD"}

private

Parameter: name of output variable.

Definition at line 51 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_listOfPIDs

Gaudi::Property<std::vector<int> > DerivationFramework::TruthIsolationTool::m_listOfPIDs {this, "particleIDsToCalculate", {11,13,22}, "List of the pdgIDs of particles for which to calculate isolation"}

private

Parameter: List of pdgIDs of particles to dress.

Definition at line 45 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

m_variableR

Gaudi::Property<bool> DerivationFramework::TruthIsolationTool::m_variableR {this, "VariableR", false, "Use radius that shrinks with pT in isolation"}

private

Parameter: Use variable radius?

Definition at line 57 of file DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h.

---

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

• DerivationFramework/DerivationFrameworkMCTruth/DerivationFrameworkMCTruth/TruthIsolationTool.h
• DerivationFramework/DerivationFrameworkMCTruth/src/TruthIsolationTool.cxx