reco::RecoCandidate Class Reference

#include <RecoCandidate.h>

Inheritance diagram for reco::RecoCandidate:

Public Types
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...

Public Member Functions
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...
bool	overlap (const Candidate &) const override=0
	check overlap with another candidate 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...

Protected Member Functions
template<typename R >
bool	checkOverlap (const R &r1, const R &r2) const
	check if two components overlap More...

Friends
template<typename , typename , typename >
struct	component

Detailed Description

base class for all Reco Candidates

Author

Luca Lista, INFN

Definition at line 20 of file RecoCandidate.h.

Member Enumeration Documentation

TrackType

enum reco::RecoCandidate::TrackType

track type

Enumerator
noTrackType
recoTrackType
gsfTrackType

Definition at line 56 of file RecoCandidate.h.

{ noTrackType, recoTrackType, gsfTrackType };

Constructor & Destructor Documentation

RecoCandidate() [1/2]

reco::RecoCandidate::RecoCandidate ( )

inline

default constructor

Definition at line 23 of file RecoCandidate.h.

: LeafCandidate() {}

RecoCandidate() [2/2]

template<typename P4 >

reco::RecoCandidate::RecoCandidate ( Charge  q, const P4 &  p4, const Point &  vtx = Point(0, 0, 0), int  pdgId = 0, int  status = 0  )

inline

constructor from values

Definition at line 26 of file RecoCandidate.h.

        : LeafCandidate(q, p4, vtx, pdgId, status) {}

~RecoCandidate()

RecoCandidate::~RecoCandidate ( )

override

destructor

Definition at line 7 of file RecoCandidate.cc.

{}

Member Function Documentation

bestTrack()

const Track * RecoCandidate::bestTrack ( ) const

overridevirtual

best track pointer

Reimplemented from reco::Candidate.

Definition at line 29 of file RecoCandidate.cc.

References combinedMuon(), edm::Ref< C, T, F >::get(), gsfTrack(), edm::Ref< C, T, F >::isNonnull(), standAloneMuon(), and track().

Referenced by dxyError(), dzError(), CandIsoDepositProducer::extractTrack(), and Muon.Muon::ptErr().

                                            {
  TrackRef muRef = combinedMuon();
  if (muRef.isNonnull())
    return muRef.get();
  TrackRef trkRef = track();
  if (trkRef.isNonnull())
    return trkRef.get();
  GsfTrackRef gsfTrkRef = gsfTrack();
  if (gsfTrkRef.isNonnull())
    return gsfTrkRef.get();
  TrackRef staRef = standAloneMuon();
  if (staRef.isNonnull())
    return staRef.get();
  return nullptr;
}

bestTrackRef()

TrackBaseRef RecoCandidate::bestTrackRef ( ) const

virtual

best track RefToBase

Reimplemented in reco::Muon.

Definition at line 45 of file RecoCandidate.cc.

References combinedMuon(), gsfTrack(), edm::Ref< C, T, F >::isNonnull(), standAloneMuon(), and track().

Referenced by pat::helper::VertexingHelper::getTrack_().

                                               {
  TrackRef muRef = combinedMuon();
  if (muRef.isNonnull())
    return TrackBaseRef(muRef);
  TrackRef trkRef = track();
  if (trkRef.isNonnull())
    return TrackBaseRef(trkRef);
  GsfTrackRef gsfTrkRef = gsfTrack();
  if (gsfTrkRef.isNonnull())
    return TrackBaseRef(gsfTrkRef);
  TrackRef staRef = standAloneMuon();
  if (staRef.isNonnull())
    return TrackBaseRef(staRef);
  return TrackBaseRef();
}

bestTrackType()

RecoCandidate::TrackType RecoCandidate::bestTrackType ( ) const

virtual

track type

Definition at line 61 of file RecoCandidate.cc.

References combinedMuon(), gsfTrack(), gsfTrackType, noTrackType, recoTrackType, and track().

                                                          {
  if (combinedMuon().isNonnull())
    return recoTrackType;
  if (track().isNonnull())
    return recoTrackType;
  if (gsfTrack().isNonnull())
    return gsfTrackType;
  return noTrackType;
}

caloTower()

CaloTowerRef RecoCandidate::caloTower ( ) const

virtual

reference to a CaloTower

Reimplemented in pat::GenericParticle, and reco::RecoCaloTowerCandidate.

Definition at line 27 of file RecoCandidate.cc.

Referenced by pat::GenericParticle::overlap().

{ return CaloTowerRef(); }

checkOverlap()

template<typename R >

bool reco::RecoCandidate::checkOverlap ( const R &  r1, const R &  r2  ) const

inlineprotected

check if two components overlap

Definition at line 67 of file RecoCandidate.h.

References diffTwoXMLs::r2.

Referenced by reco::RecoCaloTowerCandidate::overlap(), reco::RecoEcalCandidate::overlap(), reco::RecoStandAloneMuonCandidate::overlap(), reco::RecoChargedCandidate::overlap(), reco::BaseTau::overlap(), reco::SiStripElectron::overlap(), reco::HcalIsolatedTrackCandidate::overlap(), reco::GsfElectron::overlap(), reco::IsolatedPixelTrackCandidate::overlap(), and reco::PFTau::overlap().

                                                      {
      return (!r1.isNull() && !r2.isNull() && r1 == r2);
    }

clone()

RecoCandidate * RecoCandidate::clone ( void  ) const

overridevirtual

returns a clone of the Candidate object

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::PFTau, pat::Lepton< reco::BaseTau >, pat::Lepton< reco::GsfElectron >, pat::Lepton< reco::Muon >, reco::RecoChargedCandidate, reco::RecoEcalCandidate, reco::RecoStandAloneMuonCandidate, and reco::BaseTau.

Definition at line 9 of file RecoCandidate.cc.

References Exception.

                                          {
  throw cms::Exception("LogicError", "reco::RecoCandidate is abstract, so it's clone() method can't be implemented.\n");
}

combinedMuon()

TrackRef RecoCandidate::combinedMuon ( ) const

virtual

reference to a stand-alone muon Track

Reimplemented in pat::GenericParticle, pat::Muon, and reco::Muon.

Definition at line 23 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), bestTrackType(), CandIsoDepositProducer::extractTrack(), MatcherUsingTracksAlgorithm::getTrack(), pat::GenericParticle::overlap(), and PropagateToMuon::startingState().

{ return TrackRef(); }

dxyError()

float RecoCandidate::dxyError ( ) const

overridevirtual

uncertainty on dxy

Reimplemented from reco::Candidate.

Definition at line 78 of file RecoCandidate.cc.

References bestTrack(), and reco::TrackBase::dxyError().

                                    {
  const Track* tr = bestTrack();
  if (tr != nullptr)
    return tr->dxyError();
  else
    return 0;
}

dzError()

float RecoCandidate::dzError ( ) const

overridevirtual

uncertainty on dz

Reimplemented from reco::Candidate.

Definition at line 71 of file RecoCandidate.cc.

References bestTrack(), and reco::TrackBase::dzError().

                                   {
  const Track* tr = bestTrack();
  if (tr != nullptr)
    return tr->dzError();
  else
    return 0;
}

gsfTrack()

GsfTrackRef RecoCandidate::gsfTrack ( ) const

virtual

reference to a GsfTrack

Reimplemented in reco::GsfElectron, pat::GenericParticle, pat::Electron, and reco::Electron.

Definition at line 19 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), bestTrackType(), Electron.Electron::dxy(), Electron.Electron::dz(), Electron.Electron::edxy(), Electron.Electron::edz(), CandIsoDepositProducer::extractTrack(), Electron.Electron::lostInner(), and pat::GenericParticle::overlap().

{ return GsfTrackRef(); }

numberOfTracks()

size_t RecoCandidate::numberOfTracks ( ) const

virtual

number of multiple Tracks

Reimplemented in pat::GenericParticle.

Definition at line 17 of file RecoCandidate.cc.

{ return 0; }

overlap()

bool reco::RecoCandidate::overlap ( const Candidate &  ) const

overridepure virtual

check overlap with another candidate

Reimplemented from reco::LeafCandidate.

Implemented in reco::Photon, reco::Muon, reco::PFTau, reco::IsolatedPixelTrackCandidate, reco::GsfElectron, reco::HcalIsolatedTrackCandidate, reco::SiStripElectron, reco::MET, reco::CaloMET, reco::GenMET, reco::Electron, reco::BaseTau, reco::RecoChargedCandidate, reco::RecoEcalCandidate, reco::RecoStandAloneMuonCandidate, and reco::RecoCaloTowerCandidate.

standAloneMuon()

TrackRef RecoCandidate::standAloneMuon ( ) const

virtual

reference to a stand-alone muon Track

Reimplemented in pat::GenericParticle, pat::Muon, reco::Muon, and reco::RecoStandAloneMuonCandidate.

Definition at line 21 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), CandIsoDepositProducer::extractTrack(), MatcherUsingTracksAlgorithm::getTrack(), pat::GenericParticle::overlap(), and PropagateToMuon::startingState().

{ return TrackRef(); }

superCluster()

SuperClusterRef RecoCandidate::superCluster ( ) const

virtual

reference to a SuperCluster

Reimplemented in reco::GsfElectron, pat::GenericParticle, reco::SiStripElectron, pat::Electron, pat::Photon, reco::Photon, reco::RecoEcalCandidate, and reco::Electron.

Definition at line 25 of file RecoCandidate.cc.

Referenced by PFCandIsolatorFromDeposits::SingleDeposit::compute(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), pat::GenericParticle::overlap(), and EgammaHLTTrackIsolation::photonIsolation().

{ return SuperClusterRef(); }

track() [1/2]

TrackRef RecoCandidate::track ( ) const

virtual

reference to a Track

Reimplemented in reco::IsolatedPixelTrackCandidate, pat::Electron, pat::Muon, reco::HcalIsolatedTrackCandidate, pat::GenericParticle, reco::Muon, reco::RecoChargedCandidate, and reco::Electron.

Definition at line 13 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), bestTrackType(), CandIsoDepositProducer::extractTrack(), MatcherUsingTracksAlgorithm::getTrack(), reco::BaseTau::overlap(), pat::GenericParticle::overlap(), reco::SiStripElectron::overlap(), reco::PFTau::overlap(), and PropagateToMuon::startingState().

{ return TrackRef(); }

track() [2/2]

TrackRef RecoCandidate::track ( size_t  ) const

virtual

reference to one of multiple Tracks

Reimplemented in pat::GenericParticle.

Definition at line 15 of file RecoCandidate.cc.

{ return TrackRef(); }

Friends And Related Function Documentation

component

template<typename , typename , typename >

friend struct component

friend

Definition at line 73 of file RecoCandidate.h.