#include <Candidate.h>

Inheritance diagram for reco::Candidate:

Classes
struct	daughter_iterator
Public Types
enum	{ dimension = 3 }
enum	{ size = dimension * (dimension + 1)/2 }
	matix size More...
typedef int	Charge
	electric charge type
typedef candidate::const_iterator	const_iterator
typedef math::Error< dimension > ::type	CovarianceMatrix
	covariance error matrix (3x3)
typedef unsigned int	index
	index type
typedef candidate::iterator	iterator
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector.
typedef math::XYZPoint	Point
	point in the space
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector.
typedef size_t	size_type
typedef math::XYZVector	Vector
	point in the space
Public Member Functions
virtual const_iterator	begin () const =0
	first daughter const_iterator
virtual iterator	begin ()=0
	first daughter iterator
template<typename S >
daughter_iterator< S >::type	beginFilter (const S &s) const
virtual Vector	boostToCM () const =0
	Candidate ()
	default constructor
virtual int	charge () const =0
	electric charge
virtual Candidate *	clone () const =0
	returns a clone of the Candidate object
virtual const Candidate *	daughter (size_type i) const =0
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode)
virtual Candidate *	daughter (size_type i)=0
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1
virtual Candidate *	daughter (const std::string &s)=0
	return daughter with a specified role name
virtual const Candidate *	daughter (const std::string &s) const =0
	return daughter with a specified role name
virtual const_iterator	end () const =0
	last daughter const_iterator
virtual iterator	end ()=0
	last daughter iterator
template<typename S >
daughter_iterator< S >::type	endFilter (const S &s) const
virtual double	energy () const =0
	energy
virtual double	et () const =0
	transverse energy
virtual double	eta () const =0
	momentum pseudorapidity
virtual void	fillVertexCovariance (CovarianceMatrix &v) const =0
template<typename T >
T	get () const
	get a component
template<typename T , typename Tag >
T	get () const
	get a component
template<typename T , typename Tag >
T	get (size_type i) const
	get a component
template<typename T >
T	get (size_type i) const
	get a component
virtual bool	hasMasterClone () const =0
virtual bool	hasMasterClonePtr () const =0
virtual bool	isCaloMuon () const =0
virtual bool	isConvertedPhoton () const =0
virtual bool	isElectron () const =0
virtual bool	isGlobalMuon () const =0
virtual bool	isJet () const =0
virtual bool	isMuon () const =0
virtual bool	isPhoton () const =0
virtual bool	isStandAloneMuon () const =0
virtual bool	isTrackerMuon () const =0
virtual bool	longLived () const =0
	is long lived?
virtual double	mass () const =0
	mass
virtual bool	massConstraint () const =0
	do mass constraint?
virtual double	massSqr () const =0
	mass squared
virtual const CandidateBaseRef &	masterClone () const =0
virtual const CandidatePtr &	masterClonePtr () const =0
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type
virtual Vector	momentum () const =0
	spatial momentum vector
virtual const Candidate *	mother (size_type i=0) const =0
	return pointer to mother
virtual double	mt () const =0
	transverse mass
virtual double	mtSqr () const =0
	transverse mass squared
template<typename T >
size_type	numberOf () const
	number of components
template<typename T , typename Tag >
size_type	numberOf () const
	number of components
virtual size_type	numberOfDaughters () const =0
	number of daughters
virtual size_type	numberOfMothers () const =0
	number of mothers (zero or one in most of but not all the cases)
virtual size_t	numberOfSourceCandidatePtrs () const =0
virtual double	p () const =0
	magnitude of momentum vector
virtual const LorentzVector &	p4 () const =0
	four-momentum Lorentz vector
virtual int	pdgId () const =0
	PDG identifier.
virtual double	phi () const =0
	momentum azimuthal angle
virtual const PolarLorentzVector &	polarP4 () const =0
	four-momentum Lorentz vector
virtual double	pt () const =0
	transverse momentum
virtual double	px () const =0
	x coordinate of momentum vector
virtual double	py () const =0
	y coordinate of momentum vector
virtual double	pz () const =0
	z coordinate of momentum vector
virtual double	rapidity () const =0
	rapidity
virtual void	setCharge (Charge q)=0
	set electric charge
virtual void	setLongLived ()=0
	set long lived flag
virtual void	setMass (double m)=0
	set particle mass
virtual void	setMassConstraint ()=0
	set mass constraint flag
virtual void	setP4 (const PolarLorentzVector &p4)=0
	set 4-momentum
virtual void	setP4 (const LorentzVector &p4)=0
	set 4-momentum
virtual void	setPdgId (int pdgId)=0
virtual void	setPz (double pz)=0
virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate.
virtual void	setStatus (int status)=0
	set status word
virtual void	setThreeCharge (Charge qx3)=0
	set electric charge
virtual void	setVertex (const Point &vertex)=0
	set vertex
virtual CandidatePtr	sourceCandidatePtr (size_type i) const
virtual int	status () const =0
	status word
virtual double	theta () const =0
	momentum polar angle
virtual int	threeCharge () const =0
	electric charge
virtual const Point &	vertex () const =0
	vertex position
virtual double	vertexChi2 () const =0
	chi-squares
virtual double	vertexCovariance (int i, int j) const =0
	(i, j)-th element of error matrix, i, j = 0, ... 2
virtual CovarianceMatrix	vertexCovariance () const
	fill SMatrix
virtual double	vertexNdof () const =0
virtual double	vertexNormalizedChi2 () const =0
	chi-squared divided by n.d.o.f.
virtual double	vx () const =0
	x coordinate of vertex position
virtual double	vy () const =0
	y coordinate of vertex position
virtual double	vz () const =0
	z coordinate of vertex position
virtual double	y () const =0
	rapidity
virtual	~Candidate ()
	destructor
Protected Member Functions
virtual bool	overlap (const Candidate &) const =0
	check overlap with another Candidate
Friends
class	::OverlapChecker
struct	component
class	ShallowCloneCandidate
class	ShallowClonePtrCandidate

Detailed Description

abstract interface for physics objects

Author:: Luca Lista (INFN), Benedikt Hegner (CERN)

Definition at line 29 of file Candidate.h.

Member Typedef Documentation

typedef int reco::Candidate::Charge

electric charge type

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 36 of file Candidate.h.

typedef candidate::const_iterator reco::Candidate::const_iterator

Definition at line 32 of file Candidate.h.

typedef math::Error<dimension>::type reco::Candidate::CovarianceMatrix

covariance error matrix (3x3)

Definition at line 48 of file Candidate.h.

typedef unsigned int reco::Candidate::index

index type

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 52 of file Candidate.h.

typedef candidate::iterator reco::Candidate::iterator

Definition at line 33 of file Candidate.h.

typedef math::XYZTLorentzVector reco::Candidate::LorentzVector

Lorentz vector.

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 38 of file Candidate.h.

typedef math::XYZPoint reco::Candidate::Point

point in the space

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 42 of file Candidate.h.

typedef math::PtEtaPhiMLorentzVector reco::Candidate::PolarLorentzVector

Lorentz vector.

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 40 of file Candidate.h.

typedef size_t reco::Candidate::size_type

Definition at line 31 of file Candidate.h.

typedef math::XYZVector reco::Candidate::Vector

point in the space

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 44 of file Candidate.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

dimension

Definition at line 46 of file Candidate.h.

{ dimension = 3 };

anonymous enum

matix size

Enumerator:

size

Definition at line 50 of file Candidate.h.

{ size = dimension * (dimension + 1)/2 };

Constructor & Destructor Documentation

reco::Candidate::Candidate ( ) [inline]

default constructor

Definition at line 55 of file Candidate.h.

Referenced by GeneratorTau::computeStableDecayProducts(), GeneratorTau::decayToPDGClassification(), and GeneratorTau::getLeadTrack().

{};

Candidate::~Candidate ( ) [virtual]

destructor

Definition at line 5 of file Candidate.cc.

{ }

Member Function Documentation

virtual const_iterator reco::Candidate::begin ( ) const [pure virtual]

virtual iterator reco::Candidate::begin ( ) [pure virtual]

first daughter iterator

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::CompositeRefCandidateT< GenParticleRefVector >.

template<typename S >

daughter_iterator<S>::type reco::Candidate::beginFilter ( const S & s ) const [inline]

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 252 of file Candidate.h.

References begin(), and end().

                                                                         {
      return boost::make_filter_iterator(s, begin(), end());
    }

virtual Vector reco::Candidate::boostToCM ( ) const [pure virtual]

boost vector to boost a Lorentz vector to the particle center of mass system

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual int reco::Candidate::charge ( ) const [pure virtual]

electric charge

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual Candidate* reco::Candidate::clone ( ) const [pure virtual]

returns a clone of the Candidate object

Implemented in reco::CandidateWithRef< Ref >, reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::NamedCompositeCandidate, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, reco::VertexCompositeCandidate, reco::Electron, reco::GsfElectron, reco::Photon, reco::SiStripElectron, reco::EcalIsolatedParticleCandidate, reco::IsolatedPixelTrackCandidate, reco::GenParticle, reco::BasicJet, reco::CaloJet, reco::GenJet, reco::JPTJet, reco::PFClusterJet, reco::PFJet, reco::TrackJet, l1extra::L1EmParticle, l1extra::L1EtMissParticle, l1extra::L1JetParticle, l1extra::L1MuonParticle, reco::MET, reco::Muon, reco::IsolatedPFCandidate, reco::PFCandidate, reco::PileUpPFCandidate, pat::CompositeCandidate, pat::Electron, pat::GenericParticle, pat::Jet, pat::MET, pat::Muon, pat::Particle, pat::PFParticle, pat::Photon, pat::Tau, reco::CaloRecHitCandidate, reco::RecoCaloTowerCandidate, reco::RecoCandidate, reco::RecoChargedCandidate, reco::RecoEcalCandidate, reco::RecoStandAloneMuonCandidate, reco::BaseTau, reco::CaloTau, reco::PFTau, reco::PFTauDecayMode, reco::CompositeRefCandidateT< GenParticleRefVector >, pat::Lepton< reco::BaseTau >, pat::Lepton< reco::GsfElectron >, and pat::Lepton< reco::Muon >.

Referenced by reco::CompositeCandidate::addDaughter(), reco::NamedCompositeCandidate::addDaughter(), and cloneDecayTree().

virtual const Candidate* reco::Candidate::daughter ( size_type i ) const [pure virtual]

return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode)

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::NamedCompositeCandidate, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, pat::Jet, and reco::CompositeRefCandidateT< GenParticleRefVector >.

virtual Candidate* reco::Candidate::daughter ( size_type i ) [pure virtual]

return daughter at a given position, i = 0, ... numberOfDaughters() - 1

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::NamedCompositeCandidate, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::CompositeRefCandidateT< GenParticleRefVector >.

virtual Candidate* reco::Candidate::daughter ( const std::string & s ) [pure virtual]

return daughter with a specified role name

Implemented in reco::CompositeCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::NamedCompositeCandidate.

virtual const Candidate* reco::Candidate::daughter ( const std::string & s ) const [pure virtual]

return daughter with a specified role name

Implemented in reco::CompositeCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::NamedCompositeCandidate.

virtual const_iterator reco::Candidate::end ( ) const [pure virtual]

virtual iterator reco::Candidate::end ( ) [pure virtual]

last daughter iterator

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::CompositeRefCandidateT< GenParticleRefVector >.

template<typename S >

daughter_iterator<S>::type reco::Candidate::endFilter ( const S & s ) const [inline]

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 256 of file Candidate.h.

References end().

                                                                       {
      return boost::make_filter_iterator(s, end(), end());
    }

virtual double reco::Candidate::energy ( ) const [pure virtual]

virtual double reco::Candidate::et ( ) const [pure virtual]

transverse energy

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by FWCandidateLegoProxyBuilder::build(), egammaisolation::EgammaTrackExtractor::deposit(), GenericBenchmark::fill(), GenericBenchmark::fillHistos(), PFMETFilter::filter(), PFFilter::filter(), myspace::greaterEt(), CandOneToManyDeltaRMatcher::produce(), and METAlgo::run().

virtual double reco::Candidate::eta ( ) const [pure virtual]

momentum pseudorapidity

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::CastorTower, and reco::EcalIsolatedParticleCandidate.

Referenced by GenericBenchmark::accepted(), DimuonStatistics::analyze(), MCAcceptanceAnalyzer::analyze(), ZHistogrammer::analyze(), ZMuMu_efficiencyAnalyzer::analyze(), MCEfficiencyAnalyzer::analyze(), ZMuMuEfficiency::analyze(), ZMuMu_vtxAnalyzer::analyze(), HLTMCtruth::analyze(), HypothesisAnalyzer::analyze(), gamma_radiative_analyzer::analyze(), ZMCHistogrammer::analyze(), ZMuMu_MCanalyzer::analyze(), TopValidation::analyze(), FWCandidateLegoProxyBuilder::build(), egammaisolation::EgammaTrackExtractor::deposit(), HICaloUtil::EcalEta(), HICaloUtil::EcalPhi(), GenericBenchmark::fill(), PFCandidateMonitor::fill(), PFJetMonitor::fill(), GenericBenchmark::fillHistos(), CandidateBenchmark::fillOne(), MatchCandidateBenchmark::fillOne(), PFCandidateMonitor::fillOne(), PFJetFilter::filter(), PFMETFilter::filter(), ZToMuMuFilter::filter(), PFFilter::filter(), HLTMuonValidator::findMatches(), HiGammaJetSignalDef::getDeltaR(), PhotonTkIsolation::getIso(), ZMuMuPerformances::getParticleEta(), ZMuMu_vtxAnalyzer::getParticleEta(), ZMuMu_MCanalyzer::getParticleEta(), ZMuMuEfficiency::getParticleEta(), ZMuMu_efficiencyAnalyzer::getParticleEta(), Match::operator()(), ZSelector::operator()(), operator<<(), HLTmmkFilter::overlap(), HLTmmkkFilter::overlap(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), TtEvent::printParticle(), CandOneToManyDeltaRMatcher::produce(), CastorFastTowerProducer::produce(), ZMuMuUserDataOneTrack::produce(), ZMuMuUserData::produce(), ZToLLEdmNtupleDumper::produce(), CastorFastClusterProducer::produce(), and TrackingRegionsFromBeamSpotAndL2Tau::regions().

virtual void reco::Candidate::fillVertexCovariance ( CovarianceMatrix & v ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::VertexCompositeCandidate.

Referenced by vertexCovariance().

template<typename T , typename Tag >

T reco::Candidate::get ( void ) const [inline]

get a component

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 221 of file Candidate.h.

References edm::RefToBase< T >::get(), hasMasterClone(), and masterClone().

                                                     { 
      if ( hasMasterClone() ) return masterClone()->get<T, Tag>();
      else return reco::get<T, Tag>( * this ); 
    }

template<typename T >

T reco::Candidate::get ( size_type i ) const [inline]

get a component

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 226 of file Candidate.h.

References edm::RefToBase< T >::get(), hasMasterClone(), i, and masterClone().

                                                    { 
      if ( hasMasterClone() ) return masterClone()->get<T>( i );
      else return reco::get<T>( * this, i ); 
    }

template<typename T , typename Tag >

T reco::Candidate::get ( size_type i ) const [inline]

get a component

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 231 of file Candidate.h.

References edm::RefToBase< T >::get(), hasMasterClone(), i, and masterClone().

                                                                  { 
      if ( hasMasterClone() ) return masterClone()->get<T, Tag>( i );
      else return reco::get<T, Tag>( * this, i ); 
    }

template<typename T >

T reco::Candidate::get ( void ) const [inline]

get a component

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 216 of file Candidate.h.

References edm::RefToBase< T >::get(), hasMasterClone(), and masterClone().

Referenced by dimuonHLTFilterCheck::analyze(), ZMuMuPerformances::analyze(), ZMuMuSaMassHistogram::analyze(), egammaisolation::EgammaHcalExtractor::deposit(), egammaisolation::EgammaRecHitExtractor::deposit(), egammaisolation::EgammaTowerExtractor::deposit(), egammaisolation::EgammaEcalExtractor::deposit(), ZGlobalVsSAIsolationAnalyzer::evaluate(), EgammaEcalIsolation::getEcalEtSum(), EgammaHcalIsolation::getHcalESum(), EgammaHcalIsolation::getHcalESumDepth1(), EgammaHcalIsolation::getHcalESumDepth2(), EgammaHcalIsolation::getHcalEtSum(), EgammaHcalIsolation::getHcalEtSumDepth1(), EgammaHcalIsolation::getHcalEtSumDepth2(), EgammaRecHitIsolation::getSum_(), EgammaTowerIsolation::getTowerESum(), EgammaTowerIsolation::getTowerEtSum(), ZMuMuAnalyzer_cynematics::isContained(), JetMaker::makeSpecific(), ZMuMuOverlap::operator()(), ZMuMuUserData::produce(), ZToLLEdmNtupleDumper::produce(), and CandMassKinFitter::set().

                                       { 
      if ( hasMasterClone() ) return masterClone()->get<T>();
      else return reco::get<T>( * this ); 
    }

virtual bool reco::Candidate::hasMasterClone ( ) const [pure virtual]

returns true if this candidate has a reference to a master clone. This only happens if the concrete Candidate type is ShallowCloneCandidate

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::ShallowCloneCandidate.

Referenced by PFCandCommonVertexFitterBase::fill(), reco::GenJet::genParticle(), get(), JetMaker::makeSpecific(), numberOf(), OverlapChecker::operator()(), FastCandMatcher< C >::operator()(), ZToMuMuIsolationSelector< Isolator >::operator()(), CandMatcherBase< C1, C2 >::operator()(), ZToMuMuIsoDepositSelector< Isolator >::operator()(), reco::utilsNew::CandMatcher< C >::operator[](), reco::PFTauDecayMode::pfMasterClones(), and ZToLLEdmNtupleDumper::produce().

virtual bool reco::Candidate::hasMasterClonePtr ( ) const [pure virtual]

returns true if this candidate has a ptr to a master clone. This only happens if the concrete Candidate type is ShallowClonePtrCandidate

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::ShallowClonePtrCandidate.

virtual bool reco::Candidate::isCaloMuon ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Muon.

virtual bool reco::Candidate::isConvertedPhoton ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, and reco::ShallowClonePtrCandidate.

virtual bool reco::Candidate::isElectron ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, reco::Electron, reco::GsfElectron, and reco::SiStripElectron.

Referenced by egammaisolation::EgammaTrackExtractor::deposit().

virtual bool reco::Candidate::isGlobalMuon ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Muon.

Referenced by GlbMuQualityCutsAnalysis::analyze(), ZMuMu_Radiative_analyzer::analyze(), dimuonHLTFilterCheck::nDimuonsByType(), modules::ZHLTMatchFilter::operator()(), and ZGoldenFilter::operator()().

virtual bool reco::Candidate::isJet ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Jet.

virtual bool reco::Candidate::isMuon ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Muon.

virtual bool reco::Candidate::isPhoton ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Photon.

virtual bool reco::Candidate::isStandAloneMuon ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Muon.

Referenced by GlbMuQualityCutsAnalysis::analyze(), dimuonHLTFilterCheck::nDimuonsByType(), modules::ZHLTMatchFilter::operator()(), and ZGoldenFilter::operator()().

virtual bool reco::Candidate::isTrackerMuon ( ) const [pure virtual]

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::Muon.

Referenced by GlbMuQualityCutsAnalysis::analyze(), dimuonHLTFilterCheck::nDimuonsByType(), and modules::ZHLTMatchFilter::operator()().

virtual bool reco::Candidate::longLived ( ) const [pure virtual]

is long lived?

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by CandKinematicVertexFitter::set().

virtual double reco::Candidate::mass ( ) const [pure virtual]

mass

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual bool reco::Candidate::massConstraint ( ) const [pure virtual]

do mass constraint?

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual double reco::Candidate::massSqr ( ) const [pure virtual]

mass squared

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual const CandidateBaseRef& reco::Candidate::masterClone ( ) const [pure virtual]

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowCloneCandidate

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::ShallowCloneCandidate.

virtual const CandidatePtr& reco::Candidate::masterClonePtr ( ) const [pure virtual]

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowClonePtrCandidate

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::ShallowClonePtrCandidate.

template<typename Ref >

Ref reco::Candidate::masterRef ( ) const [inline]

cast master clone reference to a concrete type

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 213 of file Candidate.h.

References masterClone().

{ return masterClone().template castTo<Ref>(); }

virtual Vector reco::Candidate::momentum ( ) const [pure virtual]

spatial momentum vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by reco::isodeposit::IsoDepositExtractor::deposit(), reco::isodeposit::IsoDepositExtractor::deposits(), reco::Jet::detectorP4(), PFTauDiscriminants::MainTrackAngle::doComputation(), PFTauDiscriminants::TrackAngle::doComputation(), PFTauDiscriminants::PiZeroAngle::doComputation(), PFTauDiscriminants::ChargedOutlierAngle::doComputation(), PFTauDiscriminants::NeutralOutlierAngle::doComputation(), PFTauDiscriminants::OutlierAngle::doComputation(), CandIsoDepositProducer::extractTrack(), PhotonTkIsolation::getIso(), reco::Jet::physicsP4(), TauRegionalPixelSeedGenerator::regions(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), and PixelUnpackingRegions::run().

virtual const Candidate* reco::Candidate::mother ( size_type i = 0 ) const [pure virtual]

return pointer to mother

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::CompositeRefCandidateT< GenParticleRefVector >.

Referenced by ErsatzMEt::analyze(), ZMuPtScaleAnalyzer::analyze(), ElectronMcSignalValidator::analyze(), zPdfUnc::analyze(), EWKSystUnc::analyze(), ZLONLOHistogrammer::analyze(), myFastSimVal::analyze(), GsfElectronMCAnalyzer::analyze(), ParticleDecayDrawer::analyze(), FlavorHistoryProducer::getAncestors(), CandMCTagUtils::getAncestors(), HeavyFlavorValidation::getMotherId(), McSelector::isSelected(), ZMuMuIsolationAnalyzer::muTag(), FastCandMatcher< C >::operator()(), and operator<<().

virtual double reco::Candidate::mt ( ) const [pure virtual]

transverse mass

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual double reco::Candidate::mtSqr ( ) const [pure virtual]

transverse mass squared

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

template<typename T >

size_type reco::Candidate::numberOf ( ) const [inline]

number of components

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 236 of file Candidate.h.

References hasMasterClone(), and masterClone().

                                                    { 
      if ( hasMasterClone() ) return masterClone()->numberOf<T>();
      else return reco::numberOf<T>( * this ); 
    }

template<typename T , typename Tag >

size_type reco::Candidate::numberOf ( ) const [inline]

number of components

Reimplemented in reco::LeafCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::LeafRefCandidateT< T >.

Definition at line 241 of file Candidate.h.

References hasMasterClone(), and masterClone().

                                                                  { 
      if ( hasMasterClone() ) return masterClone()->numberOf<T, Tag>();
      else return reco::numberOf<T, Tag>( * this ); 
    }

virtual size_type reco::Candidate::numberOfDaughters ( ) const [pure virtual]

number of daughters

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, pat::Jet, and reco::CompositeRefCandidateT< GenParticleRefVector >.

virtual size_type reco::Candidate::numberOfMothers ( ) const [pure virtual]

number of mothers (zero or one in most of but not all the cases)

Implemented in reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and reco::CompositeRefCandidateT< GenParticleRefVector >.

Referenced by ZMuPtScaleAnalyzer::analyze(), zPdfUnc::analyze(), ZLONLOHistogrammer::analyze(), EWKSystUnc::analyze(), FlavorHistoryProducer::getAncestors(), CandMCTagUtils::getAncestors(), FastCandMatcher< C >::operator()(), operator<<(), and FlavorHistoryProducer::produce().

virtual size_t reco::Candidate::numberOfSourceCandidatePtrs ( ) const [pure virtual]

return the number of source Candidates ( the candidates used to construct this Candidate)

Implemented in reco::CompositePtrCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::PFCandidate, pat::Electron, pat::Muon, and reco::PFTau.

Referenced by reco::PFCandidate::overlap().

virtual bool reco::Candidate::overlap ( const Candidate & ) const [protected, pure virtual]

check overlap with another Candidate

Implemented in reco::CandidateWithRef< Ref >, reco::CompositeCandidate, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::CompositeRefCandidateT< D >, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, reco::Electron, reco::GsfElectron, reco::Photon, reco::SiStripElectron, reco::IsolatedPixelTrackCandidate, reco::GenParticle, reco::BasicJet, reco::CaloJet, reco::GenJet, reco::JPTJet, reco::PFClusterJet, reco::PFJet, reco::TrackJet, reco::CaloMET, reco::GenMET, reco::MET, reco::Muon, reco::PFCandidate, reco::CaloRecHitCandidate, reco::RecoCaloTowerCandidate, reco::RecoCandidate, reco::RecoChargedCandidate, reco::RecoEcalCandidate, reco::RecoStandAloneMuonCandidate, reco::BaseTau, reco::CaloTau, reco::PFTau, and reco::CompositeRefCandidateT< GenParticleRefVector >.

Referenced by OverlapChecker::operator()().

virtual double reco::Candidate::p ( ) const [pure virtual]

magnitude of momentum vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual const LorentzVector& reco::Candidate::p4 ( ) const [pure virtual]

four-momentum Lorentz vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by ZHistogrammer::analyze(), MCAcceptanceAnalyzer::analyze(), ErsatzMEt::analyze(), myFastSimVal::analyze(), ZMCHistogrammer::analyze(), JetCharge::charge(), HiggsDQM::DistancePhi(), PFTauDiscriminants::Dalitz::doComputation(), PFTauDiscriminants::OutlierSumPt::doComputation(), PFTauDiscriminants::OutlierMass::doComputation(), PFTauDiscriminants::InvariantMass::doComputation(), JetPartonMatcher::fillAlgoritDefinition(), JetPartonMatcher::fillPhysicsDefinition(), reco::modules::JetFlavourIdentifier::findCandidates(), FlavorHistoryProducer::getClosestJet(), ZMuMuEfficiency::getParticleP4(), ZMuMu_efficiencyAnalyzer::getParticleP4(), ZMuMu_MCanalyzer::getParticleP4(), ZMuMu_vtxAnalyzer::getParticleP4(), ZMuMuPerformances::getParticleP4(), helicityAngle(), fftjetcms::FFTJetInterface::loadInputCollection(), ZSelector::operator()(), reco::LeafCandidate::overlap(), reco::LeafRefCandidateT< T >::overlap(), CandOneToManyDeltaRMatcher::produce(), PFRecoTauDecayModeDeterminator::produce(), L1HLTJetsMatching::produce(), PFJetsMatchedToFilteredCaloJetsProducer::produce(), AddFourMomenta::set(), ApplyEnergyCorrection::set(), Booster::set(), CandMassKinFitter::set(), and pat::DiObjectProxy::totalP4().

virtual int reco::Candidate::pdgId ( ) const [pure virtual]

PDG identifier.

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual double reco::Candidate::phi ( ) const [pure virtual]

momentum azimuthal angle

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::CastorTower, reco::EcalIsolatedParticleCandidate, and pat::MHT.

Referenced by fireworks::addStraightLineSegment(), ZHistogrammer::analyze(), HLTMCtruth::analyze(), ZMCHistogrammer::analyze(), FWCandidateLegoProxyBuilder::build(), CaloMETAnalyzer::computeEmHaMET(), pat::DiObjectProxy::deltaPhi(), egammaisolation::EgammaTrackExtractor::deposit(), HICaloUtil::EcalPhi(), GenericBenchmark::fill(), PFCandidateMonitor::fill(), PFJetMonitor::fill(), GenericBenchmark::fillHistos(), CandidateBenchmark::fillOne(), MatchCandidateBenchmark::fillOne(), PFCandidateMonitor::fillOne(), PFJetFilter::filter(), PFMETFilter::filter(), PFFilter::filter(), HLTMuonValidator::findMatches(), HiGammaJetSignalDef::getDeltaPhi(), HiGammaJetSignalDef::getDeltaR(), ZMuMuEfficiency::getParticlePhi(), ZMuMu_efficiencyAnalyzer::getParticlePhi(), ZMuMu_vtxAnalyzer::getParticlePhi(), ZMuMu_MCanalyzer::getParticlePhi(), ZMuMuPerformances::getParticlePhi(), Match::operator()(), Balance::operator()(), operator<<(), HLTmmkFilter::overlap(), HLTmmkkFilter::overlap(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), TtEvent::printParticle(), CandOneToManyDeltaRMatcher::produce(), CastorFastTowerProducer::produce(), ZMuMuUserDataOneTrack::produce(), ZMuMuUserData::produce(), ZToLLEdmNtupleDumper::produce(), CastorFastClusterProducer::produce(), FSRWeightProducer::produce(), METAlgo::run(), and CaloMETAnalyzer::validateMET().

virtual const PolarLorentzVector& reco::Candidate::polarP4 ( ) const [pure virtual]

four-momentum Lorentz vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by ZMuMuSaMassHistogram::analyze(), pat::GenericParticle::fillInFrom(), ZMuMuUserData::produce(), and ZToLLEdmNtupleDumper::produce().

virtual double reco::Candidate::pt ( ) const [pure virtual]

transverse momentum

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::SiStripElectron.

virtual double reco::Candidate::px ( ) const [pure virtual]

x coordinate of momentum vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by FWInvMassDialog::Calculate(), GenericBenchmark::fill(), GenericBenchmark::fillHistos(), PFMETFilter::filter(), PlotMakerL1::invariantMass(), PlotMakerReco::invariantMass(), fireworks::prepareCandidate(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), and PropagateToMuon::startingState().

virtual double reco::Candidate::py ( ) const [pure virtual]

y coordinate of momentum vector

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by FWInvMassDialog::Calculate(), GenericBenchmark::fill(), GenericBenchmark::fillHistos(), PFMETFilter::filter(), PlotMakerL1::invariantMass(), PlotMakerReco::invariantMass(), fireworks::prepareCandidate(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), and PropagateToMuon::startingState().

virtual double reco::Candidate::pz ( ) const [pure virtual]

z coordinate of momentum vector

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::SiStripElectron.

Referenced by FWInvMassDialog::Calculate(), PlotMakerL1::invariantMass(), PlotMakerReco::invariantMass(), fireworks::prepareCandidate(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), and PropagateToMuon::startingState().

virtual double reco::Candidate::rapidity ( ) const [pure virtual]

rapidity

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by ZHistogrammer::analyze(), ZMCHistogrammer::analyze(), ZMuMuUserDataOneTrack::produce(), ZMuMuUserData::produce(), and ZToLLEdmNtupleDumper::produce().

virtual void reco::Candidate::setCharge ( Charge q ) [pure virtual]

set electric charge

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by AddFourMomenta::set().

virtual void reco::Candidate::setLongLived ( ) [pure virtual]

set long lived flag

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setMass ( double m ) [pure virtual]

set particle mass

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by PFRecoTauDecayModeDeterminator::produce().

virtual void reco::Candidate::setMassConstraint ( ) [pure virtual]

set mass constraint flag

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setP4 ( const PolarLorentzVector & p4 ) [pure virtual]

set 4-momentum

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setP4 ( const LorentzVector & p4 ) [pure virtual]

set 4-momentum

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by CandCommonVertexFitterBase::set(), CandKinematicVertexFitter::set(), AddFourMomenta::set(), ApplyEnergyCorrection::set(), PFCandCommonVertexFitterBase::set(), Booster::set(), and CandMassKinFitter::set().

virtual void reco::Candidate::setPdgId ( int pdgId ) [pure virtual]

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setPz ( double pz ) [pure virtual]

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setSourceCandidatePtr ( const CandidatePtr & ptr ) [inline, virtual]

Set the ptr to the source Candidate.

necessary, to allow a parallel treatment of all candidates in PF2PAT. Does nothing for most Candidate classes, including CompositePtrCandidates, where the source information is in fact the collection of ptrs to daughters. For non-Composite Candidates, this function can be used to set the ptr to the source of the Candidate, which will allow to keep track of the reconstruction history.

Definition at line 181 of file Candidate.h.

{};

virtual void reco::Candidate::setStatus ( int status ) [pure virtual]

set status word

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setThreeCharge ( Charge qx3 ) [pure virtual]

set electric charge

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual void reco::Candidate::setVertex ( const Point & vertex ) [pure virtual]

set vertex

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::Photon.

Referenced by CandCommonVertexFitterBase::set(), CandKinematicVertexFitter::set(), and PFCandCommonVertexFitterBase::set().

virtual CandidatePtr reco::Candidate::sourceCandidatePtr ( size_type i ) const [inline, virtual]

return a Ptr to one of the source Candidates ( the candidates used to construct this Candidate)

Reimplemented in reco::CompositePtrCandidate, reco::LeafCandidate, reco::LeafRefCandidateT< T >, reco::PFCandidate, pat::Electron, pat::Muon, and reco::PFTau.

Definition at line 169 of file Candidate.h.

Referenced by reco::PFCandidate::overlap().

                                                                 {
      return CandidatePtr();
    }

virtual int reco::Candidate::status ( ) const [pure virtual]

status word

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual double reco::Candidate::theta ( ) const [pure virtual]

momentum polar angle

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Referenced by fireworks::addStraightLineSegment(), ZHistogrammer::analyze(), ZMCHistogrammer::analyze(), CaloMETAnalyzer::computeEmHaMET(), FSRWeightProducer::produce(), METAlgo::run(), and CaloMETAnalyzer::validateMET().

virtual int reco::Candidate::threeCharge ( ) const [pure virtual]

electric charge

Implemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

virtual const Point& reco::Candidate::vertex ( ) const [pure virtual]

vertex position

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::PFCandidate.

Referenced by pat::helper::VertexingHelper::associate(), egammaisolation::EgammaTrackExtractor::deposit(), reco::isodeposit::IsoDepositExtractor::deposit(), reco::isodeposit::IsoDepositExtractor::deposits(), HICaloUtil::EcalEta(), HICaloUtil::EcalPhi(), CandIsoDepositProducer::extractTrack(), pat::GenericParticle::fillInFrom(), pat::PATSingleVertexSelector::filter_(), PhotonTkIsolation::getIso(), pat::VertexAssociationSelector::operator()(), reco::LeafCandidate::overlap(), reco::LeafRefCandidateT< T >::overlap(), fireworks::prepareCandidate(), and pat::VertexAssociationSelector::simpleAssociation().

virtual double reco::Candidate::vertexChi2 ( ) const [pure virtual]

chi-squares

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::VertexCompositeCandidate.

Referenced by pat::PATSingleVertexSelector::filter_().

virtual CovarianceMatrix reco::Candidate::vertexCovariance ( ) const [inline, virtual]

fill SMatrix

Reimplemented in reco::LeafCandidate, and reco::LeafRefCandidateT< T >.

Definition at line 197 of file Candidate.h.

References fillVertexCovariance(), and m.

{ CovarianceMatrix m; fillVertexCovariance(m); return m; }  //TODO

virtual double reco::Candidate::vertexCovariance	(	int	i,
		int	j
	)		const `[pure virtual]`

(i, j)-th element of error matrix, i, j = 0, ... 2

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::VertexCompositeCandidate.

Referenced by pat::PATSingleVertexSelector::filter_().

virtual double reco::Candidate::vertexNdof ( ) const [pure virtual]

Number of degrees of freedom Meant to be Double32_t for soft-assignment fitters: tracks may contribute to the vertex with fractional weights. The ndof is then = to the sum of the track weights. see e.g. CMS NOTE-2006/032, CMS NOTE-2004/002

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::VertexCompositeCandidate.

Referenced by pat::PATSingleVertexSelector::filter_().

virtual double reco::Candidate::vertexNormalizedChi2 ( ) const [pure virtual]

chi-squared divided by n.d.o.f.

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::VertexCompositeCandidate.

Referenced by ZToLLEdmNtupleDumper::produce().

virtual double reco::Candidate::vx ( ) const [pure virtual]

x coordinate of vertex position

Implemented in reco::LeafCandidate, reco::LeafRefCandidateT< T >, and reco::PFCandidate.

Referenced by FBaseSimEvent::addParticles(), HLTMCtruth::analyze(), myFastSimVal::analyze(), pat::VertexAssociationSelector::operator()(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), and PropagateToMuon::startingState().

virtual double reco::Candidate::vy ( ) const [pure virtual]

y coordinate of vertex position