test
CMS 3D CMS Logo

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

virtual bool overlap (const Candidate &) const
 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

collection of references to daughters

Definition at line 20 of file CompositeRefBaseCandidate.h.

Constructor & Destructor Documentation

reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( )
inline

default constructor

Definition at line 22 of file CompositeRefBaseCandidate.h.

Referenced by clone().

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.

25  :
26  LeafCandidate( q, p4, vtx, pdgId, status, integerCharge ) { }
virtual int pdgId() const
PDG identifier.
virtual int status() const
status word
virtual const LorentzVector & p4() const
four-momentum Lorentz vector
Definition: LeafCandidate.h:99
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 28 of file CompositeRefBaseCandidate.h.

29  :
30  LeafCandidate( q, p4, vtx, pdgId, status, integerCharge ) { }
virtual int pdgId() const
PDG identifier.
virtual int status() const
status word
virtual const LorentzVector & p4() const
four-momentum Lorentz vector
Definition: LeafCandidate.h:99
reco::CompositeRefBaseCandidate::CompositeRefBaseCandidate ( const Candidate c)
inlineexplicit

constructor from a particle

Definition at line 32 of file CompositeRefBaseCandidate.h.

CompositeRefBaseCandidate::~CompositeRefBaseCandidate ( )
virtual

destructor

Definition at line 6 of file CompositeRefBaseCandidate.cc.

6  {
7 }

Member Function Documentation

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

add a daughter via a reference

Definition at line 62 of file CompositeRefBaseCandidate.h.

References dau.

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

62  {
63  dau.push_back( cand );
64  }
daughters dau
collection of references to daughters
void reco::CompositeRefBaseCandidate::clearDaughters ( )
inline

clear daughter references

Definition at line 51 of file CompositeRefBaseCandidate.h.

References dau.

51 { dau.clear(); }
daughters dau
collection of references to daughters
CompositeRefBaseCandidate * CompositeRefBaseCandidate::clone ( void  ) const
virtual

returns a clone of the candidate

Reimplemented from reco::LeafCandidate.

Definition at line 9 of file CompositeRefBaseCandidate.cc.

References CompositeRefBaseCandidate().

9  {
10  return new CompositeRefBaseCandidate( * this );
11 }
CompositeRefBaseCandidate()
default constructor
const Candidate * CompositeRefBaseCandidate::daughter ( size_type  i) const
virtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 13 of file CompositeRefBaseCandidate.cc.

References dau, i, and numberOfDaughters().

13  {
14  return ( i < numberOfDaughters() ) ? & * dau[ i ] : 0; // i >= 0, since i is unsigned
15 }
virtual size_t numberOfDaughters() const
number of daughters
int i
Definition: DBlmapReader.cc:9
daughters dau
collection of references to daughters
Candidate * CompositeRefBaseCandidate::daughter ( size_type  i)
virtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 21 of file CompositeRefBaseCandidate.cc.

21  {
22  return 0;
23 }
CandidateBaseRef reco::CompositeRefBaseCandidate::daughterRef ( size_type  i) const
inline

reference to daughter at given position

Definition at line 53 of file CompositeRefBaseCandidate.h.

References dau, and i.

53 { return dau[ i ]; }
int i
Definition: DBlmapReader.cc:9
daughters dau
collection of references to daughters
const Candidate * CompositeRefBaseCandidate::mother ( size_type  i) const
virtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 17 of file CompositeRefBaseCandidate.cc.

17  {
18  return 0;
19 }
size_t CompositeRefBaseCandidate::numberOfDaughters ( ) const
virtual

number of daughters

Reimplemented from reco::LeafCandidate.

Definition at line 25 of file CompositeRefBaseCandidate.cc.

References dau.

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

25  {
26  return dau.size();
27 }
daughters dau
collection of references to daughters
size_t CompositeRefBaseCandidate::numberOfMothers ( ) const
virtual

number of mothers

Reimplemented from reco::LeafCandidate.

Definition at line 29 of file CompositeRefBaseCandidate.cc.

29  {
30  return 0;
31 }
bool CompositeRefBaseCandidate::overlap ( const Candidate c2) const
privatevirtual

check overlap with another candidate

Reimplemented from reco::LeafCandidate.

Definition at line 33 of file CompositeRefBaseCandidate.cc.

References Exception.

33  {
34  throw cms::Exception( "Error" ) << "can't check overlap internally for CompositeRefBaseCanddate";
35 }

Member Data Documentation

daughters reco::CompositeRefBaseCandidate::dau
private

collection of references to daughters

Definition at line 57 of file CompositeRefBaseCandidate.h.

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