Jets made from MC generator particles. More...

#include <GenJet.h>

Inheritance diagram for reco::GenJet:

Classes
struct	Specific

Public Member Functions
float	auxiliaryEnergy () const

virtual GenJet *	clone () const
	Polymorphic clone. More...

float	detectorEta (float fZVertex) const
	Detector Eta (use reference Z and jet kinematics only) More...

float	emEnergy () const

	GenJet ()

	GenJet (const LorentzVector &fP4, const Point &fVertex, const Specific &fSpecific, const Jet::Constituents &fConstituents)

	GenJet (const LorentzVector &fP4, const Point &fVertex, const Specific &fSpecific)

	GenJet (const LorentzVector &fP4, const Specific &fSpecific, const Jet::Constituents &fConstituents)

virtual const GenParticle *	getGenConstituent (unsigned fIndex) const
	get specific constituent More...

virtual std::vector< const GenParticle * >	getGenConstituents () const
	get all constituents More...

const Specific &	getSpecific () const

float	hadEnergy () const

float	invisibleEnergy () const

virtual std::string	print () const
	Print object. More...

void	setSpecific (const Specific &spec)
	set the specific (note: responsibility of keeping it consistent with the jet daughers belongs to the caller) More...

virtual	~GenJet ()

Public Member Functions inherited from reco::Jet
float	constituentEtaPhiSpread () const

float	constituentPtDistribution () const

float	etaetaMoment () const
	eta-eta second moment, ET weighted More...

float	etaphiMoment () const
	eta-phi second moment, ET weighted More...

EtaPhiMoments	etaPhiStatistics () const
	eta-phi statistics, ET weighted More...

float	etInAnnulus (float fRmin, float fRmax) const
	ET in annulus between rmin and rmax around jet direction. More...

virtual Constituents	getJetConstituents () const
	list of constituents More...

virtual std::vector< const reco::Candidate * >	getJetConstituentsQuick () const
	quick list of constituents More...

bool	isJet () const

	Jet ()
	Default constructor. More...

	Jet (const LorentzVector &fP4, const Point &fVertex)
	Initiator. More...

	Jet (const LorentzVector &fP4, const Point &fVertex, const Constituents &fConstituents)

virtual float	jetArea () const
	get jet area More...

float	maxDistance () const
	maximum distance from jet to constituent More...

int	nCarrying (float fFraction) const
	return # of constituent carrying fraction of energy More...

virtual int	nConstituents () const
	of constituents More...

virtual int	nPasses () const
	number of passes taken by algorithm More...

float	phiphiMoment () const
	phi-phi second moment, ET weighted More...

virtual float	pileup () const
	pileup energy contribution as calculated by algorithm More...

virtual void	scaleEnergy (double fScale)
	scale energy of the jet More...

virtual void	setJetArea (float fArea)
	set jet area More...

virtual void	setNPasses (int fPasses)
	Set number of passes taken by algorithm. More...

virtual void	setPileup (float fEnergy)
	Set pileup energy contribution as calculated by algorithm. More...

virtual	~Jet ()
	Destructor. More...

Public Member Functions inherited from reco::CompositePtrCandidate
void	addDaughter (const CandidatePtr &)
	add a daughter via a reference More...

void	clearDaughters ()
	clear daughter references More...

	CompositePtrCandidate ()
	default constructor More...

	CompositePtrCandidate (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...

	CompositePtrCandidate (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...

	CompositePtrCandidate (const Candidate &p)
	constructor from a Candidate More...

virtual const Candidate *	daughter (size_type) const
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...

virtual Candidate *	daughter (size_type)
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...

CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...

const daughters &	daughterPtrVector () const
	references to daughtes More...

virtual const Candidate *	mother (size_t i=0) const
	return pointer to mother More...

virtual size_t	numberOfDaughters () const
	number of daughters More...

virtual size_t	numberOfMothers () const
	number of mothers More...

virtual size_type	numberOfSourceCandidatePtrs () const

virtual CandidatePtr	sourceCandidatePtr (size_type i) const

virtual	~CompositePtrCandidate ()
	destructor More...

Public Member Functions inherited from reco::LeafCandidate
virtual Vector	boostToCM () const final

virtual 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)

virtual Candidate *	daughter (const std::string &s)
	return daughter with a specified role name More...

virtual const Candidate *	daughter (const std::string &s) const
	return daughter with a specified role name More...

virtual double	energy () const final
	energy More...

virtual double	et () const final
	transverse energy More...

virtual double	et2 () const final
	transverse energy squared (use this for cut!) More...

virtual double	eta () const final
	momentum pseudorapidity More...

virtual void	fillVertexCovariance (CovarianceMatrix &v) const
	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...

virtual bool	hasMasterClone () const

virtual bool	hasMasterClonePtr () const

virtual bool	isCaloMuon () const

virtual bool	isConvertedPhoton () const

virtual bool	isElectron () const

virtual bool	isGlobalMuon () const

virtual bool	isMuon () const

virtual bool	isPhoton () const

virtual bool	isStandAloneMuon () const

virtual bool	isTrackerMuon () const

	LeafCandidate ()

	LeafCandidate (const Candidate &c)

template<typename... Args>
	LeafCandidate (Args &&...args)

	LeafCandidate (LeafCandidate &rh)

	LeafCandidate (LeafCandidate &&)=default

	LeafCandidate (LeafCandidate const &)=default

virtual bool	longLived () const final
	is long lived? More...

virtual double	mass () const final
	mass More...

virtual bool	massConstraint () const final
	do mass constraint? More...

virtual double	massSqr () const final
	mass squared More...

virtual const CandidateBaseRef &	masterClone () const

virtual const CandidatePtr &	masterClonePtr () const

template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...

virtual Vector	momentum () const final
	spatial momentum vector More...

virtual double	mt () const final
	transverse mass More...

virtual 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...

LeafCandidate &	operator= (LeafCandidate &&)=default

LeafCandidate &	operator= (LeafCandidate const &)=default

virtual double	p () const final
	magnitude of momentum vector More...

virtual const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...

virtual int	pdgId () const final
	PDG identifier. More...

virtual double	phi () const final
	momentum azimuthal angle More...

virtual const PolarLorentzVector &	polarP4 () const final
	four-momentum Lorentz vector More...

virtual double	pt () const final
	transverse momentum More...

virtual double	px () const final
	x coordinate of momentum vector More...

virtual double	py () const final
	y coordinate of momentum vector More...

virtual double	pz () const final
	z coordinate of momentum vector More...

virtual double	rapidity () const final
	rapidity More...

virtual void	setCharge (Charge q) final
	set electric charge More...

virtual void	setLongLived () final

virtual void	setMass (double m) final
	set particle mass More...

virtual void	setMassConstraint () final

virtual void	setP4 (const LorentzVector &p4) final
	set 4-momentum More...

virtual void	setP4 (const PolarLorentzVector &p4) final
	set 4-momentum More...

virtual void	setPdgId (int pdgId) final

virtual void	setPz (double pz) final

virtual void	setStatus (int status) final
	set status word More...

virtual void	setThreeCharge (Charge qx3) final
	set electric charge More...

virtual void	setVertex (const Point &vertex)
	set vertex More...

virtual int	status () const final
	status word More...

virtual double	theta () const final
	momentum polar angle More...

virtual int	threeCharge () const final
	electric charge More...

virtual const Point &	vertex () const
	vertex position (overwritten by PF...) More...

virtual double	vertexChi2 () const
	chi-squares More...

virtual double	vertexCovariance (int i, int j) const
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...

CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...

virtual double	vertexNdof () const

virtual double	vertexNormalizedChi2 () const
	chi-squared divided by n.d.o.f. More...

virtual double	vx () const
	x coordinate of vertex position More...

virtual double	vy () const
	y coordinate of vertex position More...

virtual double	vz () const
	z coordinate of vertex position More...

virtual double	y () const final
	rapidity More...

virtual	~LeafCandidate ()
	destructor More...

Public Member Functions inherited from reco::Candidate
const_iterator	begin () const
	first daughter const_iterator More...

iterator	begin ()
	first daughter 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...

const_iterator	end () const
	last daughter const_iterator More...

iterator	end ()
	last daughter 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...

Static Public Member Functions
static const GenParticle *	genParticle (const reco::Candidate *fConstituent)
	convert generic constituent to specific type More...

Static Public Member Functions inherited from reco::Jet
static float	detectorEta (float fZVertex, float fPhysicsEta)
	static function to convert physics eta to detector eta More...

static Candidate::LorentzVector	detectorP4 (const Candidate::Point &vertex, const Candidate &inParticle)

static float	physicsEta (float fZVertex, float fDetectorEta)
	static function to convert detector eta to physics eta More...

static Candidate::LorentzVector	physicsP4 (const Candidate::Point &newVertex, const Candidate &inParticle, const Candidate::Point &oldVertex=Candidate::Point(0, 0, 0))

Private Member Functions
virtual bool	overlap (const Candidate &) const
	Polymorphic overlap. More...

Private Attributes
Specific	m_specific

Additional Inherited Members
Public Types inherited from reco::Jet
typedef edm::Ptr< Candidate >	Constituent

typedef std::vector< Constituent >	Constituents

Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtr >	daughters
	collection of references to daughters More...

typedef std::vector< CandidatePtr >	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...

Detailed Description

Jets made from MC generator particles.

GenJet represents Jets made from MC candidates Provide energy contributions from different particle types in addition to generic Jet parameters

Author: Fedor Ratnikov, UMd

Version: Original March 31, 2006 by F.R.

Definition at line 24 of file GenJet.h.

Constructor & Destructor Documentation

reco::GenJet::GenJet ( )

inline

Default constructor

Definition at line 44 of file GenJet.h.

Referenced by clone().

44 {}

GenJet::GenJet	(	const LorentzVector &	fP4,
		const Point &	fVertex,
		const Specific &	fSpecific,
		const Jet::Constituents &	fConstituents
	)

Constructor from values

Definition at line 19 of file GenJet.cc.

   : Jet (fP4, fVertex, fConstituents),
     m_specific (fSpecific)
 {}

GenJet::GenJet	(	const LorentzVector &	fP4,
		const Point &	fVertex,
		const Specific &	fSpecific
	)

Definition at line 13 of file GenJet.cc.

   : Jet (fP4, fVertex),
     m_specific (fSpecific)
 {}

GenJet::GenJet	(	const LorentzVector &	fP4,
		const Specific &	fSpecific,
		const Jet::Constituents &	fConstituents
	)

backward compatible, vertex=(0,0,0)

Definition at line 26 of file GenJet.cc.

   : Jet (fP4, Point(0,0,0), fConstituents),
     m_specific (fSpecific)
 {}

virtual reco::GenJet::~GenJet ( )

inlinevirtual

Definition at line 55 of file GenJet.h.

55 {};

Member Function Documentation

float reco::GenJet::auxiliaryEnergy ( ) const

inline

Returns other energy (undecayed Sigmas etc.)

Definition at line 63 of file GenJet.h.

References reco::GenJet::Specific::m_AuxiliaryEnergy, and m_specific.

Referenced by print().

63 {return m_specific.m_AuxiliaryEnergy;};

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

reco::GenJet::Specific::m_AuxiliaryEnergy

float m_AuxiliaryEnergy

Anything else (undecayed Sigmas etc.)

Definition: GenJet.h:40

GenJet * GenJet::clone ( void ) const

virtual

Polymorphic clone.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 64 of file GenJet.cc.

References GenJet().

                              {
   return new GenJet (*this);
 }

float GenJet::detectorEta ( float fZVertex ) const

Detector Eta (use reference Z and jet kinematics only)

Definition at line 34 of file GenJet.cc.

References reco::Jet::detectorEta(), and reco::LeafCandidate::eta().

                                                {
   return Jet::detectorEta (fZVertex, eta());
 }

float reco::GenJet::emEnergy ( ) const

inline

Returns energy of electromagnetic particles

Definition at line 57 of file GenJet.h.

References reco::GenJet::Specific::m_EmEnergy, and m_specific.

Referenced by main(), and print().

57 {return m_specific.m_EmEnergy;};

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

reco::GenJet::Specific::m_EmEnergy

float m_EmEnergy

Energy of EM particles.

Definition: GenJet.h:34

const GenParticle * GenJet::genParticle ( const reco::Candidate * fConstituent )

static

convert generic constituent to specific type

Definition at line 38 of file GenJet.cc.

References newFWLiteAna::base, Exception, edm::RefToBase< T >::get(), reco::Candidate::hasMasterClone(), reco::Candidate::masterClone(), and mps_fire::result.

Referenced by getGenConstituent(), and JetMatchingTools::getGenParticle().

                                                                      {
   const Candidate* base = fConstituent;
   if (fConstituent->hasMasterClone ()) base = fConstituent->masterClone().get ();
   const GenParticle* result = dynamic_cast<const GenParticle*> (base);
   if (!result) throw cms::Exception("Invalid Constituent") << "GenJet constituent is not of the type GenParticle";
   return result;
 }

const GenParticle * GenJet::getGenConstituent ( unsigned fIndex ) const

virtual

get specific constituent

Definition at line 46 of file GenJet.cc.

References reco::Candidate::begin(), reco::Candidate::end(), and genParticle().

Referenced by getGenConstituents().

                                                                    {
   // no direct access, have to iterate for now
   int index (fIndex);
   Candidate::const_iterator daugh = begin ();
   for (; --index >= 0 && daugh != end (); daugh++) {}
   if (daugh != end ()) { // in range
     const Candidate* constituent = &*daugh; // deref
     return genParticle (constituent);
   }
   return 0;
 }

std::vector< const GenParticle * > GenJet::getGenConstituents ( ) const

virtual

get all constituents

Definition at line 58 of file GenJet.cc.

References getGenConstituent(), i, reco::CompositePtrCandidate::numberOfDaughters(), and mps_fire::result.

Referenced by JetMatchingTools::getGenParticles(), PFJetBenchmark::gettrue(), print(), and PFJetBenchmark::printGenJet().

                                                                  {
   std::vector <const GenParticle*> result;
   for (unsigned i = 0;  i <  numberOfDaughters (); i++) result.push_back (getGenConstituent (i));
   return result;
 }

const Specific& reco::GenJet::getSpecific ( ) const

inline

Definition at line 77 of file GenJet.h.

References m_specific.

77 {return m_specific;}

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

float reco::GenJet::hadEnergy ( ) const

inline

Returns energy of hadronic particles

Definition at line 59 of file GenJet.h.

References reco::GenJet::Specific::m_HadEnergy, and m_specific.

Referenced by main(), and print().

59 {return m_specific.m_HadEnergy;};

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

reco::GenJet::Specific::m_HadEnergy

float m_HadEnergy

Energy of Hadrons.

Definition: GenJet.h:36

float reco::GenJet::invisibleEnergy ( ) const

inline

Returns invisible energy

Definition at line 61 of file GenJet.h.

References reco::GenJet::Specific::m_InvisibleEnergy, and m_specific.

Referenced by print().

61 {return m_specific.m_InvisibleEnergy;};

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

reco::GenJet::Specific::m_InvisibleEnergy

float m_InvisibleEnergy

Invisible energy (mu, nu, ...)

Definition: GenJet.h:38

bool GenJet::overlap ( const Candidate & ) const

privatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 68 of file GenJet.cc.

                                               {
   return false;
 }

std::string GenJet::print ( void ) const

virtual

Print object.

Reimplemented from reco::Jet.

Definition at line 72 of file GenJet.cc.

References auxiliaryEnergy(), emEnergy(), reco::LeafCandidate::eta(), getGenConstituents(), hadEnergy(), i, invisibleEnergy(), GenerateHcalLaserBadRunList::out, reco::LeafCandidate::p(), reco::LeafCandidate::pdgId(), reco::LeafCandidate::phi(), reco::Jet::print(), and reco::LeafCandidate::pt().

Referenced by TauGenJetDumper::analyze().

                                {
   std::ostringstream out;
   out << Jet::print () // generic jet info
       << "    GenJet specific:" << std::endl
       << "      em/had/invisible/aux  energies: " 
       << emEnergy() << '/' << hadEnergy()  << '/' << invisibleEnergy() << '/' << auxiliaryEnergy() << std::endl;
   out << "      MC particles:" << std::endl;
   std::vector <const GenParticle*> mcparts = getGenConstituents ();
   for (unsigned i = 0; i < mcparts.size (); i++) {
     const GenParticle* mcpart = mcparts[i];
     if (mcpart) {
       out << "      #" << i << "  PDG code:" << mcpart->pdgId() 
       << ", p/pt/eta/phi: " << mcpart->p() << '/' << mcpart->pt() << '/' << mcpart->eta() << '/' << mcpart->phi() << std::endl;
     }
     else {
       out << "      #" << i << "  No information about constituent" << std::endl;
     }
   }
   return out.str ();
 }

void reco::GenJet::setSpecific ( const Specific & spec )

inline

set the specific (note: responsibility of keeping it consistent with the jet daughers belongs to the caller)

Definition at line 80 of file GenJet.h.

References m_specific.

Referenced by pat::PATGenJetSlimmer::produce().

80 {m_specific = spec;}

reco::GenJet::m_specific

Specific m_specific

Definition: GenJet.h:94

Member Data Documentation

Specific reco::GenJet::m_specific

private

Definition at line 94 of file GenJet.h.

Referenced by auxiliaryEnergy(), emEnergy(), getSpecific(), hadEnergy(), invisibleEnergy(), and setSpecific().

Classes

Public Member Functions

of constituents

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation