CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Attributes
l1t::PFJet Class Reference

#include <PFJet.h>

Inheritance diagram for l1t::PFJet:
l1t::L1Candidate reco::LeafCandidate reco::Candidate

Public Types

typedef std::vector< edm::Ptr< l1t::PFCandidate > > Constituents
 constituent information. note that this is not going to be available in the hardware! More...
 
enum  HWEncoding { HWEncoding::CT, HWEncoding::GT }
 
typedef std::array< uint64_t, 2 > PackedJet
 
- 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

void addConstituent (const edm::Ptr< l1t::PFCandidate > &cand)
 adds a candidate to this cluster; note that this only records the information, it's up to you to also set the 4-vector appropriately More...
 
void calibratePt (float newpt)
 
const Constituentsconstituents () const
 constituent information. note that this is not going to be available in the hardware! More...
 
const reco::Candidatedaughter (size_type i) const override
 return daughter at a given position (throws an exception) More...
 
edm::Ptr< l1t::PFCandidatedaughterPtr (size_type i) const
 
const PackedJetencodedJet (const HWEncoding encoding=HWEncoding::GT) const
 
const PackedJetgetHWJetCT () const
 
const PackedJetgetHWJetGT () const
 
size_t numberOfDaughters () const override
 number of daughters More...
 
 PFJet ()
 
 PFJet (float pt, float eta, float phi, float mass=0, int hwpt=0, int hweta=0, int hwphi=0)
 
 PFJet (const LorentzVector &p4, int hwpt=0, int hweta=0, int hwphi=0)
 
float rawPt () const
 
void setEncodedJet (const HWEncoding encoding, const PackedJet jet)
 
- Public Member Functions inherited from l1t::L1Candidate
int hwEta () const
 
int hwIso () const
 
int hwPhi () const
 
int hwPt () const
 
int hwQual () const
 
 L1Candidate ()
 
 L1Candidate (const LorentzVector &p4, int pt=0, int eta=0, int phi=0, int qual=0, int iso=0)
 
 L1Candidate (const PolarLorentzVector &p4, int pt=0, int eta=0, int phi=0, int qual=0, int iso=0)
 
virtual bool operator!= (const l1t::L1Candidate &rhs) const
 
virtual bool operator== (const l1t::L1Candidate &rhs) const
 
void setHwEta (int eta)
 
void setHwIso (int iso)
 
void setHwPhi (int phi)
 
void setHwPt (int pt)
 
void setHwQual (int qual)
 
 ~L1Candidate () override
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge More...
 
LeafCandidateclone () 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)
 
Candidatedaughter (size_type) override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
const Candidatedaughter (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 isJet () 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 CandidateBaseRefmasterClone () const override
 
const CandidatePtrmasterClonePtr () 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 Candidatemother (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 numberOfMothers () const override
 number of mothers More...
 
size_t numberOfSourceCandidatePtrs () const override
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
double p () const final
 magnitude of momentum vector More...
 
const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
int pdgId () const final
 PDG identifier. More...
 
double phi () const final
 momentum azimuthal angle More...
 
const PolarLorentzVectorpolarP4 () 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 Pointvertex () 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 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...
 

Private Attributes

Constituents constituents_
 
std::array< PackedJet, 2 > encodedJet_ = {{{{0, 0}}, {{0, 0}}}}
 
float rawPt_
 

Additional Inherited Members

Detailed Description

Definition at line 11 of file PFJet.h.

Member Typedef Documentation

◆ Constituents

constituent information. note that this is not going to be available in the hardware!

Definition at line 14 of file PFJet.h.

◆ PackedJet

typedef std::array<uint64_t, 2> l1t::PFJet::PackedJet

Definition at line 43 of file PFJet.h.

Member Enumeration Documentation

◆ HWEncoding

Enumerator
CT 
GT 

Definition at line 42 of file PFJet.h.

42 { CT, GT };
static TString GT
Definition: Zmumumerge.cc:65

Constructor & Destructor Documentation

◆ PFJet() [1/3]

l1t::PFJet::PFJet ( )
inline

Definition at line 16 of file PFJet.h.

16 {}

◆ PFJet() [2/3]

l1t::PFJet::PFJet ( float  pt,
float  eta,
float  phi,
float  mass = 0,
int  hwpt = 0,
int  hweta = 0,
int  hwphi = 0 
)
inline

Definition at line 17 of file PFJet.h.

18  : L1Candidate(PolarLorentzVector(pt, eta, phi, mass), hwpt, hweta, hwphi, /*hwQuality=*/0), rawPt_(pt) {}
double pt() const final
transverse momentum
float rawPt_
Definition: PFJet.h:56
math::PtEtaPhiMLorentzVector PolarLorentzVector
Lorentz vector.
Definition: LeafCandidate.h:25
double mass() const final
mass
double phi() const final
momentum azimuthal angle
double eta() const final
momentum pseudorapidity

◆ PFJet() [3/3]

l1t::PFJet::PFJet ( const LorentzVector p4,
int  hwpt = 0,
int  hweta = 0,
int  hwphi = 0 
)
inline

Definition at line 20 of file PFJet.h.

21  : L1Candidate(p4, hwpt, hweta, hwphi, /*hwQuality=*/0), rawPt_(p4.Pt()) {}
float rawPt_
Definition: PFJet.h:56
const LorentzVector & p4() const final
four-momentum Lorentz vector

Member Function Documentation

◆ addConstituent()

void l1t::PFJet::addConstituent ( const edm::Ptr< l1t::PFCandidate > &  cand)
inline

adds a candidate to this cluster; note that this only records the information, it's up to you to also set the 4-vector appropriately

Definition at line 32 of file PFJet.h.

References constituents_.

Referenced by L1SeedConePFJetProducer::convertHWToEDM().

32 { constituents_.emplace_back(cand); }
Constituents constituents_
Definition: PFJet.h:57

◆ calibratePt()

void l1t::PFJet::calibratePt ( float  newpt)

Definition at line 3 of file PFJet.cc.

References reco::LeafCandidate::eta(), reco::LeafCandidate::mass(), reco::LeafCandidate::phi(), and reco::LeafCandidate::setP4().

3 { setP4(PolarLorentzVector(newpt, eta(), phi(), mass())); }
math::PtEtaPhiMLorentzVector PolarLorentzVector
Lorentz vector.
Definition: LeafCandidate.h:25
double mass() const final
mass
double phi() const final
momentum azimuthal angle
void setP4(const LorentzVector &p4) final
set 4-momentum
double eta() const final
momentum pseudorapidity

◆ constituents()

const Constituents& l1t::PFJet::constituents ( ) const
inline

constituent information. note that this is not going to be available in the hardware!

Definition at line 30 of file PFJet.h.

References constituents_.

Referenced by BJetId::compute().

30 { return constituents_; }
Constituents constituents_
Definition: PFJet.h:57

◆ daughter()

const reco::Candidate* l1t::PFJet::daughter ( size_type  ) const
inlineoverridevirtual

return daughter at a given position (throws an exception)

Reimplemented from reco::LeafCandidate.

Definition at line 36 of file PFJet.h.

References constituents_, and mps_fire::i.

36 { return constituents_[i].get(); }
Constituents constituents_
Definition: PFJet.h:57

◆ daughterPtr()

edm::Ptr<l1t::PFCandidate> l1t::PFJet::daughterPtr ( size_type  i) const
inline

Definition at line 38 of file PFJet.h.

References constituents_, and mps_fire::i.

38 { return constituents_[i]; }
Constituents constituents_
Definition: PFJet.h:57

◆ encodedJet()

const PackedJet& l1t::PFJet::encodedJet ( const HWEncoding  encoding = HWEncoding::GT) const
inline

Definition at line 44 of file PFJet.h.

References encodedJet_.

Referenced by getHWJetCT(), and getHWJetGT().

44  {
45  return encodedJet_[static_cast<int>(encoding)];
46  }
std::array< PackedJet, 2 > encodedJet_
Definition: PFJet.h:58

◆ getHWJetCT()

const PackedJet& l1t::PFJet::getHWJetCT ( ) const
inline

Definition at line 53 of file PFJet.h.

References CT, and encodedJet().

53 { return encodedJet(HWEncoding::CT); }
const PackedJet & encodedJet(const HWEncoding encoding=HWEncoding::GT) const
Definition: PFJet.h:44

◆ getHWJetGT()

const PackedJet& l1t::PFJet::getHWJetGT ( ) const
inline

Definition at line 52 of file PFJet.h.

References encodedJet(), and GT.

52 { return encodedJet(HWEncoding::GT); }
const PackedJet & encodedJet(const HWEncoding encoding=HWEncoding::GT) const
Definition: PFJet.h:44

◆ numberOfDaughters()

size_t l1t::PFJet::numberOfDaughters ( ) const
inlineoverridevirtual

number of daughters

Reimplemented from reco::LeafCandidate.

Definition at line 35 of file PFJet.h.

References constituents_.

35 { return constituents_.size(); }
Constituents constituents_
Definition: PFJet.h:57

◆ rawPt()

float l1t::PFJet::rawPt ( ) const
inline

Definition at line 27 of file PFJet.h.

References rawPt_.

Referenced by BJetId::compute().

27 { return rawPt_; }
float rawPt_
Definition: PFJet.h:56

◆ setEncodedJet()

void l1t::PFJet::setEncodedJet ( const HWEncoding  encoding,
const PackedJet  jet 
)
inline

Definition at line 47 of file PFJet.h.

References encodedJet_, and metsig::jet.

Referenced by L1SeedConePFJetProducer::convertHWToEDM().

47  {
48  encodedJet_[static_cast<int>(encoding)] = jet;
49  }
std::array< PackedJet, 2 > encodedJet_
Definition: PFJet.h:58

Member Data Documentation

◆ constituents_

Constituents l1t::PFJet::constituents_
private

Definition at line 57 of file PFJet.h.

Referenced by addConstituent(), constituents(), daughter(), daughterPtr(), and numberOfDaughters().

◆ encodedJet_

std::array<PackedJet, 2> l1t::PFJet::encodedJet_ = {{{{0, 0}}, {{0, 0}}}}
private

Definition at line 58 of file PFJet.h.

Referenced by encodedJet(), and setEncodedJet().

◆ rawPt_

float l1t::PFJet::rawPt_
private

Definition at line 56 of file PFJet.h.

Referenced by rawPt().