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 | Private Member Functions | Private Attributes
reco::CompositeRefCandidate Class Reference

#include <CompositeRefCandidate.h>

Inheritance diagram for reco::CompositeRefCandidate:
reco::LeafCandidate reco::Candidate

Public Types

typedef CandidateRefVector daughters
 collection of references to daughters More...
 
typedef CandidateRefVector mothers
 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 CandidateRef &)
 add a daughter via a reference More...
 
void addMother (const CandidateRef &)
 add a daughter via a reference More...
 
void clearDaughters ()
 clear daughter references More...
 
CompositeRefCandidateclone () const override
 returns a clone of the candidate More...
 
 CompositeRefCandidate ()
 default constructor More...
 
 CompositeRefCandidate (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...
 
 CompositeRefCandidate (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...
 
 CompositeRefCandidate (const Candidate &p)
 constructor from a candidate 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...
 
CandidateRef daughterRef (size_type i) const
 reference to daughter at given position More...
 
const daughtersdaughterRefVector () const
 references to daughtes More...
 
const Candidatemother (size_t i=0) const override
 return pointer to mother More...
 
CandidateRef motherRef (size_type i=0) const
 reference to mother at given position More...
 
const mothersmotherRefVector () const
 references to mothers More...
 
size_t numberOfDaughters () const override
 number of daughters More...
 
size_t numberOfMothers () const override
 number of mothers (zero or one in most of but not all the cases) More...
 
void resetDaughters (const edm::ProductID &id)
 set daughters product ID More...
 
 ~CompositeRefCandidate () 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...
 
daughters mom
 collection of references to mothers More...
 

Additional Inherited Members

Detailed Description

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

Author
Luca Lista, INFN

Definition at line 17 of file CompositeRefCandidate.h.

Member Typedef Documentation

collection of references to daughters

Definition at line 20 of file CompositeRefCandidate.h.

collection of references to daughters

Definition at line 22 of file CompositeRefCandidate.h.

Constructor & Destructor Documentation

reco::CompositeRefCandidate::CompositeRefCandidate ( )
inline

default constructor

Definition at line 24 of file CompositeRefCandidate.h.

Referenced by clone().

reco::CompositeRefCandidate::CompositeRefCandidate ( 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 26 of file CompositeRefCandidate.h.

32  : 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.
reco::CompositeRefCandidate::CompositeRefCandidate ( 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 34 of file CompositeRefCandidate.h.

40  : 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.
reco::CompositeRefCandidate::CompositeRefCandidate ( const Candidate p)
inlineexplicit

constructor from a candidate

Definition at line 42 of file CompositeRefCandidate.h.

42 : LeafCandidate(p) {}
double p() const final
magnitude of momentum vector
CompositeRefCandidate::~CompositeRefCandidate ( )
override

destructor

Definition at line 6 of file CompositeRefCandidate.cc.

6 {}

Member Function Documentation

void reco::CompositeRefCandidate::addDaughter ( const CandidateRef cand)
inline

add a daughter via a reference

Definition at line 84 of file CompositeRefCandidate.h.

References dau, and edm::RefVector< C, T, F >::push_back().

84 { dau.push_back(cand); }
daughters dau
collection of references to daughters
void push_back(value_type const &ref)
Add a Ref&lt;C, T&gt; to the RefVector.
Definition: RefVector.h:67
void reco::CompositeRefCandidate::addMother ( const CandidateRef cand)
inline

add a daughter via a reference

Definition at line 86 of file CompositeRefCandidate.h.

References mom, and edm::RefVector< C, T, F >::push_back().

86 { mom.push_back(cand); }
daughters mom
collection of references to mothers
void push_back(value_type const &ref)
Add a Ref&lt;C, T&gt; to the RefVector.
Definition: RefVector.h:67
void reco::CompositeRefCandidate::clearDaughters ( )
inline

clear daughter references

Definition at line 59 of file CompositeRefCandidate.h.

References edm::RefVector< C, T, F >::clear(), and dau.

59 { dau.clear(); }
daughters dau
collection of references to daughters
void clear()
Clear the vector.
Definition: RefVector.h:142
CompositeRefCandidate * CompositeRefCandidate::clone ( void  ) const
overridevirtual

returns a clone of the candidate

Implements reco::Candidate.

Definition at line 8 of file CompositeRefCandidate.cc.

References CompositeRefCandidate().

8 { return new CompositeRefCandidate(*this); }
CompositeRefCandidate()
default constructor
const Candidate * CompositeRefCandidate::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 CompositeRefCandidate.cc.

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

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

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

Implements reco::Candidate.

Definition at line 18 of file CompositeRefCandidate.cc.

18 { return nullptr; }
CandidateRef reco::CompositeRefCandidate::daughterRef ( size_type  i) const
inline

reference to daughter at given position

Definition at line 61 of file CompositeRefCandidate.h.

References dau, and mps_fire::i.

61 { return dau[i]; }
daughters dau
collection of references to daughters
const daughters& reco::CompositeRefCandidate::daughterRefVector ( ) const
inline

references to daughtes

Definition at line 63 of file CompositeRefCandidate.h.

References dau.

63 { return dau; }
daughters dau
collection of references to daughters
const Candidate * CompositeRefCandidate::mother ( size_t  i = 0) const
overridevirtual

return pointer to mother

Implements reco::Candidate.

Definition at line 14 of file CompositeRefCandidate.cc.

References mps_fire::i, mom, and numberOfMothers().

14  {
15  return (i < numberOfMothers()) ? &*mom[i] : nullptr; // i >= 0, since i is unsigned
16 }
size_t numberOfMothers() const override
number of mothers (zero or one in most of but not all the cases)
daughters mom
collection of references to mothers
CandidateRef reco::CompositeRefCandidate::motherRef ( size_type  i = 0) const
inline

reference to mother at given position

Definition at line 65 of file CompositeRefCandidate.h.

References mps_fire::i, and mom.

65 { return mom[i]; }
daughters mom
collection of references to mothers
const mothers& reco::CompositeRefCandidate::motherRefVector ( ) const
inline

references to mothers

Definition at line 67 of file CompositeRefCandidate.h.

References mom.

67 { return mom; }
daughters mom
collection of references to mothers
size_t CompositeRefCandidate::numberOfDaughters ( ) const
overridevirtual

number of daughters

Implements reco::Candidate.

Definition at line 20 of file CompositeRefCandidate.cc.

References dau, and edm::RefVector< C, T, F >::size().

Referenced by daughter().

20 { return dau.size(); }
daughters dau
collection of references to daughters
size_type size() const
Size of the RefVector.
Definition: RefVector.h:102
size_t CompositeRefCandidate::numberOfMothers ( ) const
overridevirtual

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

Implements reco::Candidate.

Definition at line 22 of file CompositeRefCandidate.cc.

References mom, and edm::RefVector< C, T, F >::size().

Referenced by mother().

22 { return mom.size(); }
daughters mom
collection of references to mothers
size_type size() const
Size of the RefVector.
Definition: RefVector.h:102
bool CompositeRefCandidate::overlap ( const Candidate c2) const
overrideprivatevirtual

check overlap with another candidate

Implements reco::Candidate.

Definition at line 24 of file CompositeRefCandidate.cc.

References Exception.

24  {
25  throw cms::Exception("Error") << "can't check overlap internally for CompositeRefCanddate";
26 }
void reco::CompositeRefCandidate::resetDaughters ( const edm::ProductID id)
inline

set daughters product ID

Definition at line 69 of file CompositeRefCandidate.h.

References dau.

69 { dau = daughters(id); }
daughters dau
collection of references to daughters
CandidateRefVector daughters
collection of references to daughters

Member Data Documentation

daughters reco::CompositeRefCandidate::dau
private

collection of references to daughters

Definition at line 77 of file CompositeRefCandidate.h.

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

daughters reco::CompositeRefCandidate::mom
private

collection of references to mothers

Definition at line 79 of file CompositeRefCandidate.h.

Referenced by addMother(), mother(), motherRef(), motherRefVector(), and numberOfMothers().