CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
reco::LeafRefCandidateT Class Reference

#include <LeafRefCandidateT.h>

Inheritance diagram for reco::LeafRefCandidateT:
reco::LeafCandidate reco::Candidate reco::RecoChargedRefCandidate reco::RecoPFClusterRefCandidate

Public Types

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::LeafCandidate
typedef int Charge
 electric charge type More...
 
typedef CandidateCollection daughters
 collection of daughter candidates More...
 
typedef unsigned int index
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef math::XYZVector Vector
 point in the space More...
 
- Public Types inherited from reco::Candidate
enum  { dimension = 3 }
 
enum  { size = dimension * (dimension + 1) / 2 }
 matix size More...
 
typedef int Charge
 electric charge type More...
 
typedef candidate::const_iterator const_iterator
 
typedef math::Error< dimension >::type CovarianceMatrix
 covariance error matrix (3x3) More...
 
typedef unsigned int index
 index type More...
 
typedef candidate::iterator iterator
 
typedef math::XYZTLorentzVector LorentzVector
 Lorentz vector. More...
 
typedef math::XYZPoint Point
 point in the space More...
 
typedef math::PtEtaPhiMLorentzVector PolarLorentzVector
 Lorentz vector. More...
 
typedef size_t size_type
 
typedef math::XYZVector Vector
 point in the space More...
 

Public Member Functions

const Candidatedaughter (size_type) const final
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (size_type) final
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) final
 return daughter with a specified role name More...
 
const Candidatedaughter (const std::string &s) const final
 return daughter with a specified role name More...
 
template<typename C >
get () const
 get a component More...
 
template<typename C , typename Tag >
get () const
 get a component More...
 
template<typename C >
get (size_type i) const
 get a component More...
 
template<typename C , typename Tag >
get (size_type i) const
 get a component More...
 
bool hasMasterClone () const final
 This only happens if the concrete Candidate type is ShallowCloneCandidate. More...
 
bool hasMasterClonePtr () const final
 
bool isCaloMuon () const final
 
bool isConvertedPhoton () const final
 
bool isElectron () const final
 
bool isGlobalMuon () const final
 
bool isJet () const final
 
bool isMuon () const final
 
bool isPhoton () const final
 
bool isStandAloneMuon () const final
 
bool isTrackerMuon () const final
 
 LeafRefCandidateT ()
 default constructor More...
 
template<class REF >
 LeafRefCandidateT (const REF &c, float m)
 
const CandidateBaseRefmasterClone () const final
 
const CandidatePtrmasterClonePtr () const final
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
const Candidatemother (size_type) const final
 return mother at a given position (throws an exception) More...
 
template<typename C >
size_type numberOf () const
 number of components More...
 
template<typename C , typename Tag >
size_type numberOf () const
 number of components More...
 
size_t numberOfDaughters () const final
 number of daughters More...
 
size_t numberOfMothers () const final
 number of mothers More...
 
size_t numberOfSourceCandidatePtrs () const final
 
CandidatePtr sourceCandidatePtr (size_type i) const final
 
 ~LeafRefCandidateT () override
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge More...
 
LeafCandidateclone () const override
 returns a clone of the Candidate object More...
 
void construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
 
double energy () const final
 energy More...
 
double et () const final
 transverse energy More...
 
double et2 () const final
 transverse energy squared (use this for cut!) More...
 
double eta () const final
 momentum pseudorapidity More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
bool longLived () const final
 is long lived? More...
 
double mass () const final
 mass More...
 
bool massConstraint () const final
 do mass constraint? More...
 
double massSqr () const final
 mass squared More...
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
Vector momentum () const final
 spatial momentum vector More...
 
double mt () const final
 transverse mass More...
 
double mtSqr () const final
 transverse mass squared More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
double p () const final
 magnitude of momentum vector More...
 
const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
int pdgId () const final
 PDG identifier. More...
 
double phi () const final
 momentum azimuthal angle More...
 
const PolarLorentzVectorpolarP4 () const final
 four-momentum Lorentz vector More...
 
double pt () const final
 transverse momentum More...
 
double px () const final
 x coordinate of momentum vector More...
 
double py () const final
 y coordinate of momentum vector More...
 
double pz () const final
 z coordinate of momentum vector More...
 
double rapidity () const final
 rapidity More...
 
void setCharge (Charge q) final
 set electric charge More...
 
void setLongLived () final
 
void setMass (double m) final
 set particle mass More...
 
void setMassConstraint () final
 
void setP4 (const LorentzVector &p4) final
 set 4-momentum More...
 
void setP4 (const PolarLorentzVector &p4) final
 set 4-momentum More...
 
void setPdgId (int pdgId) final
 
void setPz (double pz) final
 
void setStatus (int status) final
 set status word More...
 
void setThreeCharge (Charge qx3) final
 set electric charge More...
 
void setVertex (const Point &vertex) override
 set vertex More...
 
int status () const final
 status word More...
 
double theta () const final
 momentum polar angle More...
 
int threeCharge () const final
 electric charge More...
 
const Pointvertex () const override
 vertex position (overwritten by PF...) More...
 
double vertexChi2 () const override
 chi-squares More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
double vertexNdof () const override
 
double vertexNormalizedChi2 () const override
 chi-squared divided by n.d.o.f. More...
 
double vx () const override
 x coordinate of vertex position More...
 
double vy () const override
 y coordinate of vertex position More...
 
double vz () const override
 z coordinate of vertex position More...
 
double y () const final
 rapidity More...
 
 ~LeafCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::Candidate
const_iterator begin () const
 first daughter const_iterator More...
 
iterator begin ()
 first daughter iterator More...
 
virtual const TrackbestTrack () const
 
 Candidate ()
 default constructor 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...
 
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...
 

Static Public Member Functions

static short Class_Version ()
 

Protected Member Functions

template<typename REF >
REF getRef () const
 
bool overlap (const Candidate &) const override
 check overlap with another Candidate More...
 
virtual bool overlap (const LeafRefCandidateT &) const
 

Protected Attributes

edm::RefCoreWithIndex ref_
 

Friends

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

Detailed Description

particle candidate with no constituent nor daughters, that takes the 3-vector from a constituent T (where T satisfies T->pt(), etc, like a TrackRef), and the mass is set

Author
Luca Lista, INFN

Definition at line 17 of file LeafRefCandidateT.h.

Member Typedef Documentation

◆ Charge

electric charge type

Definition at line 22 of file LeafRefCandidateT.h.

◆ daughters

collection of daughter candidates

Definition at line 20 of file LeafRefCandidateT.h.

◆ index

typedef unsigned int reco::LeafRefCandidateT::index

Definition at line 32 of file LeafRefCandidateT.h.

◆ LorentzVector

Lorentz vector.

Definition at line 24 of file LeafRefCandidateT.h.

◆ Point

point in the space

Definition at line 28 of file LeafRefCandidateT.h.

◆ PolarLorentzVector

Lorentz vector.

Definition at line 26 of file LeafRefCandidateT.h.

◆ Vector

point in the space

Definition at line 30 of file LeafRefCandidateT.h.

Constructor & Destructor Documentation

◆ LeafRefCandidateT() [1/2]

reco::LeafRefCandidateT::LeafRefCandidateT ( )
inline

default constructor

Definition at line 35 of file LeafRefCandidateT.h.

35 {}

◆ LeafRefCandidateT() [2/2]

template<class REF >
reco::LeafRefCandidateT::LeafRefCandidateT ( const REF &  c,
float  m 
)
inline

Definition at line 38 of file LeafRefCandidateT.h.

39  : LeafCandidate(c->charge(), PolarLorentzVector(c->pt(), c->eta(), c->phi(), m), c->vertex()),
40  ref_(c.refCore(), c.key()) {}
edm::RefCoreWithIndex ref_
math::PtEtaPhiMLorentzVector PolarLorentzVector
Lorentz vector.

◆ ~LeafRefCandidateT()

reco::LeafRefCandidateT::~LeafRefCandidateT ( )
inlineoverride

destructor

Definition at line 42 of file LeafRefCandidateT.h.

42 {}

Member Function Documentation

◆ Class_Version()

static short reco::LeafRefCandidateT::Class_Version ( )
inlinestatic

Definition at line 160 of file LeafRefCandidateT.h.

162 :

◆ daughter() [1/4]

const Candidate* reco::LeafRefCandidateT::daughter ( size_type  ) const
inlinefinalvirtual

return daughter at a given position (throws an exception)

Reimplemented from reco::LeafCandidate.

Definition at line 55 of file LeafRefCandidateT.h.

55 { return nullptr; }

◆ daughter() [2/4]

Candidate* reco::LeafRefCandidateT::daughter ( size_type  )
inlinefinalvirtual

return daughter at a given position (throws an exception)

Reimplemented from reco::LeafCandidate.

Definition at line 61 of file LeafRefCandidateT.h.

61 { return nullptr; }

◆ daughter() [3/4]

Candidate* reco::LeafRefCandidateT::daughter ( const std::string &  s)
inlinefinalvirtual

return daughter with a specified role name

Reimplemented from reco::LeafCandidate.

Definition at line 63 of file LeafRefCandidateT.h.

63 { return nullptr; }

◆ daughter() [4/4]

const Candidate* reco::LeafRefCandidateT::daughter ( const std::string &  s) const
inlinefinalvirtual

return daughter with a specified role name

Reimplemented from reco::LeafCandidate.

Definition at line 65 of file LeafRefCandidateT.h.

65 { return nullptr; }

◆ get() [1/4]

template<typename C >
C reco::LeafRefCandidateT::get ( ) const
inline

◆ get() [2/4]

template<typename C , typename Tag >
C reco::LeafRefCandidateT::get ( ) const
inline

◆ get() [3/4]

template<typename C >
C reco::LeafRefCandidateT::get ( size_type  i) const
inline

◆ get() [4/4]

template<typename C , typename Tag >
C reco::LeafRefCandidateT::get ( size_type  i) const
inline

◆ getRef()

template<typename REF >
REF reco::LeafRefCandidateT::getRef ( ) const
inlineprotected

Definition at line 47 of file LeafRefCandidateT.h.

References edm::RefCoreWithIndex::index(), ref_, and edm::RefCoreWithIndex::toRefCore().

47  {
48  return REF(ref_.toRefCore(), ref_.index());
49  }
RefCore const & toRefCore() const
edm::RefCoreWithIndex ref_
unsigned int index() const

◆ hasMasterClone()

bool reco::LeafRefCandidateT::hasMasterClone ( ) const
inlinefinalvirtual

This only happens if the concrete Candidate type is ShallowCloneCandidate.

Reimplemented from reco::LeafCandidate.

Definition at line 77 of file LeafRefCandidateT.h.

Referenced by get(), and numberOf().

77 { return false; }

◆ hasMasterClonePtr()

bool reco::LeafRefCandidateT::hasMasterClonePtr ( ) const
inlinefinalvirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 86 of file LeafRefCandidateT.h.

86 { return false; }

◆ isCaloMuon()

bool reco::LeafRefCandidateT::isCaloMuon ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 155 of file LeafRefCandidateT.h.

155 { return false; }

◆ isConvertedPhoton()

bool reco::LeafRefCandidateT::isConvertedPhoton ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 157 of file LeafRefCandidateT.h.

157 { return false; }

◆ isElectron()

bool reco::LeafRefCandidateT::isElectron ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 150 of file LeafRefCandidateT.h.

150 { return false; }

◆ isGlobalMuon()

bool reco::LeafRefCandidateT::isGlobalMuon ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 153 of file LeafRefCandidateT.h.

Referenced by Muon.Muon::muonID().

153 { return false; }

◆ isJet()

bool reco::LeafRefCandidateT::isJet ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 158 of file LeafRefCandidateT.h.

158 { return false; }

◆ isMuon()

bool reco::LeafRefCandidateT::isMuon ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 151 of file LeafRefCandidateT.h.

151 { return false; }

◆ isPhoton()

bool reco::LeafRefCandidateT::isPhoton ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 156 of file LeafRefCandidateT.h.

156 { return false; }

◆ isStandAloneMuon()

bool reco::LeafRefCandidateT::isStandAloneMuon ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 152 of file LeafRefCandidateT.h.

152 { return false; }

◆ isTrackerMuon()

bool reco::LeafRefCandidateT::isTrackerMuon ( ) const
inlinefinalvirtual

Reimplemented from reco::LeafCandidate.

Definition at line 154 of file LeafRefCandidateT.h.

154 { return false; }

◆ masterClone()

const CandidateBaseRef& reco::LeafRefCandidateT::masterClone ( ) const
inlinefinalvirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 80 of file LeafRefCandidateT.h.

Referenced by get(), and numberOf().

80  {
81  static const CandidateBaseRef dummyRef;
82  return dummyRef;
83  }
edm::RefToBase< Candidate > CandidateBaseRef
persistent reference to an object in a collection of Candidate objects
Definition: CandidateFwd.h:31

◆ masterClonePtr()

const CandidatePtr& reco::LeafRefCandidateT::masterClonePtr ( ) const
inlinefinalvirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 89 of file LeafRefCandidateT.h.

89  {
90  static const CandidatePtr dummyPtr;
91  return dummyPtr;
92  }
edm::Ptr< Candidate > CandidatePtr
persistent reference to an object in a collection of Candidate objects
Definition: CandidateFwd.h:25

◆ masterRef()

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

cast master clone reference to a concrete type

Definition at line 96 of file LeafRefCandidateT.h.

96  {
97  Ref dummyRef;
98  return dummyRef;
99  }

◆ mother()

const Candidate* reco::LeafRefCandidateT::mother ( size_type  ) const
inlinefinalvirtual

return mother at a given position (throws an exception)

Reimplemented from reco::LeafCandidate.

Definition at line 59 of file LeafRefCandidateT.h.

59 { return nullptr; }

◆ numberOf() [1/2]

template<typename C >
size_type reco::LeafRefCandidateT::numberOf ( ) const
inline

number of components

Definition at line 135 of file LeafRefCandidateT.h.

References hasMasterClone(), and masterClone().

135  {
136  if (hasMasterClone())
137  return masterClone()->template numberOf<C>();
138  else
139  return reco::numberOf<C>(*this);
140  }
const CandidateBaseRef & masterClone() const final
bool hasMasterClone() const final
This only happens if the concrete Candidate type is ShallowCloneCandidate.

◆ numberOf() [2/2]

template<typename C , typename Tag >
size_type reco::LeafRefCandidateT::numberOf ( ) const
inline

number of components

Definition at line 143 of file LeafRefCandidateT.h.

References hasMasterClone(), and masterClone().

143  {
144  if (hasMasterClone())
145  return masterClone()->template numberOf<C, Tag>();
146  else
147  return reco::numberOf<C, Tag>(*this);
148  }
const CandidateBaseRef & masterClone() const final
bool hasMasterClone() const final
This only happens if the concrete Candidate type is ShallowCloneCandidate.

◆ numberOfDaughters()

size_t reco::LeafRefCandidateT::numberOfDaughters ( ) const
inlinefinalvirtual

number of daughters

Reimplemented from reco::LeafCandidate.

Definition at line 53 of file LeafRefCandidateT.h.

53 { return 0; }

◆ numberOfMothers()

size_t reco::LeafRefCandidateT::numberOfMothers ( ) const
inlinefinalvirtual

number of mothers

Reimplemented from reco::LeafCandidate.

Definition at line 57 of file LeafRefCandidateT.h.

57 { return 0; }

◆ numberOfSourceCandidatePtrs()

size_t reco::LeafRefCandidateT::numberOfSourceCandidatePtrs ( ) const
inlinefinalvirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 68 of file LeafRefCandidateT.h.

68 { return 0; }

◆ overlap() [1/2]

bool reco::LeafRefCandidateT::overlap ( const Candidate o) const
inlineoverrideprotectedvirtual

check overlap with another Candidate

Reimplemented from reco::LeafCandidate.

Definition at line 199 of file LeafRefCandidateT.h.

References reco::LeafCandidate::charge(), EcalTangentSkim_cfg::o, reco::LeafCandidate::p4(), and reco::LeafCandidate::vertex().

199  {
200  return p4() == o.p4() && vertex() == o.vertex() && charge() == o.charge();
201  }
const Point & vertex() const override
vertex position (overwritten by PF...)
const LorentzVector & p4() const final
four-momentum Lorentz vector
int charge() const final
electric charge

◆ overlap() [2/2]

bool reco::LeafRefCandidateT::overlap ( const LeafRefCandidateT o) const
inlineprotectedvirtual

Definition at line 203 of file LeafRefCandidateT.h.

References edm::RefCoreWithIndex::id(), edm::RefCoreWithIndex::index(), EcalTangentSkim_cfg::o, and ref_.

203  {
204  return (ref_.id() == o.ref_.id()) & (ref_.index() == o.ref_.index());
205  }
ProductID id() const
edm::RefCoreWithIndex ref_
unsigned int index() const

◆ sourceCandidatePtr()

CandidatePtr reco::LeafRefCandidateT::sourceCandidatePtr ( size_type  i) const
inlinefinalvirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 71 of file LeafRefCandidateT.h.

71  {
72  static const CandidatePtr dummyPtr;
73  return dummyPtr;
74  }
edm::Ptr< Candidate > CandidatePtr
persistent reference to an object in a collection of Candidate objects
Definition: CandidateFwd.h:25

Friends And Related Function Documentation

◆ ::OverlapChecker

friend class ::OverlapChecker
friend

Definition at line 168 of file LeafRefCandidateT.h.

◆ component

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

Definition at line 167 of file LeafRefCandidateT.h.

◆ ShallowCloneCandidate

friend class ShallowCloneCandidate
friend

Definition at line 169 of file LeafRefCandidateT.h.

◆ ShallowClonePtrCandidate

friend class ShallowClonePtrCandidate
friend

Definition at line 170 of file LeafRefCandidateT.h.

Member Data Documentation

◆ ref_

edm::RefCoreWithIndex reco::LeafRefCandidateT::ref_
protected

Definition at line 173 of file LeafRefCandidateT.h.

Referenced by getRef(), and overlap().