reco::CompositePtrCandidate Class Reference

#include <CompositePtrCandidate.h>

Inheritance diagram for reco::CompositePtrCandidate:

Public Types
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
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...
virtual CompositePtrCandidate *	clone () const
	returns a clone of the candidate 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...
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 ()
	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...
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
template<typename S >
daughter_iterator< S >::type	beginFilter (const S &s) 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 Types
typedef candidate::const_iterator_imp_specific < daughters >	const_iterator_imp_specific
	const iterator implementation More...
typedef candidate::iterator_imp_specific_dummy < daughters >	iterator_imp_specific
	iterator implementation 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
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 reco::Candidate composed of daughters. The daughters has persistent references (edm::Ptr <...>) to reco::Candidate stored in a separate collection.

Author

Luca Lista, INFN

Definition at line 19 of file CompositePtrCandidate.h.

Member Typedef Documentation

typedef candidate::const_iterator_imp_specific<daughters> reco::CompositePtrCandidate::const_iterator_imp_specific

private

const iterator implementation

Definition at line 81 of file CompositePtrCandidate.h.

typedef std::vector<CandidatePtr> reco::CompositePtrCandidate::daughters

collection of references to daughters

Definition at line 22 of file CompositePtrCandidate.h.

typedef candidate::iterator_imp_specific_dummy<daughters> reco::CompositePtrCandidate::iterator_imp_specific

private

iterator implementation

Definition at line 83 of file CompositePtrCandidate.h.

typedef std::vector<CandidatePtr> reco::CompositePtrCandidate::mothers

collection of references to daughters

Definition at line 24 of file CompositePtrCandidate.h.

Constructor & Destructor Documentation

reco::CompositePtrCandidate::CompositePtrCandidate ( )

inline

default constructor

Definition at line 26 of file CompositePtrCandidate.h.

Referenced by clone().

: LeafCandidate() { }

reco::CompositePtrCandidate::CompositePtrCandidate ( 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 28 of file CompositePtrCandidate.h.

                                                                          :
      LeafCandidate( q, p4, vtx, pdgId, status, integerCharge ) { }

reco::CompositePtrCandidate::CompositePtrCandidate ( 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 32 of file CompositePtrCandidate.h.

                                                                          :
      LeafCandidate( q, p4, vtx, pdgId, status, integerCharge ) { }

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

inlineexplicit

constructor from a Candidate

Definition at line 36 of file CompositePtrCandidate.h.

: LeafCandidate( p ) { }

CompositePtrCandidate::~CompositePtrCandidate ( )

virtual

destructor

Definition at line 6 of file CompositePtrCandidate.cc.

                                              { 
}

Member Function Documentation

void reco::CompositePtrCandidate::addDaughter ( const CandidatePtr &  cand )

inline

add a daughter via a reference

Definition at line 90 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::RecoTauPiZeroStripPlugin2::addCandsToStrip(), VirtualJetProducer::copyConstituents(), reco::Jet::Jet(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), pat::PATJetSlimmer::produce(), RecoTauJetRegionProducer::produce(), and reco::WMuNuCandidatePtr::WMuNuCandidatePtr().

                                                                            { 
    dau.push_back( cand ); 
  }

Candidate::const_iterator CompositePtrCandidate::begin ( void  ) const

virtual

first daughter const_iterator

Reimplemented from reco::LeafCandidate.

Definition at line 13 of file CompositePtrCandidate.cc.

References dau.

Referenced by PFJetIDSelectionFunctor::firstDataCuts(), reco::GenJet::getGenConstituent(), and CastorTowerJetMonitor::processEventJets().

                                                           { 
  return const_iterator( new const_iterator_imp_specific( dau.begin() ) ); 
}

Candidate::iterator CompositePtrCandidate::begin ( void  )

virtual

first daughter iterator

Reimplemented from reco::LeafCandidate.

Definition at line 21 of file CompositePtrCandidate.cc.

                                               { 
  return iterator( new iterator_imp_specific ); 
}

void reco::CompositePtrCandidate::clearDaughters ( )

inline

clear daughter references

Definition at line 61 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), pat::PATGenJetSlimmer::produce(), pat::PATJetSlimmer::produce(), and RecoTauJetRegionProducer::produce().

{ dau.clear(); }

CompositePtrCandidate * CompositePtrCandidate::clone ( void  ) const

virtual

returns a clone of the candidate

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::PFJet, reco::CaloJet, reco::JPTJet, pat::Jet, reco::GenJet, reco::TrackJet, reco::PFClusterJet, reco::VertexCompositePtrCandidate, and reco::BasicJet.

Definition at line 9 of file CompositePtrCandidate.cc.

References CompositePtrCandidate().

Referenced by ChainedJetCorrector::correction(), and PileupJetIdProducer::produce().

                                                           { 
  return new CompositePtrCandidate( * this ); 
}

const Candidate * CompositePtrCandidate::daughter ( size_type  i ) const

virtual

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

Reimplemented from reco::LeafCandidate.

Reimplemented in pat::Jet.

Definition at line 29 of file CompositePtrCandidate.cc.

References dau, i, and numberOfDaughters().

Referenced by pat::Jet::daughter(), reco::Jet::getJetConstituentsQuick(), reco::RecoTauPiZero::maxDeltaEta(), reco::RecoTauPiZero::maxDeltaPhi(), reco::RecoTauPiZero::numberOfElectrons(), and reco::RecoTauPiZero::numberOfGammas().

                                                                     { 
  return ( i < numberOfDaughters() ) ? & * dau[ i ] : 0; // i >= 0, since i is unsigned
}

Candidate * CompositePtrCandidate::daughter ( size_type  i )

virtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 37 of file CompositePtrCandidate.cc.

                                                         { 
  return 0;
}

CandidatePtr reco::CompositePtrCandidate::daughterPtr ( size_type  i ) const

inline

reference to daughter at given position

Definition at line 63 of file CompositePtrCandidate.h.

References dau, and i.

Referenced by pat::Jet::cacheCaloTowers(), pat::Jet::cachePFCandidates(), reco::CaloJet::getCaloConstituent(), pat::Jet::getCaloConstituent(), reco::Jet::getJetConstituents(), reco::PFJet::getPFConstituent(), pat::Jet::getPFConstituent(), reco::RecoTauPiZero::print(), reco::Jet::print(), pat::PATTrackAndVertexUnpacker::produce(), and sourceCandidatePtr().

{ return dau[ i ]; }

const daughters& reco::CompositePtrCandidate::daughterPtrVector ( ) const

inline

references to daughtes

Definition at line 65 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::RecoTauConstructor::addPiZero(), JetMCTagUtils::genTauDecayMode(), reco::tau::RecoTauBuilderCombinatoricPlugin::operator()(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), pat::PATJetSlimmer::produce(), and pat::PATPackedCandidateProducer::produce().

{ return dau; }

Candidate::const_iterator CompositePtrCandidate::end ( void  ) const

virtual

last daughter const_iterator

Reimplemented from reco::LeafCandidate.

Definition at line 17 of file CompositePtrCandidate.cc.

References dau.

Referenced by Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), PFJetIDSelectionFunctor::firstDataCuts(), reco::GenJet::getGenConstituent(), and CastorTowerJetMonitor::processEventJets().

                                                         { 
  return const_iterator( new const_iterator_imp_specific( dau.end() ) ); 
}    

Candidate::iterator CompositePtrCandidate::end ( void  )

virtual

last daughter iterator

Reimplemented from reco::LeafCandidate.

Definition at line 25 of file CompositePtrCandidate.cc.

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

                                             { 
  return iterator( new iterator_imp_specific ); 
}    

const Candidate * CompositePtrCandidate::mother ( size_t  i = 0 ) const

virtual

return pointer to mother

Reimplemented from reco::LeafCandidate.

Definition at line 33 of file CompositePtrCandidate.cc.

                                                                   { 
  return 0;
}

size_t CompositePtrCandidate::numberOfDaughters ( ) const

virtual

number of daughters

Reimplemented from reco::LeafCandidate.

Reimplemented in pat::Jet.

Definition at line 41 of file CompositePtrCandidate.cc.

References dau.

Referenced by daughter(), reco::tau::RecoTauPhotonFilter::filter(), PFJetIDSelectionFunctor::firstDataCuts(), reco::CaloJet::getCaloConstituents(), reco::GenJet::getGenConstituents(), reco::Jet::getJetConstituents(), reco::Jet::getJetConstituentsQuick(), reco::PFJet::getPFConstituents(), reco::PFJet::getTrackRefs(), reco::RecoTauPiZero::maxDeltaEta(), reco::RecoTauPiZero::maxDeltaPhi(), reco::Jet::nConstituents(), pat::Jet::numberOfDaughters(), reco::RecoTauPiZero::numberOfElectrons(), reco::RecoTauPiZero::numberOfGammas(), numberOfSourceCandidatePtrs(), reco::TrackJet::numberOfTracks(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), reco::RecoTauPiZero::print(), reco::Jet::print(), and pat::PATTrackAndVertexUnpacker::produce().

                                                      { 
  return dau.size(); 
}

size_t CompositePtrCandidate::numberOfMothers ( ) const

virtual

number of mothers

Reimplemented from reco::LeafCandidate.

Definition at line 45 of file CompositePtrCandidate.cc.

                                                    { 
  return 0;
}

size_t CompositePtrCandidate::numberOfSourceCandidatePtrs ( ) const

virtual

number of source candidates ( the candidates used to construct this Candidate). for CompositeRefBaseCandidates, the source candidates are the daughters.

Reimplemented from reco::LeafCandidate.

Definition at line 49 of file CompositePtrCandidate.cc.

References numberOfDaughters().

                                                                { 
  return numberOfDaughters(); 
}

bool CompositePtrCandidate::overlap ( const Candidate &  c2 ) const

privatevirtual

check overlap with another candidate

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::PFJet, reco::CaloJet, reco::JPTJet, reco::GenJet, reco::TrackJet, reco::PFClusterJet, and reco::BasicJet.

Definition at line 57 of file CompositePtrCandidate.cc.

References edm::hlt::Exception.

                                                                {
  throw cms::Exception( "Error" ) << "can't check overlap internally for CompositePtrCanddate";
}

CandidatePtr CompositePtrCandidate::sourceCandidatePtr ( size_type  i ) const

virtual

return a RefToBase to one of the source Candidates ( the candidates used to construct this Candidate). for CompositeRefBaseCandidates, the source candidates are the daughters.

Reimplemented from reco::LeafCandidate.

Definition at line 53 of file CompositePtrCandidate.cc.

References daughterPtr().

                                                                          {
  return daughterPtr(i);
}

Member Data Documentation

daughters reco::CompositePtrCandidate::dau

private

collection of references to daughters

Definition at line 85 of file CompositePtrCandidate.h.

Referenced by addDaughter(), begin(), pat::Jet::cacheCaloTowers(), pat::Jet::cachePFCandidates(), clearDaughters(), daughter(), daughterPtr(), daughterPtrVector(), end(), reco::CaloJet::getCaloConstituent(), pat::Jet::getCaloConstituent(), reco::PFJet::getPFConstituent(), pat::Jet::getPFConstituent(), and numberOfDaughters().