CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes
reco::CompositeRefBaseCandidate Class Reference

#include <CompositeRefBaseCandidate.h>

Inheritance diagram for reco::CompositeRefBaseCandidate:
reco::LeafCandidate reco::Candidate pat::MHT reco::GenericJet

Public Types

typedef std::vector< CandidateBaseRefdaughters
 collection of references to daughters 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

void addDaughter (const CandidateBaseRef &)
 add a daughter via a reference More...
 
void clearDaughters ()
 clear daughter references More...
 
CompositeRefBaseCandidateclone () const override
 returns a clone of the candidate More...
 
 CompositeRefBaseCandidate ()
 default constructor More...
 
 CompositeRefBaseCandidate (Charge q, const LorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositeRefBaseCandidate (Charge q, const PolarLorentzVector &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 CompositeRefBaseCandidate (const Candidate &c)
 constructor from a particle More...
 
const Candidatedaughter (size_type) const override
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
 
Candidatedaughter (size_type) override
 return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
 
CandidateBaseRef daughterRef (size_type i) const
 reference to daughter at given position More...
 
const Candidatemother (size_type) const override
 return mother at a given position, i = 0, ... numberOfMothers() - 1 (read only mode) More...
 
size_t numberOfDaughters () const override
 number of daughters More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
 ~CompositeRefBaseCandidate () 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)
 
const Candidatedaughter (size_type) const override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (size_type) override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
double energy () const final
 energy More...
 
double et () const final
 transverse energy More...
 
double et2 () const final
 transverse energy squared (use this for cut!) More...
 
double eta () const final
 momentum pseudorapidity More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
bool hasMasterClone () const override
 
bool hasMasterClonePtr () const override
 
bool isCaloMuon () const override
 
bool isConvertedPhoton () const override
 
bool isElectron () const override
 
bool isGlobalMuon () const override
 
bool isJet () const override
 
bool isMuon () const override
 
bool isPhoton () const override
 
bool isStandAloneMuon () const override
 
bool isTrackerMuon () const override
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
bool longLived () const final
 is long lived? More...
 
double mass () const final
 mass More...
 
bool massConstraint () const final
 do mass constraint? More...
 
double massSqr () const final
 mass squared More...
 
const CandidateBaseRefmasterClone () const override
 
const CandidatePtrmasterClonePtr () const override
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
Vector momentum () const final
 spatial momentum vector More...
 
const Candidatemother (size_type) const override
 return mother at a given position (throws an exception) More...
 
double mt () const final
 transverse mass More...
 
double mtSqr () const final
 transverse mass squared More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
size_t numberOfDaughters () const override
 number of daughters More...
 
size_t numberOfMothers () const override
 number of mothers More...
 
size_t numberOfSourceCandidatePtrs () const override
 
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...
 
CandidatePtr sourceCandidatePtr (size_type i) const override
 
int status () const final
 status word More...
 
double theta () const final
 momentum polar angle More...
 
int threeCharge () const final
 electric charge More...
 
const 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...
 

Private Member Functions

bool overlap (const Candidate &) const override
 check overlap with another candidate More...
 

Private Attributes

daughters dau
 collection of references to daughters More...
 

Additional Inherited Members

Detailed Description

a reco::Candidate composed of daughters. The daughters has persistent references (edm::RefToBase<...>) to reco::Candidate stored in a separate collection.

Author
Luca Lista, INFN

Definition at line 17 of file CompositeRefBaseCandidate.h.

Member Typedef Documentation

◆ daughters

collection of references to daughters

Definition at line 20 of file CompositeRefBaseCandidate.h.

Constructor & Destructor Documentation

◆ CompositeRefBaseCandidate() [1/4]

reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( )
inline

default constructor

Definition at line 22 of file CompositeRefBaseCandidate.h.

Referenced by clone().

◆ CompositeRefBaseCandidate() [2/4]

reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( Charge  q,
const LorentzVector p4,
const Point vtx = Point(0, 0, 0),
int  pdgId = 0,
int  status = 0,
bool  integerCharge = true 
)
inline

constructor from values

Definition at line 24 of file CompositeRefBaseCandidate.h.

30  : LeafCandidate(q, p4, vtx, pdgId, status, integerCharge) {}
int status() const final
status word
const LorentzVector & p4() const final
four-momentum Lorentz vector
int pdgId() const final
PDG identifier.

◆ CompositeRefBaseCandidate() [3/4]

reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( Charge  q,
const PolarLorentzVector p4,
const Point vtx = Point(0, 0, 0),
int  pdgId = 0,
int  status = 0,
bool  integerCharge = true 
)
inline

constructor from values

Definition at line 32 of file CompositeRefBaseCandidate.h.

38  : LeafCandidate(q, p4, vtx, pdgId, status, integerCharge) {}
int status() const final
status word
const LorentzVector & p4() const final
four-momentum Lorentz vector
int pdgId() const final
PDG identifier.

◆ CompositeRefBaseCandidate() [4/4]

reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( const Candidate c)
inlineexplicit

constructor from a particle

Definition at line 40 of file CompositeRefBaseCandidate.h.

◆ ~CompositeRefBaseCandidate()

CompositeRefBaseCandidate::~CompositeRefBaseCandidate ( )
override

destructor

Definition at line 6 of file CompositeRefBaseCandidate.cc.

6 {}

Member Function Documentation

◆ addDaughter()

void reco::CompositeRefBaseCandidate::addDaughter ( const CandidateBaseRef cand)
inline

add a daughter via a reference

Definition at line 70 of file CompositeRefBaseCandidate.h.

References dau.

Referenced by reco::GenericJet::GenericJet().

70 { dau.push_back(cand); }
daughters dau
collection of references to daughters

◆ clearDaughters()

void reco::CompositeRefBaseCandidate::clearDaughters ( )
inline

clear daughter references

Definition at line 59 of file CompositeRefBaseCandidate.h.

References dau.

59 { dau.clear(); }
daughters dau
collection of references to daughters

◆ clone()

CompositeRefBaseCandidate * CompositeRefBaseCandidate::clone ( void  ) const
overridevirtual

returns a clone of the candidate

Implements reco::Candidate.

Definition at line 8 of file CompositeRefBaseCandidate.cc.

References CompositeRefBaseCandidate().

8 { return new CompositeRefBaseCandidate(*this); }
CompositeRefBaseCandidate()
default constructor

◆ daughter() [1/2]

const Candidate * CompositeRefBaseCandidate::daughter ( size_type  i) const
overridevirtual

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

Implements reco::Candidate.

Definition at line 10 of file CompositeRefBaseCandidate.cc.

References dau, mps_fire::i, and numberOfDaughters().

10  {
11  return (i < numberOfDaughters()) ? &*dau[i] : nullptr; // i >= 0, since i is unsigned
12 }
daughters dau
collection of references to daughters
size_t numberOfDaughters() const override
number of daughters

◆ daughter() [2/2]

Candidate * CompositeRefBaseCandidate::daughter ( size_type  i)
overridevirtual

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

Implements reco::Candidate.

Definition at line 16 of file CompositeRefBaseCandidate.cc.

16 { return nullptr; }

◆ daughterRef()

CandidateBaseRef reco::CompositeRefBaseCandidate::daughterRef ( size_type  i) const
inline

reference to daughter at given position

Definition at line 61 of file CompositeRefBaseCandidate.h.

References dau, and mps_fire::i.

61 { return dau[i]; }
daughters dau
collection of references to daughters

◆ mother()

const Candidate * CompositeRefBaseCandidate::mother ( size_type  i) const
overridevirtual

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

Implements reco::Candidate.

Definition at line 14 of file CompositeRefBaseCandidate.cc.

14 { return nullptr; }

◆ numberOfDaughters()

size_t CompositeRefBaseCandidate::numberOfDaughters ( ) const
overridevirtual

number of daughters

Implements reco::Candidate.

Definition at line 18 of file CompositeRefBaseCandidate.cc.

References dau.

Referenced by daughter(), and reco::GenericJet::nConstituents().

18 { return dau.size(); }
daughters dau
collection of references to daughters

◆ numberOfMothers()

size_t CompositeRefBaseCandidate::numberOfMothers ( ) const
overridevirtual

number of mothers

Implements reco::Candidate.

Definition at line 20 of file CompositeRefBaseCandidate.cc.

20 { return 0; }

◆ overlap()

bool CompositeRefBaseCandidate::overlap ( const Candidate c2) const
overrideprivatevirtual

check overlap with another candidate

Implements reco::Candidate.

Definition at line 22 of file CompositeRefBaseCandidate.cc.

References Exception.

22  {
23  throw cms::Exception("Error") << "can't check overlap internally for CompositeRefBaseCanddate";
24 }

Member Data Documentation

◆ dau

daughters reco::CompositeRefBaseCandidate::dau
private

collection of references to daughters

Definition at line 65 of file CompositeRefBaseCandidate.h.

Referenced by addDaughter(), clearDaughters(), daughter(), daughterRef(), and numberOfDaughters().