CMS 3D CMS Logo

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

#include <VertexCompositeCandidate.h>

Inheritance diagram for reco::VertexCompositeCandidate:
reco::CompositeCandidate reco::LeafCandidate reco::Candidate

Public Member Functions

VertexCompositeCandidateclone () const override
 returns a clone of the candidate More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
void setChi2AndNdof (double chi2, double ndof)
 set chi2 and ndof More...
 
void setCovariance (const CovarianceMatrix &m)
 set covariance matrix More...
 
double vertexChi2 () const override
 chi-squares More...
 
 VertexCompositeCandidate ()
 
 VertexCompositeCandidate (Charge q, const LorentzVector &p4, const Point &vtx, const CovarianceMatrix &err, double chi2, double ndof, int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 VertexCompositeCandidate (Charge q, const LorentzVector &p4, const Point &vtx, int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 VertexCompositeCandidate (const Candidate &p)
 constructor from values More...
 
 VertexCompositeCandidate (const CompositeCandidate &p)
 constructor from values More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
double vertexNdof () const override
 
double vertexNormalizedChi2 () const override
 chi-squared divided by n.d.o.f. More...
 
 ~VertexCompositeCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::CompositeCandidate
void addDaughter (const Candidate &, const std::string &s="")
 add a clone of the passed candidate as daughter More...
 
void addDaughter (std::unique_ptr< Candidate >, const std::string &s="")
 add a clone of the passed candidate as daughter More...
 
void applyRoles ()
 
void clearDaughters ()
 clear daughters More...
 
void clearRoles ()
 
template<typename P4 >
 CompositeCandidate (Charge q, const P4 &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true, std::string name="")
 constructor from values More...
 
 CompositeCandidate (const Candidate &p, const std::string &name, role_collection const &roles)
 constructor from values More...
 
 CompositeCandidate (const Candidate &p, const std::string &name="")
 constructor from values More...
 
 CompositeCandidate (std::string name="")
 default constructor More...
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name 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...
 
const Candidatemother (size_type i=0) const override
 return pointer to mother More...
 
std::string name () const
 get the name of the candidate More...
 
size_type numberOfDaughters () const override
 number of daughters More...
 
size_type numberOfMothers () const override
 number of mothers (zero or one in most of but not all the cases) More...
 
role_collection const & roles () const
 get the roles More...
 
void setName (std::string name)
 set the name of the candidate More...
 
void setRoles (const role_collection &roles)
 set the roles More...
 
 ~CompositeCandidate () override
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
Vector boostToCM () const final
 
int charge () const final
 electric charge More...
 
void construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
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...
 
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...
 
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 ()
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (const Candidate &c)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate &rh)
 
 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...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix 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
iterator begin ()
 first daughter iterator More...
 
const_iterator begin () const
 first daughter const_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...
 
iterator end ()
 last daughter iterator More...
 
const_iterator end () const
 last daughter const_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

index idx (index i, index j) const
 position index More...
 

Private Attributes

Double32_t chi2_
 chi-sqared More...
 
Double32_t covariance_ [size]
 covariance matrix (3x3) as vector More...
 
Double32_t ndof_
 number of degrees of freedom More...
 

Additional Inherited Members

- Public Types inherited from reco::CompositeCandidate
typedef CandidateCollection daughters
 collection of daughters More...
 
typedef std::vector< std::string > role_collection
 
- 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...
 

Detailed Description

A composite Candidate with error matrix and other vertex fix information.

Author
Luca Lista, INFN

Definition at line 16 of file VertexCompositeCandidate.h.

Constructor & Destructor Documentation

◆ VertexCompositeCandidate() [1/5]

reco::VertexCompositeCandidate::VertexCompositeCandidate ( )
inline

Definition at line 18 of file VertexCompositeCandidate.h.

18 : CompositeCandidate() {}

Referenced by clone().

◆ VertexCompositeCandidate() [2/5]

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

constructor from values

Definition at line 20 of file VertexCompositeCandidate.h.

22  : CompositeCandidate(q, p4, vtx, pdgId, status, integerCharge), chi2_(0), ndof_(0) {}

◆ VertexCompositeCandidate() [3/5]

VertexCompositeCandidate::VertexCompositeCandidate ( Charge  q,
const LorentzVector p4,
const Point vtx,
const CovarianceMatrix err,
double  chi2,
double  ndof,
int  pdgId = 0,
int  status = 0,
bool  integerCharge = true 
)

constructor from values

Definition at line 5 of file VertexCompositeCandidate.cc.

14  : CompositeCandidate(q, p4, vtx, pdgId, status, integerCharge), chi2_(chi2), ndof_(ndof) {
16 }

References submitPVResolutionJobs::err, and setCovariance().

◆ VertexCompositeCandidate() [4/5]

reco::VertexCompositeCandidate::VertexCompositeCandidate ( const Candidate p)
inlineexplicit

constructor from values

Definition at line 34 of file VertexCompositeCandidate.h.

34 : CompositeCandidate(p), chi2_(0), ndof_(0) {}

◆ VertexCompositeCandidate() [5/5]

reco::VertexCompositeCandidate::VertexCompositeCandidate ( const CompositeCandidate p)
inlineexplicit

constructor from values

Definition at line 36 of file VertexCompositeCandidate.h.

36 : CompositeCandidate(p), chi2_(0), ndof_(0) {}

◆ ~VertexCompositeCandidate()

VertexCompositeCandidate::~VertexCompositeCandidate ( )
override

destructor

Definition at line 18 of file VertexCompositeCandidate.cc.

18 {}

Member Function Documentation

◆ clone()

VertexCompositeCandidate * VertexCompositeCandidate::clone ( void  ) const
overridevirtual

returns a clone of the candidate

Reimplemented from reco::CompositeCandidate.

Definition at line 20 of file VertexCompositeCandidate.cc.

20 { return new VertexCompositeCandidate(*this); }

References VertexCompositeCandidate().

◆ fillVertexCovariance()

void VertexCompositeCandidate::fillVertexCovariance ( CovarianceMatrix v) const
overridevirtual

fill SMatrix

Reimplemented from reco::LeafCandidate.

Definition at line 22 of file VertexCompositeCandidate.cc.

22  {
23  index idx = 0;
24  for (index i = 0; i < dimension; ++i)
25  for (index j = 0; j <= i; ++j)
26  err(i, j) = covariance_[idx++];
27 }

References covariance_, reco::Candidate::dimension, submitPVResolutionJobs::err, mps_fire::i, idx(), and dqmiolumiharvest::j.

◆ idx()

index reco::VertexCompositeCandidate::idx ( index  i,
index  j 
) const
inlineprivate

position index

Definition at line 73 of file VertexCompositeCandidate.h.

73  {
74  int a = (i <= j ? i : j), b = (i <= j ? j : i);
75  return b * (b + 1) / 2 + a;
76  }

References a, b, mps_fire::i, and dqmiolumiharvest::j.

Referenced by fillVertexCovariance(), setCovariance(), ntupleDataFormat.TrackMatchInfo::track(), ntupleDataFormat.TrackingParticleMatchInfo::trackingParticle(), and vertexCovariance().

◆ setChi2AndNdof()

void reco::VertexCompositeCandidate::setChi2AndNdof ( double  chi2,
double  ndof 
)
inline

set chi2 and ndof

Definition at line 58 of file VertexCompositeCandidate.h.

58  {
59  chi2_ = chi2;
60  ndof_ = ndof;
61  }

References hltPixelTracks_cff::chi2, chi2_, ndof, and ndof_.

◆ setCovariance()

void VertexCompositeCandidate::setCovariance ( const CovarianceMatrix m)

set covariance matrix

Definition at line 29 of file VertexCompositeCandidate.cc.

29  {
30  index idx = 0;
31  for (index i = 0; i < dimension; ++i)
32  for (index j = 0; j <= i; ++j)
33  covariance_[idx++] = err(i, j);
34 }

References covariance_, reco::Candidate::dimension, submitPVResolutionJobs::err, mps_fire::i, idx(), and dqmiolumiharvest::j.

Referenced by VertexCompositeCandidate().

◆ vertexChi2()

double reco::VertexCompositeCandidate::vertexChi2 ( ) const
inlineoverridevirtual

chi-squares

Reimplemented from reco::LeafCandidate.

Definition at line 42 of file VertexCompositeCandidate.h.

42 { return chi2_; }

References chi2_.

Referenced by CandKinematicVertexFitter::fill().

◆ vertexCovariance()

double reco::VertexCompositeCandidate::vertexCovariance ( int  i,
int  j 
) const
inlineoverridevirtual

(i, j)-th element of error matrix, i, j = 0, ... 2

Reimplemented from reco::LeafCandidate.

Definition at line 53 of file VertexCompositeCandidate.h.

53 { return covariance_[idx(i, j)]; }

References covariance_, mps_fire::i, idx(), and dqmiolumiharvest::j.

◆ vertexNdof()

double reco::VertexCompositeCandidate::vertexNdof ( ) const
inlineoverridevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 49 of file VertexCompositeCandidate.h.

49 { return ndof_; }

References ndof_.

◆ vertexNormalizedChi2()

double reco::VertexCompositeCandidate::vertexNormalizedChi2 ( ) const
inlineoverridevirtual

chi-squared divided by n.d.o.f.

Reimplemented from reco::LeafCandidate.

Definition at line 51 of file VertexCompositeCandidate.h.

51 { return chi2_ / ndof_; }

References chi2_, and ndof_.

Member Data Documentation

◆ chi2_

Double32_t reco::VertexCompositeCandidate::chi2_
private

chi-sqared

Definition at line 67 of file VertexCompositeCandidate.h.

Referenced by setChi2AndNdof(), vertexChi2(), and vertexNormalizedChi2().

◆ covariance_

Double32_t reco::VertexCompositeCandidate::covariance_[size]
private

covariance matrix (3x3) as vector

Definition at line 71 of file VertexCompositeCandidate.h.

Referenced by fillVertexCovariance(), setCovariance(), and vertexCovariance().

◆ ndof_

Double32_t reco::VertexCompositeCandidate::ndof_
private

number of degrees of freedom

Definition at line 69 of file VertexCompositeCandidate.h.

Referenced by setChi2AndNdof(), vertexNdof(), and vertexNormalizedChi2().

mps_fire.i
i
Definition: mps_fire.py:428
reco::LeafCandidate::status
int status() const final
status word
Definition: LeafCandidate.h:180
reco::LeafCandidate::index
unsigned int index
Definition: LeafCandidate.h:31
hltPixelTracks_cff.chi2
chi2
Definition: hltPixelTracks_cff.py:25
ndof
Definition: HIMultiTrackSelector.h:49
reco::VertexCompositeCandidate::chi2_
Double32_t chi2_
chi-sqared
Definition: VertexCompositeCandidate.h:67
reco::VertexCompositeCandidate::covariance_
Double32_t covariance_[size]
covariance matrix (3x3) as vector
Definition: VertexCompositeCandidate.h:71
reco::VertexCompositeCandidate::idx
index idx(index i, index j) const
position index
Definition: VertexCompositeCandidate.h:73
b
double b
Definition: hdecay.h:118
a
double a
Definition: hdecay.h:119
reco::LeafCandidate::pdgId
int pdgId() const final
PDG identifier.
Definition: LeafCandidate.h:176
reco::VertexCompositeCandidate::ndof_
Double32_t ndof_
number of degrees of freedom
Definition: VertexCompositeCandidate.h:69
reco::LeafCandidate::p4
const LorentzVector & p4() const final
four-momentum Lorentz vector
Definition: LeafCandidate.h:114
reco::CompositeCandidate::CompositeCandidate
CompositeCandidate(std::string name="")
default constructor
Definition: CompositeCandidate.h:27
submitPVResolutionJobs.q
q
Definition: submitPVResolutionJobs.py:84
submitPVResolutionJobs.err
err
Definition: submitPVResolutionJobs.py:85
reco::VertexCompositeCandidate::VertexCompositeCandidate
VertexCompositeCandidate()
Definition: VertexCompositeCandidate.h:18
extraflags_cff.vtx
vtx
Definition: extraflags_cff.py:18
reco::LeafCandidate::p
double p() const final
magnitude of momentum vector
Definition: LeafCandidate.h:123
reco::Candidate::dimension
Definition: Candidate.h:44
reco::VertexCompositeCandidate::setCovariance
void setCovariance(const CovarianceMatrix &m)
set covariance matrix
Definition: VertexCompositeCandidate.cc:29
dqmiolumiharvest.j
j
Definition: dqmiolumiharvest.py:66