CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Member Functions | Friends
reco::Candidate Class Referenceabstract

#include <Candidate.h>

Inheritance diagram for reco::Candidate:
pat::PackedCandidate pat::PackedGenParticle reco::LeafCandidate CaloTower reco::CompositeRefCandidateT< GenParticleRefVector > l1extra::L1EmParticle l1extra::L1EtMissParticle l1extra::L1JetParticle l1extra::L1MuonParticle L1GObject L1MuKBMTrack l1t::HPSPFTau l1t::L1Candidate pat::IsolatedTrack pat::TriggerObject pat::PATObject< reco::LeafCandidate > reco::CaloRecHitCandidate reco::CandidateWithRef< Ref > reco::CastorTower reco::CompositeCandidate reco::CompositePtrCandidate reco::CompositeRefBaseCandidate reco::CompositeRefCandidate reco::CompositeRefCandidateT< D > reco::EcalIsolatedParticleCandidate reco::LeafRefCandidateT reco::RecoCandidate reco::ShallowCloneCandidate reco::ShallowClonePtrCandidate TICLCandidate ZMuMuRochCorAnalyzer.DiMuon

Public Types

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_iterator begin () const
 first daughter const_iterator More...
 
iterator begin ()
 first daughter iterator More...
 
virtual const TrackbestTrack () const
 
virtual Vector boostToCM () const =0
 
 Candidate ()
 default constructor More...
 
virtual int charge () const =0
 electric charge More...
 
virtual Candidateclone () const =0
 returns a clone of the Candidate object More...
 
virtual const Candidatedaughter (size_type i) const =0
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
 
virtual Candidatedaughter (size_type i)=0
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
 
virtual Candidatedaughter (const std::string &s)=0
 return daughter with a specified role name More...
 
virtual const Candidatedaughter (const std::string &s) const =0
 return daughter with a specified role name More...
 
virtual float dxyError () const
 uncertainty on dxy More...
 
virtual float dzError () const
 uncertainty on dz More...
 
const_iterator end () const
 last daughter const_iterator More...
 
iterator end ()
 last daughter iterator More...
 
virtual double energy () const =0
 energy More...
 
virtual double et () const =0
 transverse energy More...
 
virtual double et2 () const =0
 transverse energy squared (use this for cut!) More...
 
virtual double eta () const =0
 momentum pseudorapidity More...
 
virtual void fillVertexCovariance (CovarianceMatrix &v) const =0
 
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 =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? More...
 
virtual double mass () const =0
 mass More...
 
virtual bool massConstraint () const =0
 do mass constraint? More...
 
virtual double massSqr () const =0
 mass squared More...
 
virtual const CandidateBaseRefmasterClone () const =0
 
virtual const CandidatePtrmasterClonePtr () const =0
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
virtual Vector momentum () const =0
 spatial momentum vector More...
 
virtual const Candidatemother (size_type i=0) const =0
 return pointer to mother More...
 
virtual double mt () const =0
 transverse mass More...
 
virtual double mtSqr () const =0
 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_type numberOfDaughters () const =0
 number of daughters More...
 
virtual size_type numberOfMothers () const =0
 number of mothers (zero or one in most of but not all the cases) More...
 
virtual size_t numberOfSourceCandidatePtrs () const =0
 
virtual double p () const =0
 magnitude of momentum vector More...
 
virtual const LorentzVectorp4 () const =0
 four-momentum Lorentz vector More...
 
virtual int pdgId () const =0
 PDG identifier. More...
 
virtual double phi () const =0
 momentum azimuthal angle More...
 
virtual const PolarLorentzVectorpolarP4 () const =0
 four-momentum Lorentz vector More...
 
virtual double pt () const =0
 transverse momentum More...
 
virtual double px () const =0
 x coordinate of momentum vector More...
 
virtual double py () const =0
 y coordinate of momentum vector More...
 
virtual double pz () const =0
 z coordinate of momentum vector More...
 
virtual double rapidity () const =0
 rapidity More...
 
virtual void setCharge (Charge q)=0
 set electric charge More...
 
virtual void setLongLived ()=0
 set long lived flag More...
 
virtual void setMass (double m)=0
 set particle mass More...
 
virtual void setMassConstraint ()=0
 set mass constraint flag More...
 
virtual void setP4 (const LorentzVector &p4)=0
 set 4-momentum More...
 
virtual void setP4 (const PolarLorentzVector &p4)=0
 set 4-momentum More...
 
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. More...
 
virtual void setStatus (int status)=0
 set status word More...
 
virtual void setThreeCharge (Charge qx3)=0
 set electric charge More...
 
virtual void setVertex (const Point &vertex)=0
 set vertex More...
 
virtual CandidatePtr sourceCandidatePtr (size_type i) const
 
virtual int status () const =0
 status word More...
 
virtual double theta () const =0
 momentum polar angle More...
 
virtual int threeCharge () const =0
 electric charge More...
 
virtual const Pointvertex () const =0
 vertex position More...
 
virtual double vertexChi2 () const =0
 chi-squares More...
 
virtual double vertexCovariance (int i, int j) const =0
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
virtual CovarianceMatrix vertexCovariance () const
 fill SMatrix More...
 
virtual double vertexNdof () const =0
 
virtual double vertexNormalizedChi2 () const =0
 chi-squared divided by n.d.o.f. More...
 
virtual double vx () const =0
 x coordinate of vertex position More...
 
virtual double vy () const =0
 y coordinate of vertex position More...
 
virtual double vz () const =0
 z coordinate of vertex position More...
 
virtual double y () const =0
 rapidity More...
 
virtual ~Candidate ()
 destructor More...
 

Protected Member Functions

virtual bool overlap (const Candidate &) const =0
 check overlap with another Candidate More...
 

Friends

class ::OverlapChecker
 
template<typename , typename , typename >
struct component
 
class ShallowCloneCandidate
 
class ShallowClonePtrCandidate
 

Detailed Description

abstract interface for physics objects

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

Definition at line 27 of file Candidate.h.

Member Typedef Documentation

electric charge type

Definition at line 34 of file Candidate.h.

Definition at line 30 of file Candidate.h.

covariance error matrix (3x3)

Definition at line 46 of file Candidate.h.

typedef unsigned int reco::Candidate::index

index type

Definition at line 50 of file Candidate.h.

Definition at line 31 of file Candidate.h.

Lorentz vector.

Definition at line 36 of file Candidate.h.

point in the space

Definition at line 40 of file Candidate.h.

Lorentz vector.

Definition at line 38 of file Candidate.h.

Definition at line 29 of file Candidate.h.

point in the space

Definition at line 42 of file Candidate.h.

Member Enumeration Documentation

anonymous enum
Enumerator
dimension 

Definition at line 44 of file Candidate.h.

anonymous enum

matix size

Enumerator
size 

Definition at line 48 of file Candidate.h.

Constructor & Destructor Documentation

reco::Candidate::Candidate ( )
inline

default constructor

Definition at line 53 of file Candidate.h.

53 {};
Candidate::~Candidate ( )
virtual

destructor

Definition at line 5 of file Candidate.cc.

5 {}

Member Function Documentation

const_iterator reco::Candidate::begin ( void  ) const
inline
iterator reco::Candidate::begin ( void  )
inline

first daughter iterator

Definition at line 147 of file Candidate.h.

147 { return iterator(this, 0); }
candidate::iterator iterator
Definition: Candidate.h:31
virtual const Track* reco::Candidate::bestTrack ( ) const
inlinevirtual
virtual Vector reco::Candidate::boostToCM ( ) const
pure virtual

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

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

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

electric charge

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by BPHDecayToChargedXXbarBuilder::addParticle(), BPHDecayToTkpTknSymChargeBuilder::addParticle(), reco::tau::atECALEntrance(), FWCandidateProxyBuilder::build(), BPHX3872ToJPsiPiPiBuilder::build(), BPHPlusMinusCandidate::build(), BPHDecayToV0SameMassBuilder::buildCandidate(), NamedCandCombinerBase::combine(), CandCombinerBase< OutputCollection, CandPtr >::combine(), PileupJetIdAlgo::computeIdVariables(), TtDecayChannelSelector::countProngs(), reco::isodeposit::IsoDepositExtractor::deposit(), reco::isodeposit::IsoDepositExtractor::deposits(), CandidateChargeBTagComputer::discriminator(), CandIsoDepositProducer::extractTrack(), pat::GenericParticle::fillInFrom(), CandidateBenchmark::fillOne(), L1TPhase2CorrelatorOffline::McVars::fillPropagated(), reco::tau::RecoTauQualityCuts::filterCand(), reco::tau::RecoTauQualityCuts::filterChargedCand(), reco::PFTauDecayMode::filteredObjectCandidates(), TtDilepEvtSolutionMaker::HasPositiveCharge(), TtFullLepKinSolutionProducer::HasPositiveCharge(), TtDilepEvtSolutionMaker::LepDiffCharge(), TtFullLepKinSolutionProducer::LepDiffCharge(), MatcherByPullsAlgorithm::match(), MatcherUsingTracksAlgorithm::match(), ParametersDefinerForTP::momentum(), helpers::MCTruthPairSelector< T >::operator()(), PositionAtECalEntranceComputer::operator()(), reco::LeafCandidate::overlap(), pat::PackedGenParticle::overlap(), pat::PackedCandidate::overlap(), reco::PFRecoTauChargedHadron::PFRecoTauChargedHadron(), fireworks::prepareCandidate(), NamedCandCombinerBase::preselect(), CandCombinerBase< OutputCollection, CandPtr >::preselect(), printP4(), PseudoTopProducer::produce(), pat::L1MuonMatcher::produce(), pat::HLTL1MuonMatcher::produce(), SoftKillerProducer::produce(), VertexTableProducer::produce(), L1TMicroGMTInputProducerFromGen::produce(), l1t::GenToInputProducer::produce(), BPHRecoBuilder::sameTrack(), AddFourMomenta::set(), PropagateToMuon::startingState(), hltriggeroffline::PropagateToMuon::startingState(), MatcherUsingTracksAlgorithm::startingState(), reco::tau::sumPFCandCharge(), BPHDecayVertex::tTracks(), and ParametersDefinerForTP::vertex().

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

returns a clone of the Candidate object

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

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

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 pat::Jet, pat::PackedCandidate, pat::PackedGenParticle, reco::LeafCandidate, reco::NamedCompositeCandidate, reco::CompositeCandidate, reco::LeafRefCandidateT, reco::CompositeRefCandidateT< D >, reco::CompositeRefCandidateT< GenParticleRefVector >, reco::CompositePtrCandidate, reco::CompositeRefBaseCandidate, reco::CompositeRefCandidate, reco::ShallowCloneCandidate, reco::ShallowClonePtrCandidate, and l1t::PFJet.

Referenced by helper::CandDecayStoreManager::add(), myFastSimVal::analyze(), HLTMCtruth::analyze(), L1TPhase2CorrelatorOffline::analyze(), TtFullLeptonicEvent::b(), TtFullLeptonicEvent::bBar(), BPHDecayToV0Builder::buildFromV0(), cloneDecayTree(), reco::CompositeCandidate::CompositeCandidate(), reco::ShallowCloneCandidate::daughter(), ParticleDecayDrawer::decay(), CandCommonVertexFitterBase::fill(), CandKinematicVertexFitter::fill(), reco::modules::JetFlavourIdentifier::findCandidates(), BPHDaughters::get(), PseudoTopProducer::getLast(), MuScleFitMuonSelector::getStatus1Muon(), MuScleFitMuonSelector::getStatus3Muon(), GenHFHadronMatcher::hasHadronDaughter(), ParticleDecayDrawer::hasValidDaughters(), ParticleTreeDrawer::hasValidDaughters(), helicityAngle(), invalidateTree(), PseudoTopProducer::isBHadron(), TtFullLeptonicEvent::lepton(), TtFullLeptonicEvent::leptonBar(), TtFullLeptonicEvent::neutrino(), TtFullLeptonicEvent::neutrinoBar(), CompositeCandSelector< Selector, T1, T2, nDau >::operator()(), GenJetParticleSelector::operator()(), reco::utilsNew::CandMatcher< C >::operator[](), reco::PFTauDecayMode::pfMasterClones(), ParticleTreeDrawer::printDecay(), ProbeMulteplicityProducer::produce(), GenParticles2HepMCConverter::produce(), VertexTableProducer::produce(), TauSpinnerCMS::readParticlesfromReco(), tnp::TagProbePairMaker::run(), CandMassKinFitter::set(), reco::tau::RecoTauBuilderConePlugin::setTauQuantities(), InputGenJetsParticleSelector::testPartonChildren(), TtFullLeptonicEvent::wMinus(), TtFullLeptonicEvent::wPlus(), and zMCLeptonDaughters().

virtual Candidate* reco::Candidate::daughter ( size_type  i)
pure virtual
virtual Candidate* reco::Candidate::daughter ( const std::string &  s)
pure virtual
virtual const Candidate* reco::Candidate::daughter ( const std::string &  s) const
pure virtual
virtual float reco::Candidate::dxyError ( ) const
inlinevirtual

uncertainty on dxy

Reimplemented in pat::PackedCandidate, reco::PFCandidate, pat::IsolatedTrack, reco::RecoCandidate, and reco::RecoChargedRefCandidate.

Definition at line 275 of file Candidate.h.

275  {
276  return 0;
277  } // { const Track * tr=bestTrack(); if(tr!=nullptr) return tr->dxyError(); else return 0; }
virtual float reco::Candidate::dzError ( ) const
inlinevirtual

uncertainty on dz

Reimplemented in pat::PackedCandidate, reco::PFCandidate, pat::IsolatedTrack, reco::RecoCandidate, and reco::RecoChargedRefCandidate.

Definition at line 271 of file Candidate.h.

271  {
272  return 0;
273  } // { const Track * tr=bestTrack(); if(tr!=nullptr) return tr->dzError(); else return 0; }
const_iterator reco::Candidate::end ( void  ) const
inline
iterator reco::Candidate::end ( void  )
inline

last daughter iterator

Definition at line 149 of file Candidate.h.

References numberOfDaughters().

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

149 { return iterator(this, numberOfDaughters()); }
virtual size_type numberOfDaughters() const =0
number of daughters
candidate::iterator iterator
Definition: Candidate.h:31
virtual double reco::Candidate::energy ( ) const
pure virtual
virtual double reco::Candidate::et ( ) const
pure virtual
virtual double reco::Candidate::et2 ( ) const
pure virtual

transverse energy squared (use this for cut!)

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

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

momentum pseudorapidity

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by Particle.Particle::__str__(), BPHDaughterSelect::accept(), GenericBenchmark::accepted(), l1tpf_calo::SingleCaloClusterer::add(), HLTMCtruth::analyze(), FWCandidateLegoProxyBuilder::build(), btagbtvdeep::TrackInfoBuilder::buildTrackInfo(), PileupJetIdAlgo::computeIdVariables(), egammaisolation::EgammaTrackExtractor::deposit(), PFRecoTauDiscriminationByHPSSelection::discriminate(), GenericBenchmark::fill(), PFCandidateMonitor::fill(), FWCandidateTowerProxyBuilder::fillCaloData(), GenericBenchmark::fillHistos(), CandidateBenchmark::fillOne(), MatchCandidateBenchmark::fillOne(), PFCandidateMonitor::fillOne(), L1TPhase2CorrelatorOffline::McVars::fillP4(), PFFilter::filter(), PFMETFilter::filter(), PFJetFilter::filter(), DYToMuMuGenFilter::filter(), BadParticleFilter::filter(), HLTMuonPlotter::findMatches(), HiGammaJetSignalDef::getDeltaR(), PhotonTkIsolation::getIso(), FWCandidateTowerSliceSelector::getItemEntryEtaPhi(), ShiftedParticleProducer::getUncShift(), heppy::IsolationComputer::isoSumNeutralsWeighted(), heppy::IsolationComputer::isoSumRaw(), Jet.Jet::jetID(), MatcherByPullsAlgorithm::match(), PuppiPhoton::matchPFCandidate(), PositionAtECalEntranceComputer::operator()(), AntiElectronDeadECAL::operator()(), operator<<(), HLTmmkFilter::overlap(), HLTmmkkFilter::overlap(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), printP4(), ttevent::printParticle(), CastorFastClusterProducer::produce(), CastorFastTowerProducer::produce(), CandOneToManyDeltaRMatcher::produce(), GenParticles2HepMCConverter::produce(), MultShiftMETcorrInputProducer::produce(), MultShiftMETcorrDBInputProducer::produce(), HFJetShowerShape::produce(), L1TMicroGMTInputProducerFromGen::produce(), l1t::GenToInputProducer::produce(), Jet.Jet::puJetId(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), SetPtEtaPhi(), setPtEtaPhi(), MultiTrackValidator::tpDR(), and MultiTrackValidator::trackDR().

virtual void reco::Candidate::fillVertexCovariance ( CovarianceMatrix v) const
pure virtual
template<typename T >
T reco::Candidate::get ( ) const
inline

get a component

Definition at line 221 of file Candidate.h.

References get(), hasMasterClone(), and masterClone().

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), submitPVValidationJobs.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), util.rrapi.RRApi::columns(), EgammaTowerIsolationNew< NC >::compute(), util.rrapi.RRApi::count(), rrapi.RRApi::count(), util.rrapi.RRApi::data(), rrapi.RRApi::data(), egammaisolation::EgammaHcalExtractor::deposit(), egammaisolation::EgammaRecHitExtractor::deposit(), egammaisolation::EgammaEcalExtractor::deposit(), egammaisolation::EgammaTowerExtractor::deposit(), CandCommonVertexFitterBase::fill(), CandKinematicVertexFitter::fill(), get(), reco::LeafCandidate::get(), betterConfigParser.BetterConfigParser::getCompares(), EgammaEcalIsolation::getEcalEtSum(), BPHTrackReference::getFromRC(), betterConfigParser.BetterConfigParser::getGeneral(), EgammaHcalIsolation::getHcalESum(), EgammaHcalIsolation::getHcalESumBc(), EgammaHcalIsolation::getHcalEtSum(), EgammaHcalIsolation::getHcalEtSumBc(), betterConfigParser.BetterConfigParser::getResultingSection(), submitPVValidationJobs.BetterConfigParser::getResultingSection(), EgammaRecHitIsolation::getSum_(), EgammaTowerIsolation::getTowerESum(), EgammaTowerIsolation::getTowerEtSum(), reco::makeSpecific(), pat::PackedGenParticle::mother(), util.rrapi.RRApi::report(), rrapi.RRApi::report(), util.rrapi.RRApi::reports(), rrapi.RRApi::reports(), PFSpecificAlgo::run(), METAlgo::run(), CandMassKinFitter::set(), util.rrapi.RRApi::tables(), rrapi.RRApi::tables(), util.rrapi.RRApi::tags(), rrapi.RRApi::tags(), util.rrapi.RRApi::templates(), rrapi.RRApi::templates(), util.rrapi.RRApi::workspaces(), and rrapi.RRApi::workspaces().

221  {
222  if (hasMasterClone())
223  return masterClone()->get<T>();
224  else
225  return reco::get<T>(*this);
226  }
virtual bool hasMasterClone() const =0
T get() const
get a component
Definition: Candidate.h:221
long double T
virtual const CandidateBaseRef & masterClone() const =0
template<typename T , typename Tag >
T reco::Candidate::get ( ) const
inline
template<typename T >
T reco::Candidate::get ( size_type  i) const
inline
template<typename T , typename Tag >
T reco::Candidate::get ( size_type  i) const
inline
virtual bool reco::Candidate::hasMasterClone ( ) const
pure virtual
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 pat::PackedCandidate, pat::PackedGenParticle, reco::LeafCandidate, reco::LeafRefCandidateT, and reco::ShallowClonePtrCandidate.

virtual bool reco::Candidate::isCaloMuon ( ) const
pure virtual
virtual bool reco::Candidate::isConvertedPhoton ( ) const
pure virtual
virtual bool reco::Candidate::isElectron ( ) const
pure virtual
virtual bool reco::Candidate::isGlobalMuon ( ) const
pure virtual
virtual bool reco::Candidate::isJet ( ) const
pure virtual
virtual bool reco::Candidate::isMuon ( ) const
pure virtual
virtual bool reco::Candidate::isPhoton ( ) const
pure virtual
virtual bool reco::Candidate::isStandAloneMuon ( ) const
pure virtual
virtual bool reco::Candidate::isTrackerMuon ( ) const
pure virtual
virtual bool reco::Candidate::longLived ( ) const
pure virtual
virtual double reco::Candidate::mass ( ) const
pure virtual
virtual bool reco::Candidate::massConstraint ( ) const
pure virtual

do mass constraint?

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

virtual double reco::Candidate::massSqr ( ) const
pure virtual
virtual const CandidateBaseRef& reco::Candidate::masterClone ( ) const
pure virtual
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 pat::PackedCandidate, pat::PackedGenParticle, reco::LeafCandidate, reco::LeafRefCandidateT, and reco::ShallowClonePtrCandidate.

template<typename Ref >
Ref reco::Candidate::masterRef ( ) const
inline

cast master clone reference to a concrete type

Definition at line 215 of file Candidate.h.

References masterClone().

215  {
216  return masterClone().template castTo<Ref>();
217  }
virtual const CandidateBaseRef & masterClone() const =0
virtual Vector reco::Candidate::momentum ( ) const
pure virtual
virtual const Candidate* reco::Candidate::mother ( size_type  i = 0) const
pure virtual
virtual double reco::Candidate::mt ( ) const
pure virtual

transverse mass

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

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

transverse mass squared

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

template<typename T >
size_type reco::Candidate::numberOf ( ) const
inline

number of components

Definition at line 253 of file Candidate.h.

References hasMasterClone(), masterClone(), and numberOf().

Referenced by numberOf(), and reco::LeafCandidate::numberOf().

253  {
254  if (hasMasterClone())
255  return masterClone()->numberOf<T>();
256  else
257  return reco::numberOf<T>(*this);
258  }
virtual bool hasMasterClone() const =0
size_type numberOf() const
number of components
Definition: Candidate.h:253
long double T
virtual const CandidateBaseRef & masterClone() const =0
template<typename T , typename Tag >
size_type reco::Candidate::numberOf ( ) const
inline

number of components

Definition at line 261 of file Candidate.h.

References hasMasterClone(), masterClone(), and numberOf().

261  {
262  if (hasMasterClone())
263  return masterClone()->numberOf<T, Tag>();
264  else
265  return reco::numberOf<T, Tag>(*this);
266  }
virtual bool hasMasterClone() const =0
size_type numberOf() const
number of components
Definition: Candidate.h:253
long double T
virtual const CandidateBaseRef & masterClone() const =0
virtual size_type reco::Candidate::numberOfDaughters ( ) const
pure virtual

number of daughters

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

Referenced by helper::CandDecayStoreManager::add(), myFastSimVal::analyze(), ElectronMcSignalValidatorMiniAOD::analyze(), ElectronMcSignalValidator::analyze(), HLTMCtruth::analyze(), L1TPhase2CorrelatorOffline::analyze(), reco::PFTauDecayMode::associatedChargedPFCandidates(), reco::PFTauDecayMode::associatedNeutralPFCandidates(), TopDecaySubset::checkShowerModel(), cloneDecayTree(), reco::CompositeCandidate::CompositeCandidate(), ParticleDecayDrawer::decay(), end(), CandCommonVertexFitterBase::fill(), CandKinematicVertexFitter::fill(), reco::PFTauDecayMode::filteredPFCandidates(), reco::modules::JetFlavourIdentifier::findCandidates(), PseudoTopProducer::getLast(), MuScleFitMuonSelector::getStatus1Muon(), MuScleFitMuonSelector::getStatus3Muon(), GenHFHadronMatcher::hasHadronDaughter(), ParticleDecayDrawer::hasValidDaughters(), ParticleTreeDrawer::hasValidDaughters(), helicityAngle(), invalidateTree(), PseudoTopProducer::isBHadron(), reco::ShallowCloneCandidate::numberOfDaughters(), CompositeCandSelector< Selector, T1, T2, nDau >::operator()(), OverlapChecker::operator()(), GenJetParticleSelector::operator()(), operator<<(), reco::utilsNew::CandMatcher< C >::operator[](), reco::PFTauDecayMode::pfMasterClones(), ParticleTreeDrawer::printDecay(), InputGenJetsParticleSelector::produce(), tnp::TagProbePairMaker::run(), CandMassKinFitter::set(), AddFourMomenta::set(), InputGenJetsParticleSelector::testPartonChildren(), and zMCLeptonDaughters().

virtual size_type reco::Candidate::numberOfMothers ( ) const
pure virtual
virtual size_t reco::Candidate::numberOfSourceCandidatePtrs ( ) const
pure virtual
virtual bool reco::Candidate::overlap ( const Candidate ) const
protectedpure virtual
virtual double reco::Candidate::p ( ) const
pure virtual
virtual const LorentzVector& reco::Candidate::p4 ( ) const
pure virtual

four-momentum Lorentz vector

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by BPHDecayToChargedXXbarBuilder::addParticle(), BPHDecayToTkpTknSymChargeBuilder::addParticle(), myFastSimVal::analyze(), L1TPhase2CorrelatorOffline::analyze(), HLTExoticaSubAnalysis::analyze(), EmbeddingLHEProducer::assign_4vector(), FWCandidateProxyBuilder::build(), BPHX3872ToJPsiPiPiBuilder::build(), BPHDecayToV0Builder::buildFromV0(), JetCharge::charge(), reco::PFMETProducerMVA::chargedFracInCone(), PFRecoTauDiscriminationByHPSSelection::discriminate(), HiggsDQM::DistancePhi(), DQMExample_Step1::DistancePhi(), Tau.Tau::dxy_approx(), Tau.Tau::dz(), TopDecaySubset::fillListing(), L1TPhase2CorrelatorOffline::McVars::fillPropagated(), reco::modules::JetFlavourIdentifier::findCandidates(), MuScleFitMuonSelector::findGenMuFromRes(), FlavorHistoryProducer::getClosestJet(), helicityAngle(), fftjetcms::FFTJetInterface::loadInputCollection(), ParametersDefinerForTP::momentum(), PositionAtECalEntranceComputer::operator()(), reco::LeafCandidate::overlap(), pat::PackedGenParticle::overlap(), pat::PackedCandidate::overlap(), TopDecaySubset::p4(), Lepton.Lepton::p4WithFSR(), DeepTauId::processIsolationPFComponents(), DeepTauId::processSignalPFComponents(), PseudoTopProducer::produce(), L1HLTJetsMatching::produce(), PFJetsMatchedToFilteredCaloJetsProducer::produce(), CandOneToManyDeltaRMatcher::produce(), HLTTriMuonIsolation::produce(), GenParticles2HepMCConverter::produce(), ShiftedParticleProducer::produce(), SoftKillerProducer::produce(), METAlgo::run(), CandMassKinFitter::set(), ApplyEnergyCorrection::set(), Booster::set(), AddFourMomenta::set(), reco::tau::RecoTauBuilderConePlugin::setTauQuantities(), reco::tau::sumPFCandP4(), pat::DiObjectProxy::totalP4(), and ParametersDefinerForTP::vertex().

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

PDG identifier.

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by Particle.Particle::__str__(), TopDecaySubset::addRadiation(), TauDecay_GenParticle::AddRadInfo(), myFastSimVal::analyze(), ElectronMcSignalValidatorMiniAOD::analyze(), ElectronMcSignalValidator::analyze(), HLTMCtruth::analyze(), ResolutionCreator::analyze(), GsfElectronMCAnalyzer::analyze(), L1TPhase2CorrelatorOffline::analyze(), GenHFHadronMatcher::analyzeMothers(), TopDecaySubset::checkShowerModel(), PileupJetIdAlgo::computeIdVariables(), ParticleDecayDrawer::decay(), CandCommonVertexFitterBase::fill(), CandKinematicVertexFitter::fill(), pat::GenericParticle::fillInFrom(), TopDecaySubset::fillListing(), BTagSkimMC::filter(), DYToMuMuGenFilter::filter(), BadParticleFilter::filter(), reco::tau::RecoTauQualityCuts::filterCandByType(), EmbeddingLHEProducer::find_original_muon(), ttHFGenFilter::FindAllTopMothers(), reco::modules::JetFlavourIdentifier::findCandidates(), GenHFHadronMatcher::findHadronJets(), TopDecaySubset::findLastParticleInChain(), TopDecaySubset::findPrimalW(), reco::flavour(), InputGenJetsParticleSelector::fromResonance(), PseudoTopProducer::getLast(), HeavyFlavorValidation::getMotherId(), MuScleFitMuonSelector::getStatus1Muon(), MuScleFitMuonSelector::getStatus3Muon(), CandMCTagUtils::hasBottom(), CandMCTagUtils::hasCharm(), PseudoTopProducer::isBHadron(), reco::isElectron(), PseudoTopProducer::isFromHadron(), GenHFHadronMatcher::isHadron(), TauValidation::isLastTauinChain(), reco::isLepton(), CandMCTagUtils::isLightParton(), reco::isMuon(), reco::isNeutrino(), CandMCTagUtils::isParton(), HiPhotonType::IsPrompt(), reco::isTau(), reco::makeSpecific(), PuppiPhoton::matchPFCandidate(), helpers::MCTruthPairSelector< T >::operator()(), GenJetParticleSelector::operator()(), AntiElectronDeadECAL::operator()(), operator<<(), ParticleTreeDrawer::printDecay(), PseudoTopProducer::produce(), CastorFastTowerProducer::produce(), CastorFastClusterProducer::produce(), GenParticles2HepMCConverter::produce(), InputGenJetsParticleSelector::produce(), MultShiftMETcorrInputProducer::produce(), PartonSelector::produce(), MultShiftMETcorrDBInputProducer::produce(), Onia2MuMuPAT::produce(), HFJetShowerShape::produce(), SoftKillerProducer::produce(), L1TMicroGMTInputProducerFromGen::produce(), FlavorHistoryProducer::produce(), l1t::GenToInputProducer::produce(), TauSpinnerCMS::readParticlesfromReco(), PFSpecificAlgo::run(), TtDecayChannelSelector::search(), TtDecayChannelSelector::tauDecay(), InputGenJetsParticleSelector::testPartonChildren(), heppy::FSRWeightAlgo::weight(), and zMCLeptonDaughters().

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

momentum azimuthal angle

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by Particle.Particle::__str__(), l1tpf_calo::SingleCaloClusterer::add(), fireworks::addStraightLineSegment(), HLTMCtruth::analyze(), B2GDQM::analyzeJets(), FWCandidateLegoProxyBuilder::build(), pat::DiObjectProxy::deltaPhi(), egammaisolation::EgammaTrackExtractor::deposit(), PFRecoTauDiscriminationByHPSSelection::discriminate(), GenericBenchmark::fill(), PFCandidateMonitor::fill(), FWCandidateTowerProxyBuilder::fillCaloData(), GenericBenchmark::fillHistos(), CandidateBenchmark::fillOne(), MatchCandidateBenchmark::fillOne(), PFCandidateMonitor::fillOne(), L1TPhase2CorrelatorOffline::McVars::fillP4(), PFFilter::filter(), PFMETFilter::filter(), PFJetFilter::filter(), BadParticleFilter::filter(), HLTMuonPlotter::findMatches(), HiGammaJetSignalDef::getDeltaPhi(), HiGammaJetSignalDef::getDeltaR(), FWCandidateTowerSliceSelector::getItemEntryEtaPhi(), MatcherByPullsAlgorithm::match(), PuppiPhoton::matchPFCandidate(), AntiElectronDeadECAL::operator()(), operator<<(), HLTmmkFilter::overlap(), HLTmmkkFilter::overlap(), ntupleDataFormat.Track::phiPull(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), printP4(), ttevent::printParticle(), CastorFastClusterProducer::produce(), CastorFastTowerProducer::produce(), CandOneToManyDeltaRMatcher::produce(), HFJetShowerShape::produce(), L1TMicroGMTInputProducerFromGen::produce(), l1t::GenToInputProducer::produce(), SetPtEtaPhi(), setPtEtaPhi(), MultiTrackValidator::tpDR(), MultiTrackValidator::trackDR(), and heppy::FSRWeightAlgo::weight().

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

four-momentum Lorentz vector

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

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

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

transverse momentum

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by Particle.Particle::__str__(), ZMuMuRochCorAnalyzer.DiMuon::__str__(), DiObject.DiMuon::__str__(), BPHDaughterSelect::accept(), GenericBenchmark::accepted(), l1tpf_calo::SingleCaloClusterer::add(), fireworks::addStraightLineSegment(), BPHHistoSpecificDecay::analyze(), HLTMCtruth::analyze(), TauTagValidation::analyze(), B2GDQM::analyzeJets(), GenHFHadronMatcher::analyzeMothers(), FWCandidateLegoProxyBuilder::build(), pat::PATPackedCandidateProducer::calcDz(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), reco::PFMETProducerMVA::chargedFracInCone(), PileupJetIdAlgo::computeIdVariables(), CandidateChargeBTagComputer::discriminator(), GenericBenchmark::fill(), PFCandidateMonitor::fill(), CandidateBenchmark::fillOne(), MatchCandidateBenchmark::fillOne(), PFCandidateMonitor::fillOne(), L1TPhase2CorrelatorOffline::McVars::fillP4(), PFJetFilter::filter(), DYToMuMuGenFilter::filter(), BadParticleFilter::filter(), FWCandidateTowerProxyBuilder::getEt(), ShiftedParticleProducer::getUncShift(), fftjetcms::FFTJetInterface::loadInputCollection(), MatcherByPullsAlgorithm::match(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), AntiElectronDeadECAL::operator()(), SortCandByDecreasingPt::operator()(), HLTMuonPlotter::matchesByDescendingPt::operator()(), HLTMuonPlotter::MatchStruct::operator<(), operator<<(), HLTMuonPlotter::MatchStruct::operator>(), HLTmmkkFilter::overlap(), HLTmmkFilter::overlap(), ParticleTreeDrawer::printInfo(), ParticleDecayDrawer::printP4(), printP4(), ttevent::printParticle(), IsolationProducerForTracks::produce(), PseudoTopProducer::produce(), L1HLTJetsMatching::produce(), InputGenJetsParticleSelector::produce(), pat::L1MuonMatcher::produce(), MultShiftMETcorrInputProducer::produce(), pat::HLTL1MuonMatcher::produce(), MultShiftMETcorrDBInputProducer::produce(), HFJetShowerShape::produce(), L1TMicroGMTInputProducerFromGen::produce(), l1t::GenToInputProducer::produce(), TtDilepEvtSolutionMaker::PTComp(), TtFullLepKinSolutionProducer::PTComp(), Electron.Electron::ptErr(), ntupleDataFormat.Track::ptPull(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), Jet.Jet::setCorrP4(), SetPtEtaPhi(), setPtEtaPhi(), reco::tau::RecoTauBuilderConePlugin::setTauQuantities(), and reco::tau::sumPFCandPt().

virtual double reco::Candidate::px ( ) const
pure virtual
virtual double reco::Candidate::py ( ) const
pure virtual
virtual double reco::Candidate::pz ( ) const
pure virtual
virtual double reco::Candidate::rapidity ( ) const
pure virtual
virtual void reco::Candidate::setCharge ( Charge  q)
pure virtual

set electric charge

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Referenced by AddFourMomenta::set().

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

set long lived flag

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

virtual void reco::Candidate::setMass ( double  m)
pure virtual
virtual void reco::Candidate::setMassConstraint ( )
pure virtual

set mass constraint flag

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

virtual void reco::Candidate::setP4 ( const LorentzVector p4)
pure virtual
virtual void reco::Candidate::setP4 ( const PolarLorentzVector p4)
pure virtual

set 4-momentum

Implemented in reco::LeafCandidate.

Referenced by Jet.Jet::setCorrP4().

virtual void reco::Candidate::setPdgId ( int  pdgId)
pure virtual
virtual void reco::Candidate::setPz ( double  pz)
pure virtual
virtual void reco::Candidate::setSourceCandidatePtr ( const CandidatePtr ptr)
inlinevirtual

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 179 of file Candidate.h.

179 {};
virtual void reco::Candidate::setStatus ( int  status)
pure virtual

set status word

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

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

set electric charge

Implemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

virtual void reco::Candidate::setVertex ( const Point vertex)
pure virtual
virtual CandidatePtr reco::Candidate::sourceCandidatePtr ( size_type  i) const
inlinevirtual

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

Reimplemented in pat::PackedCandidate, pat::Photon, pat::Tau, reco::PFTau, pat::Electron, pat::PackedGenParticle, pat::Muon, reco::PFCandidate, reco::LeafCandidate, reco::CompositePtrCandidate, and reco::LeafRefCandidateT.

Definition at line 169 of file Candidate.h.

Referenced by heppy::IsolationComputer::addVetos(), heppy::IsolationComputer::isoSumNeutralsWeighted(), heppy::IsolationComputer::isoSumRaw(), and reco::PFCandidate::overlap().

169 { return CandidatePtr(); }
edm::Ptr< Candidate > CandidatePtr
persistent reference to an object in a collection of Candidate objects
Definition: CandidateFwd.h:25
virtual int reco::Candidate::status ( ) const
pure virtual
virtual double reco::Candidate::theta ( ) const
pure virtual
virtual int reco::Candidate::threeCharge ( ) const
pure virtual
virtual const Point& reco::Candidate::vertex ( ) const
pure virtual
virtual double reco::Candidate::vertexChi2 ( ) const
pure virtual
virtual double reco::Candidate::vertexCovariance ( int  i,
int  j 
) const
pure virtual
virtual CovarianceMatrix reco::Candidate::vertexCovariance ( ) const
inlinevirtual

fill SMatrix

Reimplemented in pat::PackedCandidate, pat::PackedGenParticle, and reco::LeafCandidate.

Definition at line 195 of file Candidate.h.

References fillVertexCovariance(), and visualization-live-secondInstance_cfg::m.

195  {
198  return m;
199  } //TODO
virtual void fillVertexCovariance(CovarianceMatrix &v) const =0
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 pat::PackedCandidate, pat::PackedGenParticle, reco::LeafCandidate, reco::VertexCompositePtrCandidate, and reco::VertexCompositeCandidate.

virtual double reco::Candidate::vertexNormalizedChi2 ( ) const
pure virtual
virtual double reco::Candidate::vx ( ) const
pure virtual
virtual double reco::Candidate::vy ( ) const
pure virtual
virtual double reco::Candidate::vz ( ) const
pure virtual
virtual double reco::Candidate::y ( ) const
pure virtual

Friends And Related Function Documentation

friend class ::OverlapChecker
friend

Definition at line 294 of file Candidate.h.

template<typename , typename , typename >
friend struct component
friend

Definition at line 293 of file Candidate.h.

friend class ShallowCloneCandidate
friend

Definition at line 295 of file Candidate.h.

friend class ShallowClonePtrCandidate
friend

Definition at line 296 of file Candidate.h.