TopGenEvent Class Reference

Base class to hold information for reduced top generator information. More...

#include "AnalysisDataFormats/TopObjects/interface/TopGenEvent.h"

Inheritance diagram for TopGenEvent:

Public Member Functions
const reco::GenParticle *	b () const
	return b quark if available; 0 else More...
const reco::GenParticle *	bBar () const
	return anti-b quark if available; 0 else More...
const reco::GenParticle *	candidate (int id, unsigned int parentId=0) const
	get candidate with given pdg id if available; 0 else More...
const reco::GenParticle *	daughterQuarkBarOfWMinus () const
	return anti-quark daughter of anti-W boson More...
const reco::GenParticle *	daughterQuarkBarOfWPlus () const
	return anti-quark daughter of W boson More...
const reco::GenParticle *	daughterQuarkOfTop (bool invertCharge=false) const
	return daughter quark of top quark (which can have flavor b, s or d) More...
const reco::GenParticle *	daughterQuarkOfTopBar () const
	return daughter quark of anti-top quark (which can have flavor b, s or d) More...
const reco::GenParticle *	daughterQuarkOfWMinus () const
	return quark daughter of anti-W boson More...
const reco::GenParticle *	daughterQuarkOfWPlus (bool invertQuarkCharge=false, bool invertBosonCharge=false) const
	return quark daughter quark of W boson More...
const reco::GenParticle *	eMinus () const
	return electron if available; 0 else More...
const reco::GenParticle *	ePlus () const
	return positron if available; 0 else More...
const reco::GenParticleCollection &	initialPartons () const
	return particles of initial partons More...
std::vector< const reco::GenParticle * >	lightQuarks (bool includingBQuarks=false) const
	return all light quarks or all quarks including b's More...
const reco::GenParticle *	muMinus () const
	return muon if available; 0 else More...
const reco::GenParticle *	muPlus () const
	return anti-muon if available; 0 else More...
int	numberOfBQuarks (bool fromTopQuark=true) const
	return number of b quarks in the decay chain More...
int	numberOfLeptons (bool fromWBoson=true) const
	return number of leptons in the decay chain More...
int	numberOfLeptons (WDecay::LeptonType type, bool fromWBoson=true) const
	return number of leptons in the decay chain More...
const reco::GenParticleCollection &	particles () const
	return particles of decay chain More...
void	print () const
std::vector< const reco::GenParticle * >	radiatedGluons (int pdgId) const
	return radiated gluons from particle with pdgId More...
const reco::GenParticle *	tauMinus () const
	return tau if available; 0 else More...
const reco::GenParticle *	tauPlus () const
	return anti-tau if available; 0 else More...
const reco::GenParticle *	top () const
	return top if available; 0 else More...
const reco::GenParticle *	topBar () const
	return anti-top if available; 0 else More...
	TopGenEvent ()
	empty constructor More...
	TopGenEvent (reco::GenParticleRefProd &decaySubset, reco::GenParticleRefProd &iniSubset)
	default constructor More...
std::vector< const reco::GenParticle * >	topSisters () const
	return number of top anti-top sisters More...
const reco::GenParticle *	wMinus () const
	return W minus if available; 0 else More...
const reco::GenParticle *	wPlus () const
	return W plus if available; 0 else More...
virtual	~TopGenEvent ()
	default destructor More...

Protected Attributes
reco::GenParticleRefProd	initPartons_
	reference to the list of initial partons (has to be kept in the event!) More...
reco::GenParticleRefProd	parts_
	reference to the top decay chain (has to be kept in the event!) More...

Detailed Description

Base class to hold information for reduced top generator information.

The structure holds reference information to the generator particles of the decay chains for each top quark and of the initial partons. It provides access and administration.

Definition at line 40 of file TopGenEvent.h.

Constructor & Destructor Documentation

TopGenEvent() [1/2]

TopGenEvent::TopGenEvent ( )

inline

empty constructor

Definition at line 43 of file TopGenEvent.h.

{};

TopGenEvent() [2/2]

TopGenEvent::TopGenEvent	(	reco::GenParticleRefProd &	decaySubset,
		reco::GenParticleRefProd &	iniSubset
	)

default constructor

default contructor

Definition at line 9 of file TopGenEvent.cc.

References TopDecaySubset_cfi::decaySubset, initPartons_, TopInitSubset_cfi::initSubset, and parts_.

                                                                                                {
  parts_ = decaySubset;
  initPartons_ = initSubset;
}

~TopGenEvent()

virtual TopGenEvent::~TopGenEvent ( )

inlinevirtual

default destructor

Definition at line 47 of file TopGenEvent.h.

{};

Member Function Documentation

b()

const reco::GenParticle* TopGenEvent::b ( ) const

inline

return b quark if available; 0 else

Definition at line 97 of file TopGenEvent.h.

References TopDecayID::bID, candidate(), and TopDecayID::tID.

Referenced by TtDilepEvtSolution::getGenB(), and TtHadEvtSolution::getGenHadb().

{ return candidate(TopDecayID::bID, TopDecayID::tID); }

bBar()

const reco::GenParticle* TopGenEvent::bBar ( ) const

inline

return anti-b quark if available; 0 else

Definition at line 99 of file TopGenEvent.h.

References TopDecayID::bID, candidate(), and TopDecayID::tID.

Referenced by TtDilepEvtSolution::getGenBbar(), and TtHadEvtSolution::getGenHadbbar().

{ return candidate(-TopDecayID::bID, TopDecayID::tID); }

candidate()

const reco::GenParticle * TopGenEvent::candidate	(	int	id,
		unsigned int	parentId = 0
	)		const

get candidate with given pdg id if available; 0 else

Definition at line 14 of file TopGenEvent.cc.

References funct::abs(), mps_fire::i, triggerObjects_cff::id, createfilelist::int, parts_, and EgammaValidation_cff::pdgId.

Referenced by b(), bBar(), eMinus(), ePlus(), muMinus(), muPlus(), tauMinus(), tauPlus(), top(), topBar(), wMinus(), and wPlus().

                                                                                 {
  const reco::GenParticle* cand = nullptr;
  const reco::GenParticleCollection& partsColl = *parts_;
  for (unsigned int i = 0; i < partsColl.size(); ++i) {
    if (partsColl[i].pdgId() == id) {
      if (parentId == 0 ? true : partsColl[i].mother() && std::abs(partsColl[i].mother()->pdgId()) == (int)parentId) {
        cand = &partsColl[i];
      }
    }
  }
  return cand;
}

daughterQuarkBarOfWMinus()

const reco::GenParticle* TopGenEvent::daughterQuarkBarOfWMinus ( ) const

inline

return anti-quark daughter of anti-W boson

Definition at line 76 of file TopGenEvent.h.

References daughterQuarkOfWPlus().

Referenced by TtHadEvtSolution::getGenHadk().

{ return daughterQuarkOfWPlus(true, true); };

daughterQuarkBarOfWPlus()

const reco::GenParticle* TopGenEvent::daughterQuarkBarOfWPlus ( ) const

inline

return anti-quark daughter of W boson

Definition at line 74 of file TopGenEvent.h.

References daughterQuarkOfWPlus().

Referenced by TtHadEvtSolution::getGenHadq().

{ return daughterQuarkOfWPlus(true, false); };

daughterQuarkOfTop()

const reco::GenParticle * TopGenEvent::daughterQuarkOfTop

(

bool

invertCharge = false

)

const

return daughter quark of top quark (which can have flavor b, s or d)

Definition at line 132 of file TopGenEvent.cc.

References funct::abs(), reco::Candidate::begin(), TopDecayID::bID, reco::Candidate::end(), Exception, edm::errors::InvalidReference, parts_, reco::LeafCandidate::pdgId(), TopDecayID::tID, and top().

Referenced by daughterQuarkOfTopBar().

                                                                              {
  const reco::GenParticle* cand = nullptr;
  for (reco::GenParticleCollection::const_iterator top = parts_->begin(); top < parts_->end(); ++top) {
    if (top->pdgId() == (invertCharge ? -TopDecayID::tID : TopDecayID::tID)) {
      for (reco::GenParticle::const_iterator quark = top->begin(); quark < top->end(); ++quark) {
        if (std::abs(quark->pdgId()) <= TopDecayID::bID) {
          cand = dynamic_cast<const reco::GenParticle*>(&(*quark));
          if (cand == nullptr) {
            throw edm::Exception(edm::errors::InvalidReference, "Not a GenParticle");
          }
          break;
        }
      }
    }
  }
  return cand;
}

daughterQuarkOfTopBar()

const reco::GenParticle* TopGenEvent::daughterQuarkOfTopBar ( ) const

inline

return daughter quark of anti-top quark (which can have flavor b, s or d)

Definition at line 68 of file TopGenEvent.h.

References daughterQuarkOfTop().

{ return daughterQuarkOfTop(true); };

daughterQuarkOfWMinus()

const reco::GenParticle* TopGenEvent::daughterQuarkOfWMinus ( ) const

inline

return quark daughter of anti-W boson

Definition at line 72 of file TopGenEvent.h.

References daughterQuarkOfWPlus().

Referenced by TtHadEvtSolution::getGenHadj().

{ return daughterQuarkOfWPlus(false, true); };

daughterQuarkOfWPlus()

const reco::GenParticle * TopGenEvent::daughterQuarkOfWPlus	(	bool	invertQuarkCharge = false,
		bool	invertBosonCharge = false
	)		const

return quark daughter quark of W boson

Definition at line 150 of file TopGenEvent.cc.

References funct::abs(), TopDecayID::bID, reco::flavour(), mps_fire::i, parts_, EgammaValidation_cff::pdgId, and TopDecayID::WID.

Referenced by daughterQuarkBarOfWMinus(), daughterQuarkBarOfWPlus(), daughterQuarkOfWMinus(), and TtHadEvtSolution::getGenHadp().

                                                                                                             {
  const reco::GenParticle* cand = nullptr;
  const reco::GenParticleCollection& partsColl = *parts_;
  for (unsigned int i = 0; i < partsColl.size(); ++i) {
    if (partsColl[i].mother() &&
        partsColl[i].mother()->pdgId() == (invertBosonCharge ? -TopDecayID::WID : TopDecayID::WID) &&
        std::abs(partsColl[i].pdgId()) <= TopDecayID::bID &&
        (invertQuarkCharge ? reco::flavour(partsColl[i]) < 0 : reco::flavour(partsColl[i]) > 0)) {
      cand = &partsColl[i];
    }
  }
  return cand;
}

eMinus()

const reco::GenParticle* TopGenEvent::eMinus ( ) const

inline

return electron if available; 0 else

Definition at line 81 of file TopGenEvent.h.

References candidate(), TopDecayID::elecID, and TopDecayID::WID.

{ return candidate(TopDecayID::elecID, TopDecayID::WID); }

ePlus()

const reco::GenParticle* TopGenEvent::ePlus ( ) const

inline

return positron if available; 0 else

Definition at line 83 of file TopGenEvent.h.

References candidate(), TopDecayID::elecID, and TopDecayID::WID.

{ return candidate(-TopDecayID::elecID, TopDecayID::WID); }

initialPartons()

const reco::GenParticleCollection& TopGenEvent::initialPartons ( ) const

inline

return particles of initial partons

Definition at line 52 of file TopGenEvent.h.

References initPartons_.

{ return *initPartons_; }

lightQuarks()

std::vector< const reco::GenParticle * > TopGenEvent::lightQuarks

(

bool

includingBQuarks = false

)

const

return all light quarks or all quarks including b's

Definition at line 164 of file TopGenEvent.cc.

References funct::abs(), TopDecayID::bID, Exception, edm::errors::InvalidReference, and parts_.

                                                                                      {
  std::vector<const reco::GenParticle*> lightQuarks;
  for (reco::GenParticleCollection::const_iterator part = parts_->begin(); part < parts_->end(); ++part) {
    if ((includingBQuarks && std::abs(part->pdgId()) == TopDecayID::bID) || std::abs(part->pdgId()) < TopDecayID::bID) {
      if (dynamic_cast<const reco::GenParticle*>(&(*part)) == nullptr) {
        throw edm::Exception(edm::errors::InvalidReference, "Not a GenParticle");
      }
      lightQuarks.push_back(part->clone());
    }
  }
  return lightQuarks;
}

muMinus()

const reco::GenParticle* TopGenEvent::muMinus ( ) const

inline

return muon if available; 0 else

Definition at line 85 of file TopGenEvent.h.

References candidate(), TopDecayID::muonID, and TopDecayID::WID.

{ return candidate(TopDecayID::muonID, TopDecayID::WID); }

muPlus()

const reco::GenParticle* TopGenEvent::muPlus ( ) const

inline

return anti-muon if available; 0 else

Definition at line 87 of file TopGenEvent.h.

References candidate(), TopDecayID::muonID, and TopDecayID::WID.

{ return candidate(-TopDecayID::muonID, TopDecayID::WID); }

numberOfBQuarks()

int TopGenEvent::numberOfBQuarks

(

bool

fromTopQuark = true

)

const

return number of b quarks in the decay chain

Definition at line 99 of file TopGenEvent.cc.

References funct::abs(), TopDecayID::bID, mps_fire::i, parts_, EgammaValidation_cff::pdgId, and TopDecayID::tID.

                                                        {
  int bq = 0;
  const reco::GenParticleCollection& partsColl = *parts_;
  for (unsigned int i = 0; i < partsColl.size(); ++i) {
    //depend if radiation qqbar are included or not
    if (std::abs(partsColl[i].pdgId()) == TopDecayID::bID) {
      if (fromTopQuark) {
        if (partsColl[i].mother() && std::abs(partsColl[i].mother()->pdgId()) == TopDecayID::tID) {
          ++bq;
        }
      } else {
        ++bq;
      }
    }
  }
  return bq;
}

numberOfLeptons() [1/2]

int TopGenEvent::numberOfLeptons

(

bool

fromWBoson = true

)

const

return number of leptons in the decay chain

Definition at line 41 of file TopGenEvent.cc.

References funct::abs(), mps_fire::i, reco::isLepton(), parts_, EgammaValidation_cff::pdgId, and TopDecayID::WID.

Referenced by TtGenEvent::isNumberOfLeptons().

                                                      {
  int lep = 0;
  const reco::GenParticleCollection& partsColl = *parts_;
  for (unsigned int i = 0; i < partsColl.size(); ++i) {
    if (reco::isLepton(partsColl[i])) {
      if (fromWBoson) {
        if (partsColl[i].mother() && std::abs(partsColl[i].mother()->pdgId()) == TopDecayID::WID) {
          ++lep;
        }
      } else {
        ++lep;
      }
    }
  }
  return lep;
}

numberOfLeptons() [2/2]

int TopGenEvent::numberOfLeptons	(	WDecay::LeptonType	type,
		bool	fromWBoson = true
	)		const

return number of leptons in the decay chain

Definition at line 58 of file TopGenEvent.cc.

References funct::abs(), TopDecayID::elecID, mps_fire::i, reco::isLepton(), WDecay::kElec, WDecay::kMuon, WDecay::kNone, WDecay::kTau, objects.autophobj::leptonType, TopDecayID::muonID, parts_, EgammaValidation_cff::pdgId, TopDecayID::tauID, and TopDecayID::WID.

                                                                                        {
  int leptonType = -1;
  switch (typeRestriction) {
      // resolve whether or not there is
      // any restriction in lepton types
    case WDecay::kElec:
      leptonType = TopDecayID::elecID;
      break;
    case WDecay::kMuon:
      leptonType = TopDecayID::muonID;
      break;
    case WDecay::kTau:
      leptonType = TopDecayID::tauID;
      break;
    case WDecay::kNone:
      break;
  }
  int lep = 0;
  const reco::GenParticleCollection& partsColl = *parts_;
  for (unsigned int i = 0; i < partsColl.size(); ++i) {
    if (fromWBoson) {
      // restrict to particles originating from the W boson
      if (!(partsColl[i].mother() && std::abs(partsColl[i].mother()->pdgId()) == TopDecayID::WID)) {
        continue;
      }
    }
    if (leptonType > 0) {
      // in case of lepton type restriction
      if (std::abs(partsColl[i].pdgId()) == leptonType) {
        ++lep;
      }
    } else {
      // take any lepton type into account else
      if (reco::isLepton(partsColl[i])) {
        ++lep;
      }
    }
  }
  return lep;
}

particles()

const reco::GenParticleCollection& TopGenEvent::particles ( ) const

inline

return particles of decay chain

Definition at line 50 of file TopGenEvent.h.

References parts_.

{ return *parts_; }

print()

void TopGenEvent::print

(

void

)

const

print content of the top decay chain as formated LogInfo to the MessageLogger output for debugging

Definition at line 27 of file TopGenEvent.cc.

References dqm-mbProfile::log, and parts_.

                              {
  edm::LogVerbatim log("TopGenEvent");
  log << "\n"
      << "--------------------------------------\n"
      << "- Dump TopGenEvent Content           -\n"
      << "--------------------------------------\n";
  for (reco::GenParticleCollection::const_iterator part = parts_->begin(); part < parts_->end(); ++part) {
    log << "pdgId:" << std::setw(5) << part->pdgId() << ", "
        << "mass:" << std::setw(11) << part->p4().mass() << ", "
        << "energy:" << std::setw(11) << part->energy() << ", "
        << "pt:" << std::setw(11) << part->pt() << "\n";
  }
}

radiatedGluons()

std::vector< const reco::GenParticle * > TopGenEvent::radiatedGluons

(

int

pdgId

)

const

return radiated gluons from particle with pdgId

Definition at line 177 of file TopGenEvent.cc.

References Exception, TopDecayID::glueID, edm::errors::InvalidReference, parts_, and EgammaValidation_cff::pdgId.

Referenced by TtGenEvent::hadronicDecayTopRadiation(), and TtGenEvent::leptonicDecayTopRadiation().

                                                                             {
  std::vector<const reco::GenParticle*> rads;
  for (reco::GenParticleCollection::const_iterator part = parts_->begin(); part < parts_->end(); ++part) {
    if (part->mother() && part->mother()->pdgId() == pdgId) {
      if (part->pdgId() == TopDecayID::glueID) {
        if (dynamic_cast<const reco::GenParticle*>(&(*part)) == nullptr) {
          throw edm::Exception(edm::errors::InvalidReference, "Not a GenParticle");
        }
      }
      rads.push_back(part->clone());
    }
  }
  return rads;
}

tauMinus()

const reco::GenParticle* TopGenEvent::tauMinus ( ) const

inline

return tau if available; 0 else

Definition at line 89 of file TopGenEvent.h.

References candidate(), TopDecayID::tauID, and TopDecayID::WID.

{ return candidate(TopDecayID::tauID, TopDecayID::WID); }

tauPlus()

const reco::GenParticle* TopGenEvent::tauPlus ( ) const

inline

return anti-tau if available; 0 else

Definition at line 91 of file TopGenEvent.h.

References candidate(), TopDecayID::tauID, and TopDecayID::WID.

{ return candidate(-TopDecayID::tauID, TopDecayID::WID); }

top()

const reco::GenParticle* TopGenEvent::top ( ) const

inline

return top if available; 0 else

Definition at line 101 of file TopGenEvent.h.

References candidate(), and TopDecayID::tID.

Referenced by daughterQuarkOfTop(), TtDilepEvtSolution::getGenT(), TtGenEvent::isTtBar(), and TtGenEvent::TtGenEvent().

{ return candidate(TopDecayID::tID); }

topBar()

const reco::GenParticle* TopGenEvent::topBar ( ) const

inline

return anti-top if available; 0 else

Definition at line 103 of file TopGenEvent.h.

References candidate(), and TopDecayID::tID.

Referenced by TtDilepEvtSolution::getGenTbar(), TtGenEvent::isTtBar(), and TtGenEvent::TtGenEvent().

{ return candidate(-TopDecayID::tID); }

topSisters()

std::vector< const reco::GenParticle * > TopGenEvent::topSisters

(

)

const

return number of top anti-top sisters

Definition at line 117 of file TopGenEvent.cc.

References funct::abs(), Exception, edm::errors::InvalidReference, parts_, and TopDecayID::tID.

                                                                {
  std::vector<const reco::GenParticle*> sisters;
  for (reco::GenParticleCollection::const_iterator part = parts_->begin(); part < parts_->end(); ++part) {
    if (part->numberOfMothers() == 0 && std::abs(part->pdgId()) != TopDecayID::tID) {
      // choose top sister which do not have a
      // mother and are whether top nor anti-top
      if (dynamic_cast<const reco::GenParticle*>(&(*part)) == nullptr) {
        throw edm::Exception(edm::errors::InvalidReference, "Not a GenParticle");
      }
      sisters.push_back(part->clone());
    }
  }
  return sisters;
}

wMinus()

const reco::GenParticle* TopGenEvent::wMinus ( ) const

inline

return W minus if available; 0 else

Definition at line 93 of file TopGenEvent.h.

References candidate(), TopDecayID::tID, and TopDecayID::WID.

Referenced by TtDilepEvtSolution::getGenWm().

{ return candidate(-TopDecayID::WID, TopDecayID::tID); }

wPlus()

const reco::GenParticle* TopGenEvent::wPlus ( ) const

inline

return W plus if available; 0 else

Definition at line 95 of file TopGenEvent.h.

References candidate(), TopDecayID::tID, and TopDecayID::WID.

Referenced by TtDilepEvtSolution::getGenWp().

{ return candidate(TopDecayID::WID, TopDecayID::tID); }

Member Data Documentation

initPartons_

reco::GenParticleRefProd TopGenEvent::initPartons_

protected

reference to the list of initial partons (has to be kept in the event!)

Definition at line 113 of file TopGenEvent.h.

Referenced by TtGenEvent::fromGluonFusion(), TtGenEvent::fromQuarkAnnihilation(), initialPartons(), StGenEvent::StGenEvent(), TopGenEvent(), and TtGenEvent::TtGenEvent().

parts_

reco::GenParticleRefProd TopGenEvent::parts_

protected

reference to the top decay chain (has to be kept in the event!)

Definition at line 111 of file TopGenEvent.h.

Referenced by StGenEvent::associatedB(), candidate(), daughterQuarkOfTop(), daughterQuarkOfWPlus(), StGenEvent::decayB(), TtGenEvent::hadronicDecayB(), TtGenEvent::hadronicDecayQuark(), TtGenEvent::hadronicDecayTop(), TtGenEvent::hadronicDecayW(), TtGenEvent::lepton(), TtGenEvent::leptonBar(), TtGenEvent::leptonicDecayB(), TtGenEvent::leptonicDecayTop(), TtGenEvent::leptonicDecayW(), lightQuarks(), TtGenEvent::neutrino(), TtGenEvent::neutrinoBar(), numberOfBQuarks(), numberOfLeptons(), particles(), print(), radiatedGluons(), StGenEvent::singleLepton(), TtGenEvent::singleLepton(), StGenEvent::singleNeutrino(), TtGenEvent::singleNeutrino(), StGenEvent::singleTop(), StGenEvent::singleW(), StGenEvent::StGenEvent(), TopGenEvent(), topSisters(), and TtGenEvent::TtGenEvent().