Base class for all types of Jets. More...

#include <Jet.h>

Inheritance diagram for reco::Jet:

Classes
class	EtaPhiMoments
	record to store eta-phi first and second moments More...

Public Types
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...

Public Member Functions
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

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 std::string	print () const
	Print object. 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 *	clone () const override
	returns a clone of the candidate 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...

LeafCandidate *	clone () const override
	returns a clone of the Candidate object 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...

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

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

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

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

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

Static Public Member Functions
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 Attributes
bool	mIsWeighted

float	mJetArea

int	mPassNumber

float	mPileupEnergy

Additional Inherited Members

Detailed Description

Base class for all types of Jets.

GenericJet describes jets made from arbitrary constituents, No direct constituents reference is stored for now

Author: Fedor Ratnikov, UMd

Version: Mar 23, 2007 by F.R.

Jet describes properties common for all kinds of jets, essentially kinematics. Base class for all types of Jets.

Author: Fedor Ratnikov, UMd

Version: Original: April 22, 2005 by Fernando Varela Rodriguez.; May 23, 2006 by F.R.

Definition at line 20 of file Jet.h.

Member Typedef Documentation

◆ Constituent

typedef edm::Ptr<Candidate> reco::Jet::Constituent

Definition at line 22 of file Jet.h.

◆ Constituents

typedef std::vector<Constituent> reco::Jet::Constituents

Definition at line 23 of file Jet.h.

Constructor & Destructor Documentation

◆ Jet() [1/3]

reco::Jet::Jet ( )

inline

Default constructor.

Definition at line 36 of file Jet.h.

36 : mJetArea(0), mPileupEnergy(0), mPassNumber(0), mIsWeighted(false) {}

◆ Jet() [2/3]

reco::Jet::Jet	(	const LorentzVector &	fP4,
		const Point &	fVertex
	)

Initiator.

◆ Jet() [3/3]

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

◆ ~Jet()

reco::Jet::~Jet ( )

inlineoverride

Destructor.

Definition at line 41 of file Jet.h.

41 {}

Member Function Documentation

◆ constituentEtaPhiSpread()

float reco::Jet::constituentEtaPhiSpread ( ) const

◆ constituentPtDistribution()

float reco::Jet::constituentPtDistribution ( ) const

◆ detectorEta()

static float reco::Jet::detectorEta	(	float	fZVertex,
		float	fPhysicsEta
	)

static

static function to convert physics eta to detector eta

Referenced by reco::GenJet::detectorEta().

◆ detectorP4()

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

static

Referenced by reco::CaloJet::detectorP4().

◆ etaetaMoment()

float reco::Jet::etaetaMoment ( ) const

eta-eta second moment, ET weighted

Referenced by fireworks::makeEveJetCone().

◆ etaphiMoment()

float reco::Jet::etaphiMoment ( ) const

eta-phi second moment, ET weighted

◆ etaPhiStatistics()

EtaPhiMoments reco::Jet::etaPhiStatistics ( ) const

eta-phi statistics, ET weighted

◆ etInAnnulus()

float reco::Jet::etInAnnulus	(	float	fRmin,
		float	fRmax
	)		const

ET in annulus between rmin and rmax around jet direction.

◆ getJetConstituents()

virtual Constituents reco::Jet::getJetConstituents ( ) const

virtual

list of constituents

Referenced by fireworks::makeEveJetCone(), CATopJetHelper::operator()(), CAWZJetHelperUser::operator()(), CATopJetHelperUser::operator()(), QjetsAdder::produce(), JetPlusTrackProducer::produce(), CastorClusterProducer::produce(), and JetPlusTrackProducerAA::produce().

◆ getJetConstituentsQuick()

virtual std::vector<const reco::Candidate*> reco::Jet::getJetConstituentsQuick ( ) const

virtual

quick list of constituents

◆ isJet()

bool reco::Jet::isJet ( ) const

overridevirtual

Reimplemented from reco::LeafCandidate.

◆ isWeighted()

virtual int reco::Jet::isWeighted ( ) const

inlinevirtual

boolean if weights were applied by algorithm (e.g. PUPPI weights)

Definition at line 118 of file Jet.h.

118 { return mIsWeighted; }

References mIsWeighted.

Referenced by BoostedDoubleSVProducer::calcNsubjettiness(), and setIsWeighted().

◆ jetArea()

virtual float reco::Jet::jetArea ( ) const

inlinevirtual

get jet area

Definition at line 103 of file Jet.h.

103 { return mJetArea; }

References mJetArea.

Referenced by L1FastjetCorrector::correction(), L1FastjetCorrectorImpl::correction(), CaloJetSlimmer::produce(), and BoostedTauSeedsProducer::produce().

◆ maxDistance()

float reco::Jet::maxDistance ( ) const

maximum distance from jet to constituent

◆ nCarrying()

int reco::Jet::nCarrying ( float fFraction ) const

return # of constituent carrying fraction of energy

Referenced by reco::CaloJet::n60(), pat::Jet::n60(), reco::CaloJet::n90(), and pat::Jet::n90().

◆ nConstituents()

virtual int reco::Jet::nConstituents ( ) const

inlinevirtual

of constituents

Definition at line 65 of file Jet.h.

65 { return numberOfDaughters(); }

References reco::CompositePtrCandidate::numberOfDaughters().

Referenced by JetAnalyzer::analyze(), main(), reco::PFMETProducerMVA::passPFLooseId(), BoostedTauSeedsProducer::produce(), and JetIdSelector< T >::produce().

◆ nPasses()

virtual int reco::Jet::nPasses ( ) const

inlinevirtual

number of passes taken by algorithm

Definition at line 113 of file Jet.h.

113 { return mPassNumber; }

References mPassNumber.

◆ phiphiMoment()

float reco::Jet::phiphiMoment ( ) const

phi-phi second moment, ET weighted

Referenced by fireworks::makeEveJetCone().

◆ physicsEta()

static float reco::Jet::physicsEta	(	float	fZVertex,
		float	fDetectorEta
	)

static

static function to convert detector eta to physics eta

◆ physicsP4()

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

static

Referenced by reco::CaloJet::physicsP4().

◆ pileup()

virtual float reco::Jet::pileup ( ) const

inlinevirtual

pileup energy contribution as calculated by algorithm

Definition at line 108 of file Jet.h.

108 { return mPileupEnergy; }

References mPileupEnergy.

◆ print()

virtual std::string reco::Jet::print ( ) const

virtual

Print object.

Reimplemented in reco::PFJet, reco::CaloJet, reco::JPTJet, reco::GenJet, reco::TrackJet, reco::PFClusterJet, and reco::BasicJet.

Referenced by reco::BasicJet::print(), reco::PFClusterJet::print(), reco::TrackJet::print(), reco::GenJet::print(), reco::JPTJet::print(), reco::CaloJet::print(), and reco::PFJet::print().

◆ scaleEnergy()

virtual void reco::Jet::scaleEnergy ( double fScale )

virtual

scale energy of the jet

Reimplemented in pat::Jet.

Referenced by JetTester::analyze(), JetAnalyzer::analyze(), TopSingleLepton::MonitorEnsemble::fill(), TopDiLeptonOffline::MonitorEnsemble::fill(), SingleTopTChannelLepton::MonitorEnsemble::fill(), CorrectJet::operator()(), MVAJetPuIdProducer::produce(), JetPlusTrackProducer::produce(), and JetPlusTrackProducerAA::produce().

◆ setIsWeighted()

virtual void reco::Jet::setIsWeighted ( bool isWeighted )

inlinevirtual

Set boolean if weights were applied by algorithm (e.g. PUPPI weights)

Definition at line 116 of file Jet.h.

116 { mIsWeighted = isWeighted; }

References isWeighted(), and mIsWeighted.

◆ setJetArea()

virtual void reco::Jet::setJetArea ( float fArea )

inlinevirtual

set jet area

Definition at line 101 of file Jet.h.

101 { mJetArea = fArea; }

References mJetArea.

Referenced by ParticleLevelProducer::addGenJet(), JetPlusTrackAddonSeedProducer::produce(), cms::CompoundJetProducer::writeCompoundJets(), and VirtualJetProducer::writeCompoundJets().

◆ setNPasses()

virtual void reco::Jet::setNPasses ( int fPasses )

inlinevirtual

Set number of passes taken by algorithm.

Definition at line 111 of file Jet.h.

111 { mPassNumber = fPasses; }

References mPassNumber.

◆ setPileup()

virtual void reco::Jet::setPileup ( float fEnergy )

inlinevirtual

Set pileup energy contribution as calculated by algorithm.

Definition at line 106 of file Jet.h.

106 { mPileupEnergy = fEnergy; }

References hcaldqm::quantity::fEnergy, and mPileupEnergy.

Member Data Documentation

◆ mIsWeighted

bool reco::Jet::mIsWeighted

private

Definition at line 126 of file Jet.h.

Referenced by isWeighted(), and setIsWeighted().

◆ mJetArea

float reco::Jet::mJetArea

private

Definition at line 123 of file Jet.h.

Referenced by jetArea(), and setJetArea().

◆ mPassNumber

int reco::Jet::mPassNumber

private

Definition at line 125 of file Jet.h.

Referenced by nPasses(), and setNPasses().

◆ mPileupEnergy

float reco::Jet::mPileupEnergy

private

Definition at line 124 of file Jet.h.

Referenced by pileup(), and setPileup().

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Constituent

◆ Constituents

Constructor & Destructor Documentation

◆ Jet() [1/3]

◆ Jet() [2/3]

◆ Jet() [3/3]

◆ ~Jet()

Member Function Documentation

◆ constituentEtaPhiSpread()

◆ constituentPtDistribution()

◆ detectorEta()

◆ detectorP4()

◆ etaetaMoment()

◆ etaphiMoment()

◆ etaPhiStatistics()

◆ etInAnnulus()

◆ getJetConstituents()

◆ getJetConstituentsQuick()

◆ isJet()

◆ isWeighted()

◆ jetArea()

◆ maxDistance()

◆ nCarrying()

◆ nConstituents()

of constituents

◆ nPasses()

◆ phiphiMoment()

◆ physicsEta()

◆ physicsP4()

◆ pileup()

◆ print()

◆ scaleEnergy()

◆ setIsWeighted()

◆ setJetArea()

◆ setNPasses()

◆ setPileup()

Member Data Documentation

◆ mIsWeighted

◆ mJetArea

◆ mPassNumber

◆ mPileupEnergy