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

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

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.

Constructor & Destructor Documentation

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

Definition at line 4 of file CaloCluster.cc.

8  : L1Candidate(p4, pt, eta, phi),
9  m_clusterFlags(0x7FF) // first 11 flags at 1
10 {
11 
12 }
double eta() const final
momentum pseudorapidity
double pt() const final
transverse momentum
const LorentzVector & p4() const final
four-momentum Lorentz vector
Definition: LeafCandidate.h:99
double phi() const final
momentum azimuthal angle
l1t::CaloCluster::~CaloCluster ( )
override

Definition at line 14 of file CaloCluster.cc.

Referenced by CaloCluster().

15 {
16 
17 }

Member Function Documentation

bool l1t::CaloCluster::checkClusterFlag ( ClusterFlag  flag) const
int l1t::CaloCluster::clusterFlags ( ) const
inline

Definition at line 60 of file CaloCluster.h.

References haddnano::cl, m_clusterFlags, and operator<().

60 {return m_clusterFlags;}
int l1t::CaloCluster::fgECAL ( ) const

Definition at line 106 of file CaloCluster.cc.

References m_fgECAL.

Referenced by CaloCluster(), and setFgECAL().

107 {
108  return m_fgECAL;
109 }
int l1t::CaloCluster::fgEta ( ) const

Definition at line 91 of file CaloCluster.cc.

References m_fgEta.

Referenced by CaloCluster(), and setFgEta().

92 {
93  return m_fgEta;
94 }
int l1t::CaloCluster::fgPhi ( ) const

Definition at line 96 of file CaloCluster.cc.

References m_fgPhi.

Referenced by CaloCluster(), and setFgPhi().

97 {
98  return m_fgPhi;
99 }
int l1t::CaloCluster::hOverE ( ) const

Definition at line 101 of file CaloCluster.cc.

References m_hOverE.

Referenced by CaloCluster(), and setHOverE().

102 {
103  return m_hOverE;
104 }
int l1t::CaloCluster::hwPtEm ( ) const

Definition at line 76 of file CaloCluster.cc.

References m_hwPtEm.

Referenced by CaloCluster().

77 {
78  return m_hwPtEm;
79 }
int l1t::CaloCluster::hwPtHad ( ) const

Definition at line 81 of file CaloCluster.cc.

References m_hwPtHad.

Referenced by CaloCluster().

82 {
83  return m_hwPtHad;
84 }
int l1t::CaloCluster::hwSeedPt ( ) const

Definition at line 86 of file CaloCluster.cc.

References m_hwSeedPt.

Referenced by CaloCluster().

87 {
88  return m_hwSeedPt;
89 }
bool l1t::CaloCluster::isValid ( void  ) const

Definition at line 71 of file CaloCluster.cc.

References checkClusterFlag(), and INCLUDE_SEED.

Referenced by ntupleDataFormat._Object::_checkIsValid(), CaloCluster(), and core.AutoHandle.AutoHandle::ReallyLoad().

72 {
73  return ( checkClusterFlag(INCLUDE_SEED) );
74 }
bool checkClusterFlag(ClusterFlag flag) const
Definition: CaloCluster.cc:66
bool l1t::CaloCluster::operator< ( const CaloCluster cl) const

Definition at line 111 of file CaloCluster.cc.

References funct::abs(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), and l1t::L1Candidate::hwPt().

Referenced by clusterFlags().

112 {
113  bool res = false;
114  // Favour high pT
115  if(hwPt()<cl.hwPt()) res = true;
116  else if(hwPt()==cl.hwPt()) {
117  // Favour central clusters
118  if( abs(hwEta())>abs(cl.hwEta()) ) res = true;
119  else if( abs(hwEta())==abs(cl.hwEta()) ){
120  // Favour small phi (arbitrary)
121  if(hwPhi()>cl.hwPhi()) res = true;
122  }
123  }
124  return res;
125 }
int hwPhi() const
Definition: L1Candidate.h:50
Definition: Electron.h:6
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
int hwEta() const
Definition: L1Candidate.h:49
int hwPt() const
Definition: L1Candidate.h:48
bool l1t::CaloCluster::operator<= ( const CaloCluster cl) const
inline

Definition at line 64 of file CaloCluster.h.

64 {return !(cl>*this);};
bool l1t::CaloCluster::operator> ( const CaloCluster cl) const
inline

Definition at line 63 of file CaloCluster.h.

63 {return cl<*this;};
bool l1t::CaloCluster::operator>= ( const CaloCluster cl) const
inline

Definition at line 65 of file CaloCluster.h.

References m_clusterFlags.

65 {return !(cl<*this);};
void l1t::CaloCluster::setClusterFlag ( ClusterFlag  flag,
bool  val = true 
)

Definition at line 19 of file CaloCluster.cc.

References RemoveAddSevLevel::flag, and m_clusterFlags.

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

20 {
21  if(val)
22  {
23  m_clusterFlags |= (0x1<<flag);
24  }
25  else
26  {
27  m_clusterFlags &= ~(0x1<<flag);
28  }
29 };
void l1t::CaloCluster::setFgECAL ( int  fgECAL)

Definition at line 61 of file CaloCluster.cc.

References fgECAL(), and m_fgECAL.

Referenced by CaloCluster(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

62 {
63  m_fgECAL = fgECAL;
64 }
int fgECAL() const
Definition: CaloCluster.cc:106
void l1t::CaloCluster::setFgEta ( int  fgEta)

Definition at line 46 of file CaloCluster.cc.

References fgEta(), and m_fgEta.

Referenced by CaloCluster().

47 {
48  m_fgEta = fgEta;
49 }
int fgEta() const
Definition: CaloCluster.cc:91
void l1t::CaloCluster::setFgPhi ( int  fgPhi)

Definition at line 51 of file CaloCluster.cc.

References fgPhi(), and m_fgPhi.

Referenced by CaloCluster().

52 {
53  m_fgPhi = fgPhi;
54 }
int fgPhi() const
Definition: CaloCluster.cc:96
void l1t::CaloCluster::setHOverE ( int  hOverE)

Definition at line 56 of file CaloCluster.cc.

References hOverE(), and m_hOverE.

Referenced by CaloCluster(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

57 {
58  m_hOverE = hOverE;
59 }
int hOverE() const
Definition: CaloCluster.cc:101
void l1t::CaloCluster::setHwPtEm ( int  pt)

Definition at line 31 of file CaloCluster.cc.

References m_hwPtEm, and reco::LeafCandidate::pt().

Referenced by CaloCluster(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

32 {
33  m_hwPtEm = pt;
34 }
double pt() const final
transverse momentum
void l1t::CaloCluster::setHwPtHad ( int  pt)

Definition at line 36 of file CaloCluster.cc.

References m_hwPtHad, and reco::LeafCandidate::pt().

Referenced by CaloCluster(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

37 {
38  m_hwPtHad = pt;
39 }
double pt() const final
transverse momentum
void l1t::CaloCluster::setHwSeedPt ( int  pt)

Definition at line 41 of file CaloCluster.cc.

References m_hwSeedPt, and reco::LeafCandidate::pt().

Referenced by CaloCluster(), and l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

42 {
43  m_hwSeedPt = pt;
44 }
double pt() const final
transverse momentum

Member Data Documentation

int l1t::CaloCluster::m_clusterFlags
private

Definition at line 65 of file CaloCluster.h.

Referenced by checkClusterFlag(), clusterFlags(), operator>=(), and setClusterFlag().

int l1t::CaloCluster::m_fgECAL
private

Definition at line 82 of file CaloCluster.h.

Referenced by fgECAL(), and setFgECAL().

int l1t::CaloCluster::m_fgEta
private

Definition at line 77 of file CaloCluster.h.

Referenced by fgEta(), and setFgEta().

int l1t::CaloCluster::m_fgPhi
private

Definition at line 78 of file CaloCluster.h.

Referenced by fgPhi(), and setFgPhi().

int l1t::CaloCluster::m_hOverE
private

Definition at line 81 of file CaloCluster.h.

Referenced by hOverE(), and setHOverE().

int l1t::CaloCluster::m_hwPtEm
private

Definition at line 72 of file CaloCluster.h.

Referenced by hwPtEm(), and setHwPtEm().

int l1t::CaloCluster::m_hwPtHad
private

Definition at line 73 of file CaloCluster.h.

Referenced by hwPtHad(), and setHwPtHad().

int l1t::CaloCluster::m_hwSeedPt
private

Definition at line 74 of file CaloCluster.h.

Referenced by hwSeedPt(), and setHwSeedPt().