reco::VertexCompositePtrCandidate Class Reference

#include <VertexCompositePtrCandidate.h>

Inheritance diagram for reco::VertexCompositePtrCandidate:

Public Types
typedef math::Error< dimension >::type	Error
	the following functions are implemented to have a more consistent interface with the one of reco::Vertex More...
Public Types inherited from reco::CompositePtrCandidate
typedef std::vector< CandidatePtr >	daughters
	collection of references to daughters More...
typedef std::vector< CandidatePtr >	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
virtual VertexCompositePtrCandidate *	clone () const
	returns a clone of the candidate More...
Error	error () const
virtual void	fillVertexCovariance (CovarianceMatrix &v) const
	fill SMatrix More...
const Point &	position () const
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...
	VertexCompositePtrCandidate ()
	VertexCompositePtrCandidate (Charge q, const LorentzVector &p4, const Point &vtx, int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	VertexCompositePtrCandidate (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...
	VertexCompositePtrCandidate (const Candidate &p)
	constructor from values More...
	VertexCompositePtrCandidate (const CompositePtrCandidate &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	~VertexCompositePtrCandidate ()
	destructor More...
Public Member Functions inherited from reco::CompositePtrCandidate
void	addDaughter (const CandidatePtr &)
	add a daughter via a reference More...
void	clearDaughters ()
	clear daughter references More...
	CompositePtrCandidate ()
	default constructor More...
	CompositePtrCandidate (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...
	CompositePtrCandidate (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...
	CompositePtrCandidate (const Candidate &p)
	constructor from a Candidate More...
const Candidate *	daughter (size_type) const override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
Candidate *	daughter (size_type) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
virtual CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...
virtual const daughters &	daughterPtrVector () const
	references to daughtes More...
const Candidate *	mother (size_t i=0) const override
	return pointer to mother More...
size_t	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers More...
size_type	numberOfSourceCandidatePtrs () const override
CandidatePtr	sourceCandidatePtr (size_type i) const override
	~CompositePtrCandidate () 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 Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (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...
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 CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () 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 Candidate *	mother (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
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
double	p () const final
	magnitude of momentum vector More...
const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...
int	pdgId () const final
	PDG identifier. More...
double	phi () const final
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () 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 Point &	vertex () 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
const_iterator	begin () const
	first daughter const_iterator More...
iterator	begin ()
	first daughter iterator More...
virtual const Track *	bestTrack () 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

Detailed Description

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

Author

Luca Lista, INFN

Definition at line 16 of file VertexCompositePtrCandidate.h.

Member Typedef Documentation

typedef math::Error<dimension>::type reco::VertexCompositePtrCandidate::Error

the following functions are implemented to have a more consistent interface with the one of reco::Vertex

Definition at line 64 of file VertexCompositePtrCandidate.h.

Constructor & Destructor Documentation

reco::VertexCompositePtrCandidate::VertexCompositePtrCandidate ( )

inline

Definition at line 18 of file VertexCompositePtrCandidate.h.

Referenced by clone(), and VertexCompositePtrCandidate().

: CompositePtrCandidate() { }

reco::VertexCompositePtrCandidate::VertexCompositePtrCandidate ( 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 VertexCompositePtrCandidate.h.

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

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

VertexCompositePtrCandidate::VertexCompositePtrCandidate	(	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 VertexCompositePtrCandidate.cc.

References setCovariance().

                                                                      :
  CompositePtrCandidate(q, p4, vtx, pdgId, status, integerCharge),
  chi2_(chi2), ndof_(ndof) { 
  setCovariance(err);
}

reco::VertexCompositePtrCandidate::VertexCompositePtrCandidate ( const Candidate &  p )

inlineexplicit

constructor from values

Definition at line 29 of file VertexCompositePtrCandidate.h.

                                                              :
      CompositePtrCandidate(p), chi2_(0), ndof_(0) { }

reco::VertexCompositePtrCandidate::VertexCompositePtrCandidate ( const CompositePtrCandidate &  p )

inlineexplicit

constructor from values

Definition at line 32 of file VertexCompositePtrCandidate.h.

References clone(), and ~VertexCompositePtrCandidate().

                                                                          :
      CompositePtrCandidate(p), chi2_(0), ndof_(0) { }

VertexCompositePtrCandidate::~VertexCompositePtrCandidate ( )

virtual

destructor

Definition at line 13 of file VertexCompositePtrCandidate.cc.

Referenced by VertexCompositePtrCandidate().

{ }

Member Function Documentation

VertexCompositePtrCandidate * VertexCompositePtrCandidate::clone ( void  ) const

virtual

returns a clone of the candidate

Reimplemented from reco::CompositePtrCandidate.

Definition at line 15 of file VertexCompositePtrCandidate.cc.

References VertexCompositePtrCandidate().

Referenced by VertexCompositePtrCandidate().

                                                                       { 
  return new VertexCompositePtrCandidate(*this); 
}

Error reco::VertexCompositePtrCandidate::error ( ) const

inline

Definition at line 66 of file VertexCompositePtrCandidate.h.

References fillVertexCovariance(), and funct::m.

Referenced by argparse.ArgumentParser::_get_option_tuples(), python.rootplot.argparse.ArgumentParser::_get_option_tuples(), argparse.ArgumentParser::_parse_known_args(), python.rootplot.argparse.ArgumentParser::_parse_known_args(), argparse.ArgumentParser::_parse_optional(), python.rootplot.argparse.ArgumentParser::_parse_optional(), argparse.ArgumentParser::_read_args_from_files(), python.rootplot.argparse.ArgumentParser::_read_args_from_files(), argparse.ArgumentParser::add_subparsers(), python.rootplot.argparse.ArgumentParser::add_subparsers(), FWSecVertexCandidateProxyBuilder::build(), FWVertexCandidateProxyBuilder::build(), Page1Parser.Page1Parser::check_for_whole_start_tag(), argparse.ArgumentParser::parse_args(), python.rootplot.argparse.ArgumentParser::parse_args(), argparse.ArgumentParser::parse_known_args(), and python.rootplot.argparse.ArgumentParser::parse_known_args().

{ Error m; fillVertexCovariance( m ); return m; }

void VertexCompositePtrCandidate::fillVertexCovariance ( CovarianceMatrix &  v ) const

virtual

fill SMatrix

Reimplemented from reco::LeafCandidate.

Definition at line 19 of file VertexCompositePtrCandidate.cc.

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

Referenced by reco::TemplatedSecondaryVertex< SV >::computeDist1d(), reco::TemplatedSecondaryVertex< SV >::computeDist2d(), reco::TemplatedSecondaryVertex< SV >::computeDist3d(), error(), vertexCovariance(), btagbtvdeep::vertexD3d(), and btagbtvdeep::vertexDxy().

                                                                                  {
  index idx = 0;
  for(index i = 0; i < dimension; ++i) 
    for(index j = 0; j <= i; ++ j)
      err(i, j) = covariance_[idx++];
}

index reco::VertexCompositePtrCandidate::idx ( index  i, index  j  ) const

inlineprivate

position index

Definition at line 76 of file VertexCompositePtrCandidate.h.

References a, and b.

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

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

const Point& reco::VertexCompositePtrCandidate::position ( ) const

inline

Definition at line 65 of file VertexCompositePtrCandidate.h.

References reco::LeafCandidate::vertex().

{return vertex();}  

void reco::VertexCompositePtrCandidate::setChi2AndNdof ( double  chi2, double  ndof  )

inline

set chi2 and ndof

Definition at line 57 of file VertexCompositePtrCandidate.h.

References vertices_cff::chi2, chi2_, funct::m, ndof, ndof_, and setCovariance().

Referenced by TransientVertex::operator reco::VertexCompositePtrCandidate(), and TemplatedSecondaryVertexProducer< IPTI, VTX >::SVBuilder::operator()().

                                                  {
      chi2_ = chi2; ndof_ = ndof;
    }

void VertexCompositePtrCandidate::setCovariance

(

const CovarianceMatrix &

m

)

set covariance matrix

Definition at line 26 of file VertexCompositePtrCandidate.cc.

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

Referenced by TransientVertex::operator reco::VertexCompositePtrCandidate(), TemplatedSecondaryVertexProducer< IPTI, VTX >::SVBuilder::operator()(), setChi2AndNdof(), and VertexCompositePtrCandidate().

                                                                            {
  index idx = 0;
  for(index i = 0; i < dimension; ++i) 
    for(index j = 0; j <= i; ++j)
      covariance_[idx++] = err(i, j);
}

virtual double reco::VertexCompositePtrCandidate::vertexChi2 ( ) const

inlinevirtual

chi-squares

Reimplemented from reco::LeafCandidate.

Definition at line 39 of file VertexCompositePtrCandidate.h.

References chi2_.

Referenced by pat::PATTrackAndVertexUnpacker::produce(), and btagbtvdeep::svToFeatures().

{ return chi2_; }

virtual double reco::VertexCompositePtrCandidate::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 VertexCompositePtrCandidate.h.

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

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

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

virtual double reco::VertexCompositePtrCandidate::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 VertexCompositePtrCandidate.h.

References ndof_.

Referenced by pat::PATTrackAndVertexUnpacker::produce(), and btagbtvdeep::svToFeatures().

{ return ndof_; }

virtual double reco::VertexCompositePtrCandidate::vertexNormalizedChi2 ( ) const

inlinevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 48 of file VertexCompositePtrCandidate.h.

References chi2_, and ndof_.

{ return chi2_ / ndof_; }

Member Data Documentation

Double32_t reco::VertexCompositePtrCandidate::chi2_

private

chi-sqared

Definition at line 70 of file VertexCompositePtrCandidate.h.

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

Double32_t reco::VertexCompositePtrCandidate::covariance_[size]

private

covariance matrix (3x3) as vector

Definition at line 74 of file VertexCompositePtrCandidate.h.

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

Double32_t reco::VertexCompositePtrCandidate::ndof_

private

number of degrees of freedom

Definition at line 72 of file VertexCompositePtrCandidate.h.

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