CMS 3D CMS Logo

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

#include <HGCalMulticluster.h>

Inheritance diagram for l1t::HGCalMulticluster:
l1t::HGCalClusterT< l1t::HGCalCluster > l1t::L1Candidate reco::LeafCandidate reco::Candidate

Classes

struct  KeyGetter
 

Public Types

enum  EnergyInterpretation { EM = 0 }
 
typedef boost::transform_iterator< KeyGetter< std::map< EnergyInterpretation, double >::const_iterator >, std::map< EnergyInterpretation, double >::const_iteratorEnergyInterpretation_const_iterator
 
- Public Types inherited from l1t::HGCalClusterT< l1t::HGCalCluster >
typedef std::unordered_map< uint32_t, edm::Ptr< l1t::HGCalCluster > >::const_iterator const_iterator
 
- 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

std::pair< EnergyInterpretation_const_iterator, EnergyInterpretation_const_iteratorenergyInterpretations () const
 
 HGCalMulticluster ()
 
 HGCalMulticluster (const LorentzVector p4, int pt=0, int eta=0, int phi=0)
 
 HGCalMulticluster (const edm::Ptr< l1t::HGCalCluster > &tc, float fraction=1)
 
float hOverE () const
 
double iEnergy (const HGCalMulticluster::EnergyInterpretation eInt) const
 
EnergyInterpretation_const_iterator interpretations_begin () const
 
EnergyInterpretation_const_iterator interpretations_end () const
 
size_type interpretations_size () const
 
math::XYZTLorentzVector iP4 (const HGCalMulticluster::EnergyInterpretation eInt) const
 
math::PtEtaPhiMLorentzVector iPolarP4 (const HGCalMulticluster::EnergyInterpretation eInt) const
 
double iPt (const HGCalMulticluster::EnergyInterpretation eInt) const
 
void saveEnergyInterpretation (const HGCalMulticluster::EnergyInterpretation eInt, double energy)
 
void saveHOverE ()
 
 ~HGCalMulticluster () override
 
- Public Member Functions inherited from l1t::HGCalClusterT< l1t::HGCalCluster >
void addConstituent (const edm::Ptr< l1t::HGCalCluster > &c, bool updateCentre=true, float fraction=1.)
 
const GlobalPointcentre () const
 
const GlobalPointcentreProj () const
 
const std::unordered_map< uint32_t, edm::Ptr< l1t::HGCalCluster > > & constituents () const
 
const_iterator constituents_begin () const
 
const_iterator constituents_end () const
 
int coreShowerLength () const
 
uint32_t detId () const
 
double distance (const l1t::HGCalTriggerCell &tc) const
 
int ebm0 () const
 
int ebm1 () const
 
float eMax () const
 
float emax1layers () const
 
float emax3layers () const
 
float emax5layers () const
 
float eot () const
 
float first1layers () const
 
float first3layers () const
 
float first5layers () const
 
float firstHcal1layers () const
 
float firstHcal3layers () const
 
float firstHcal5layers () const
 
int firstLayer () const
 
int hbm () const
 
 HGCalClusterT ()
 
 HGCalClusterT (const LorentzVector p4, int pt=0, int eta=0, int phi=0)
 
 HGCalClusterT (const edm::Ptr< l1t::HGCalCluster > &c, float fraction=1.)
 
double hOverE () const
 
float last1layers () const
 
float last3layers () const
 
float last5layers () const
 
float layer10percent () const
 
float layer50percent () const
 
float layer90percent () const
 
int maxLayer () const
 
double mipPt () const
 
bool operator< (const HGCalClusterT< l1t::HGCalCluster > &cl) const
 
bool operator<= (const HGCalClusterT< l1t::HGCalCluster > &cl) const
 
bool operator> (const HGCalClusterT< l1t::HGCalCluster > &cl) const
 
bool operator>= (const HGCalClusterT< l1t::HGCalCluster > &cl) const
 
const GlobalPointposition () const
 
void removeConstituent (const edm::Ptr< l1t::HGCalCluster > &c, bool updateCentre=true)
 
double seedMipPt () const
 
void setCoreShowerLength (int coreShowerLength)
 
void setDetId (uint32_t id)
 
void setEbm0 (int ebm0)
 
void setEbm1 (int ebm1)
 
void setEMax (float eMax)
 
void setEmax1layers (float emax1layers)
 
void setEmax3layers (float emax3layers)
 
void setEmax5layers (float emax5layers)
 
void setEot (float eot)
 
void setFirst1layers (float first1layers)
 
void setFirst3layers (float first3layers)
 
void setFirst5layers (float first5layers)
 
void setFirstHcal1layers (float firstHcal1layers)
 
void setFirstHcal3layers (float firstHcal3layers)
 
void setFirstHcal5layers (float firstHcal5layers)
 
void setFirstLayer (int firstLayer)
 
void setHbm (int hbm)
 
void setLast1layers (float last1layers)
 
void setLast3layers (float last3layers)
 
void setLast5layers (float last5layers)
 
void setLayer10percent (float layer10percent)
 
void setLayer50percent (float layer50percent)
 
void setLayer90percent (float layer90percent)
 
void setMaxLayer (int maxLayer)
 
void setPt (double pt)
 
void setShowerLength (int showerLength)
 
void setSigmaEtaEtaMax (float sigmaEtaEtaMax)
 
void setSigmaEtaEtaTot (float sigmaEtaEtaTot)
 
void setSigmaPhiPhiMax (float sigmaPhiPhiMax)
 
void setSigmaPhiPhiTot (float sigmaPhiPhiTot)
 
void setSigmaRRMax (float sigmaRRMax)
 
void setSigmaRRMean (float sigmaRRMean)
 
void setSigmaRRTot (float sigmaRRTot)
 
void setSigmaZZ (float sigmaZZ)
 
void setTriggerCells67percent (float triggerCells67percent)
 
void setTriggerCells90percent (float triggerCells90percent)
 
void setValid (bool valid)
 
void setVarEtaEta (float varEtaEta)
 
void setVarPhiPhi (float varPhiPhi)
 
void setVarRR (float varRR)
 
void setVarZZ (float varZZ)
 
void setZBarycenter (float zBarycenter)
 
int showerLength () const
 
float sigmaEtaEtaMax () const
 
float sigmaEtaEtaTot () const
 
float sigmaPhiPhiMax () const
 
float sigmaPhiPhiTot () const
 
float sigmaRRMax () const
 
float sigmaRRMean () const
 
float sigmaRRTot () const
 
float sigmaZZ () const
 
unsigned size () const
 
uint32_t subdetId () const
 
double sumPt () const
 
float triggerCells67percent () const
 
float triggerCells90percent () const
 
bool valid () const
 
float varEtaEta () const
 
float varPhiPhi () const
 
float varRR () const
 
float varZZ () const
 
float zBarycenter () const
 
 ~HGCalClusterT () 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 Member Functions

double interpretationFraction (const HGCalMulticluster::EnergyInterpretation eInt) const
 
template<typename Iter >
boost::transform_iterator< KeyGetter< Iter >, Iter > key_iterator (Iter itr) const
 

Private Attributes

std::map< EnergyInterpretation, double > energyInterpretationFractions_
 
float hOverE_
 
bool hOverEValid_
 

Additional Inherited Members

Detailed Description

Definition at line 13 of file HGCalMulticluster.h.

Member Typedef Documentation

◆ EnergyInterpretation_const_iterator

Definition at line 70 of file HGCalMulticluster.h.

Member Enumeration Documentation

◆ EnergyInterpretation

Enumerator
EM 

Definition at line 36 of file HGCalMulticluster.h.

Constructor & Destructor Documentation

◆ HGCalMulticluster() [1/3]

l1t::HGCalMulticluster::HGCalMulticluster ( )
inline

Definition at line 15 of file HGCalMulticluster.h.

15 : hOverEValid_(false) {}

◆ HGCalMulticluster() [2/3]

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

Definition at line 5 of file HGCalMulticluster.cc.

double pt() const final
transverse momentum
const LorentzVector & p4() const final
four-momentum Lorentz vector
double phi() const final
momentum azimuthal angle
double eta() const final
momentum pseudorapidity

◆ HGCalMulticluster() [3/3]

HGCalMulticluster::HGCalMulticluster ( const edm::Ptr< l1t::HGCalCluster > &  tc,
float  fraction = 1 
)

◆ ~HGCalMulticluster()

HGCalMulticluster::~HGCalMulticluster ( )
override

Definition at line 11 of file HGCalMulticluster.cc.

11 {}

Member Function Documentation

◆ energyInterpretations()

std::pair<EnergyInterpretation_const_iterator, EnergyInterpretation_const_iterator> l1t::HGCalMulticluster::energyInterpretations ( ) const
inline

Definition at line 72 of file HGCalMulticluster.h.

References energyInterpretationFractions_, and key_iterator().

72  {
73  return std::make_pair(key_iterator(energyInterpretationFractions_.cbegin()),
75  }
std::map< EnergyInterpretation, double > energyInterpretationFractions_
boost::transform_iterator< KeyGetter< Iter >, Iter > key_iterator(Iter itr) const

◆ hOverE()

float l1t::HGCalMulticluster::hOverE ( ) const
inline

Definition at line 22 of file HGCalMulticluster.h.

References l1t::HGCalClusterT< C >::hOverE(), hOverE_, and hOverEValid_.

22  {
23  // --- this below would be faster when reading old objects, as HoE will only be computed once,
24  // --- but it may not be allowed by CMS rules because of the const_cast
25  // --- and could potentially cause a data race
26  // if (!hOverEValid_) (const_cast<HGCalMulticluster*>(this))->saveHOverE();
27  // --- this below is safe in any case
29  }
double hOverE() const

◆ iEnergy()

double l1t::HGCalMulticluster::iEnergy ( const HGCalMulticluster::EnergyInterpretation  eInt) const
inline

Definition at line 40 of file HGCalMulticluster.h.

References reco::LeafCandidate::energy(), and interpretationFraction().

40  {
41  return energy() * interpretationFraction(eInt);
42  }
double interpretationFraction(const HGCalMulticluster::EnergyInterpretation eInt) const
double energy() const final
energy

◆ interpretationFraction()

double HGCalMulticluster::interpretationFraction ( const HGCalMulticluster::EnergyInterpretation  eInt) const
private

Definition at line 17 of file HGCalMulticluster.cc.

References energyInterpretationFractions_.

Referenced by iEnergy(), iP4(), iPolarP4(), and iPt().

17  {
18  auto intAndEnergyFraction = energyInterpretationFractions_.find(eInt);
19  if (intAndEnergyFraction == energyInterpretationFractions_.end()) {
20  // NOTE: this is an arbitary choice: we return the default cluster energy if this interpreation is not available!
21  return 1;
22  }
23  return intAndEnergyFraction->second;
24 }
std::map< EnergyInterpretation, double > energyInterpretationFractions_

◆ interpretations_begin()

EnergyInterpretation_const_iterator l1t::HGCalMulticluster::interpretations_begin ( ) const
inline

Definition at line 77 of file HGCalMulticluster.h.

References energyInterpretationFractions_, and key_iterator().

77  {
79  }
std::map< EnergyInterpretation, double > energyInterpretationFractions_
boost::transform_iterator< KeyGetter< Iter >, Iter > key_iterator(Iter itr) const

◆ interpretations_end()

EnergyInterpretation_const_iterator l1t::HGCalMulticluster::interpretations_end ( ) const
inline

Definition at line 81 of file HGCalMulticluster.h.

References energyInterpretationFractions_, and key_iterator().

81  {
83  }
std::map< EnergyInterpretation, double > energyInterpretationFractions_
boost::transform_iterator< KeyGetter< Iter >, Iter > key_iterator(Iter itr) const

◆ interpretations_size()

size_type l1t::HGCalMulticluster::interpretations_size ( ) const
inline

Definition at line 85 of file HGCalMulticluster.h.

References energyInterpretationFractions_.

85 { return energyInterpretationFractions_.size(); }
std::map< EnergyInterpretation, double > energyInterpretationFractions_

◆ iP4()

math::XYZTLorentzVector l1t::HGCalMulticluster::iP4 ( const HGCalMulticluster::EnergyInterpretation  eInt) const
inline

Definition at line 46 of file HGCalMulticluster.h.

References interpretationFraction(), and reco::LeafCandidate::p4().

46  {
47  return p4() * interpretationFraction(eInt);
48  }
const LorentzVector & p4() const final
four-momentum Lorentz vector
double interpretationFraction(const HGCalMulticluster::EnergyInterpretation eInt) const

◆ iPolarP4()

math::PtEtaPhiMLorentzVector l1t::HGCalMulticluster::iPolarP4 ( const HGCalMulticluster::EnergyInterpretation  eInt) const
inline

Definition at line 50 of file HGCalMulticluster.h.

References reco::LeafCandidate::eta(), interpretationFraction(), reco::LeafCandidate::phi(), and reco::LeafCandidate::pt().

50  {
51  return math::PtEtaPhiMLorentzVector(pt() * interpretationFraction(eInt), eta(), phi(), 0.);
52  }
double pt() const final
transverse momentum
PtEtaPhiMLorentzVectorD PtEtaPhiMLorentzVector
Lorentz vector with cartesian internal representation.
Definition: LorentzVector.h:25
double interpretationFraction(const HGCalMulticluster::EnergyInterpretation eInt) const
double phi() const final
momentum azimuthal angle
double eta() const final
momentum pseudorapidity

◆ iPt()

double l1t::HGCalMulticluster::iPt ( const HGCalMulticluster::EnergyInterpretation  eInt) const
inline

Definition at line 44 of file HGCalMulticluster.h.

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

44 { return pt() * interpretationFraction(eInt); }
double pt() const final
transverse momentum
double interpretationFraction(const HGCalMulticluster::EnergyInterpretation eInt) const

◆ key_iterator()

template<typename Iter >
boost::transform_iterator<KeyGetter<Iter>, Iter> l1t::HGCalMulticluster::key_iterator ( Iter  itr) const
inlineprivate

Definition at line 63 of file HGCalMulticluster.h.

Referenced by energyInterpretations(), interpretations_begin(), and interpretations_end().

63  {
64  return boost::make_transform_iterator<KeyGetter<Iter>, Iter>(itr, KeyGetter<Iter>());
65  }

◆ saveEnergyInterpretation()

void HGCalMulticluster::saveEnergyInterpretation ( const HGCalMulticluster::EnergyInterpretation  eInt,
double  energy 
)

Definition at line 13 of file HGCalMulticluster.cc.

References reco::LeafCandidate::energy(), and energyInterpretationFractions_.

Referenced by HGCalTriggerClusterInterpretationEM::interpret().

13  {
15 }
std::map< EnergyInterpretation, double > energyInterpretationFractions_
double energy() const final
energy

◆ saveHOverE()

void l1t::HGCalMulticluster::saveHOverE ( )
inline

Member Data Documentation

◆ energyInterpretationFractions_

std::map<EnergyInterpretation, double> l1t::HGCalMulticluster::energyInterpretationFractions_
private

◆ hOverE_

float l1t::HGCalMulticluster::hOverE_
private

Definition at line 90 of file HGCalMulticluster.h.

Referenced by hOverE(), and saveHOverE().

◆ hOverEValid_

bool l1t::HGCalMulticluster::hOverEValid_
private

Definition at line 91 of file HGCalMulticluster.h.

Referenced by hOverE(), and saveHOverE().