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...
CompositePtrCandidate *	clone () const override
	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...
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...
CandidatePtr	daughterPtr (size_type i) const
	reference to daughter at given position More...
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...
LeafCandidate *	clone () const override
	returns a clone of the Candidate object 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...
void	fillVertexCovariance (CovarianceMatrix &v) const override
	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...
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...
double	vertexChi2 () const override
	chi-squares More...
double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...
double	vertexNdof () const override
double	vertexNormalizedChi2 () const override
	chi-squared divided by n.d.o.f. 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
bool	overlap (const Candidate &) const override
	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.

References addDaughter(), clone(), daughter(), reco::LeafCandidate::daughter(), numberOfDaughters(), numberOfMothers(), and ~CompositePtrCandidate().

: LeafCandidate( p ) { }

CompositePtrCandidate::~CompositePtrCandidate ( )

override

destructor

Definition at line 6 of file CompositePtrCandidate.cc.

Referenced by CompositePtrCandidate().

                                              { 
}

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(), CompositePtrCandidate(), VirtualJetProducer::copyConstituents(), TransientVertex::operator reco::VertexCompositePtrCandidate(), 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

overridevirtual

returns a clone of the candidate

Implements reco::Candidate.

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

Definition at line 9 of file CompositePtrCandidate.cc.

References CompositePtrCandidate().

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

                                                           { 
  return new CompositePtrCandidate( * this ); 
}

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

overridevirtual

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

Implements reco::Candidate.

Reimplemented in pat::Jet.

Definition at line 13 of file CompositePtrCandidate.cc.

References dau, mps_fire::i, and numberOfDaughters().

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

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

Candidate * CompositePtrCandidate::daughter ( size_type  i )

overridevirtual

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

Implements reco::Candidate.

Definition at line 21 of file CompositePtrCandidate.cc.

                                                         { 
  return nullptr;
}

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

Referenced by PileupJetIdAlgo::computeIdVariables(), reco::CaloJet::getCaloConstituent(), reco::PFJet::getPFConstituent(), reco::operator<<(), reco::PFClusterJet::pfCluster(), reco::RecoTauPiZero::print(), pat::PATTrackAndVertexUnpacker::produce(), SoftPFMuonTagInfoProducer::produce(), sourceCandidatePtr(), and reco::TrackJet::track().

{ return dau[ i ]; }

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

inline

references to daughtes

Definition at line 55 of file CompositePtrCandidate.h.

References dau, mps_fire::i, mother(), numberOfSourceCandidatePtrs(), and sourceCandidatePtr().

Referenced by reco::tau::RecoTauConstructor::addPiZero(), LeptonJetVarProducer< T >::calculatePtRatioRel(), vertexTools::computeSharedTracks(), BoostedDoubleSVProducer::etaRelToTauAxis(), BJetEnergyRegressionMVA::fillAdditionalVariables(), JetMCTagUtils::genTauDecayMode(), Jet.Jet::leadingTrack(), GhostTrackComputer::operator()(), 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

overridevirtual

return pointer to mother

Implements reco::Candidate.

Definition at line 17 of file CompositePtrCandidate.cc.

Referenced by daughterPtrVector().

                                                                   { 
  return nullptr;
}

size_t CompositePtrCandidate::numberOfDaughters ( ) const

overridevirtual

number of daughters

Implements reco::Candidate.

Reimplemented in pat::Jet.

Definition at line 25 of file CompositePtrCandidate.cc.

References dau.

Referenced by B2GDQM::analyzeAllHad(), B2GDQM::analyzeSemiE(), B2GDQM::analyzeSemiMu(), FWSecVertexCandidateProxyBuilder::build(), FWVertexCandidateProxyBuilder::build(), BoostedDoubleSVProducer::calcNsubjettiness(), CompositePtrCandidate(), 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::operator<<(), reco::PFClusterJet::print(), reco::RecoTauPiZero::print(), pat::PATTrackAndVertexUnpacker::produce(), SoftPFMuonTagInfoProducer::produce(), and reco::TrackJet::tracks().

                                                      { 
  return dau.size(); 
}

size_t CompositePtrCandidate::numberOfMothers ( ) const

overridevirtual

number of mothers

Implements reco::Candidate.

Definition at line 29 of file CompositePtrCandidate.cc.

Referenced by CompositePtrCandidate().

                                                    { 
  return 0;
}

size_t CompositePtrCandidate::numberOfSourceCandidatePtrs ( ) const

overridevirtual

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

Implements reco::Candidate.

Definition at line 33 of file CompositePtrCandidate.cc.

References numberOfDaughters().

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

                                                                { 
  return numberOfDaughters(); 
}

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

overrideprivatevirtual

check overlap with another candidate

Implements reco::Candidate.

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

overridevirtual

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

Definition at line 37 of file CompositePtrCandidate.cc.

References daughterPtr().

Referenced by PileupJetIdAlgo::computeIdVariables(), and daughterPtrVector().

                                                                          {
  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(), numberOfDaughters(), reco::operator<<(), reco::PFClusterJet::pfCluster(), and reco::TrackJet::track().