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
virtual const Track *	bestTrack () const
	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...
virtual RecoCandidate *	clone () const
	returns a clone of the Candidate object More...
virtual reco::TrackRef	combinedMuon () const
	reference to a stand-alone muon Track More...
virtual float	dxyError () const
	uncertainty on dxy More...
virtual float	dzError () const
	uncertainty on dz More...
virtual reco::GsfTrackRef	gsfTrack () const
	reference to a GsfTrack More...
virtual size_t	numberOfTracks () const
	number of multiple Tracks More...
virtual bool	overlap (const Candidate &) const =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...
virtual	~RecoCandidate ()
	destructor More...
Public Member Functions inherited from reco::LeafCandidate
virtual Vector	boostToCM () const
virtual int	charge () const
	electric charge More...
void	construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
virtual const Candidate *	daughter (size_type) const
	return daughter at a given position (throws an exception) More...
virtual Candidate *	daughter (size_type)
	return daughter at a given position (throws an exception) More...
virtual Candidate *	daughter (const std::string &s)
	return daughter with a specified role name More...
virtual const Candidate *	daughter (const std::string &s) const
	return daughter with a specified role name More...
virtual double	energy () const
	energy More...
virtual double	et () const
	transverse energy More...
virtual double	et2 () const
	transverse energy squared (use this for cut!) More...
virtual double	eta () const
	momentum pseudorapidity More...
virtual void	fillVertexCovariance (CovarianceMatrix &v) const
	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...
virtual bool	hasMasterClone () const
virtual bool	hasMasterClonePtr () const
virtual bool	isCaloMuon () const
virtual bool	isConvertedPhoton () const
virtual bool	isElectron () const
virtual bool	isGlobalMuon () const
virtual bool	isJet () const
virtual bool	isMuon () const
virtual bool	isPhoton () const
virtual bool	isStandAloneMuon () const
virtual bool	isTrackerMuon () const
	LeafCandidate ()
	LeafCandidate (const Candidate &c)
template<typename... Args>
	LeafCandidate (Args &&...args)
	LeafCandidate (LeafCandidate &rh)
	LeafCandidate (LeafCandidate &&)=default
	LeafCandidate (LeafCandidate const &)=default
virtual bool	longLived () const
	is long lived? More...
virtual double	mass () const
	mass More...
virtual bool	massConstraint () const
	do mass constraint? More...
virtual double	massSqr () const
	mass squared More...
virtual const CandidateBaseRef &	masterClone () const
virtual const CandidatePtr &	masterClonePtr () const
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
virtual Vector	momentum () const
	spatial momentum vector More...
virtual const Candidate *	mother (size_type) const
	return mother at a given position (throws an exception) More...
virtual double	mt () const
	transverse mass More...
virtual double	mtSqr () const
	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...
virtual size_t	numberOfDaughters () const
	number of daughters More...
virtual size_t	numberOfMothers () const
	number of mothers More...
virtual size_t	numberOfSourceCandidatePtrs () const
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
virtual double	p () const
	magnitude of momentum vector More...
virtual const LorentzVector &	p4 () const
	four-momentum Lorentz vector More...
virtual int	pdgId () const
	PDG identifier. More...
virtual double	phi () const
	momentum azimuthal angle More...
virtual const PolarLorentzVector &	polarP4 () const
	four-momentum Lorentz vector More...
virtual double	pt () const
	transverse momentum More...
virtual double	px () const
	x coordinate of momentum vector More...
virtual double	py () const
	y coordinate of momentum vector More...
virtual double	pz () const
	z coordinate of momentum vector More...
virtual double	rapidity () const
	rapidity More...
virtual void	setCharge (Charge q)
	set electric charge More...
virtual void	setLongLived ()
virtual void	setMass (double m)
	set particle mass More...
virtual void	setMassConstraint ()
virtual void	setP4 (const LorentzVector &p4)
	set 4-momentum More...
virtual void	setP4 (const PolarLorentzVector &p4)
	set 4-momentum More...
virtual void	setPdgId (int pdgId)
virtual void	setPz (double pz)
virtual void	setStatus (int status)
	set status word More...
virtual void	setThreeCharge (Charge qx3)
	set electric charge More...
virtual void	setVertex (const Point &vertex)
	set vertex More...
virtual CandidatePtr	sourceCandidatePtr (size_type i) const
virtual int	status () const
	status word More...
virtual double	theta () const
	momentum polar angle More...
virtual int	threeCharge () const
	electric charge More...
virtual const Point &	vertex () const
	vertex position (overwritten by PF...) More...
virtual double	vertexChi2 () const
	chi-squares More...
virtual double	vertexCovariance (int i, int j) const
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
CovarianceMatrix	vertexCovariance () const
	return SMatrix More...
virtual double	vertexNdof () const
virtual double	vertexNormalizedChi2 () const
	chi-squared divided by n.d.o.f. More...
virtual double	vx () const
	x coordinate of vertex position More...
virtual double	vy () const
	y coordinate of vertex position More...
virtual double	vz () const
	z coordinate of vertex position More...
virtual double	y () const
	rapidity More...
virtual	~LeafCandidate ()
	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

enum reco::RecoCandidate::TrackType

track type

Enumerator
noTrackType
recoTrackType
gsfTrackType

Definition at line 57 of file RecoCandidate.h.

{ noTrackType, recoTrackType, gsfTrackType };

Constructor & Destructor Documentation

reco::RecoCandidate::RecoCandidate ( )

inline

default constructor

Definition at line 23 of file RecoCandidate.h.

: LeafCandidate() { }

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

virtual

destructor

Definition at line 7 of file RecoCandidate.cc.

{ }

Member Function Documentation

const Track * RecoCandidate::bestTrack ( ) const

virtual

best track pointer

Reimplemented from reco::Candidate.

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

Definition at line 45 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(), and CandIsoDepositProducer::extractTrack().

                                             {
  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 0;
}

TrackBaseRef RecoCandidate::bestTrackRef ( ) const

virtual

best track RefToBase

Reimplemented in reco::Muon.

Definition at line 61 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();
}

RecoCandidate::TrackType RecoCandidate::bestTrackType ( ) const

virtual

track type

Definition at line 74 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;
}

CaloTowerRef RecoCandidate::caloTower ( ) const

virtual

reference to a CaloTower

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

Definition at line 41 of file RecoCandidate.cc.

Referenced by reco::RecoCaloTowerCandidate::overlap(), and pat::GenericParticle::overlap().

                                            {
  return CaloTowerRef();
}

template<typename R >

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

inlineprotected

check if two components overlap

Definition at line 69 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::ME0Muon::overlap(), reco::CaloTau::overlap(), reco::HcalIsolatedTrackCandidate::overlap(), reco::SiStripElectron::overlap(), reco::IsolatedPixelTrackCandidate::overlap(), reco::GsfElectron::overlap(), and reco::PFTau::overlap().

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

RecoCandidate * RecoCandidate::clone ( void  ) const

virtual

returns a clone of the Candidate object

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::GsfElectron, reco::IsolatedPixelTrackCandidate, pat::Tau, reco::SiStripElectron, pat::Electron, pat::MET, pat::Muon, pat::Photon, reco::HcalIsolatedTrackCandidate, reco::PFTau, pat::GenericParticle, reco::MET, reco::Photon, pat::Lepton< reco::BaseTau >, pat::Lepton< reco::GsfElectron >, pat::Lepton< reco::Muon >, reco::Muon, reco::RecoChargedCandidate, reco::RecoEcalCandidate, reco::RecoStandAloneMuonCandidate, reco::RecoCaloTowerCandidate, reco::Electron, reco::BaseTau, and reco::CaloTau.

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");
}

TrackRef RecoCandidate::combinedMuon ( ) const

virtual

reference to a stand-alone muon Track

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

Definition at line 33 of file RecoCandidate.cc.

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

                                           {
  return TrackRef();
}

float RecoCandidate::dxyError ( ) const

virtual

uncertainty on dxy

Reimplemented from reco::Candidate.

Definition at line 92 of file RecoCandidate.cc.

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

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

float RecoCandidate::dzError ( ) const

virtual

uncertainty on dz

Reimplemented from reco::Candidate.

Definition at line 84 of file RecoCandidate.cc.

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

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

GsfTrackRef RecoCandidate::gsfTrack ( ) const

virtual

reference to a GsfTrack

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

Definition at line 25 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(), pat::GenericParticle::overlap(), and reco::GsfElectron::overlap().

                                          {
  return GsfTrackRef();
}

size_t RecoCandidate::numberOfTracks ( ) const

virtual

number of multiple Tracks

Reimplemented in pat::GenericParticle.

Definition at line 21 of file RecoCandidate.cc.

                                           {
  return 0;
}

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

pure virtual

check overlap with another candidate

Reimplemented from reco::LeafCandidate.

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

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 29 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), CandIsoDepositProducer::extractTrack(), MatcherUsingTracksAlgorithm::getTrack(), reco::RecoStandAloneMuonCandidate::overlap(), reco::RecoChargedCandidate::overlap(), pat::GenericParticle::overlap(), PropagateToMuon::startingState(), and MatcherByPullsAlgorithm::track().

                                             {
  return TrackRef();
}

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 37 of file RecoCandidate.cc.

Referenced by PFCandIsolatorFromDeposits::SingleDeposit::compute(), pat::helper::OverlapBySuperClusterSeed::fillOverlapsForItem(), EgammaHLTEcalIsolation::isolPtSum(), EgammaHLTHcalIsolationDoubleCone::isolPtSum(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), reco::RecoEcalCandidate::overlap(), pat::GenericParticle::overlap(), reco::SiStripElectron::overlap(), reco::GsfElectron::overlap(), and EgammaHLTTrackIsolation::photonIsolation().

                                                  {
  return SuperClusterRef();
}

TrackRef RecoCandidate::track ( ) const

virtual

reference to a Track

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

Definition at line 13 of file RecoCandidate.cc.

Referenced by bestTrack(), bestTrackRef(), bestTrackType(), CandIsoDepositProducer::extractTrack(), MatcherUsingTracksAlgorithm::getTrack(), reco::RecoStandAloneMuonCandidate::overlap(), reco::RecoChargedCandidate::overlap(), reco::BaseTau::overlap(), pat::GenericParticle::overlap(), reco::ME0Muon::overlap(), reco::CaloTau::overlap(), reco::HcalIsolatedTrackCandidate::overlap(), reco::SiStripElectron::overlap(), reco::IsolatedPixelTrackCandidate::overlap(), reco::PFTau::overlap(), PropagateToMuon::startingState(), and MatcherByPullsAlgorithm::track().

                                    {
  return TrackRef();
}

TrackRef RecoCandidate::track ( size_t  ) const

virtual

reference to one of multiple Tracks

Reimplemented in pat::GenericParticle.

Definition at line 17 of file RecoCandidate.cc.

                                            {
  return TrackRef();
}

Friends And Related Function Documentation

template<typename , typename , typename >

friend struct component

friend

Definition at line 74 of file RecoCandidate.h.