reco::GenJet Class Reference

Jets made from MC generator particles. More...

#include <GenJet.h>

Inheritance diagram for reco::GenJet:

Classes
struct	Specific

Public Member Functions
float	auxiliaryEnergy () const
float	chargedEmEnergy () const
int	chargedEmMultiplicity () const
float	chargedHadronEnergy () const
int	chargedHadronMultiplicity () const
GenJet *	clone () const override
	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
float	muonEnergy () const
int	muonMultiplicity () const
float	neutralEmEnergy () const
int	neutralEmMultiplicity () const
float	neutralHadronEnergy () const
int	neutralHadronMultiplicity () const
std::string	print () const override
	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...
	~GenJet () override
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 override
virtual int	isWeighted () const
	boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
	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	setIsWeighted (bool isWeighted)
	Set boolean if weights were applied by algorithm (e.g. PUPPI weights) 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...
	~Jet () override
	Destructor. More...
Public Member Functions inherited from reco::CompositePtrCandidate
void	addDaughter (const CandidatePtr &)
	add a daughter via a reference More...
virtual 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...
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...
virtual CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...
virtual const daughters &	daughterPtrVector () const
	references to daughtes More...
const Candidate *	mother (size_t i=0) const override
	return pointer to mother More...
size_t	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers More...
size_type	numberOfSourceCandidatePtrs () const override
CandidatePtr	sourceCandidatePtr (size_type i) const override
	~CompositePtrCandidate () 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 (size_type) const override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (const std::string &s) const 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	isMuon () const override
bool	isPhoton () const override
bool	isStandAloneMuon () const override
bool	isTrackerMuon () const override
	LeafCandidate ()
	LeafCandidate (const Candidate &c)
template<typename... Args>
	LeafCandidate (Args &&...args)
	LeafCandidate (LeafCandidate &rh)
	LeafCandidate (LeafCandidate &&)=default
	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...
const Candidate *	mother (size_type) const override
	return mother at a given position (throws an exception) 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	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers 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...
double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
CovarianceMatrix	vertexCovariance () const final
	return SMatrix 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
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
bool	overlap (const Candidate &) const override
	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. Added GenJet specifics, 2019 by Salvatore Rappoccio

Definition at line 23 of file GenJet.h.

Constructor & Destructor Documentation

reco::GenJet::GenJet ( )

inline

Default constructor

Definition at line 72 of file GenJet.h.

Referenced by clone().

{}

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

Constructor from values

Definition at line 16 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 22 of file GenJet.cc.

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

reco::GenJet::~GenJet ( )

inlineoverride

Definition at line 84 of file GenJet.h.

{};

Member Function Documentation

float reco::GenJet::auxiliaryEnergy ( ) const

inline

Returns other energy (undecayed Sigmas etc.)

Definition at line 92 of file GenJet.h.

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

Referenced by print().

{ return m_specific.m_AuxiliaryEnergy; };

float reco::GenJet::chargedEmEnergy ( ) const

inline

Definition at line 97 of file GenJet.h.

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

Referenced by Jet.Jet::chargedEmEnergyFraction(), and Jet.Jet::jetID().

{ return m_specific.m_ChargedEmEnergy; }

int reco::GenJet::chargedEmMultiplicity ( ) const

inline

Definition at line 102 of file GenJet.h.

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

{ return m_specific.m_ChargedEmMultiplicity; }

float reco::GenJet::chargedHadronEnergy ( ) const

inline

Definition at line 95 of file GenJet.h.

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

Referenced by Jet.Jet::chargedHadronEnergyFraction(), and Jet.Jet::jetID().

{ return m_specific.m_ChargedHadronEnergy; }

int reco::GenJet::chargedHadronMultiplicity ( ) const

inline

Definition at line 100 of file GenJet.h.

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

Referenced by Jet.Jet::jetID().

{ return m_specific.m_ChargedHadronMultiplicity; }

GenJet * GenJet::clone ( void  ) const

overridevirtual

Polymorphic clone.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 58 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 26 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 86 of file GenJet.h.

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

Referenced by main(), and print().

{ return m_specific.m_EmEnergy; };

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

static

convert generic constituent to specific type

Definition at line 28 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 38 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 nullptr;
}

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

virtual

get all constituents

Definition at line 51 of file GenJet.cc.

References getGenConstituent(), mps_fire::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 118 of file GenJet.h.

References m_specific.

{ return m_specific; }

float reco::GenJet::hadEnergy ( ) const

inline

Returns energy of hadronic particles

Definition at line 88 of file GenJet.h.

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

Referenced by main(), and print().

{ return m_specific.m_HadEnergy; };

float reco::GenJet::invisibleEnergy ( ) const

inline

Returns invisible energy

Definition at line 90 of file GenJet.h.

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

Referenced by print().

{ return m_specific.m_InvisibleEnergy; };

float reco::GenJet::muonEnergy ( ) const

inline

Definition at line 99 of file GenJet.h.

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

Referenced by Jet.Jet::jetID(), and Jet.Jet::muonEnergyFraction().

{ return m_specific.m_MuonEnergy; }

int reco::GenJet::muonMultiplicity ( ) const

inline

Definition at line 104 of file GenJet.h.

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

{ return m_specific.m_MuonMultiplicity; }

float reco::GenJet::neutralEmEnergy ( ) const

inline

Definition at line 98 of file GenJet.h.

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

Referenced by Jet.Jet::jetID(), and Jet.Jet::neutralEmEnergyFraction().

{ return m_specific.m_NeutralEmEnergy; }

int reco::GenJet::neutralEmMultiplicity ( ) const

inline

Definition at line 103 of file GenJet.h.

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

{ return m_specific.m_NeutralEmMultiplicity; }

float reco::GenJet::neutralHadronEnergy ( ) const

inline

Definition at line 96 of file GenJet.h.

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

Referenced by Jet.Jet::jetID(), and Jet.Jet::neutralHadronEnergyFraction().

{ return m_specific.m_NeutralHadronEnergy; }

int reco::GenJet::neutralHadronMultiplicity ( ) const

inline

Definition at line 101 of file GenJet.h.

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

{ return m_specific.m_NeutralHadronMultiplicity; }

bool GenJet::overlap ( const Candidate &  ) const

overrideprivatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositePtrCandidate.

Definition at line 60 of file GenJet.cc.

{ return false; }

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

overridevirtual

Print object.

Reimplemented from reco::Jet.

Definition at line 62 of file GenJet.cc.

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

                              {
  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 121 of file GenJet.h.

References m_specific.

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

{ m_specific = spec; }

Member Data Documentation

Specific reco::GenJet::m_specific

private

Definition at line 135 of file GenJet.h.

Referenced by auxiliaryEnergy(), chargedEmEnergy(), chargedEmMultiplicity(), chargedHadronEnergy(), chargedHadronMultiplicity(), emEnergy(), getSpecific(), hadEnergy(), invisibleEnergy(), muonEnergy(), muonMultiplicity(), neutralEmEnergy(), neutralEmMultiplicity(), neutralHadronEnergy(), neutralHadronMultiplicity(), and setSpecific().