reco::GenParticle Class Reference

#include <GenParticle.h>

Inheritance diagram for reco::GenParticle:

Public Member Functions
GenParticle *	clone () const override
	return a clone More...
int	collisionId () const
bool	fromHardProcessBeforeFSR () const
bool	fromHardProcessDecayed () const
bool	fromHardProcessFinalState () const
	GenParticle ()
	default constructor More...
	GenParticle (Charge q, const LorentzVector &p4, const Point &vtx, int pdgId, int status, bool integerCharge)
	constrocturo from values More...
	GenParticle (Charge q, const PolarLorentzVector &p4, const Point &vtx, int pdgId, int status, bool integerCharge)
	constrocturo from values More...
	GenParticle (const LeafCandidate &c)
	default constructor More...
bool	isDirectHardProcessTauDecayProductFinalState () const
bool	isDirectPromptTauDecayProductFinalState () const
bool	isHardProcess () const
bool	isLastCopy () const
bool	isLastCopyBeforeFSR () const
bool	isMostlyLikePythia6Status3 ()
bool	isPromptDecayed () const
bool	isPromptFinalState () const
void	setCollisionId (int s)
GenStatusFlags &	statusFlags ()
const GenStatusFlags &	statusFlags () const
	~GenParticle () override
	destructor More...
Public Member Functions inherited from reco::CompositeRefCandidateT< GenParticleRefVector >
void	addDaughter (const typename daughters::value_type &)
	add a daughter via a reference More...
void	addMother (const typename mothers::value_type &)
	add a daughter via a reference More...
void	clearDaughters ()
	clear daughter references More...
void	clearMothers ()
	clear mother references More...
CompositeRefCandidateT< GenParticleRefVector > *	clone () const override
	returns a clone of the candidate More...
	CompositeRefCandidateT ()
	default constructor More...
	CompositeRefCandidateT (Charge q, const LorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	CompositeRefCandidateT (Charge q, const PolarLorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	CompositeRefCandidateT (const LeafCandidate &c)
	constructor from a particle More...
const Candidate *	daughter (size_type) const override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
Candidate *	daughter (size_type) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
daughters::value_type	daughterRef (size_type i) const
	reference to daughter at given position More...
const daughters &	daughterRefVector () const
	references to daughtes More...
const Candidate *	mother (size_type=0) const override
	return mother at a given position, i = 0, ... numberOfMothers() - 1 (read only mode) More...
daughters::value_type	motherRef (size_type i=0) const
	reference to mother at given position More...
const mothers &	motherRefVector () const
	references to mothers More...
size_t	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers More...
void	resetDaughters (const edm::ProductID &id)
	set daughters product ID More...
void	resetMothers (const edm::ProductID &id)
	set mother product ID More...
	~CompositeRefCandidateT () override
	destructor More...
Public Member Functions inherited from reco::LeafCandidate
Vector	boostToCM () const final
int	charge () const final
	electric charge More...
void	construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
const Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
double	energy () const final
	energy More...
double	et () const final
	transverse energy More...
double	et2 () const final
	transverse energy squared (use this for cut!) More...
double	eta () const final
	momentum pseudorapidity More...
void	fillVertexCovariance (CovarianceMatrix &v) const override
	fill SMatrix More...
template<typename T >
T	get () const
	get a component More...
template<typename T , typename Tag >
T	get () const
	get a component More...
template<typename T >
T	get (size_type i) const
	get a component More...
template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...
bool	hasMasterClone () const override
bool	hasMasterClonePtr () const override
bool	isCaloMuon () const override
bool	isConvertedPhoton () const override
bool	isElectron () const override
bool	isGlobalMuon () const override
bool	isJet () const override
bool	isMuon () const override
bool	isPhoton () const override
bool	isStandAloneMuon () const override
bool	isTrackerMuon () const override
	LeafCandidate ()
template<typename... Args>
	LeafCandidate (Args &&... args)
	LeafCandidate (const Candidate &c)
	LeafCandidate (LeafCandidate &&)=default
	LeafCandidate (LeafCandidate &rh)
	LeafCandidate (LeafCandidate const &)=default
bool	longLived () const final
	is long lived? More...
double	mass () const final
	mass More...
bool	massConstraint () const final
	do mass constraint? More...
double	massSqr () const final
	mass squared More...
const CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () const override
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
Vector	momentum () const final
	spatial momentum vector More...
double	mt () const final
	transverse mass More...
double	mtSqr () const final
	transverse mass squared More...
template<typename T >
size_type	numberOf () const
	number of components More...
template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...
size_t	numberOfSourceCandidatePtrs () const override
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
double	p () const final
	magnitude of momentum vector More...
const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...
int	pdgId () const final
	PDG identifier. More...
double	phi () const final
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () const final
	four-momentum Lorentz vector More...
double	pt () const final
	transverse momentum More...
double	px () const final
	x coordinate of momentum vector More...
double	py () const final
	y coordinate of momentum vector More...
double	pz () const final
	z coordinate of momentum vector More...
double	rapidity () const final
	rapidity More...
void	setCharge (Charge q) final
	set electric charge More...
void	setLongLived () final
void	setMass (double m) final
	set particle mass More...
void	setMassConstraint () final
void	setP4 (const LorentzVector &p4) final
	set 4-momentum More...
void	setP4 (const PolarLorentzVector &p4) final
	set 4-momentum More...
void	setPdgId (int pdgId) final
void	setPz (double pz) final
void	setStatus (int status) final
	set status word More...
void	setThreeCharge (Charge qx3) final
	set electric charge More...
void	setVertex (const Point &vertex) override
	set vertex More...
CandidatePtr	sourceCandidatePtr (size_type i) const override
int	status () const final
	status word More...
double	theta () const final
	momentum polar angle More...
int	threeCharge () const final
	electric charge More...
const Point &	vertex () const override
	vertex position (overwritten by PF...) More...
double	vertexChi2 () const override
	chi-squares More...
CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...
double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
double	vertexNdof () const override
double	vertexNormalizedChi2 () const override
	chi-squared divided by n.d.o.f. More...
double	vx () const override
	x coordinate of vertex position More...
double	vy () const override
	y coordinate of vertex position More...
double	vz () const override
	z coordinate of vertex position More...
double	y () const final
	rapidity More...
	~LeafCandidate () override
	destructor More...
Public Member Functions inherited from reco::Candidate
iterator	begin ()
	first daughter iterator More...
const_iterator	begin () const
	first daughter const_iterator More...
virtual const Track *	bestTrack () const
	Candidate ()
	default constructor More...
virtual float	dxyError () const
	uncertainty on dxy More...
virtual float	dzError () const
	uncertainty on dz More...
iterator	end ()
	last daughter iterator More...
const_iterator	end () const
	last daughter const_iterator More...
template<typename T >
T	get () const
	get a component More...
template<typename T , typename Tag >
T	get () const
	get a component More...
template<typename T >
T	get (size_type i) const
	get a component More...
template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
template<typename T >
size_type	numberOf () const
	number of components More...
template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...
virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate. More...
virtual	~Candidate ()
	destructor More...

Private Member Functions
bool	overlap (const Candidate &) const override
	checp overlap with another candidate More...

Private Attributes
int	collisionId_
GenStatusFlags	statusFlags_

Additional Inherited Members
Public Types inherited from reco::CompositeRefCandidateT< GenParticleRefVector >
typedef GenParticleRefVector	daughters
	collection of references to daughters More...
typedef GenParticleRefVector	mothers
	collection of references to daughters More...
Public Types inherited from reco::LeafCandidate
typedef int	Charge
	electric charge type More...
typedef CandidateCollection	daughters
	collection of daughter candidates More...
typedef unsigned int	index
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...
typedef math::XYZPoint	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
typedef math::XYZVector	Vector
	point in the space More...
Public Types inherited from reco::Candidate
enum	{ dimension = 3 }
enum	{ size = dimension * (dimension + 1) / 2 }
	matix size More...
typedef int	Charge
	electric charge type More...
typedef candidate::const_iterator	const_iterator
typedef math::Error< dimension >::type	CovarianceMatrix
	covariance error matrix (3x3) More...
typedef unsigned int	index
	index type More...
typedef candidate::iterator	iterator
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...
typedef math::XYZPoint	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
typedef size_t	size_type
typedef math::XYZVector	Vector
	point in the space More...
Static Public Member Functions inherited from reco::CompositeRefCandidateT< GenParticleRefVector >
static short	Class_Version ()

Detailed Description

particle candidate with information from HepMC::GenParticle

Author

: Luca Lista, INFN

Definition at line 21 of file GenParticle.h.

Constructor & Destructor Documentation

GenParticle() [1/4]

reco::GenParticle::GenParticle ( )

inline

default constructor

Definition at line 24 of file GenParticle.h.

{}

GenParticle() [2/4]

reco::GenParticle::GenParticle ( const LeafCandidate &  c )

inline

default constructor

Definition at line 26 of file GenParticle.h.

: CompositeRefCandidateT<GenParticleRefVector>(c) {}

GenParticle() [3/4]

reco::GenParticle::GenParticle	(	Charge	q,
		const LorentzVector &	p4,
		const Point &	vtx,
		int	pdgId,
		int	status,
		bool	integerCharge
	)

constrocturo from values

GenParticle() [4/4]

reco::GenParticle::GenParticle	(	Charge	q,
		const PolarLorentzVector &	p4,
		const Point &	vtx,
		int	pdgId,
		int	status,
		bool	integerCharge
	)

constrocturo from values

~GenParticle()

reco::GenParticle::~GenParticle ( )

override

destructor

Member Function Documentation

clone()

GenParticle* reco::GenParticle::clone ( ) const

overridevirtual

return a clone

Reimplemented from reco::LeafCandidate.

collisionId()

int reco::GenParticle::collisionId ( ) const

inline

Definition at line 36 of file GenParticle.h.

{ return collisionId_; }

References collisionId_.

Referenced by cms::SubEventGenJetProducer::inputTowers(), and HiSignalGenJetProducer::produce().

fromHardProcessBeforeFSR()

bool reco::GenParticle::fromHardProcessBeforeFSR ( ) const

inline

Definition at line 94 of file GenParticle.h.

{ return statusFlags_.fromHardProcessBeforeFSR(); }

References reco::GenStatusFlags::fromHardProcessBeforeFSR(), and statusFlags_.

Referenced by isMostlyLikePythia6Status3().

fromHardProcessDecayed()

bool reco::GenParticle::fromHardProcessDecayed ( ) const

inline

Definition at line 79 of file GenParticle.h.

                                        {
      return statusFlags_.isDecayedLeptonHadron() && statusFlags_.fromHardProcess();
    }

References reco::GenStatusFlags::fromHardProcess(), reco::GenStatusFlags::isDecayedLeptonHadron(), and statusFlags_.

fromHardProcessFinalState()

bool reco::GenParticle::fromHardProcessFinalState ( ) const

inline

Definition at line 75 of file GenParticle.h.

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

References reco::GenStatusFlags::fromHardProcess(), reco::LeafCandidate::status(), and statusFlags_.

Referenced by ElectronMVANtuplizer::matchToTruth().

isDirectHardProcessTauDecayProductFinalState()

bool reco::GenParticle::isDirectHardProcessTauDecayProductFinalState ( ) const

inline

Definition at line 85 of file GenParticle.h.

                                                              {
      return status() == 1 && statusFlags_.isDirectHardProcessTauDecayProduct();
    }

References reco::GenStatusFlags::isDirectHardProcessTauDecayProduct(), reco::LeafCandidate::status(), and statusFlags_.

Referenced by ElectronMVANtuplizer::matchToTruth().

isDirectPromptTauDecayProductFinalState()

bool reco::GenParticle::isDirectPromptTauDecayProductFinalState ( ) const

inline

Definition at line 59 of file GenParticle.h.

                                                         {
      return status() == 1 && statusFlags_.isDirectPromptTauDecayProduct();
    }

References reco::GenStatusFlags::isDirectPromptTauDecayProduct(), reco::LeafCandidate::status(), and statusFlags_.

Referenced by HGCalTriggerNtupleGenTau::isChargedHadron(), HGCalTriggerNtupleGenTau::isElectron(), HGCalTriggerNtupleGenTau::isGamma(), HGCalTriggerNtupleGenTau::isMuon(), HGCalTriggerNtupleGenTau::isNeutralPion(), and HGCalTriggerNtupleGenTau::isStableLepton().

isHardProcess()

bool reco::GenParticle::isHardProcess ( ) const

inline

Definition at line 72 of file GenParticle.h.

{ return statusFlags_.isHardProcess(); }

References reco::GenStatusFlags::isHardProcess(), and statusFlags_.

isLastCopy()

bool reco::GenParticle::isLastCopy ( ) const

inline

Definition at line 101 of file GenParticle.h.

{ return statusFlags_.isLastCopy(); }

References reco::GenStatusFlags::isLastCopy(), and statusFlags_.

Referenced by HGCalTriggerNtupleGenTau::isChargedHadron(), HGCalTriggerNtupleGenTau::isChargedHadronFromResonance(), HGCalTriggerNtupleGenTau::isElectron(), HGCalTriggerNtupleGenTau::isGamma(), HGCalTriggerNtupleGenTau::isMuon(), and HGCalTriggerNtupleGenTau::isStableLepton().

isLastCopyBeforeFSR()

bool reco::GenParticle::isLastCopyBeforeFSR ( ) const

inline

Definition at line 106 of file GenParticle.h.

{ return statusFlags_.isLastCopyBeforeFSR(); }

References reco::GenStatusFlags::isLastCopyBeforeFSR(), and statusFlags_.

isMostlyLikePythia6Status3()

bool reco::GenParticle::isMostlyLikePythia6Status3 ( )

inline

Definition at line 97 of file GenParticle.h.

{ return fromHardProcessBeforeFSR(); }

References fromHardProcessBeforeFSR().

isPromptDecayed()

bool reco::GenParticle::isPromptDecayed ( ) const

inline

Definition at line 55 of file GenParticle.h.

{ return statusFlags_.isDecayedLeptonHadron() && statusFlags_.isPrompt(); }

References reco::GenStatusFlags::isDecayedLeptonHadron(), reco::GenStatusFlags::isPrompt(), and statusFlags_.

Referenced by HLTTauMCProducer::produce().

isPromptFinalState()

bool reco::GenParticle::isPromptFinalState ( ) const

inline

Definition at line 51 of file GenParticle.h.

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

References reco::GenStatusFlags::isPrompt(), reco::LeafCandidate::status(), and statusFlags_.

overlap()

bool reco::GenParticle::overlap ( const Candidate &  ) const

overrideprivatevirtual

checp overlap with another candidate

Reimplemented from reco::LeafCandidate.

setCollisionId()

void reco::GenParticle::setCollisionId ( int  s )

inline

Definition at line 35 of file GenParticle.h.

{ collisionId_ = s; }

References collisionId_, and alignCSCRings::s.

Referenced by GenParticlePruner::produce().

statusFlags() [1/2]

GenStatusFlags& reco::GenParticle::statusFlags ( )

inline

Definition at line 39 of file GenParticle.h.

{ return statusFlags_; }

References statusFlags_.

statusFlags() [2/2]

const GenStatusFlags& reco::GenParticle::statusFlags ( ) const

inline

Definition at line 38 of file GenParticle.h.

{ return statusFlags_; }

References statusFlags_.

Referenced by HGCalTriggerNtupleGenTau::isGamma(), HGCalTriggerNtupleGenTau::isNeutralPion(), HGCalTriggerNtupleGenTau::isNeutralPionFromResonance(), and GenParticlePruner::produce().

Member Data Documentation

collisionId_

int reco::GenParticle::collisionId_

private

Definition at line 111 of file GenParticle.h.

Referenced by collisionId(), and setCollisionId().

statusFlags_

GenStatusFlags reco::GenParticle::statusFlags_

private

Definition at line 112 of file GenParticle.h.

Referenced by fromHardProcessBeforeFSR(), fromHardProcessDecayed(), fromHardProcessFinalState(), isDirectHardProcessTauDecayProductFinalState(), isDirectPromptTauDecayProductFinalState(), isHardProcess(), isLastCopy(), isLastCopyBeforeFSR(), isPromptDecayed(), isPromptFinalState(), and statusFlags().