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...
virtual const_iterator	begin () const
	first daughter const_iterator More...
virtual iterator	begin ()
	first daughter iterator 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...
virtual const Candidate *	daughter (size_type) const
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
virtual Candidate *	daughter (size_type)
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...
const daughters &	daughterPtrVector () const
	references to daughtes More...
virtual const_iterator	end () const
	last daughter const_iterator More...
virtual iterator	end ()
	last daughter iterator More...
virtual const Candidate *	mother (size_t i=0) const
	return pointer to mother More...
virtual size_t	numberOfDaughters () const
	number of daughters More...
virtual size_t	numberOfMothers () const
	number of mothers More...
virtual size_type	numberOfSourceCandidatePtrs () const
virtual CandidatePtr	sourceCandidatePtr (size_type i) const
virtual	~CompositePtrCandidate ()
	destructor More...
Public Member Functions inherited from reco::LeafCandidate
template<typename S >
daughter_iterator< S >::type	beginFilter (const S &s) const
virtual Vector	boostToCM () const
virtual int	charge () const
	electric charge More...
virtual Candidate *	daughter (const std::string &s)
	return daughter with a specified role name More...
virtual const Candidate *	daughter (const std::string &s) const
	return daughter with a specified role name More...
template<typename S >
daughter_iterator< S >::type	endFilter (const S &s) const
virtual double	energy () const
	energy More...
virtual double	et () const
	transverse energy More...
virtual float	eta () const
	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 ()
	default constructor More...
	LeafCandidate (const Candidate &c)
template<typename P4 >
	LeafCandidate (Charge q, const P4 &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from Any values More...
	LeafCandidate (Charge q, const PtEtaPhiMass &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	LeafCandidate (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...
	LeafCandidate (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...
	LeafCandidate (Charge q, const GlobalVector &p3, float iEnergy, bool massless, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
	LeafCandidate (Charge q, const GlobalVector &p3, float iEnergy, float imass, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true)
	constructor from values More...
virtual bool	longLived () const
	is long lived? More...
virtual float	mass () const
	mass More...
virtual bool	massConstraint () const
	do mass constraint? More...
virtual float	massSqr () const
	mass squared More...
virtual const CandidateBaseRef &	masterClone () const
virtual const CandidatePtr &	masterClonePtr () 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 double	p () const
	magnitude of momentum vector More...
virtual const LorentzVector &	p4 () const
	four-momentum Lorentz vector More...
virtual int	pdgId () const
	PDG identifier. More...
virtual float	phi () const
	momentum azimuthal angle More...
virtual const PolarLorentzVector &	polarP4 () const
	four-momentum Lorentz vector More...
virtual float	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 ()
	set long lived flag More...
virtual void	setMass (double m)
	set particle mass More...
virtual void	setMassConstraint ()
	set mass constraint flag More...
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 int	status () const
	status word More...
virtual double	theta () const
	momentum polar angle More...
virtual int	threeCharge () const
	electric charge More...
virtual const Point &	vertex () const
	vertex position (overwritten by PF...) More...
CovarianceMatrix	vertexCovariance () const
	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
	rapidity More...
virtual	~LeafCandidate ()
	destructor More...
Public Member Functions inherited from reco::Candidate
template<typename S >
daughter_iterator< S >::type	beginFilter (const S &s) const
virtual const Track *	bestTrack () const
	Candidate ()
	default constructor More...
template<typename S >
daughter_iterator< S >::type	endFilter (const S &s) const
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
Static Public Member Functions inherited from reco::LeafCandidate
static double	dmass (GlobalVector v, double e)
static double	magd (GlobalVector v)
Static Public Attributes inherited from reco::LeafCandidate
static const unsigned int	longLivedTag = 65536
	long lived flag More...
static const unsigned int	massConstraintTag = 131072
	do mass constraint flag More...
Protected Member Functions inherited from reco::LeafCandidate
void	cacheCartesian () const
	set internal cache More...
void	cachePolar () const
	set internal cache More...
void	clearCache () const
	clear internal cache More...
Protected Attributes inherited from reco::LeafCandidate
bool	cacheCartesianFixed_
bool	cachePolarFixed_
	has cache been set? More...
float	eta_
float	mass_
LorentzVector	p4Cartesian_
	internal cache for p4 More...
PolarLorentzVector	p4Polar_
	internal cache for p4 More...
int	pdgId_
	PDG identifier. More...
float	phi_
float	pt_
	four-momentum Lorentz vector More...
Charge	qx3_
	electric charge More...
int	status_
	status word More...
Point	vertex_
	vertex position More...

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().

: 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.

                                                                           :
      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.

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

VertexCompositePtrCandidate::~VertexCompositePtrCandidate ( )

virtual

destructor

Definition at line 13 of file VertexCompositePtrCandidate.cc.

{ }

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().

                                                                       { 
  return new VertexCompositePtrCandidate(*this); 
}

Error reco::VertexCompositePtrCandidate::error ( ) const

inline

Definition at line 66 of file VertexCompositePtrCandidate.h.

References fillVertexCovariance(), and 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(), 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, i, idx(), and j.

Referenced by reco::TemplatedSecondaryVertex< SV >::computeDist2d(), reco::TemplatedSecondaryVertex< SV >::computeDist3d(), and error().

                                                                                  {
  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, b, and j.

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 chi2_, and ndof_.

Referenced by 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, i, idx(), and j.

Referenced by TransientVertex::operator reco::VertexCompositePtrCandidate(), TemplatedSecondaryVertexProducer< IPTI, VTX >::SVBuilder::operator()(), 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().

{ 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_, and idx().

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().

{ 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().