l1t::PFCandidate Class Reference

#include <PFCandidate.h>

Inheritance diagram for l1t::PFCandidate:

Public Types
typedef l1t::SAMuonRef	MuonRef
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
float	caloEta () const
float	caloPhi () const
float	dxy () const
uint64_t	encodedPuppi64 () const
int16_t	hwDxy () const
uint16_t	hwEmID () const
uint16_t	hwPuppiWeight () const
uint16_t	hwTkQuality () const
int16_t	hwZ0 () const
ParticleType	id () const
const MuonRef &	muon () 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 PFClusterRef &	pfCluster () const
const PFTrackRef &	pfTrack () const
float	puppiWeight () const
	PUPPI weight (-1 if not available) More...
void	setCaloEta (float caloeta)
void	setCaloPhi (float calophi)
void	setDxy (float dxy)
void	setEncodedPuppi64 (uint64_t encodedPuppi64)
void	setHwDxy (int16_t hwDxy)
void	setHwEmID (uint16_t hwEmID)
void	setHwPuppiWeight (uint16_t hwPuppiWeight)
void	setHwTkQuality (uint16_t hwTkQuality)
void	setHwZ0 (int16_t hwZ0)
void	setMuon (const MuonRef &ref)
void	setPFCluster (const PFClusterRef &ref)
void	setPFTrack (const PFTrackRef &ref)
void	setZ0 (float z0)
float	z0 () const
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...
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 (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	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 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...

Private Member Functions
void	setPdgIdFromParticleType (int charge, ParticleType kind)

Private Attributes
float	caloEta_
float	caloPhi_
PFClusterRef	clusterRef_
float	dxy_
uint64_t	encodedPuppi64_
int16_t	hwDxy_
uint16_t	hwEmID_
uint16_t	hwPuppiWeight_
uint16_t	hwTkQuality_
int16_t	hwZ0_
MuonRef	muonRef_
float	puppiWeight_
PFTrackRef	trackRef_

Additional Inherited Members

Detailed Description

Definition at line 13 of file PFCandidate.h.

Member Typedef Documentation

MuonRef

typedef l1t::SAMuonRef l1t::PFCandidate::MuonRef

Definition at line 15 of file PFCandidate.h.

Member Enumeration Documentation

ParticleType

enum l1t::PFCandidate::ParticleType

Enumerator
ChargedHadron
Electron
NeutralHadron
Photon
Muon

Definition at line 16 of file PFCandidate.h.

{ ChargedHadron = 0, Electron = 1, NeutralHadron = 2, Photon = 3, Muon = 4 };

Constructor & Destructor Documentation

PFCandidate() [1/3]

l1t::PFCandidate::PFCandidate ( )

inline

Definition at line 18 of file PFCandidate.h.

{}

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 19 of file PFCandidate.h.

        : PFCandidate(kind, charge, PolarLorentzVector(p), puppiWeight, hwpt, hweta, hwphi) {}

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

    : L1Candidate(p, hwpt, hweta, hwphi, /*hwQuality=*/int(kind)),
      dxy_(0),
      puppiWeight_(puppiWeight),
      caloEta_(0),
      caloPhi_(0),
      hwZ0_(0),
      hwDxy_(0),
      hwTkQuality_(0),
      hwPuppiWeight_(0),
      hwEmID_(0),
      encodedPuppi64_(0) {
  setCharge(charge);
  setPdgIdFromParticleType(charge, kind);
}

Member Function Documentation

caloEta()

float l1t::PFCandidate::caloEta ( ) const

inline

Definition at line 56 of file PFCandidate.h.

References caloEta_.

{ return caloEta_; }

caloPhi()

float l1t::PFCandidate::caloPhi ( ) const

inline

Definition at line 57 of file PFCandidate.h.

References caloPhi_.

{ return caloPhi_; }

dxy()

float l1t::PFCandidate::dxy ( ) const

inline

Definition at line 55 of file PFCandidate.h.

References dxy_.

Referenced by Electron.Electron::cutBasedId(), ntupleDataFormat.Track::dxyPull(), and setDxy().

{ return dxy_; }

encodedPuppi64()

uint64_t l1t::PFCandidate::encodedPuppi64 ( ) const

inline

Definition at line 64 of file PFCandidate.h.

References encodedPuppi64_.

Referenced by setEncodedPuppi64().

{ return encodedPuppi64_; }

hwDxy()

int16_t l1t::PFCandidate::hwDxy ( ) const

inline

Definition at line 60 of file PFCandidate.h.

References hwDxy_.

Referenced by setHwDxy().

{ return hwDxy_; }

hwEmID()

uint16_t l1t::PFCandidate::hwEmID ( ) const

inline

Definition at line 63 of file PFCandidate.h.

References hwEmID_.

Referenced by setHwEmID().

{ return hwEmID_; }

hwPuppiWeight()

uint16_t l1t::PFCandidate::hwPuppiWeight ( ) const

inline

Definition at line 62 of file PFCandidate.h.

References hwPuppiWeight_.

Referenced by setHwPuppiWeight().

{ return hwPuppiWeight_; }

hwTkQuality()

uint16_t l1t::PFCandidate::hwTkQuality ( ) const

inline

Definition at line 61 of file PFCandidate.h.

References hwTkQuality_.

Referenced by setHwTkQuality().

{ return hwTkQuality_; }

hwZ0()

int16_t l1t::PFCandidate::hwZ0 ( ) const

inline

Definition at line 59 of file PFCandidate.h.

References hwZ0_.

Referenced by setHwZ0().

{ return hwZ0_; }

id()

ParticleType l1t::PFCandidate::id ( ) const

inline

Definition at line 35 of file PFCandidate.h.

References l1t::L1Candidate::hwQual().

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

{ return ParticleType(hwQual()); }

muon()

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

inline

Definition at line 43 of file PFCandidate.h.

References muonRef_.

{ return muonRef_; }

pfCluster()

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

inline

Definition at line 40 of file PFCandidate.h.

References clusterRef_.

{ return clusterRef_; }

pfTrack()

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

inline

Definition at line 37 of file PFCandidate.h.

References trackRef_.

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

{ return trackRef_; }

puppiWeight()

float l1t::PFCandidate::puppiWeight ( ) const

inline

PUPPI weight (-1 if not available)

Definition at line 47 of file PFCandidate.h.

References puppiWeight_.

{ return puppiWeight_; }

setCaloEta()

void l1t::PFCandidate::setCaloEta ( float  caloeta )

inline

Definition at line 51 of file PFCandidate.h.

References caloEta_.

{ caloEta_ = caloeta; }

setCaloPhi()

void l1t::PFCandidate::setCaloPhi ( float  calophi )

inline

Definition at line 52 of file PFCandidate.h.

References caloPhi_.

{ caloPhi_ = calophi; }

setDxy()

void l1t::PFCandidate::setDxy ( float  dxy )

inline

Definition at line 50 of file PFCandidate.h.

References dxy(), and dxy_.

{ dxy_ = dxy; }

setEncodedPuppi64()

void l1t::PFCandidate::setEncodedPuppi64 ( uint64_t  encodedPuppi64 )

inline

Definition at line 71 of file PFCandidate.h.

References encodedPuppi64(), and encodedPuppi64_.

{ encodedPuppi64_ = encodedPuppi64; }

setHwDxy()

void l1t::PFCandidate::setHwDxy ( int16_t  hwDxy )

inline

Definition at line 67 of file PFCandidate.h.

References hwDxy(), and hwDxy_.

{ hwDxy_ = hwDxy; }

setHwEmID()

void l1t::PFCandidate::setHwEmID ( uint16_t  hwEmID )

inline

Definition at line 70 of file PFCandidate.h.

References hwEmID(), and hwEmID_.

{ hwEmID_ = hwEmID; }

setHwPuppiWeight()

void l1t::PFCandidate::setHwPuppiWeight ( uint16_t  hwPuppiWeight )

inline

Definition at line 69 of file PFCandidate.h.

References hwPuppiWeight(), and hwPuppiWeight_.

{ hwPuppiWeight_ = hwPuppiWeight; }

setHwTkQuality()

void l1t::PFCandidate::setHwTkQuality ( uint16_t  hwTkQuality )

inline

Definition at line 68 of file PFCandidate.h.

References hwTkQuality(), and hwTkQuality_.

{ hwTkQuality_ = hwTkQuality; }

setHwZ0()

void l1t::PFCandidate::setHwZ0 ( int16_t  hwZ0 )

inline

Definition at line 66 of file PFCandidate.h.

References hwZ0(), and hwZ0_.

{ hwZ0_ = hwZ0; }

setMuon()

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

inline

Definition at line 44 of file PFCandidate.h.

References muonRef_.

{ muonRef_ = ref; }

setPdgIdFromParticleType()

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

private

Definition at line 20 of file PFCandidate.cc.

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

Referenced by PFCandidate().

                                                                           {
  switch (kind) {
    case ChargedHadron:
      setPdgId(charge > 0 ? 211 : -211);
      break;
    case Electron:
      setPdgId(charge > 0 ? -11 : +11);
      break;
    case NeutralHadron:
      setPdgId(130);
      break;
    case Photon:
      setPdgId(22);
      break;
    case Muon:
      setPdgId(charge > 0 ? -13 : +13);
      break;
  };
}

setPFCluster()

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

inline

Definition at line 41 of file PFCandidate.h.

References clusterRef_.

{ clusterRef_ = ref; }

setPFTrack()

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

inline

Definition at line 38 of file PFCandidate.h.

References trackRef_.

{ trackRef_ = ref; }

setZ0()

void l1t::PFCandidate::setZ0 ( float  z0 )

inline

Definition at line 49 of file PFCandidate.h.

References reco::LeafCandidate::setVertex(), and z0().

{ setVertex(reco::Particle::Point(0, 0, z0)); }

z0()

float l1t::PFCandidate::z0 ( ) const

inline

Definition at line 54 of file PFCandidate.h.

References reco::LeafCandidate::vz().

Referenced by setZ0().

{ return vz(); }

Member Data Documentation

caloEta_

float l1t::PFCandidate::caloEta_

private

Definition at line 77 of file PFCandidate.h.

Referenced by caloEta(), and setCaloEta().

caloPhi_

float l1t::PFCandidate::caloPhi_

private

Definition at line 77 of file PFCandidate.h.

Referenced by caloPhi(), and setCaloPhi().

clusterRef_

PFClusterRef l1t::PFCandidate::clusterRef_

private

Definition at line 74 of file PFCandidate.h.

Referenced by pfCluster(), and setPFCluster().

dxy_

float l1t::PFCandidate::dxy_

private

Definition at line 77 of file PFCandidate.h.

Referenced by dxy(), and setDxy().

encodedPuppi64_

uint64_t l1t::PFCandidate::encodedPuppi64_

private

Definition at line 81 of file PFCandidate.h.

Referenced by encodedPuppi64(), and setEncodedPuppi64().

hwDxy_

int16_t l1t::PFCandidate::hwDxy_

private

Definition at line 79 of file PFCandidate.h.

Referenced by hwDxy(), and setHwDxy().

hwEmID_

uint16_t l1t::PFCandidate::hwEmID_

private

Definition at line 80 of file PFCandidate.h.

Referenced by hwEmID(), and setHwEmID().

hwPuppiWeight_

uint16_t l1t::PFCandidate::hwPuppiWeight_

private

Definition at line 80 of file PFCandidate.h.

Referenced by hwPuppiWeight(), and setHwPuppiWeight().

hwTkQuality_

uint16_t l1t::PFCandidate::hwTkQuality_

private

Definition at line 80 of file PFCandidate.h.

Referenced by hwTkQuality(), and setHwTkQuality().

hwZ0_

int16_t l1t::PFCandidate::hwZ0_

private

Definition at line 79 of file PFCandidate.h.

Referenced by hwZ0(), and setHwZ0().

muonRef_

MuonRef l1t::PFCandidate::muonRef_

private

Definition at line 76 of file PFCandidate.h.

Referenced by muon(), and setMuon().

puppiWeight_

float l1t::PFCandidate::puppiWeight_

private

Definition at line 77 of file PFCandidate.h.

Referenced by puppiWeight().

trackRef_

PFTrackRef l1t::PFCandidate::trackRef_

private

Definition at line 75 of file PFCandidate.h.

Referenced by pfTrack(), and setPFTrack().