CMS 3D CMS Logo

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

#include <TkEm.h>

Inheritance diagram for l1t::TkEm:
l1t::L1Candidate reco::LeafCandidate reco::Candidate l1t::TkElectron

Public Types

enum  HWEncoding { HWEncoding::None, HWEncoding::CT, HWEncoding::GT }
 
- 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

template<int N>
ap_uint< NegBinaryWord () const
 
const edm::Ptr< L1Candidate > & egCaloPtr () const
 
HWEncoding encoding () const
 
l1gt::Photon hwObj () const
 
float pfIsol () const
 
float pfIsolPV () const
 
float puppiIsol () const
 
float puppiIsolPV () const
 
template<int N>
void setEgBinaryWord (ap_uint< N > word, HWEncoding encoding)
 
void setEgCaloPtr (const edm::Ptr< L1Candidate > &egPtr)
 
void setPFIsol (float pfIsol)
 
void setPFIsolPV (float pfIsolPV)
 
void setPuppiIsol (float puppiIsol)
 
void setPuppiIsolPV (float puppiIsolPV)
 
void setTrkIsol (float TrkIsol)
 
void setTrkIsolPV (float TrkIsolPV)
 
 TkEm ()
 
 TkEm (const LorentzVector &p4, float tkisol=-999., float tkisolPV=-999)
 
 TkEm (const LorentzVector &p4, const edm::Ptr< L1Candidate > &egCaloPtr, float tkisol=-999., float tkisolPV=-999)
 
float trkIsol () const
 
float trkIsolPV () 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...
 
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 Attributes

uint32_t egBinaryWord0_
 
uint32_t egBinaryWord1_
 
uint32_t egBinaryWord2_
 
edm::Ptr< L1CandidateegCaloPtr_
 
HWEncoding encoding_
 
float pfIsol_
 
float pfIsolPV_
 
float puppiIsol_
 
float puppiIsolPV_
 
float trkIsol_
 
float trkIsolPV_
 

Additional Inherited Members

Detailed Description

Definition at line 23 of file TkEm.h.

Member Enumeration Documentation

◆ HWEncoding

enum l1t::TkEm::HWEncoding
strong
Enumerator
None 
CT 
GT 

Definition at line 31 of file TkEm.h.

31 { None, CT, GT };
static TString GT
Definition: Zmumumerge.cc:66

Constructor & Destructor Documentation

◆ TkEm() [1/3]

TkEm::TkEm ( )

Definition at line 13 of file TkEm.cc.

13 {}

◆ TkEm() [2/3]

TkEm::TkEm ( const LorentzVector p4,
float  tkisol = -999.,
float  tkisolPV = -999 
)

Definition at line 15 of file TkEm.cc.

16  : TkEm(p4, edm::Ptr<L1Candidate>(), tkisol, tkisolPV) {}
const LorentzVector & p4() const final
four-momentum Lorentz vector
TkEm()
Definition: TkEm.cc:13

◆ TkEm() [3/3]

TkEm::TkEm ( const LorentzVector p4,
const edm::Ptr< L1Candidate > &  egCaloPtr,
float  tkisol = -999.,
float  tkisolPV = -999 
)

Definition at line 18 of file TkEm.cc.

19  : L1Candidate(p4),
21  trkIsol_(tkisol),
22  trkIsolPV_(tkisolPV),
23  pfIsol_(-999),
24  pfIsolPV_(-999),
25  puppiIsol_(-999),
26  puppiIsolPV_(-999),
27  egBinaryWord0_(0),
28  egBinaryWord1_(0),
29  egBinaryWord2_(0),
float puppiIsol_
Definition: TkEm.h:82
uint32_t egBinaryWord2_
Definition: TkEm.h:86
uint32_t egBinaryWord0_
Definition: TkEm.h:84
const LorentzVector & p4() const final
four-momentum Lorentz vector
float trkIsolPV_
Definition: TkEm.h:79
float trkIsol_
Definition: TkEm.h:78
HWEncoding encoding_
Definition: TkEm.h:87
const edm::Ptr< L1Candidate > & egCaloPtr() const
Definition: TkEm.h:35
float pfIsolPV_
Definition: TkEm.h:81
float puppiIsolPV_
Definition: TkEm.h:83
float pfIsol_
Definition: TkEm.h:80
edm::Ptr< L1Candidate > egCaloPtr_
Definition: TkEm.h:77
uint32_t egBinaryWord1_
Definition: TkEm.h:85

Member Function Documentation

◆ egBinaryWord()

template<int N>
ap_uint<N> l1t::TkEm::egBinaryWord ( ) const
inline

Definition at line 70 of file TkEm.h.

References egBinaryWord0_, egBinaryWord1_, and egBinaryWord2_.

Referenced by L1TCtL2EgProducer::convertToEmu().

70  {
71  return ap_uint<N>(egBinaryWord0_) | (ap_uint<N>(egBinaryWord1_) << 32) | (ap_uint<N>(egBinaryWord2_) << 64);
72  }
uint32_t egBinaryWord2_
Definition: TkEm.h:86
uint32_t egBinaryWord0_
Definition: TkEm.h:84
uint32_t egBinaryWord1_
Definition: TkEm.h:85

◆ egCaloPtr()

const edm::Ptr<L1Candidate>& l1t::TkEm::egCaloPtr ( ) const
inline

Definition at line 35 of file TkEm.h.

References egCaloPtr_.

Referenced by L1TCtL2EgProducer::convertToEmu().

35 { return egCaloPtr_; }
edm::Ptr< L1Candidate > egCaloPtr_
Definition: TkEm.h:77

◆ encoding()

HWEncoding l1t::TkEm::encoding ( ) const
inline

Definition at line 74 of file TkEm.h.

References encoding_.

Referenced by l1t::TkElectron::hwObj(), hwObj(), and setEgBinaryWord().

74 { return encoding_; }
HWEncoding encoding_
Definition: TkEm.h:87

◆ hwObj()

l1gt::Photon l1t::TkEm::hwObj ( ) const
inline

Definition at line 62 of file TkEm.h.

References encoding(), Exception, GT, and l1gt::Photon::unpack_ap().

62  {
63  if (encoding() != HWEncoding::GT) {
64  throw cms::Exception("RuntimeError") << "TkEm::hwObj : encoding is not in GT format!" << std::endl;
65  }
66  return l1gt::Photon::unpack_ap(egBinaryWord<l1gt::Photon::BITWIDTH>());
67  }
static Photon unpack_ap(const ap_uint< BITWIDTH > &src)
Definition: gt_datatypes.h:340
HWEncoding encoding() const
Definition: TkEm.h:74

◆ pfIsol()

float l1t::TkEm::pfIsol ( ) const
inline

Definition at line 39 of file TkEm.h.

References pfIsol_.

Referenced by L1TCtL2EgProducer::convertToEmu(), and setPFIsol().

39 { return pfIsol_; } // not constrained to the PV, just track ptSum
float pfIsol_
Definition: TkEm.h:80

◆ pfIsolPV()

float l1t::TkEm::pfIsolPV ( ) const
inline

Definition at line 40 of file TkEm.h.

References pfIsolPV_.

Referenced by L1TCtL2EgProducer::convertToEmu(), and setPFIsolPV().

40 { return pfIsolPV_; } // constrained to the PV by DZ
float pfIsolPV_
Definition: TkEm.h:81

◆ puppiIsol()

float l1t::TkEm::puppiIsol ( ) const
inline

Definition at line 41 of file TkEm.h.

References puppiIsol_.

Referenced by L1TCtL2EgProducer::convertToEmu(), and setPuppiIsol().

41 { return puppiIsol_; } // not constrained to the PV, just track ptSum
float puppiIsol_
Definition: TkEm.h:82

◆ puppiIsolPV()

float l1t::TkEm::puppiIsolPV ( ) const
inline

Definition at line 42 of file TkEm.h.

References puppiIsolPV_.

Referenced by setPuppiIsolPV().

42 { return puppiIsolPV_; } // constrained to the PV by DZ
float puppiIsolPV_
Definition: TkEm.h:83

◆ setEgBinaryWord()

template<int N>
void l1t::TkEm::setEgBinaryWord ( ap_uint< N word,
HWEncoding  encoding 
)
inline

Definition at line 55 of file TkEm.h.

References egBinaryWord0_, egBinaryWord1_, egBinaryWord2_, encoding(), and encoding_.

55  {
57  egBinaryWord1_ = (word >> 32);
58  egBinaryWord2_ = (word >> 64);
60  }
uint32_t egBinaryWord2_
Definition: TkEm.h:86
uint32_t egBinaryWord0_
Definition: TkEm.h:84
HWEncoding encoding_
Definition: TkEm.h:87
uint64_t word
HWEncoding encoding() const
Definition: TkEm.h:74
uint32_t egBinaryWord1_
Definition: TkEm.h:85

◆ setEgCaloPtr()

void l1t::TkEm::setEgCaloPtr ( const edm::Ptr< L1Candidate > &  egPtr)
inline

Definition at line 52 of file TkEm.h.

References egCaloPtr_.

52 { egCaloPtr_ = egPtr; }
edm::Ptr< L1Candidate > egCaloPtr_
Definition: TkEm.h:77

◆ setPFIsol()

void l1t::TkEm::setPFIsol ( float  pfIsol)
inline

Definition at line 48 of file TkEm.h.

References pfIsol(), and pfIsol_.

48 { pfIsol_ = pfIsol; }
float pfIsol_
Definition: TkEm.h:80
float pfIsol() const
Definition: TkEm.h:39

◆ setPFIsolPV()

void l1t::TkEm::setPFIsolPV ( float  pfIsolPV)
inline

Definition at line 49 of file TkEm.h.

References pfIsolPV(), and pfIsolPV_.

49 { pfIsolPV_ = pfIsolPV; }
float pfIsolPV() const
Definition: TkEm.h:40
float pfIsolPV_
Definition: TkEm.h:81

◆ setPuppiIsol()

void l1t::TkEm::setPuppiIsol ( float  puppiIsol)
inline

Definition at line 50 of file TkEm.h.

References puppiIsol(), and puppiIsol_.

50 { puppiIsol_ = puppiIsol; }
float puppiIsol_
Definition: TkEm.h:82
float puppiIsol() const
Definition: TkEm.h:41

◆ setPuppiIsolPV()

void l1t::TkEm::setPuppiIsolPV ( float  puppiIsolPV)
inline

Definition at line 51 of file TkEm.h.

References puppiIsolPV(), and puppiIsolPV_.

float puppiIsolPV_
Definition: TkEm.h:83
float puppiIsolPV() const
Definition: TkEm.h:42

◆ setTrkIsol()

void l1t::TkEm::setTrkIsol ( float  TrkIsol)
inline

Definition at line 46 of file TkEm.h.

References trkIsol_.

46 { trkIsol_ = TrkIsol; }
float trkIsol_
Definition: TkEm.h:78

◆ setTrkIsolPV()

void l1t::TkEm::setTrkIsolPV ( float  TrkIsolPV)
inline

Definition at line 47 of file TkEm.h.

References trkIsolPV_.

47 { trkIsolPV_ = TrkIsolPV; }
float trkIsolPV_
Definition: TkEm.h:79

◆ trkIsol()

float l1t::TkEm::trkIsol ( ) const
inline

Definition at line 37 of file TkEm.h.

References trkIsol_.

Referenced by L1TCtL2EgProducer::convertToEmu().

37 { return trkIsol_; } // not constrained to the PV, just track ptSum
float trkIsol_
Definition: TkEm.h:78

◆ trkIsolPV()

float l1t::TkEm::trkIsolPV ( ) const
inline

Definition at line 38 of file TkEm.h.

References trkIsolPV_.

Referenced by L1TCtL2EgProducer::convertToEmu().

38 { return trkIsolPV_; } // constrained to the PV by DZ
float trkIsolPV_
Definition: TkEm.h:79

Member Data Documentation

◆ egBinaryWord0_

uint32_t l1t::TkEm::egBinaryWord0_
private

Definition at line 84 of file TkEm.h.

Referenced by egBinaryWord(), and setEgBinaryWord().

◆ egBinaryWord1_

uint32_t l1t::TkEm::egBinaryWord1_
private

Definition at line 85 of file TkEm.h.

Referenced by egBinaryWord(), and setEgBinaryWord().

◆ egBinaryWord2_

uint32_t l1t::TkEm::egBinaryWord2_
private

Definition at line 86 of file TkEm.h.

Referenced by egBinaryWord(), and setEgBinaryWord().

◆ egCaloPtr_

edm::Ptr<L1Candidate> l1t::TkEm::egCaloPtr_
private

Definition at line 77 of file TkEm.h.

Referenced by egCaloPtr(), and setEgCaloPtr().

◆ encoding_

HWEncoding l1t::TkEm::encoding_
private

Definition at line 87 of file TkEm.h.

Referenced by encoding(), and setEgBinaryWord().

◆ pfIsol_

float l1t::TkEm::pfIsol_
private

Definition at line 80 of file TkEm.h.

Referenced by pfIsol(), and setPFIsol().

◆ pfIsolPV_

float l1t::TkEm::pfIsolPV_
private

Definition at line 81 of file TkEm.h.

Referenced by pfIsolPV(), and setPFIsolPV().

◆ puppiIsol_

float l1t::TkEm::puppiIsol_
private

Definition at line 82 of file TkEm.h.

Referenced by puppiIsol(), and setPuppiIsol().

◆ puppiIsolPV_

float l1t::TkEm::puppiIsolPV_
private

Definition at line 83 of file TkEm.h.

Referenced by puppiIsolPV(), and setPuppiIsolPV().

◆ trkIsol_

float l1t::TkEm::trkIsol_
private

Definition at line 78 of file TkEm.h.

Referenced by setTrkIsol(), and trkIsol().

◆ trkIsolPV_

float l1t::TkEm::trkIsolPV_
private

Definition at line 79 of file TkEm.h.

Referenced by setTrkIsolPV(), and trkIsolPV().