reco::MET Class Reference

#include <MET.h>

Inheritance diagram for reco::MET:

Public Member Functions
MET *	clone () 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
	MET ()
	MET (const LorentzVector &p4_, const Point &vtx_)
	MET (double sumet_, const LorentzVector &p4_, const Point &vtx_)
	MET (double sumet_, const std::vector< CorrMETData > &corr_, const LorentzVector &p4_, const Point &vtx_)
std::vector< CorrMETData >	mEtCorr () const
double	mEtSig () const
void	setSignificanceMatrix (const reco::METCovMatrix &matrix)
double	significance () const
double	sumEt () const
Public Member Functions inherited from reco::RecoCandidate
const Track *	bestTrack () 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...
RecoCandidate *	clone () 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 Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (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 CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () 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 Candidate *	mother (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
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
double	p () const final
	magnitude of momentum vector More...
const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...
int	pdgId () const final
	PDG identifier. More...
double	phi () const final
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () 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 Point &	vertex () 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...
	Candidate ()
	default constructor 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
bool	overlap (const Candidate &) const override
	check overlap with another candidate More...

Private Attributes
std::vector< CorrMETData >	corr
double	elongit
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::MET

(

)

Definition at line 19 of file MET.cc.

Referenced by clone().

         {
  sumet = 0.0;
  elongit = 0.0;
  signif_dxx = signif_dyy = signif_dyx = signif_dxy = 0.;
}

MET::MET	(	const LorentzVector &	p4_,
		const Point &	vtx_
	)

Definition at line 29 of file MET.cc.

References elongit, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

                                                    : RecoCandidate(0, p4_, vtx_) {
  sumet = 0.0;
  elongit = 0.0;
  signif_dxx = signif_dyy = signif_dyx = signif_dxy = 0.;
}

MET::MET	(	double	sumet_,
		const LorentzVector &	p4_,
		const Point &	vtx_
	)

Definition at line 39 of file MET.cc.

References elongit, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

                                                                   : RecoCandidate(0, p4_, vtx_) {
  sumet = sumet_;
  elongit = 0.0;
  signif_dxx = signif_dyy = signif_dyx = signif_dxy = 0.;
}

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

Definition at line 49 of file MET.cc.

References corr, elongit, mps_fire::i, signif_dxx, signif_dxy, signif_dyx, signif_dyy, and sumet.

    : RecoCandidate(0, p4_, vtx_) {
  sumet = sumet_;
  elongit = 0.0;
  signif_dxx = signif_dyy = signif_dyx = signif_dxy = 0.;
  //-----------------------------------
  // Fill the vector containing the corrections (corr) with vector of
  // known corrections (corr_) passed in via the constructor.
  std::vector<CorrMETData>::const_iterator i;
  for (i = corr_.begin(); i != corr_.end(); i++) {
    corr.push_back(*i);
  }
}

Member Function Documentation

MET * MET::clone ( void  ) const

overridevirtual

returns a clone of the Candidate object

Reimplemented from reco::LeafCandidate.

Reimplemented in pat::MET.

Definition at line 64 of file MET.cc.

References MET().

{ return new MET(*this); }

std::vector< double > MET::dmEx

(

)

const

Definition at line 88 of file MET.cc.

References corr, and mps_fire::i.

Referenced by e_longitudinal().

                                  {
  std::vector<double> deltas;
  std::vector<CorrMETData>::const_iterator i;
  for (i = corr.begin(); i != corr.end(); i++) {
    deltas.push_back(i->mex);
  }
  return deltas;
}

std::vector< double > MET::dmEy

(

)

const

Definition at line 100 of file MET.cc.

References corr, and mps_fire::i.

Referenced by e_longitudinal().

                                  {
  std::vector<double> deltas;
  std::vector<CorrMETData>::const_iterator i;
  for (i = corr.begin(); i != corr.end(); i++) {
    deltas.push_back(i->mey);
  }
  return deltas;
}

std::vector< double > MET::dsumEt

(

)

const

Definition at line 112 of file MET.cc.

References corr, and mps_fire::i.

Referenced by pat::MET::PackedMETUncertainty::add(), e_longitudinal(), pat::MET::findMETTotalShift(), and pat::MET::PackedMETUncertainty::set().

                                    {
  std::vector<double> deltas;
  std::vector<CorrMETData>::const_iterator i;
  for (i = corr.begin(); i != corr.end(); i++) {
    deltas.push_back(i->sumet);
  }
  return deltas;
}

double reco::MET::e_longitudinal ( ) const

inline

Definition at line 59 of file MET.h.

References dmEx(), dmEy(), dsumEt(), and elongit.

{ return elongit; }

METCovMatrix MET::getSignificanceMatrix

(

void

)

const

Definition at line 123 of file MET.cc.

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

Referenced by pat::MET::MET(), mEtCorr(), NoPileUpPFMEtProducer::produce(), CorrectedPATMETProducer::produce(), and significance().

                                                  {
  METCovMatrix result;
  result(0, 0) = signif_dxx;
  result(0, 1) = signif_dxy;
  result(1, 0) = signif_dyx;
  result(1, 1) = signif_dyy;
  return result;
}

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

inline

Definition at line 66 of file MET.h.

References corr, getSignificanceMatrix(), makeMuonMisalignmentScenario::matrix, overlap(), and setSignificanceMatrix().

Referenced by Type1PFMET::run().

{ return corr; }

double reco::MET::mEtSig ( ) const

inline

Definition at line 54 of file MET.h.

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

Referenced by METTester::analyze(), and METAnalyzer::fillMonitorElement().

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

bool MET::overlap ( const Candidate &  ) const

overrideprivatevirtual

check overlap with another candidate

Implements reco::RecoCandidate.

Definition at line 134 of file MET.cc.

Referenced by mEtCorr().

{ return false; }

void MET::setSignificanceMatrix

(

const reco::METCovMatrix &

matrix

)

Definition at line 137 of file MET.cc.

References signif_dxx, signif_dxy, signif_dyx, and signif_dyy.

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

                                                            {
  signif_dxx = inmatrix(0, 0);
  signif_dxy = inmatrix(0, 1);
  signif_dyx = inmatrix(1, 0);
  signif_dyy = inmatrix(1, 1);
  return;
}

double MET::significance

(

)

const

Definition at line 68 of file MET.cc.

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

Referenced by tnp::BaseTreeFiller::init(), mEtSig(), and reco::CaloMET::metSignificance().

                               {
  if (signif_dxx == 0 && signif_dyy == 0 && signif_dxy == 0 && signif_dyx == 0)
    return -1;
  METCovMatrix metmat = getSignificanceMatrix();
  ROOT::Math::SVector<double, 2> metvec;
  metvec(0) = this->px();
  metvec(1) = this->py();
  double signif = -1;
  double det = 0;
  metmat.Det2(det);
  if (std::abs(det) > 0.000001) {
    metmat.Invert();
    signif = ROOT::Math::Dot(metvec, (metmat * metvec));
  }
  return signif;
}

double reco::MET::sumEt ( ) const

inline

Definition at line 52 of file MET.h.

References sumet.

Referenced by WenuPlots::analyze(), METTester::analyze(), BeamHaloAnalyzer::analyze(), GlobalHaloAlgo::Calculate(), PFMETBenchmark::calculateQuantities(), reco::GenMET::ChargedEMEt(), reco::PFMET::ChargedEMEt(), reco::GenMET::ChargedHadEt(), reco::PFMET::ChargedHadEt(), reco::PFMET::chargedHadronEt(), L1JetRecoTreeProducer::doCaloMet(), L1JetRecoTreeProducer::doCaloMetBE(), L1JetRecoTreeProducer::doPFMet(), reco::PFMET::electronEt(), METAnalyzer::fillMonitorElement(), MatchMETBenchmark::fillOne(), METBenchmark::fillOne(), PFMETMonitor::fillOne(), PFMETFilter::filter(), AddCorrectionsToGenericMET::getCorrectedCaloMET(), reco::GlobalHaloData::GetCorrectedCaloMET(), AddCorrectionsToGenericMET::getCorrectedMET(), AddCorrectionsToGenericMET::getCorrectedPFMET(), reco::PFMET::HFEMEt(), reco::PFMET::HFHadronEt(), tnp::BaseTreeFiller::init(), reco::GenMET::InvisibleEt(), reco::PFMET::muonEt(), reco::GenMET::MuonEt(), reco::PFMET::MuonEt(), reco::GenMET::NeutralEMEt(), reco::PFMET::NeutralEMEt(), reco::GenMET::NeutralHadEt(), reco::PFMET::NeutralHadEt(), reco::PFMET::neutralHadronEt(), reco::PFMET::photonEt(), DistortedMETProducer::produce(), L1TPFMetNoMuProducer::produce(), JetEnergyShift::produce(), pat::PATMETSlimmer::OneMETShift::readAndSet(), Type1PFMET::run(), pat::MET::setCorShift(), L1Analysis::L1AnalysisRecoMet::SetMet(), pat::MET::setUncShift(), pat::MET::shiftedSumEt(), pat::MET::shiftedSumEt_74x(), reco::PFMET::Type6Et(), reco::PFMET::Type7Et(), and pat::MET::uncorPhi().

{ return sumet; }

Member Data Documentation

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

private

Definition at line 81 of file MET.h.

Referenced by dmEx(), dmEy(), dsumEt(), MET(), and mEtCorr().

double reco::MET::elongit

private

Definition at line 75 of file MET.h.

Referenced by e_longitudinal(), and MET().

double reco::MET::signif_dxx

private

Definition at line 77 of file MET.h.

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

double reco::MET::signif_dxy

private

Definition at line 80 of file MET.h.

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

double reco::MET::signif_dyx

private

Definition at line 79 of file MET.h.

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

double reco::MET::signif_dyy

private

Definition at line 78 of file MET.h.

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

double reco::MET::sumet

private

Definition at line 74 of file MET.h.

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