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...
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 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
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 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...
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...
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 ()
	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 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 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...
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
virtual double	p () const final
	magnitude of momentum vector More...
virtual const LorentzVector &	p4 () 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 PolarLorentzVector &	polarP4 () 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 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 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 final
	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 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 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
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

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 17 of file CompositePtrCandidate.h.

Member Typedef Documentation

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

collection of references to daughters

Definition at line 20 of file CompositePtrCandidate.h.

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

collection of references to daughters

Definition at line 22 of file CompositePtrCandidate.h.

Constructor & Destructor Documentation

reco::CompositePtrCandidate::CompositePtrCandidate ( )

inline

default constructor

Definition at line 24 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 26 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 30 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 34 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 76 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::RecoTauPiZeroStripPlugin2::addCandsToStrip(), reco::tau::RecoTauPiZeroStripPlugin3::addCandsToStrip(), ParticleLevelProducer::addGenJet(), VirtualJetProducer::copyConstituents(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), TemplatedSecondaryVertexProducer< IPTI, VTX >::SVBuilder::operator()(), ParticleLevelProducer::produce(), pat::PATSecondaryVertexSlimmer::produce(), pat::PATGenJetSlimmer::produce(), pat::PATJetSlimmer::produce(), RecoTauJetRegionProducer::produce(), and reco::WMuNuCandidatePtr::WMuNuCandidatePtr().

                                                                            { 
    dau.push_back( cand ); 
  }

void reco::CompositePtrCandidate::clearDaughters ( )

inline

clear daughter references

Definition at line 51 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), pat::PATSecondaryVertexSlimmer::produce(), 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(), MVAJetPuIdProducer::produce(), 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 13 of file CompositePtrCandidate.cc.

References dau, i, and numberOfDaughters().

Referenced by FWSecVertexCandidateProxyBuilder::build(), FWVertexCandidateProxyBuilder::build(), reco::RecoTauPiZero::maxDeltaEta(), reco::RecoTauPiZero::maxDeltaPhi(), reco::RecoTauPiZero::numberOfElectrons(), reco::RecoTauPiZero::numberOfGammas(), and reco::RecoTauPiZero::print().

                                                                     { 
  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 21 of file CompositePtrCandidate.cc.

                                                         { 
  return 0;
}

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

inline

reference to daughter at given position

Definition at line 53 of file CompositePtrCandidate.h.

References dau, and i.

Referenced by PileupJetIdAlgo::computeIdVariables(), reco::CaloJet::getCaloConstituent(), reco::PFJet::getPFConstituent(), reco::RecoTauPiZero::print(), pat::PATTrackAndVertexUnpacker::produce(), SoftPFMuonTagInfoProducer::produce(), and sourceCandidatePtr().

{ return dau[ i ]; }

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

inline

references to daughtes

Definition at line 55 of file CompositePtrCandidate.h.

References dau.

Referenced by reco::tau::RecoTauConstructor::addPiZero(), BoostedDoubleSVProducer::calcNsubjettiness(), vertexTools::computeSharedTracks(), BoostedDoubleSVProducer::etaRelToTauAxis(), JetMCTagUtils::genTauDecayMode(), Jet.Jet::leadingTrack(), reco::tau::RecoTauBuilderCombinatoricPlugin::operator()(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), CombinedSVComputer::operator()(), pat::PATSecondaryVertexSlimmer::produce(), pat::PATGenJetSlimmer::produce(), pat::PATJetSlimmer::produce(), trackWeight(), vtxP4(), and reco::btag::weight().

{ return dau; }

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

virtual

return pointer to mother

Reimplemented from reco::LeafCandidate.

Definition at line 17 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 25 of file CompositePtrCandidate.cc.

References dau.

Referenced by FWSecVertexCandidateProxyBuilder::build(), FWVertexCandidateProxyBuilder::build(), BoostedDoubleSVProducer::calcNsubjettiness(), PileupJetIdAlgo::computeIdVariables(), daughter(), reco::tau::RecoTauPhotonFilter::filter(), PFJetIDSelectionFunctor::firstDataCuts(), reco::CaloJet::getCaloConstituents(), reco::GenJet::getGenConstituents(), reco::PFJet::getPFConstituents(), reco::PFJet::getTrackRefs(), reco::RecoTauPiZero::maxDeltaEta(), reco::RecoTauPiZero::maxDeltaPhi(), reco::Jet::nConstituents(), reco::RecoTauPiZero::numberOfElectrons(), reco::RecoTauPiZero::numberOfGammas(), numberOfSourceCandidatePtrs(), reco::TrackJet::numberOfTracks(), reco::tau::xclean::CrossCleanPiZeros< PtrIter >::operator()(), reco::RecoTauPiZero::print(), pat::PATTrackAndVertexUnpacker::produce(), and SoftPFMuonTagInfoProducer::produce().

                                                      { 
  return dau.size(); 
}

size_t CompositePtrCandidate::numberOfMothers ( ) const

virtual

number of mothers

Reimplemented from reco::LeafCandidate.

Definition at line 29 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 33 of file CompositePtrCandidate.cc.

References numberOfDaughters().

Referenced by BtoCharmDecayVertexMergerT< VTX >::buildVertexProxy(), PileupJetIdAlgo::computeIdVariables(), and nTracks().

                                                                { 
  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 41 of file CompositePtrCandidate.cc.

References 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 37 of file CompositePtrCandidate.cc.

References daughterPtr().

Referenced by PileupJetIdAlgo::computeIdVariables().

                                                                          {
  return daughterPtr(i);
}

Member Data Documentation

daughters reco::CompositePtrCandidate::dau

private

collection of references to daughters

Definition at line 71 of file CompositePtrCandidate.h.

Referenced by addDaughter(), clearDaughters(), daughter(), daughterPtr(), daughterPtrVector(), reco::CaloJet::getCaloConstituent(), reco::PFJet::getPFConstituent(), and numberOfDaughters().