CMS 3D CMS Logo

List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
reco::Jet Class Reference

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

#include <Jet.h>

Inheritance diagram for reco::Jet:
reco::CompositePtrCandidate reco::LeafCandidate reco::Candidate pat::PATObject< reco::Jet > reco::BasicJet reco::CaloJet reco::GenJet reco::JPTJet reco::PFClusterJet reco::PFJet reco::TrackJet

Classes

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

Public Types

typedef edm::Ptr< CandidateConstituent
 
typedef std::vector< ConstituentConstituents
 
- Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtrdaughters
 collection of references to daughters More...
 
typedef std::vector< CandidatePtrmothers
 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
 
 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 std::string print () const
 Print object. 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...
 
virtual CompositePtrCandidateclone () const
 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...
 
virtual const Candidatedaughter (size_type) const
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
 
virtual Candidatedaughter (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 daughtersdaughterPtrVector () const
 references to daughtes More...
 
virtual const Candidatemother (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 Candidatedaughter (const std::string &s)
 return daughter with a specified role name More...
 
virtual const Candidatedaughter (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 CandidateBaseRefmasterClone () const
 
virtual const CandidatePtrmasterClonePtr () 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...
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
virtual double p () const final
 magnitude of momentum vector More...
 
virtual const LorentzVectorp4 () 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 PolarLorentzVectorpolarP4 () 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 Pointvertex () 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 TrackbestTrack () 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 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

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

Definition at line 22 of file Jet.h.

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

Definition at line 23 of file Jet.h.

Constructor & Destructor Documentation

reco::Jet::Jet ( )
inline

Default constructor.

Definition at line 36 of file Jet.h.

36 : mJetArea (0), mPileupEnergy (0), mPassNumber (0) {}
int mPassNumber
Definition: Jet.h:122
float mJetArea
Definition: Jet.h:120
float mPileupEnergy
Definition: Jet.h:121
reco::Jet::Jet ( const LorentzVector fP4,
const Point fVertex 
)

Initiator.

reco::Jet::Jet ( const LorentzVector fP4,
const Point fVertex,
const Constituents fConstituents 
)
virtual reco::Jet::~Jet ( )
inlinevirtual

Destructor.

Reimplemented in pat::Jet.

Definition at line 41 of file Jet.h.

References etaetaMoment(), etaphiMoment(), etaPhiStatistics(), etInAnnulus(), maxDistance(), nCarrying(), and phiphiMoment().

Referenced by reco::operator<<().

41 {}

Member Function Documentation

float reco::Jet::constituentEtaPhiSpread ( ) const
float reco::Jet::constituentPtDistribution ( ) const
static float reco::Jet::detectorEta ( float  fZVertex,
float  fPhysicsEta 
)
static

static function to convert physics eta to detector eta

Referenced by reco::GenJet::detectorEta(), and nConstituents().

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

eta-eta second moment, ET weighted

Referenced by fireworks::makeEveJetCone(), JetIDSelectionFunctor::operator()(), and ~Jet().

float reco::Jet::etaphiMoment ( ) const

eta-phi second moment, ET weighted

Referenced by ~Jet().

EtaPhiMoments reco::Jet::etaPhiStatistics ( ) const

eta-phi statistics, ET weighted

Referenced by ~Jet().

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

ET in annulus between rmin and rmax around jet direction.

Referenced by ~Jet().

virtual Constituents reco::Jet::getJetConstituents ( ) const
virtual
virtual std::vector<const reco::Candidate*> reco::Jet::getJetConstituentsQuick ( ) const
virtual
bool reco::Jet::isJet ( ) const
virtual

Reimplemented from reco::LeafCandidate.

Referenced by nPasses().

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

maximum distance from jet to constituent

Referenced by ~Jet().

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

return # of constituent carrying fraction of energy

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

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

number of passes taken by algorithm

Definition at line 115 of file Jet.h.

References isJet(), and mPassNumber.

115 {return mPassNumber;}
int mPassNumber
Definition: Jet.h:122
float reco::Jet::phiphiMoment ( ) const

phi-phi second moment, ET weighted

Referenced by fireworks::makeEveJetCone(), JetIDSelectionFunctor::operator()(), and ~Jet().

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

static function to convert detector eta to physics eta

Referenced by nConstituents(), and JetTracksAssociationDRVertexAssigned::produce().

static Candidate::LorentzVector reco::Jet::physicsP4 ( const Candidate::Point newVertex,
const Candidate inParticle,
const Candidate::Point oldVertex = Candidate::Point(0, 0, 0) 
)
static
virtual float reco::Jet::pileup ( ) const
inlinevirtual

pileup energy contribution as calculated by algorithm

Definition at line 110 of file Jet.h.

References mPileupEnergy.

110 {return mPileupEnergy;}
float mPileupEnergy
Definition: Jet.h:121
virtual std::string reco::Jet::print ( ) const
virtual
virtual void reco::Jet::scaleEnergy ( double  fScale)
virtual
virtual void reco::Jet::setJetArea ( float  fArea)
inlinevirtual
virtual void reco::Jet::setNPasses ( int  fPasses)
inlinevirtual

Set number of passes taken by algorithm.

Definition at line 113 of file Jet.h.

References mPassNumber.

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

113 {mPassNumber = fPasses;}
int mPassNumber
Definition: Jet.h:122
virtual void reco::Jet::setPileup ( float  fEnergy)
inlinevirtual

Set pileup energy contribution as calculated by algorithm.

Definition at line 108 of file Jet.h.

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

Referenced by HiL1Subtractor::produce(), FastjetJetProducer::produceTrackJets(), and cms::SubEventGenJetProducer::runAlgorithm().

Member Data Documentation

float reco::Jet::mJetArea
private

Definition at line 120 of file Jet.h.

Referenced by jetArea(), and setJetArea().

int reco::Jet::mPassNumber
private

Definition at line 122 of file Jet.h.

Referenced by nPasses(), and setNPasses().

float reco::Jet::mPileupEnergy
private

Definition at line 121 of file Jet.h.

Referenced by pileup(), and setPileup().