CMS 3D CMS Logo

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

#include <PFCandidate.h>

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

Public Types

typedef edm::Ptr< l1t::MuonMuonRef
 
enum  ParticleType {
  ChargedHadron = 0, Electron = 1, NeutralHadron = 2, Photon = 3,
  Muon = 4
}
 
- 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

ParticleType id () const
 
const MuonRefmuon () const
 
 PFCandidate ()
 
 PFCandidate (ParticleType kind, int charge, const LorentzVector &p, float puppiWeight=-1, int hwpt=0, int hweta=0, int hwphi=0)
 
 PFCandidate (ParticleType kind, int charge, const PolarLorentzVector &p, float puppiWeight=-1, int hwpt=0, int hweta=0, int hwphi=0)
 
const PFClusterRefpfCluster () const
 
const PFTrackRefpfTrack () const
 
float puppiWeight () const
 PUPPI weight (-1 if not available) More...
 
void setMuon (const MuonRef &ref)
 
void setPFCluster (const PFClusterRef &ref)
 
void setPFTrack (const PFTrackRef &ref)
 
- 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)
 
const Candidatedaughter (size_type) const override
 return daughter at a given position (throws an exception) More...
 
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 numberOfDaughters () const override
 number of daughters 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 Member Functions

void setPdgIdFromParticleType (int charge, ParticleType kind)
 

Private Attributes

PFClusterRef clusterRef_
 
MuonRef muonRef_
 
float puppiWeight_
 
PFTrackRef trackRef_
 

Additional Inherited Members

Detailed Description

Definition at line 12 of file PFCandidate.h.

Member Typedef Documentation

◆ MuonRef

Definition at line 14 of file PFCandidate.h.

Member Enumeration Documentation

◆ ParticleType

Enumerator
ChargedHadron 
Electron 
NeutralHadron 
Photon 
Muon 

Definition at line 15 of file PFCandidate.h.

Constructor & Destructor Documentation

◆ PFCandidate() [1/3]

l1t::PFCandidate::PFCandidate ( )
inline

Definition at line 17 of file PFCandidate.h.

17 {}

◆ PFCandidate() [2/3]

l1t::PFCandidate::PFCandidate ( ParticleType  kind,
int  charge,
const LorentzVector p,
float  puppiWeight = -1,
int  hwpt = 0,
int  hweta = 0,
int  hwphi = 0 
)
inline

Definition at line 18 of file PFCandidate.h.

25  : PFCandidate(kind, charge, PolarLorentzVector(p), puppiWeight, hwpt, hweta, hwphi) {}
math::PtEtaPhiMLorentzVector PolarLorentzVector
Lorentz vector.
Definition: LeafCandidate.h:25
double p() const final
magnitude of momentum vector
float puppiWeight() const
PUPPI weight (-1 if not available)
Definition: PFCandidate.h:46
int charge() const final
electric charge

◆ PFCandidate() [3/3]

l1t::PFCandidate::PFCandidate ( ParticleType  kind,
int  charge,
const PolarLorentzVector p,
float  puppiWeight = -1,
int  hwpt = 0,
int  hweta = 0,
int  hwphi = 0 
)

Definition at line 3 of file PFCandidate.cc.

References reco::LeafCandidate::charge(), CalibrationSummaryClient_cfi::kind, reco::LeafCandidate::setCharge(), and setPdgIdFromParticleType().

5  : L1Candidate(p, hwpt, hweta, hwphi, /*hwQuality=*/int(kind)), puppiWeight_(puppiWeight) {
8 }
void setCharge(Charge q) final
set electric charge
double p() const final
magnitude of momentum vector
float puppiWeight() const
PUPPI weight (-1 if not available)
Definition: PFCandidate.h:46
void setPdgIdFromParticleType(int charge, ParticleType kind)
Definition: PFCandidate.cc:10
int charge() const final
electric charge

Member Function Documentation

◆ id()

ParticleType l1t::PFCandidate::id ( ) const
inline

Definition at line 34 of file PFCandidate.h.

References l1t::L1Candidate::hwQual().

Referenced by L1HPSPFTauQualityCut::operator()(), and printPFCand().

34 { return ParticleType(hwQual()); }
int hwQual() const
Definition: L1Candidate.h:38

◆ muon()

const MuonRef& l1t::PFCandidate::muon ( ) const
inline

Definition at line 42 of file PFCandidate.h.

References muonRef_.

42 { return muonRef_; }
MuonRef muonRef_
Definition: PFCandidate.h:51

◆ pfCluster()

const PFClusterRef& l1t::PFCandidate::pfCluster ( ) const
inline

Definition at line 39 of file PFCandidate.h.

References clusterRef_.

39 { return clusterRef_; }
PFClusterRef clusterRef_
Definition: PFCandidate.h:49

◆ pfTrack()

const PFTrackRef& l1t::PFCandidate::pfTrack ( ) const
inline

Definition at line 36 of file PFCandidate.h.

References trackRef_.

Referenced by L1HPSPFTauQualityCut::operator()(), and printPFCand().

36 { return trackRef_; }
PFTrackRef trackRef_
Definition: PFCandidate.h:50

◆ puppiWeight()

float l1t::PFCandidate::puppiWeight ( ) const
inline

PUPPI weight (-1 if not available)

Definition at line 46 of file PFCandidate.h.

References puppiWeight_.

46 { return puppiWeight_; }

◆ setMuon()

void l1t::PFCandidate::setMuon ( const MuonRef ref)
inline

Definition at line 43 of file PFCandidate.h.

References muonRef_.

43 { muonRef_ = ref; }
MuonRef muonRef_
Definition: PFCandidate.h:51

◆ setPdgIdFromParticleType()

void l1t::PFCandidate::setPdgIdFromParticleType ( int  charge,
ParticleType  kind 
)
private

Definition at line 10 of file PFCandidate.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, CalibrationSummaryClient_cfi::kind, and nanoDQM_cff::Photon.

Referenced by PFCandidate().

10  {
11  switch (kind) {
12  case ChargedHadron:
13  setPdgId(charge > 0 ? 211 : -211);
14  break;
15  case Electron:
16  setPdgId(charge > 0 ? -11 : +11);
17  break;
18  case NeutralHadron:
19  setPdgId(130);
20  break;
21  case Photon:
22  setPdgId(22);
23  break;
24  case Muon:
25  setPdgId(charge > 0 ? -13 : +13);
26  break;
27  };
28 }
void setPdgId(int pdgId) final
int charge() const final
electric charge

◆ setPFCluster()

void l1t::PFCandidate::setPFCluster ( const PFClusterRef ref)
inline

Definition at line 40 of file PFCandidate.h.

References clusterRef_.

40 { clusterRef_ = ref; }
PFClusterRef clusterRef_
Definition: PFCandidate.h:49

◆ setPFTrack()

void l1t::PFCandidate::setPFTrack ( const PFTrackRef ref)
inline

Definition at line 37 of file PFCandidate.h.

References trackRef_.

37 { trackRef_ = ref; }
PFTrackRef trackRef_
Definition: PFCandidate.h:50

Member Data Documentation

◆ clusterRef_

PFClusterRef l1t::PFCandidate::clusterRef_
private

Definition at line 49 of file PFCandidate.h.

Referenced by pfCluster(), and setPFCluster().

◆ muonRef_

MuonRef l1t::PFCandidate::muonRef_
private

Definition at line 51 of file PFCandidate.h.

Referenced by muon(), and setMuon().

◆ puppiWeight_

float l1t::PFCandidate::puppiWeight_
private

Definition at line 52 of file PFCandidate.h.

Referenced by puppiWeight().

◆ trackRef_

PFTrackRef l1t::PFCandidate::trackRef_
private

Definition at line 50 of file PFCandidate.h.

Referenced by pfTrack(), and setPFTrack().