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

virtual VertexCompositeCandidateclone () const
 returns a clone of the candidate More...
 
virtual void fillVertexCovariance (CovarianceMatrix &v) const
 fill SMatrix More...
 
void setChi2AndNdof (double chi2, double ndof)
 set chi2 and ndof More...
 
void setCovariance (const CovarianceMatrix &m)
 set covariance matrix More...
 
virtual double vertexChi2 () const
 chi-squares More...
 
 VertexCompositeCandidate ()
 
 VertexCompositeCandidate (Charge q, const LorentzVector &p4, const Point &vtx, int pdgId=0, int status=0, bool integerCharge=true)
 constructor from values More...
 
 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 (const Candidate &p)
 constructor from values More...
 
 VertexCompositeCandidate (const CompositeCandidate &p)
 constructor from values More...
 
virtual double vertexCovariance (int i, int j) const
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
virtual double vertexNdof () const
 
virtual double vertexNormalizedChi2 () const
 chi-squared divided by n.d.o.f. More...
 
virtual ~VertexCompositeCandidate ()
 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 ()
 
 CompositeCandidate (std::string name="")
 default constructor More...
 
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="")
 constructor from values More...
 
 CompositeCandidate (const Candidate &p, const std::string &name, role_collection const &roles)
 constructor from values 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...
 
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 const Candidatemother (size_type i=0) const
 return pointer to mother More...
 
std::string name () const
 get the name of the candidate More...
 
virtual size_type numberOfDaughters () const
 number of daughters More...
 
virtual size_type numberOfMothers () const
 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...
 
virtual ~CompositeCandidate ()
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
virtual Vector boostToCM () const final
 
virtual 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)
 
virtual double energy () const final
 energy More...
 
virtual double et () const final
 transverse energy More...
 
virtual double et2 () const final
 transverse energy squared (use this for cut!) More...
 
virtual 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...
 
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 final
 is long lived? More...
 
virtual double mass () const final
 mass More...
 
virtual bool massConstraint () const final
 do mass constraint? More...
 
virtual double massSqr () const final
 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 final
 spatial momentum vector More...
 
virtual double mt () const final
 transverse mass More...
 
virtual 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...
 
virtual size_t numberOfSourceCandidatePtrs () const
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
virtual double p () const final
 magnitude of momentum vector More...
 
virtual const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
virtual int pdgId () const final
 PDG identifier. More...
 
virtual double phi () const final
 momentum azimuthal angle More...
 
virtual const PolarLorentzVectorpolarP4 () const final
 four-momentum Lorentz vector More...
 
virtual double pt () const final
 transverse momentum More...
 
virtual double px () const final
 x coordinate of momentum vector More...
 
virtual double py () const final
 y coordinate of momentum vector More...
 
virtual double pz () const final
 z coordinate of momentum vector More...
 
virtual double rapidity () const final
 rapidity More...
 
virtual void setCharge (Charge q) final
 set electric charge More...
 
virtual void setLongLived () final
 
virtual void setMass (double m) final
 set particle mass More...
 
virtual void setMassConstraint () final
 
virtual void setP4 (const LorentzVector &p4) final
 set 4-momentum More...
 
virtual void setP4 (const PolarLorentzVector &p4) final
 set 4-momentum More...
 
virtual void setPdgId (int pdgId) final
 
virtual void setPz (double pz) final
 
virtual void setStatus (int status) final
 set status word More...
 
virtual void setThreeCharge (Charge qx3) final
 set electric charge More...
 
virtual void setVertex (const Point &vertex)
 set vertex More...
 
virtual CandidatePtr sourceCandidatePtr (size_type i) const
 
virtual int status () const final
 status word More...
 
virtual double theta () const final
 momentum polar angle More...
 
virtual int threeCharge () const final
 electric charge More...
 
virtual const Pointvertex () const
 vertex position (overwritten by PF...) More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix 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 final
 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

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

reco::VertexCompositeCandidate::VertexCompositeCandidate ( )
inline

Definition at line 18 of file VertexCompositeCandidate.h.

Referenced by clone(), and VertexCompositeCandidate().

18 : CompositeCandidate() { }
CompositeCandidate(std::string name="")
default constructor
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.

References HiEvtPlane_cfi::chi2, ndof, reco::LeafCandidate::p4(), reco::LeafCandidate::pdgId(), lumiQueryAPI::q, reco::LeafCandidate::status(), VertexCompositeCandidate(), and badGlobalMuonTaggersAOD_cff::vtx.

21  :
22  CompositeCandidate(q, p4, vtx, pdgId, status, integerCharge),
23  chi2_(0), ndof_(0) { }
virtual int status() const final
status word
Double32_t ndof_
number of degrees of freedom
virtual int pdgId() const final
PDG identifier.
CompositeCandidate(std::string name="")
default constructor
virtual const LorentzVector & p4() const final
four-momentum Lorentz vector
Definition: LeafCandidate.h:99
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.

References setCovariance().

7  :
8  CompositeCandidate(q, p4, vtx, pdgId, status, integerCharge),
9  chi2_(chi2), ndof_(ndof) {
10  setCovariance(err);
11 }
virtual int status() const final
status word
Double32_t ndof_
number of degrees of freedom
void setCovariance(const CovarianceMatrix &m)
set covariance matrix
virtual int pdgId() const final
PDG identifier.
CompositeCandidate(std::string name="")
default constructor
virtual const LorentzVector & p4() const final
four-momentum Lorentz vector
Definition: LeafCandidate.h:99
reco::VertexCompositeCandidate::VertexCompositeCandidate ( const Candidate p)
inlineexplicit

constructor from values

Definition at line 29 of file VertexCompositeCandidate.h.

29  :
30  CompositeCandidate(p), chi2_(0), ndof_(0) { }
Double32_t ndof_
number of degrees of freedom
CompositeCandidate(std::string name="")
default constructor
virtual double p() const final
magnitude of momentum vector
reco::VertexCompositeCandidate::VertexCompositeCandidate ( const CompositeCandidate p)
inlineexplicit

constructor from values

Definition at line 32 of file VertexCompositeCandidate.h.

References clone(), and ~VertexCompositeCandidate().

32  :
33  CompositeCandidate(p), chi2_(0), ndof_(0) { }
Double32_t ndof_
number of degrees of freedom
CompositeCandidate(std::string name="")
default constructor
virtual double p() const final
magnitude of momentum vector
VertexCompositeCandidate::~VertexCompositeCandidate ( )
virtual

destructor

Definition at line 13 of file VertexCompositeCandidate.cc.

Referenced by VertexCompositeCandidate().

13 { }

Member Function Documentation

VertexCompositeCandidate * VertexCompositeCandidate::clone ( void  ) const
virtual

returns a clone of the candidate

Reimplemented from reco::CompositeCandidate.

Definition at line 15 of file VertexCompositeCandidate.cc.

References VertexCompositeCandidate().

Referenced by VertexCompositeCandidate().

15  {
16  return new VertexCompositeCandidate(*this);
17 }
void VertexCompositeCandidate::fillVertexCovariance ( CovarianceMatrix v) const
virtual

fill SMatrix

Reimplemented from reco::LeafCandidate.

Definition at line 19 of file VertexCompositeCandidate.cc.

References covariance_, reco::Candidate::dimension, mps_fire::i, and idx().

Referenced by vertexCovariance().

19  {
20  index idx = 0;
21  for(index i = 0; i < dimension; ++i)
22  for(index j = 0; j <= i; ++ j)
23  err(i, j) = covariance_[idx++];
24 }
index idx(index i, index j) const
position index
unsigned int index
Definition: LeafCandidate.h:31
Double32_t covariance_[size]
covariance matrix (3x3) as vector
index reco::VertexCompositeCandidate::idx ( index  i,
index  j 
) const
inlineprivate

position index

Definition at line 70 of file VertexCompositeCandidate.h.

References a, and b.

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

70  {
71  int a = (i <= j ? i : j), b = (i <= j ? j : i);
72  return b * (b + 1)/2 + a;
73  }
double b
Definition: hdecay.h:120
double a
Definition: hdecay.h:121
void reco::VertexCompositeCandidate::setChi2AndNdof ( double  chi2,
double  ndof 
)
inline
void VertexCompositeCandidate::setCovariance ( const CovarianceMatrix m)

set covariance matrix

Definition at line 26 of file VertexCompositeCandidate.cc.

References covariance_, reco::Candidate::dimension, mps_fire::i, and idx().

Referenced by CandCommonVertexFitterBase::set(), PFCandCommonVertexFitterBase::set(), CandKinematicVertexFitter::set(), setChi2AndNdof(), and VertexCompositeCandidate().

26  {
27  index idx = 0;
28  for(index i = 0; i < dimension; ++i)
29  for(index j = 0; j <= i; ++j)
30  covariance_[idx++] = err(i, j);
31 }
index idx(index i, index j) const
position index
unsigned int index
Definition: LeafCandidate.h:31
Double32_t covariance_[size]
covariance matrix (3x3) as vector
virtual double reco::VertexCompositeCandidate::vertexChi2 ( ) const
inlinevirtual

chi-squares

Reimplemented from reco::LeafCandidate.

Definition at line 39 of file VertexCompositeCandidate.h.

References chi2_.

Referenced by CandKinematicVertexFitter::fill(), and pat::PATSecondaryVertexSlimmer::produce().

39 { return chi2_; }
virtual double reco::VertexCompositeCandidate::vertexCovariance ( int  i,
int  j 
) const
inlinevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 50 of file VertexCompositeCandidate.h.

References covariance_, fillVertexCovariance(), idx(), findQualityFiles::v, and reco::LeafCandidate::vertexCovariance().

Referenced by pat::PATSecondaryVertexSlimmer::produce().

50  {
51  return covariance_[idx(i, j)];
52  }
index idx(index i, index j) const
position index
Double32_t covariance_[size]
covariance matrix (3x3) as vector
virtual double reco::VertexCompositeCandidate::vertexNdof ( ) const
inlinevirtual

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 46 of file VertexCompositeCandidate.h.

References ndof_.

Referenced by pat::PATSecondaryVertexSlimmer::produce().

46 { return ndof_; }
Double32_t ndof_
number of degrees of freedom
virtual double reco::VertexCompositeCandidate::vertexNormalizedChi2 ( ) const
inlinevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 48 of file VertexCompositeCandidate.h.

References chi2_, and ndof_.

48 { return chi2_ / ndof_; }
Double32_t ndof_
number of degrees of freedom

Member Data Documentation

Double32_t reco::VertexCompositeCandidate::chi2_
private

chi-sqared

Definition at line 64 of file VertexCompositeCandidate.h.

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

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

covariance matrix (3x3) as vector

Definition at line 68 of file VertexCompositeCandidate.h.

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

Double32_t reco::VertexCompositeCandidate::ndof_
private

number of degrees of freedom

Definition at line 66 of file VertexCompositeCandidate.h.

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