MCTruthHelper< P > Class Template Reference

#include <MCTruthHelper.h>

Public Member Functions
int	absPdgId (const reco::GenParticle &p) const
int	absPdgId (const HepMC::GenParticle &p) const
const reco::GenParticle *	daughter (const reco::GenParticle &p, unsigned int idau) const
const HepMC::GenParticle *	daughter (const HepMC::GenParticle &p, unsigned int idau) const
void	fillGenStatusFlags (const P &p, reco::GenStatusFlags &statusFlags) const
const P *	findDecayedMother (const P &p) const
const P *	findDecayedMother (const P &p, int abspdgid) const
const P *	firstCopy (const P &p) const
bool	fromHardProcess (const P &p) const
bool	fromHardProcessBeforeFSR (const P &p) const
bool	fromHardProcessDecayed (const P &p) const
bool	fromHardProcessFinalState (const P &p) const
const P *	hardProcessMotherCopy (const P &p) const
bool	isDecayedLeptonHadron (const P &p) const
bool	isDirectHadronDecayProduct (const P &p) const
bool	isDirectHardProcessTauDecayProduct (const P &p) const
bool	isDirectPromptTauDecayProduct (const P &p) const
bool	isDirectTauDecayProduct (const P &p) const
bool	isFirstCopy (const P &p) const
bool	isHadron (const P &p) const
bool	isHardProcess (const P &p) const
bool	isHardProcessTauDecayProduct (const P &p) const
bool	isLastCopy (const P &p) const
bool	isLastCopyBeforeFSR (const P &p) const
bool	isMuonDecayProduct (const P &p) const
bool	isPrompt (const P &p) const
bool	isPromptDecayed (const P &p) const
bool	isPromptFinalState (const P &p) const
bool	isPromptMuonDecayProduct (const P &p) const
bool	isPromptTauDecayProduct (const P &p) const
bool	isTauDecayProduct (const P &p) const
const P *	lastCopy (const P &p) const
const P *	lastCopyBeforeFSR (const P &p) const
const P *	lastDaughterCopyBeforeFSR (const P &p) const
const reco::GenParticle *	mother (const reco::GenParticle &p, unsigned int imoth=0) const
const HepMC::GenParticle *	mother (const HepMC::GenParticle &p, unsigned int imoth=0) const
const P *	nextCopy (const P &p) const
unsigned int	numberOfDaughters (const reco::GenParticle &p) const
unsigned int	numberOfDaughters (const HepMC::GenParticle &p) const
unsigned int	numberOfMothers (const reco::GenParticle &p) const
unsigned int	numberOfMothers (const HepMC::GenParticle &p) const
int	pdgId (const reco::GenParticle &p) const
int	pdgId (const HepMC::GenParticle &p) const
const P *	previousCopy (const P &p) const
const P *	uniqueMother (const P &p) const

Detailed Description

template<typename P>
class MCTruthHelper< P >

Definition at line 13 of file MCTruthHelper.h.

Member Function Documentation

absPdgId() [1/2]

template<typename P >

int MCTruthHelper< P >::absPdgId

(

const reco::GenParticle &

p

)

const

Definition at line 581 of file MCTruthHelper.h.

                                                             {
  return std::abs(p.pdgId());
}

absPdgId() [2/2]

template<typename P >

int MCTruthHelper< P >::absPdgId

(

const HepMC::GenParticle &

p

)

const

Definition at line 587 of file MCTruthHelper.h.

                                                              {
  return std::abs(p.pdg_id());
}

daughter() [1/2]

template<typename P >

const reco::GenParticle * MCTruthHelper< P >::daughter	(	const reco::GenParticle &	p,
		unsigned int	idau
	)		const

Definition at line 631 of file MCTruthHelper.h.

                                                                                                   {
  return static_cast<const reco::GenParticle *>(p.daughter(idau));
}

daughter() [2/2]

template<typename P >

const HepMC::GenParticle * MCTruthHelper< P >::daughter	(	const HepMC::GenParticle &	p,
		unsigned int	idau
	)		const

Definition at line 637 of file MCTruthHelper.h.

                                                                                                     {
  return *(p.end_vertex()->particles_out_const_begin() + idau);
}

fillGenStatusFlags()

template<typename P >

void MCTruthHelper< P >::fillGenStatusFlags	(	const P &	p,
		reco::GenStatusFlags &	statusFlags
	)		const

Definition at line 643 of file MCTruthHelper.h.

Referenced by GenParticleProducer::convertParticle().

                                                                                           {
  statusFlags.setIsPrompt(isPrompt(p));
  statusFlags.setIsDecayedLeptonHadron(isDecayedLeptonHadron(p));
  statusFlags.setIsTauDecayProduct(isTauDecayProduct(p));
  statusFlags.setIsPromptTauDecayProduct(isPromptTauDecayProduct(p));
  statusFlags.setIsDirectTauDecayProduct(isDirectTauDecayProduct(p));
  statusFlags.setIsDirectPromptTauDecayProduct(isDirectPromptTauDecayProduct(p));
  statusFlags.setIsDirectHadronDecayProduct(isDirectHadronDecayProduct(p));
  statusFlags.setIsHardProcess(isHardProcess(p));
  statusFlags.setFromHardProcess(fromHardProcess(p));
  statusFlags.setIsHardProcessTauDecayProduct(isHardProcessTauDecayProduct(p));
  statusFlags.setIsDirectHardProcessTauDecayProduct(isDirectHardProcessTauDecayProduct(p));
  statusFlags.setFromHardProcessBeforeFSR(fromHardProcessBeforeFSR(p));
  statusFlags.setIsFirstCopy(isFirstCopy(p));
  statusFlags.setIsLastCopy(isLastCopy(p));
  statusFlags.setIsLastCopyBeforeFSR(isLastCopyBeforeFSR(p));
}

findDecayedMother() [1/2]

template<typename P >

const P * MCTruthHelper< P >::findDecayedMother

(

const P &

p

)

const

Definition at line 541 of file MCTruthHelper.h.

                                                             {
  const P *mo = mother(p);
  std::unordered_set<const P *> dupCheck;
  while (mo && !isDecayedLeptonHadron(*mo)) {
    dupCheck.insert(mo);
    mo = mother(*mo);
    if (dupCheck.count(mo))
      return nullptr;
  }
  return mo;
}

findDecayedMother() [2/2]

template<typename P >

const P * MCTruthHelper< P >::findDecayedMother	(	const P &	p,
		int	abspdgid
	)		const

Definition at line 555 of file MCTruthHelper.h.

                                                                           {
  const P *mo = mother(p);
  std::unordered_set<const P *> dupCheck;
  while (mo && (absPdgId(*mo) != abspdgid || !isDecayedLeptonHadron(*mo))) {
    dupCheck.insert(mo);
    mo = mother(*mo);
    if (dupCheck.count(mo))
      return nullptr;
  }
  return mo;
}

firstCopy()

template<typename P >

const P * MCTruthHelper< P >::firstCopy

(

const P &

p

)

const

Definition at line 394 of file MCTruthHelper.h.

                                                     {
  const P *pcopy = &p;
  std::unordered_set<const P *> dupCheck;
  while (previousCopy(*pcopy)) {
    dupCheck.insert(pcopy);
    pcopy = previousCopy(*pcopy);
    if (dupCheck.count(pcopy))
      return nullptr;
  }
  return pcopy;
}

fromHardProcess()

template<typename P >

bool MCTruthHelper< P >::fromHardProcess

(

const P &

p

)

const

Definition at line 299 of file MCTruthHelper.h.

                                                       {
  return hardProcessMotherCopy(p) != nullptr;
}

fromHardProcessBeforeFSR()

template<typename P >

bool MCTruthHelper< P >::fromHardProcessBeforeFSR

(

const P &

p

)

const

Definition at line 331 of file MCTruthHelper.h.

                                                                {
  //pythia 6 documentation line roughly corresponds to this condition
  if (p.status() == 3)
    return true;

  //check hard process mother properties
  const P *hpc = hardProcessMotherCopy(p);
  if (!hpc)
    return false;

  //for incoming partons in pythia8, more useful information is not
  //easily available, so take only the incoming parton itself
  if (hpc->status() == 21 && (&p) == hpc)
    return true;

  //for intermediate particles in pythia 8, just take the last copy
  if (hpc->status() == 22 && isLastCopy(p))
    return true;

  //for outgoing particles in pythia 8, explicitly find the last copy
  //before FSR starting from the hardProcess particle, and take only
  //this one
  if ((hpc->status() == 23 || hpc->status() == 1) && (&p) == lastDaughterCopyBeforeFSR(*hpc))
    return true;

  //didn't satisfy any of the conditions
  return false;
}

fromHardProcessDecayed()

template<typename P >

bool MCTruthHelper< P >::fromHardProcessDecayed

(

const P &

p

)

const

Definition at line 311 of file MCTruthHelper.h.

                                                              {
  return isDecayedLeptonHadron(p) && fromHardProcess(p);
}

fromHardProcessFinalState()

template<typename P >

bool MCTruthHelper< P >::fromHardProcessFinalState

(

const P &

p

)

const

Definition at line 305 of file MCTruthHelper.h.

                                                                 {
  return p.status() == 1 && fromHardProcess(p);
}

hardProcessMotherCopy()

template<typename P >

const P * MCTruthHelper< P >::hardProcessMotherCopy

(

const P &

p

)

const

Definition at line 492 of file MCTruthHelper.h.

                                                                 {
  //is particle itself is hard process particle
  if (isHardProcess(p))
    return &p;

  //check if any other copies are hard process particles
  const P *pcopy = &p;
  std::unordered_set<const P *> dupCheck;
  while (previousCopy(*pcopy)) {
    dupCheck.insert(pcopy);
    pcopy = previousCopy(*pcopy);
    if (isHardProcess(*pcopy))
      return pcopy;
    if (dupCheck.count(pcopy))
      break;
  }
  return nullptr;
}

isDecayedLeptonHadron()

template<typename P >

bool MCTruthHelper< P >::isDecayedLeptonHadron

(

const P &

p

)

const

Definition at line 200 of file MCTruthHelper.h.

                                                             {
  return p.status() == 2 && (isHadron(p) || absPdgId(p) == 13 || absPdgId(p) == 15) && isLastCopy(p);
}

isDirectHadronDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isDirectHadronDecayProduct

(

const P &

p

)

const

Definition at line 253 of file MCTruthHelper.h.

                                                                  {
  const P *um = uniqueMother(p);
  return um && isHadron(*um) && isDecayedLeptonHadron(*um);
}

isDirectHardProcessTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isDirectHardProcessTauDecayProduct

(

const P &

p

)

const

Definition at line 324 of file MCTruthHelper.h.

                                                                          {
  const P *tau = findDecayedMother(p, 15);
  const P *dm = findDecayedMother(p);
  return tau && tau == dm && fromHardProcess(*tau);
}

isDirectPromptTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isDirectPromptTauDecayProduct

(

const P &

p

)

const

Definition at line 232 of file MCTruthHelper.h.

                                                                     {
  const P *tau = findDecayedMother(p, 15);
  const P *dm = findDecayedMother(p);
  return tau && tau == dm && isPrompt(*tau);
}

isDirectTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isDirectTauDecayProduct

(

const P &

p

)

const

Definition at line 224 of file MCTruthHelper.h.

                                                               {
  const P *tau = findDecayedMother(p, 15);
  const P *dm = findDecayedMother(p);
  return tau && tau == dm;
}

isFirstCopy()

template<typename P >

bool MCTruthHelper< P >::isFirstCopy

(

const P &

p

)

const

Definition at line 362 of file MCTruthHelper.h.

                                                   {
  return &p == firstCopy(p);
}

isHadron()

template<typename P >

bool MCTruthHelper< P >::isHadron

(

const P &

p

)

const

Definition at line 260 of file MCTruthHelper.h.

                                                {
  HepPDT::ParticleID heppdtid(pdgId(p));
  return heppdtid.isHadron();
}

isHardProcess()

template<typename P >

bool MCTruthHelper< P >::isHardProcess

(

const P &

p

)

const

Definition at line 267 of file MCTruthHelper.h.

                                                     {
  //status 3 in pythia6 means hard process;
  if (p.status() == 3)
    return true;

  //hard process codes for pythia8 are 21-29 inclusive (currently 21,22,23,24 are used)
  if (p.status() > 20 && p.status() < 30)
    return true;

  //if this is a final state or decayed particle,
  //check if direct mother is a resonance decay in pythia8 but exclude FSR branchings
  //(In pythia8 if a resonance decay product did not undergo any further branchings
  //it will be directly stored as status 1 or 2 without any status 23 copy)
  if (p.status() == 1 || p.status() == 2) {
    const P *um = mother(p);
    if (um) {
      const P *firstcopy = firstCopy(*um);
      bool fromResonance = firstcopy && firstcopy->status() == 22;

      const P *umNext = nextCopy(*um);
      bool fsrBranching = umNext && umNext->status() > 50 && umNext->status() < 60;

      if (fromResonance && !fsrBranching)
        return true;
    }
  }

  return false;
}

isHardProcessTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isHardProcessTauDecayProduct

(

const P &

p

)

const

Definition at line 317 of file MCTruthHelper.h.

                                                                    {
  const P *tau = findDecayedMother(p, 15);
  return tau && fromHardProcessDecayed(*tau);
}

isLastCopy()

template<typename P >

bool MCTruthHelper< P >::isLastCopy

(

const P &

p

)

const

Definition at line 368 of file MCTruthHelper.h.

                                                  {
  return &p == lastCopy(p);
}

isLastCopyBeforeFSR()

template<typename P >

bool MCTruthHelper< P >::isLastCopyBeforeFSR

(

const P &

p

)

const

Definition at line 374 of file MCTruthHelper.h.

                                                           {
  return &p == lastCopyBeforeFSR(p);
}

isMuonDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isMuonDecayProduct

(

const P &

p

)

const

Definition at line 240 of file MCTruthHelper.h.

                                                          {
  return findDecayedMother(p, 13) != 0;
}

isPrompt()

template<typename P >

bool MCTruthHelper< P >::isPrompt

(

const P &

p

)

const

Definition at line 186 of file MCTruthHelper.h.

                                                {
  //particle from hadron/muon/tau decay -> not prompt
  //checking all the way up the chain treats properly the radiated photon
  //case as well
  return findDecayedMother(p) == nullptr;
}

isPromptDecayed()

template<typename P >

bool MCTruthHelper< P >::isPromptDecayed

(

const P &

p

)

const

Definition at line 205 of file MCTruthHelper.h.

                                                       {
  return isDecayedLeptonHadron(p) && isPrompt(p);
}

isPromptFinalState()

template<typename P >

bool MCTruthHelper< P >::isPromptFinalState

(

const P &

p

)

const

Definition at line 195 of file MCTruthHelper.h.

                                                          {
  return p.status() == 1 && isPrompt(p);
}

isPromptMuonDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isPromptMuonDecayProduct

(

const P &

p

)

const

Definition at line 246 of file MCTruthHelper.h.

                                                                {
  const P *mu = findDecayedMother(p, 13);
  return mu && isPrompt(*mu);
}

isPromptTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isPromptTauDecayProduct

(

const P &

p

)

const

Definition at line 217 of file MCTruthHelper.h.

                                                               {
  const P *tau = findDecayedMother(p, 15);
  return tau && isPrompt(*tau);
}

isTauDecayProduct()

template<typename P >

bool MCTruthHelper< P >::isTauDecayProduct

(

const P &

p

)

const

Definition at line 211 of file MCTruthHelper.h.

                                                         {
  return findDecayedMother(p, 15) != nullptr;
}

lastCopy()

template<typename P >

const P * MCTruthHelper< P >::lastCopy

(

const P &

p

)

const

Definition at line 408 of file MCTruthHelper.h.

                                                    {
  const P *pcopy = &p;
  std::unordered_set<const P *> dupCheck;
  while (nextCopy(*pcopy)) {
    dupCheck.insert(pcopy);
    pcopy = nextCopy(*pcopy);
    if (dupCheck.count(pcopy))
      return nullptr;
  }
  return pcopy;
}

lastCopyBeforeFSR()

template<typename P >

const P * MCTruthHelper< P >::lastCopyBeforeFSR

(

const P &

p

)

const

Definition at line 422 of file MCTruthHelper.h.

                                                             {
  //start with first copy and then walk down until there is FSR
  const P *pcopy = firstCopy(p);
  if (!pcopy)
    return nullptr;
  bool hasDaughterCopy = true;
  std::unordered_set<const P *> dupCheck;
  while (hasDaughterCopy) {
    dupCheck.insert(pcopy);
    hasDaughterCopy = false;
    const unsigned int ndau = numberOfDaughters(*pcopy);
    //look for FSR
    for (unsigned int idau = 0; idau < ndau; ++idau) {
      const P *dau = daughter(*pcopy, idau);
      if (pdgId(*dau) == 21 || pdgId(*dau) == 22) {
        //has fsr (or else decayed and is the last copy by construction)
        return pcopy;
      }
    }
    //look for daughter copy
    for (unsigned int idau = 0; idau < ndau; ++idau) {
      const P *dau = daughter(*pcopy, idau);
      if (pdgId(*dau) == pdgId(p)) {
        pcopy = dau;
        hasDaughterCopy = true;
        break;
      }
    }
    if (dupCheck.count(pcopy))
      return nullptr;
  }
  return pcopy;
}

lastDaughterCopyBeforeFSR()

template<typename P >

const P * MCTruthHelper< P >::lastDaughterCopyBeforeFSR

(

const P &

p

)

const

Definition at line 458 of file MCTruthHelper.h.

                                                                     {
  //start with this particle and then walk down until there is FSR
  const P *pcopy = &p;
  bool hasDaughterCopy = true;
  std::unordered_set<const P *> dupCheck;
  while (hasDaughterCopy) {
    dupCheck.insert(pcopy);
    hasDaughterCopy = false;
    const unsigned int ndau = numberOfDaughters(*pcopy);
    //look for FSR
    for (unsigned int idau = 0; idau < ndau; ++idau) {
      const P *dau = daughter(*pcopy, idau);
      if (pdgId(*dau) == 21 || pdgId(*dau) == 22) {
        //has fsr (or else decayed and is the last copy by construction)
        return pcopy;
      }
    }
    //look for daughter copy
    for (unsigned int idau = 0; idau < ndau; ++idau) {
      const P *dau = daughter(*pcopy, idau);
      if (pdgId(*dau) == pdgId(p)) {
        pcopy = dau;
        hasDaughterCopy = true;
        break;
      }
    }
    if (dupCheck.count(pcopy))
      return nullptr;
  }
  return pcopy;
}

mother() [1/2]

template<typename P >

const reco::GenParticle * MCTruthHelper< P >::mother	(	const reco::GenParticle &	p,
		unsigned int	imoth = 0
	)		const

Definition at line 605 of file MCTruthHelper.h.

                                                                                                  {
  return static_cast<const reco::GenParticle *>(p.mother(imoth));
}

mother() [2/2]

template<typename P >

const HepMC::GenParticle * MCTruthHelper< P >::mother	(	const HepMC::GenParticle &	p,
		unsigned int	imoth = 0
	)		const

Definition at line 611 of file MCTruthHelper.h.

                                                                                                    {
  return p.production_vertex() && p.production_vertex()->particles_in_size()
             ? *(p.production_vertex()->particles_in_const_begin() + imoth)
             : nullptr;
}

nextCopy()

template<typename P >

const P * MCTruthHelper< P >::nextCopy

(

const P &

p

)

const

Definition at line 527 of file MCTruthHelper.h.

                                                    {
  const unsigned int ndau = numberOfDaughters(p);
  for (unsigned int idau = 0; idau < ndau; ++idau) {
    const P *dau = daughter(p, idau);
    if (pdgId(*dau) == pdgId(p)) {
      return dau;
    }
  }

  return nullptr;
}

numberOfDaughters() [1/2]

template<typename P >

unsigned int MCTruthHelper< P >::numberOfDaughters

(

const reco::GenParticle &

p

)

const

Definition at line 619 of file MCTruthHelper.h.

                                                                               {
  return p.numberOfDaughters();
}

numberOfDaughters() [2/2]

template<typename P >

unsigned int MCTruthHelper< P >::numberOfDaughters

(

const HepMC::GenParticle &

p

)

const

Definition at line 625 of file MCTruthHelper.h.

                                                                                {
  return p.end_vertex() ? p.end_vertex()->particles_out_size() : 0;
}

numberOfMothers() [1/2]

template<typename P >

unsigned int MCTruthHelper< P >::numberOfMothers

(

const reco::GenParticle &

p

)

const

Definition at line 593 of file MCTruthHelper.h.

                                                                             {
  return p.numberOfMothers();
}

numberOfMothers() [2/2]

template<typename P >

unsigned int MCTruthHelper< P >::numberOfMothers

(

const HepMC::GenParticle &

p

)

const

Definition at line 599 of file MCTruthHelper.h.

                                                                              {
  return p.production_vertex() ? p.production_vertex()->particles_in_size() : 0;
}

pdgId() [1/2]

template<typename P >

int MCTruthHelper< P >::pdgId

(

const reco::GenParticle &

p

)

const

Definition at line 569 of file MCTruthHelper.h.

Referenced by Particle.Particle::__str__().

                                                          {
  return p.pdgId();
}

pdgId() [2/2]

template<typename P >

int MCTruthHelper< P >::pdgId

(

const HepMC::GenParticle &

p

)

const

Definition at line 575 of file MCTruthHelper.h.

Referenced by Particle.Particle::__str__().

                                                           {
  return p.pdg_id();
}

previousCopy()

template<typename P >

const P * MCTruthHelper< P >::previousCopy

(

const P &

p

)

const

Definition at line 513 of file MCTruthHelper.h.

                                                        {
  const unsigned int nmoth = numberOfMothers(p);
  for (unsigned int imoth = 0; imoth < nmoth; ++imoth) {
    const P *moth = mother(p, imoth);
    if (pdgId(*moth) == pdgId(p)) {
      return moth;
    }
  }

  return nullptr;
}

uniqueMother()

template<typename P >

const P * MCTruthHelper< P >::uniqueMother

(

const P &

p

)

const

Definition at line 380 of file MCTruthHelper.h.

                                                        {
  const P *mo = &p;
  std::unordered_set<const P *> dupCheck;
  while (mo && pdgId(*mo) == pdgId(p)) {
    dupCheck.insert(mo);
    mo = mother(*mo);
    if (dupCheck.count(mo))
      return nullptr;
  }
  return mo;
}