CMS 3D CMS Logo

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

#include <CaloCluster.h>

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

Public Types

enum  ClusterFlag {
  INCLUDE_SEED = 0, INCLUDE_NW = 1, INCLUDE_N = 2, INCLUDE_NE = 3,
  INCLUDE_E = 4, INCLUDE_SE = 5, INCLUDE_S = 6, INCLUDE_SW = 7,
  INCLUDE_W = 8, INCLUDE_NN = 9, INCLUDE_SS = 10, TRIM_LEFT = 11,
  IS_SECONDARY = 12, MERGE_UPDOWN = 13, MERGE_LEFTRIGHT = 14
}
 
- 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

 CaloCluster ()
 
 CaloCluster (const LorentzVector p4, int pt=0, int eta=0, int phi=0)
 
bool checkClusterFlag (ClusterFlag flag) const
 
int clusterFlags () const
 
int fgECAL () const
 
int fgEta () const
 
int fgPhi () const
 
int hOverE () const
 
int hwPtEm () const
 
int hwPtHad () const
 
int hwSeedPt () const
 
bool isValid () const
 
bool operator< (const CaloCluster &cl) const
 
bool operator<= (const CaloCluster &cl) const
 
bool operator> (const CaloCluster &cl) const
 
bool operator>= (const CaloCluster &cl) const
 
void setClusterFlag (ClusterFlag flag, bool val=true)
 
void setFgECAL (int fgECAL)
 
void setFgEta (int fgEta)
 
void setFgPhi (int fgPhi)
 
void setHOverE (int hOverE)
 
void setHwPtEm (int pt)
 
void setHwPtHad (int pt)
 
void setHwSeedPt (int pt)
 
 ~CaloCluster () override
 
- 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 (const std::string &s) const override
 return daughter with a specified role name More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
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...
 
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 ()
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (const Candidate &c)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate &rh)
 
 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...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 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
iterator begin ()
 first daughter iterator More...
 
const_iterator begin () const
 first daughter const_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...
 
iterator end ()
 last daughter iterator More...
 
const_iterator end () const
 last daughter const_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

int m_clusterFlags
 
int m_fgECAL
 
int m_fgEta
 
int m_fgPhi
 
int m_hOverE
 
int m_hwPtEm
 
int m_hwPtHad
 
int m_hwSeedPt
 

Additional Inherited Members

Detailed Description

Definition at line 9 of file CaloCluster.h.

Member Enumeration Documentation

◆ ClusterFlag

Enumerator
INCLUDE_SEED 
INCLUDE_NW 
INCLUDE_N 
INCLUDE_NE 
INCLUDE_E 
INCLUDE_SE 
INCLUDE_S 
INCLUDE_SW 
INCLUDE_W 
INCLUDE_NN 
INCLUDE_SS 
TRIM_LEFT 
IS_SECONDARY 
MERGE_UPDOWN 
MERGE_LEFTRIGHT 

Definition at line 11 of file CaloCluster.h.

11  {
12  INCLUDE_SEED = 0,
13  INCLUDE_NW = 1,
14  INCLUDE_N = 2,
15  INCLUDE_NE = 3,
16  INCLUDE_E = 4,
17  INCLUDE_SE = 5,
18  INCLUDE_S = 6,
19  INCLUDE_SW = 7,
20  INCLUDE_W = 8,
21  INCLUDE_NN = 9,
22  INCLUDE_SS = 10,
23  TRIM_LEFT = 11,
24  IS_SECONDARY = 12,
25  MERGE_UPDOWN = 13, // 0=up, 1=down
26  MERGE_LEFTRIGHT = 14 // 0=left, 1=right
27  };

Constructor & Destructor Documentation

◆ CaloCluster() [1/2]

l1t::CaloCluster::CaloCluster ( )
inline

Definition at line 30 of file CaloCluster.h.

30 {}

◆ CaloCluster() [2/2]

l1t::CaloCluster::CaloCluster ( const LorentzVector  p4,
int  pt = 0,
int  eta = 0,
int  phi = 0 
)

Definition at line 4 of file CaloCluster.cc.

5  : L1Candidate(p4, pt, eta, phi),
6  m_clusterFlags(0x7FF) // first 11 flags at 1
7 {}

◆ ~CaloCluster()

l1t::CaloCluster::~CaloCluster ( )
override

Definition at line 9 of file CaloCluster.cc.

9 {}

Member Function Documentation

◆ checkClusterFlag()

bool l1t::CaloCluster::checkClusterFlag ( ClusterFlag  flag) const

◆ clusterFlags()

int l1t::CaloCluster::clusterFlags ( ) const
inline

Definition at line 53 of file CaloCluster.h.

53 { return m_clusterFlags; }

References m_clusterFlags.

◆ fgECAL()

int l1t::CaloCluster::fgECAL ( ) const

Definition at line 49 of file CaloCluster.cc.

49 { return m_fgECAL; }

◆ fgEta()

int l1t::CaloCluster::fgEta ( ) const

Definition at line 43 of file CaloCluster.cc.

43 { return m_fgEta; }

◆ fgPhi()

int l1t::CaloCluster::fgPhi ( ) const

Definition at line 45 of file CaloCluster.cc.

45 { return m_fgPhi; }

◆ hOverE()

int l1t::CaloCluster::hOverE ( ) const

Definition at line 47 of file CaloCluster.cc.

47 { return m_hOverE; }

◆ hwPtEm()

int l1t::CaloCluster::hwPtEm ( ) const

Definition at line 37 of file CaloCluster.cc.

37 { return m_hwPtEm; }

◆ hwPtHad()

int l1t::CaloCluster::hwPtHad ( ) const

Definition at line 39 of file CaloCluster.cc.

39 { return m_hwPtHad; }

◆ hwSeedPt()

int l1t::CaloCluster::hwSeedPt ( ) const

Definition at line 41 of file CaloCluster.cc.

41 { return m_hwSeedPt; }

◆ isValid()

bool l1t::CaloCluster::isValid ( void  ) const

◆ operator<()

bool l1t::CaloCluster::operator< ( const CaloCluster cl) const

Definition at line 51 of file CaloCluster.cc.

51  {
52  bool res = false;
53  // Favour high pT
54  if (hwPt() < cl.hwPt())
55  res = true;
56  else if (hwPt() == cl.hwPt()) {
57  // Favour central clusters
58  if (abs(hwEta()) > abs(cl.hwEta()))
59  res = true;
60  else if (abs(hwEta()) == abs(cl.hwEta())) {
61  // Favour small phi (arbitrary)
62  if (hwPhi() > cl.hwPhi())
63  res = true;
64  }
65  }
66  return res;
67 }

References funct::abs(), and GetRecoTauVFromDQM_MC_cff::cl.

◆ operator<=()

bool l1t::CaloCluster::operator<= ( const CaloCluster cl) const
inline

Definition at line 57 of file CaloCluster.h.

57 { return !(cl > *this); };

References GetRecoTauVFromDQM_MC_cff::cl.

◆ operator>()

bool l1t::CaloCluster::operator> ( const CaloCluster cl) const
inline

Definition at line 56 of file CaloCluster.h.

56 { return cl < *this; };

References GetRecoTauVFromDQM_MC_cff::cl.

◆ operator>=()

bool l1t::CaloCluster::operator>= ( const CaloCluster cl) const
inline

Definition at line 58 of file CaloCluster.h.

58 { return !(cl < *this); };

References GetRecoTauVFromDQM_MC_cff::cl.

◆ setClusterFlag()

void l1t::CaloCluster::setClusterFlag ( ClusterFlag  flag,
bool  val = true 
)

Definition at line 11 of file CaloCluster.cc.

11  {
12  if (val) {
13  m_clusterFlags |= (0x1 << flag);
14  } else {
15  m_clusterFlags &= ~(0x1 << flag);
16  }
17 };

References RemoveAddSevLevel::flag, and heppy_batch::val.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::trimCluster().

◆ setFgECAL()

void l1t::CaloCluster::setFgECAL ( int  fgECAL)

Definition at line 31 of file CaloCluster.cc.

31 { m_fgECAL = fgECAL; }

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

◆ setFgEta()

void l1t::CaloCluster::setFgEta ( int  fgEta)

Definition at line 25 of file CaloCluster.cc.

25 { m_fgEta = fgEta; }

◆ setFgPhi()

void l1t::CaloCluster::setFgPhi ( int  fgPhi)

Definition at line 27 of file CaloCluster.cc.

27 { m_fgPhi = fgPhi; }

◆ setHOverE()

void l1t::CaloCluster::setHOverE ( int  hOverE)

◆ setHwPtEm()

void l1t::CaloCluster::setHwPtEm ( int  pt)

◆ setHwPtHad()

void l1t::CaloCluster::setHwPtHad ( int  pt)

◆ setHwSeedPt()

void l1t::CaloCluster::setHwSeedPt ( int  pt)

Member Data Documentation

◆ m_clusterFlags

int l1t::CaloCluster::m_clusterFlags
private

Definition at line 58 of file CaloCluster.h.

Referenced by clusterFlags().

◆ m_fgECAL

int l1t::CaloCluster::m_fgECAL
private

Definition at line 75 of file CaloCluster.h.

◆ m_fgEta

int l1t::CaloCluster::m_fgEta
private

Definition at line 70 of file CaloCluster.h.

◆ m_fgPhi

int l1t::CaloCluster::m_fgPhi
private

Definition at line 71 of file CaloCluster.h.

◆ m_hOverE

int l1t::CaloCluster::m_hOverE
private

Definition at line 74 of file CaloCluster.h.

◆ m_hwPtEm

int l1t::CaloCluster::m_hwPtEm
private

Definition at line 65 of file CaloCluster.h.

◆ m_hwPtHad

int l1t::CaloCluster::m_hwPtHad
private

Definition at line 66 of file CaloCluster.h.

◆ m_hwSeedPt

int l1t::CaloCluster::m_hwSeedPt
private

Definition at line 67 of file CaloCluster.h.

l1t::CaloCluster::INCLUDE_E
Definition: CaloCluster.h:16
l1t::CaloCluster::INCLUDE_NN
Definition: CaloCluster.h:21
l1t::CaloCluster::m_fgEta
int m_fgEta
Definition: CaloCluster.h:70
l1t::CaloCluster::TRIM_LEFT
Definition: CaloCluster.h:23
l1t::L1Candidate::hwPhi
int hwPhi() const
Definition: L1Candidate.h:37
l1t::CaloCluster::INCLUDE_SW
Definition: CaloCluster.h:19
l1t::CaloCluster::IS_SECONDARY
Definition: CaloCluster.h:24
l1t::CaloCluster::m_hwPtHad
int m_hwPtHad
Definition: CaloCluster.h:66
l1t::CaloCluster::m_fgECAL
int m_fgECAL
Definition: CaloCluster.h:75
reco::LeafCandidate::pt
double pt() const final
transverse momentum
Definition: LeafCandidate.h:146
l1t::CaloCluster::MERGE_LEFTRIGHT
Definition: CaloCluster.h:26
l1t::CaloCluster::INCLUDE_SS
Definition: CaloCluster.h:22
l1t::CaloCluster::m_fgPhi
int m_fgPhi
Definition: CaloCluster.h:71
l1t::CaloCluster::fgEta
int fgEta() const
Definition: CaloCluster.cc:43
l1t::CaloCluster::m_hOverE
int m_hOverE
Definition: CaloCluster.h:74
GetRecoTauVFromDQM_MC_cff.cl
cl
Definition: GetRecoTauVFromDQM_MC_cff.py:38
l1t::CaloCluster::m_hwSeedPt
int m_hwSeedPt
Definition: CaloCluster.h:67
testProducerWithPsetDescEmpty_cfi.x1
x1
Definition: testProducerWithPsetDescEmpty_cfi.py:33
l1t::CaloCluster::INCLUDE_SEED
Definition: CaloCluster.h:12
l1t::CaloCluster::INCLUDE_SE
Definition: CaloCluster.h:17
l1t::L1Candidate::hwEta
int hwEta() const
Definition: L1Candidate.h:36
l1t::CaloCluster::fgECAL
int fgECAL() const
Definition: CaloCluster.cc:49
l1t::CaloCluster::hOverE
int hOverE() const
Definition: CaloCluster.cc:47
l1t::CaloCluster::INCLUDE_N
Definition: CaloCluster.h:14
l1t::CaloCluster::fgPhi
int fgPhi() const
Definition: CaloCluster.cc:45
l1t::L1Candidate::L1Candidate
L1Candidate()
Definition: L1Candidate.cc:4
reco::LeafCandidate::eta
double eta() const final
momentum pseudorapidity
Definition: LeafCandidate.h:152
reco::LeafCandidate::p4
const LorentzVector & p4() const final
four-momentum Lorentz vector
Definition: LeafCandidate.h:114
l1t::CaloCluster::INCLUDE_NE
Definition: CaloCluster.h:15
res
Definition: Electron.h:6
l1t::CaloCluster::m_clusterFlags
int m_clusterFlags
Definition: CaloCluster.h:58
heppy_batch.val
val
Definition: heppy_batch.py:351
l1t::CaloCluster::m_hwPtEm
int m_hwPtEm
Definition: CaloCluster.h:65
l1t::CaloCluster::INCLUDE_W
Definition: CaloCluster.h:20
reco::LeafCandidate::phi
double phi() const final
momentum azimuthal angle
Definition: LeafCandidate.h:148
l1t::CaloCluster::INCLUDE_S
Definition: CaloCluster.h:18
l1t::CaloCluster::INCLUDE_NW
Definition: CaloCluster.h:13
l1t::L1Candidate::hwPt
int hwPt() const
Definition: L1Candidate.h:35
l1t::CaloCluster::checkClusterFlag
bool checkClusterFlag(ClusterFlag flag) const
Definition: CaloCluster.cc:33
funct::abs
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
l1t::CaloCluster::MERGE_UPDOWN
Definition: CaloCluster.h:25
RemoveAddSevLevel.flag
flag
Definition: RemoveAddSevLevel.py:117