CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes
reco::MET Class Reference

#include <MET.h>

Inheritance diagram for reco::MET:
reco::RecoCandidate reco::LeafCandidate reco::Candidate pat::PATObject< reco::MET > reco::CaloMET reco::GenMET reco::PFClusterMET reco::PFMET pat::MET

Public Member Functions

METclone () const override
 returns a clone of the Candidate object More...
 
std::vector< double > dmEx () const
 
std::vector< double > dmEy () const
 
std::vector< double > dsumEt () const
 
double e_longitudinal () const
 
reco::METCovMatrix getSignificanceMatrix (void) const
 
int isWeighted () const
 boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
 
 MET ()
 
 MET (const LorentzVector &p4_, const Point &vtx_, bool isWeighted=false)
 
 MET (double sumet_, const LorentzVector &p4_, const Point &vtx_, bool isWeighted=false)
 
 MET (double sumet_, const std::vector< CorrMETData > &corr_, const LorentzVector &p4_, const Point &vtx_, bool isWeighted=false)
 
std::vector< CorrMETDatamEtCorr () const
 
double mEtSig () const
 
void setIsWeighted (bool isWeighted)
 Set boolean if weights were applied by algorithm (e.g. PUPPI weights) More...
 
void setSignificanceMatrix (const reco::METCovMatrix &matrix)
 
double significance () const
 
double sumEt () const
 
- Public Member Functions inherited from reco::RecoCandidate
const TrackbestTrack () const override
 best track pointer More...
 
virtual TrackBaseRef bestTrackRef () const
 best track RefToBase More...
 
virtual TrackType bestTrackType () const
 track type More...
 
virtual CaloTowerRef caloTower () const
 reference to a CaloTower More...
 
RecoCandidateclone () const override
 returns a clone of the Candidate object More...
 
virtual reco::TrackRef combinedMuon () const
 reference to a stand-alone muon Track More...
 
float dxyError () const override
 uncertainty on dxy More...
 
float dzError () const override
 uncertainty on dz More...
 
virtual reco::GsfTrackRef gsfTrack () const
 reference to a GsfTrack More...
 
virtual size_t numberOfTracks () const
 number of multiple Tracks More...
 
 RecoCandidate ()
 default constructor More...
 
template<typename P4 >
 RecoCandidate (Charge q, const P4 &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0)
 constructor from values More...
 
virtual reco::TrackRef standAloneMuon () const
 reference to a stand-alone muon Track More...
 
virtual reco::SuperClusterRef superCluster () const
 reference to a SuperCluster More...
 
virtual reco::TrackRef track () const
 reference to a Track More...
 
virtual reco::TrackRef track (size_t) const
 reference to one of multiple Tracks More...
 
 ~RecoCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge 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...
 
 Candidate ()
 default constructor 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 Member Functions

bool overlap (const Candidate &) const override
 check overlap with another candidate More...
 

Private Attributes

std::vector< CorrMETDatacorr
 
double elongit
 
bool mIsWeighted
 
double signif_dxx
 
double signif_dxy
 
double signif_dyx
 
double signif_dyy
 
double sumet
 

Additional Inherited Members

- Public Types inherited from reco::RecoCandidate
enum  TrackType { noTrackType, recoTrackType, gsfTrackType }
 track type More...
 
- 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...
 
- Protected Member Functions inherited from reco::RecoCandidate
template<typename R >
bool checkOverlap (const R &r1, const R &r2) const
 check if two components overlap More...
 

Detailed Description

Definition at line 41 of file MET.h.

Constructor & Destructor Documentation

◆ MET() [1/4]

MET::MET ( )

Definition at line 19 of file MET.cc.

19  {
20  sumet = 0.0;
21  elongit = 0.0;
23  mIsWeighted = false;
24 }

Referenced by clone().

◆ MET() [2/4]

MET::MET ( const LorentzVector p4_,
const Point vtx_,
bool  isWeighted = false 
)

Definition at line 30 of file MET.cc.

30  : RecoCandidate(0, p4_, vtx_) {
31  sumet = 0.0;
32  elongit = 0.0;
35 }

References elongit, isWeighted(), mIsWeighted, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

◆ MET() [3/4]

MET::MET ( double  sumet_,
const LorentzVector p4_,
const Point vtx_,
bool  isWeighted = false 
)

Definition at line 41 of file MET.cc.

41  : RecoCandidate(0, p4_, vtx_) {
42  sumet = sumet_;
43  elongit = 0.0;
46 }

References elongit, isWeighted(), mIsWeighted, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

◆ MET() [4/4]

MET::MET ( double  sumet_,
const std::vector< CorrMETData > &  corr_,
const LorentzVector p4_,
const Point vtx_,
bool  isWeighted = false 
)

Definition at line 52 of file MET.cc.

54  : RecoCandidate(0, p4_, vtx_) {
55  sumet = sumet_;
56  elongit = 0.0;
59  //-----------------------------------
60  // Fill the vector containing the corrections (corr) with vector of
61  // known corrections (corr_) passed in via the constructor.
62  std::vector<CorrMETData>::const_iterator i;
63  for (i = corr_.begin(); i != corr_.end(); i++) {
64  corr.push_back(*i);
65  }
66 }

References corr, elongit, mps_fire::i, isWeighted(), mIsWeighted, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

Member Function Documentation

◆ clone()

MET * MET::clone ( void  ) const
overridevirtual

returns a clone of the Candidate object

Reimplemented from reco::LeafCandidate.

Reimplemented in pat::MET.

Definition at line 69 of file MET.cc.

69 { return new MET(*this); }

References MET().

◆ dmEx()

std::vector< double > MET::dmEx ( ) const

Definition at line 93 of file MET.cc.

93  {
94  std::vector<double> deltas;
95  std::vector<CorrMETData>::const_iterator i;
96  for (i = corr.begin(); i != corr.end(); i++) {
97  deltas.push_back(i->mex);
98  }
99  return deltas;
100 }

References corr, and mps_fire::i.

◆ dmEy()

std::vector< double > MET::dmEy ( ) const

Definition at line 105 of file MET.cc.

105  {
106  std::vector<double> deltas;
107  std::vector<CorrMETData>::const_iterator i;
108  for (i = corr.begin(); i != corr.end(); i++) {
109  deltas.push_back(i->mey);
110  }
111  return deltas;
112 }

References corr, and mps_fire::i.

◆ dsumEt()

std::vector< double > MET::dsumEt ( ) const

Definition at line 117 of file MET.cc.

117  {
118  std::vector<double> deltas;
119  std::vector<CorrMETData>::const_iterator i;
120  for (i = corr.begin(); i != corr.end(); i++) {
121  deltas.push_back(i->sumet);
122  }
123  return deltas;
124 }

References corr, and mps_fire::i.

Referenced by pat::MET::findMETTotalShift().

◆ e_longitudinal()

double reco::MET::e_longitudinal ( ) const
inline

Definition at line 63 of file MET.h.

63 { return elongit; }

References elongit.

◆ getSignificanceMatrix()

METCovMatrix MET::getSignificanceMatrix ( void  ) const

Definition at line 128 of file MET.cc.

128  {
130  result(0, 0) = signif_dxx;
131  result(0, 1) = signif_dxy;
132  result(1, 0) = signif_dyx;
133  result(1, 1) = signif_dyy;
134  return result;
135 }

References mps_fire::result, signif_dxx, signif_dxy, signif_dyx, and signif_dyy.

Referenced by NoPileUpPFMEtProducer::produce(), and significance().

◆ isWeighted()

int reco::MET::isWeighted ( ) const
inline

boolean if weights were applied by algorithm (e.g. PUPPI weights)

Definition at line 79 of file MET.h.

79 { return mIsWeighted; }

References mIsWeighted.

Referenced by MET(), Type1PFMET::run(), and setIsWeighted().

◆ mEtCorr()

std::vector<CorrMETData> reco::MET::mEtCorr ( ) const
inline

Definition at line 70 of file MET.h.

70 { return corr; }

References corr.

Referenced by Type1PFMET::run().

◆ mEtSig()

double reco::MET::mEtSig ( ) const
inline

Definition at line 58 of file MET.h.

58 { return (sumet ? (this->et() / std::sqrt(sumet)) : (0.0)); }

References reco::LeafCandidate::et(), mathSSE::sqrt(), and sumet.

◆ overlap()

bool MET::overlap ( const Candidate ) const
overrideprivatevirtual

check overlap with another candidate

Implements reco::RecoCandidate.

Definition at line 139 of file MET.cc.

139 { return false; }

◆ setIsWeighted()

void reco::MET::setIsWeighted ( bool  isWeighted)
inline

Set boolean if weights were applied by algorithm (e.g. PUPPI weights)

Definition at line 77 of file MET.h.

References isWeighted(), and mIsWeighted.

Referenced by cms::PFMETProducer::produce().

◆ setSignificanceMatrix()

void MET::setSignificanceMatrix ( const reco::METCovMatrix matrix)

Definition at line 142 of file MET.cc.

142  {
143  signif_dxx = inmatrix(0, 0);
144  signif_dxy = inmatrix(0, 1);
145  signif_dyx = inmatrix(1, 0);
146  signif_dyy = inmatrix(1, 1);
147  return;
148 }

References signif_dxx, signif_dxy, signif_dyx, and signif_dyy.

Referenced by pat::MET::MET(), NoPileUpPFMEtProducer::produce(), pat::PATMETProducer::produce(), CorrectedPATMETProducer::produce(), reco::PFMETProducerMVA::produce(), and cms::PFMETProducer::produce().

◆ significance()

double MET::significance ( ) const

Definition at line 73 of file MET.cc.

73  {
74  if (signif_dxx == 0 && signif_dyy == 0 && signif_dxy == 0 && signif_dyx == 0)
75  return -1;
77  ROOT::Math::SVector<double, 2> metvec;
78  metvec(0) = this->px();
79  metvec(1) = this->py();
80  double signif = -1;
81  double det = 0;
82  metmat.Det2(det);
83  if (std::abs(det) > 0.000001) {
84  metmat.Invert();
85  signif = ROOT::Math::Dot(metvec, (metmat * metvec));
86  }
87  return signif;
88 }

References funct::abs(), getSignificanceMatrix(), reco::LeafCandidate::px(), reco::LeafCandidate::py(), signif_dxx, signif_dxy, signif_dyx, and signif_dyy.

Referenced by reco::CaloMET::metSignificance().

◆ sumEt()

double reco::MET::sumEt ( ) const
inline

Member Data Documentation

◆ corr

std::vector<CorrMETData> reco::MET::corr
private

Definition at line 90 of file MET.h.

Referenced by MuScleFitCorrector.MuScleFitCorr::corrected_p4(), dmEx(), dmEy(), dsumEt(), MET(), and mEtCorr().

◆ elongit

double reco::MET::elongit
private

Definition at line 84 of file MET.h.

Referenced by e_longitudinal(), and MET().

◆ mIsWeighted

bool reco::MET::mIsWeighted
private

Definition at line 91 of file MET.h.

Referenced by isWeighted(), MET(), and setIsWeighted().

◆ signif_dxx

double reco::MET::signif_dxx
private

Definition at line 86 of file MET.h.

Referenced by getSignificanceMatrix(), MET(), setSignificanceMatrix(), and significance().

◆ signif_dxy

double reco::MET::signif_dxy
private

Definition at line 89 of file MET.h.

Referenced by getSignificanceMatrix(), MET(), setSignificanceMatrix(), and significance().

◆ signif_dyx

double reco::MET::signif_dyx
private

Definition at line 88 of file MET.h.

Referenced by getSignificanceMatrix(), MET(), setSignificanceMatrix(), and significance().

◆ signif_dyy

double reco::MET::signif_dyy
private

Definition at line 87 of file MET.h.

Referenced by getSignificanceMatrix(), MET(), setSignificanceMatrix(), and significance().

◆ sumet

double reco::MET::sumet
private

Definition at line 83 of file MET.h.

Referenced by MET(), mEtSig(), and sumEt().

reco::MET::sumet
double sumet
Definition: MET.h:83
reco::MET::mIsWeighted
bool mIsWeighted
Definition: MET.h:91
mps_fire.i
i
Definition: mps_fire.py:428
reco::MET::getSignificanceMatrix
reco::METCovMatrix getSignificanceMatrix(void) const
Definition: MET.cc:128
reco::MET::signif_dxx
double signif_dxx
Definition: MET.h:86
reco::MET::isWeighted
int isWeighted() const
boolean if weights were applied by algorithm (e.g. PUPPI weights)
Definition: MET.h:79
reco::LeafCandidate::py
double py() const final
y coordinate of momentum vector
Definition: LeafCandidate.h:142
mathSSE::sqrt
T sqrt(T t)
Definition: SSEVec.h:19
reco::MET::signif_dyy
double signif_dyy
Definition: MET.h:87
reco::MET::MET
MET()
Definition: MET.cc:19
reco::MET::corr
std::vector< CorrMETData > corr
Definition: MET.h:90
reco::RecoCandidate::RecoCandidate
RecoCandidate()
default constructor
Definition: RecoCandidate.h:23
reco::LeafCandidate::et
double et() const final
transverse energy
Definition: LeafCandidate.h:127
reco::MET::signif_dyx
double signif_dyx
Definition: MET.h:88
mps_fire.result
result
Definition: mps_fire.py:311
funct::abs
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
reco::MET::signif_dxy
double signif_dxy
Definition: MET.h:89
reco::MET::elongit
double elongit
Definition: MET.h:84
reco::LeafCandidate::px
double px() const final
x coordinate of momentum vector
Definition: LeafCandidate.h:140
reco::METCovMatrix
ROOT::Math::SMatrix< double, 2 > METCovMatrix
Definition: MET.h:39