reco::CompositeCandidate Class Reference

#include <CompositeCandidate.h>

Inheritance diagram for reco::CompositeCandidate:

Public Types
typedef CandidateCollection	daughters
	collection of daughters More...
typedef std::vector< std::string >	role_collection
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 Candidate &, const std::string &s="")
	add a clone of the passed candidate as daughter More...
void	addDaughter (std::unique_ptr< Candidate >, const std::string &s="")
	add a clone of the passed candidate as daughter More...
void	applyRoles ()
void	clearDaughters ()
	clear daughters More...
void	clearRoles ()
virtual CompositeCandidate *	clone () const
	returns a clone of the candidate More...
	CompositeCandidate (std::string name="")
	default constructor More...
template<typename P4 >
	CompositeCandidate (Charge q, const P4 &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0, bool integerCharge=true, std::string name="")
	constructor from values More...
	CompositeCandidate (const Candidate &p, const std::string &name="")
	constructor from values More...
	CompositeCandidate (const Candidate &p, const std::string &name, role_collection const &roles)
	constructor from values 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...
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 const Candidate *	mother (size_type i=0) const
	return pointer to mother More...
std::string	name () const
	get the name of the candidate More...
virtual size_type	numberOfDaughters () const
	number of daughters More...
virtual size_type	numberOfMothers () const
	number of mothers (zero or one in most of but not all the cases) More...
role_collection const &	roles () const
	get the roles More...
void	setName (std::string name)
	set the name of the candidate More...
void	setRoles (const role_collection &roles)
	set the roles More...
virtual	~CompositeCandidate ()
	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 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...
virtual size_t	numberOfSourceCandidatePtrs () const
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 CandidatePtr	sourceCandidatePtr (size_type i) const
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 daughter More...

Private Attributes
daughters	dau
	collection of daughters More...
std::string	name_
	candidate name More...
role_collection	roles_
	candidate roles More...

Additional Inherited Members

Detailed Description

A Candidate composed of daughters. The daughters are owned by the composite candidate.

Author

Luca Lista, INFN

Definition at line 21 of file CompositeCandidate.h.

Member Typedef Documentation

typedef CandidateCollection reco::CompositeCandidate::daughters

collection of daughters

Definition at line 24 of file CompositeCandidate.h.

typedef std::vector<std::string> reco::CompositeCandidate::role_collection

Definition at line 25 of file CompositeCandidate.h.

Constructor & Destructor Documentation

reco::CompositeCandidate::CompositeCandidate ( std::string  name = "" )

inline

default constructor

Definition at line 27 of file CompositeCandidate.h.

Referenced by clone().

: LeafCandidate(), name_(name) { }

template<typename P4 >

reco::CompositeCandidate::CompositeCandidate ( Charge  q, const P4 &  p4, const Point &  vtx = Point( 0, 0, 0 ), int  pdgId = 0, int  status = 0, bool  integerCharge = true, std::string  name = ""  )

inline

constructor from values

Definition at line 30 of file CompositeCandidate.h.

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

CompositeCandidate::CompositeCandidate ( const Candidate &  p, const std::string &  name = ""  )

explicit

constructor from values

Definition at line 6 of file CompositeCandidate.cc.

References addDaughter(), reco::Candidate::daughter(), i, gen::n, and reco::Candidate::numberOfDaughters().

                                              :
  LeafCandidate(c), name_(name) {
  size_t n = c.numberOfDaughters();
  for(size_t i = 0; i != n; ++i) {
      addDaughter(*c.daughter(i));
  }
}

CompositeCandidate::CompositeCandidate ( const Candidate &  p, const std::string &  name, role_collection const &  roles  )

explicit

constructor from values

Definition at line 15 of file CompositeCandidate.cc.

References addDaughter(), reco::Candidate::daughter(), i, gen::n, reco::Candidate::numberOfDaughters(), alignCSCRings::r, and roles_.

                                                      :
  LeafCandidate(c), name_(name), roles_(roles) {
  size_t n = c.numberOfDaughters();
  size_t r = roles_.size();
  bool sameSize = (n == r);
  for(size_t i = 0; i != n; ++i) {
    if (sameSize && r > 0) 
      addDaughter(*c.daughter(i), roles_[i]);
    else
      addDaughter(*c.daughter(i));
  }
}

CompositeCandidate::~CompositeCandidate ( )

virtual

destructor

Reimplemented in pat::CompositeCandidate.

Definition at line 30 of file CompositeCandidate.cc.

{ }

Member Function Documentation

void CompositeCandidate::addDaughter	(	const Candidate &	cand,
		const std::string &	s = ""
	)

add a clone of the passed candidate as daughter

Definition at line 117 of file CompositeCandidate.cc.

References reco::Candidate::begin(), EnergyCorrector::c, alignmentValidation::c1, reco::Candidate::clone(), dau, reco::Candidate::end(), Exception, spr::find(), edm::OwnVector< T, P >::push_back(), roles_, and setName().

Referenced by combiner::helpers::NormalClone::addDaughter(), combiner::helpers::ShallowClone::addDaughter(), combiner::helpers::ShallowClonePtr::addDaughter(), reco::NamedCompositeCandidate::addDaughter(), cloneDecayTree(), CompositeCandidate(), ZeeCandidateFilter::filter(), V0Fitter::fitAll(), TtFullHadHypothesis::hypo(), TtFullLepHypothesis::hypo(), TtSemiLepHypothesis::hypo(), reco::PFTauDecayMode::PFTauDecayMode(), Onia2MuMuPAT::produce(), TruthTauDecayModeProducer::produce(), PatJPsiProducer::produce(), BoostedTopProducer::produce(), PFPhotonAlgo::RunPFPhoton(), PFElectronAlgo::SetCandidates(), TtSemiEvtSolution::setupHyp(), BPHDecayMomentum::sumMomentum(), and reco::WMuNuCandidate::WMuNuCandidate().

                                                                               {
  Candidate * c = cand.clone();
  if (s != "") {
    role_collection::iterator begin = roles_.begin(), end = roles_.end();
    bool isFound = (find(begin, end, s) != end);
    if (isFound) {
      throw cms::Exception("InvalidReference")
    << "CompositeCandidate::addDaughter: Already have role with name \"" << s 
    << "\", please clearDaughters, or use a new name\n";
    }
    roles_.push_back(s);
    CompositeCandidate * c1 = dynamic_cast<CompositeCandidate*>(&*c);
    if (c1 != 0) {
      c1->setName(s);
    }
  }
  dau.push_back(c);
}

void CompositeCandidate::addDaughter	(	std::unique_ptr< Candidate >	cand,
		const std::string &	s = ""
	)

add a clone of the passed candidate as daughter

Definition at line 136 of file CompositeCandidate.cc.

References reco::Candidate::begin(), alignmentValidation::c1, dau, reco::Candidate::end(), Exception, spr::find(), eostools::move(), edm::OwnVector< T, P >::push_back(), roles_, and setName().

                                                                                      {
  if (s != "") {
    role_collection::iterator begin = roles_.begin(), end = roles_.end();
    bool isFound = (find(begin, end, s) != end);
    if (isFound) {
      throw cms::Exception("InvalidReference")
    << "CompositeCandidate::addDaughter: Already have role with name \"" << s 
    << "\", please clearDaughters, or use a new name\n";
    }
    roles_.push_back(s);  
    CompositeCandidate * c1 = dynamic_cast<CompositeCandidate*>(&*cand);
    if (c1 != 0) {
      c1->setName(s);
    }
  }
  dau.push_back(std::move(cand));
}

void CompositeCandidate::applyRoles

(

)

Definition at line 55 of file CompositeCandidate.cc.

References EnergyCorrector::c, alignmentValidation::c1, daughter(), Exception, i, numberOfDaughters(), roles_, setName(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by reco::modules::RoleNames::set().

                                    {

  if (roles_.size() == 0)
    return;

  // Check if there are the same number of daughters and roles
  int N1 = roles_.size();
  int N2 = numberOfDaughters();
  if (N1 != N2) {
    throw cms::Exception("InvalidReference")
      << "CompositeCandidate::applyRoles : Number of roles and daughters differ, this is an error.\n";
  }
  // Set up the daughter roles
  for (int i = 0 ; i < N1; ++i) {
    std::string role = roles_[i];
    Candidate * c = CompositeCandidate::daughter(i);

    CompositeCandidate * c1 = dynamic_cast<CompositeCandidate *>(c);
    if (c1 != 0) {
      c1->setName(role);
    }
  }
}

void reco::CompositeCandidate::clearDaughters ( )

inline

clear daughters

Definition at line 64 of file CompositeCandidate.h.

References edm::OwnVector< T, P >::clear(), and dau.

Referenced by reco::NamedCompositeCandidate::clearDaughters(), BPHDecayMomentum::computeMomentum(), and TtSemiEvtSolution::setupHyp().

{ dau.clear(); }

void reco::CompositeCandidate::clearRoles ( )

inline

Definition at line 66 of file CompositeCandidate.h.

References roles_.

Referenced by TtSemiEvtSolution::setupHyp().

{ roles_.clear(); }

CompositeCandidate * CompositeCandidate::clone ( void  ) const

virtual

returns a clone of the candidate

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::PFCandidate, reco::PFTauDecayMode, pat::PFParticle, pat::CompositeCandidate, reco::NamedCompositeCandidate, reco::VertexCompositeCandidate, reco::IsolatedPFCandidate, and reco::PileUpPFCandidate.

Definition at line 32 of file CompositeCandidate.cc.

References CompositeCandidate().

{ return new CompositeCandidate(* this); }

const Candidate * CompositeCandidate::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 reco::NamedCompositeCandidate.

Definition at line 34 of file CompositeCandidate.cc.

References dau, i, and numberOfDaughters().

Referenced by BPHDaughterSelect::accept(), reco::WMuNuCandidate::acop(), reco::NamedCompositeCandidate::applyRoles(), applyRoles(), reco::PFTauDecayMode::chargedPionCandidates(), daughter(), reco::NamedCompositeCandidate::daughter(), BPHWriteSpecificDecay::fill(), reco::PFTauDecayMode::filteredObjectCandidates(), reco::PFTauDecayMode::neutralPionCandidates(), reco::PFTauDecayMode::PFTauDecayMode(), ZMuMuUserData::produce(), and MuScleFitMuonSelector::selectMuons().

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

Candidate * CompositeCandidate::daughter ( size_type  i )

virtual

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

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::NamedCompositeCandidate.

Definition at line 38 of file CompositeCandidate.cc.

References ztail::d, dau, and numberOfDaughters().

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

Candidate * CompositeCandidate::daughter ( const std::string &  s )

virtual

return daughter with a specified role name

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::NamedCompositeCandidate.

Definition at line 79 of file CompositeCandidate.cc.

References daughter(), Exception, newFWLiteAna::found, i, N, runTheMatrix::ret, and roles_.

                                                           {
  int ret = -1;
  int i = 0, N = roles_.size();
  bool found = false;
  for (; i < N && !found; ++i) {
    if (s == roles_[i]) {
      found = true;
      ret = i;
    }
  }

  if (ret < 0) {
    throw cms::Exception("InvalidReference")
      << "CompositeCandidate::daughter: Cannot find role " << s << "\n";
  }
  
  return daughter(ret);
}

const Candidate * CompositeCandidate::daughter ( const std::string &  s ) const

virtual

return daughter with a specified role name

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::NamedCompositeCandidate.

Definition at line 98 of file CompositeCandidate.cc.

References daughter(), Exception, newFWLiteAna::found, i, N, runTheMatrix::ret, and roles_.

                                                                        {
  int ret = -1;
  int i = 0, N = roles_.size();
  bool found = false;
  for (; i < N && !found; ++i) {
    if (s == roles_[i]) {
      found = true;
      ret = i;
    }
  }

  if (ret < 0) {
    throw cms::Exception("InvalidReference")
      << "CompositeCandidate::daughter: Cannot find role " << s << "\n";
  }
  
  return daughter(ret);
}

const Candidate * CompositeCandidate::mother ( size_type  i = 0 ) const

virtual

return pointer to mother

Reimplemented from reco::LeafCandidate.

Definition at line 43 of file CompositeCandidate.cc.

                                                              { 
  return 0;
}

std::string reco::CompositeCandidate::name ( ) const

inline

get the name of the candidate

Definition at line 41 of file CompositeCandidate.h.

References name_.

Referenced by cuy.divideElement::__init__(), cuy.plotElement::__init__(), cuy.additionElement::__init__(), cuy.superimposeElement::__init__(), cuy.graphElement::__init__(), config.CFG::__str__(), validation.Sample::digest(), VIDSelectorBase.VIDSelectorBase::initialize(), setName(), and Vispa.Views.PropertyView.Property::valueChanged().

{ return name_;}

size_t CompositeCandidate::numberOfDaughters ( ) const

virtual

number of daughters

Reimplemented from reco::LeafCandidate.

Definition at line 47 of file CompositeCandidate.cc.

References dau, and edm::OwnVector< T, P >::size().

Referenced by reco::NamedCompositeCandidate::applyRoles(), applyRoles(), reco::PFTauDecayMode::chargedPionCandidates(), daughter(), BPHWriteSpecificDecay::fill(), reco::PFTauDecayMode::filteredObjectCandidates(), reco::NamedCompositeCandidate::NamedCompositeCandidate(), reco::PFTauDecayMode::neutralPionCandidates(), reco::PFTauDecayMode::pfMasterClones(), reco::PFTauDecayMode::PFTauDecayMode(), and BoostedTopProducer::produce().

{ return dau.size(); }

size_t CompositeCandidate::numberOfMothers ( ) const

virtual

number of mothers (zero or one in most of but not all the cases)

Reimplemented from reco::LeafCandidate.

Definition at line 49 of file CompositeCandidate.cc.

{ return 0; }

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

privatevirtual

check overlap with another daughter

Reimplemented from reco::LeafCandidate.

Reimplemented in reco::PFCandidate.

Definition at line 51 of file CompositeCandidate.cc.

References Exception.

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

role_collection const& reco::CompositeCandidate::roles ( ) const

inline

get the roles

Definition at line 45 of file CompositeCandidate.h.

References roles_.

Referenced by TtEvent::isHypoValid(), and setRoles().

{ return roles_; }

void reco::CompositeCandidate::setName ( std::string  name )

inline

set the name of the candidate

Definition at line 43 of file CompositeCandidate.h.

References name(), and name_.

Referenced by Vispa.Gui.PortWidget.PortWidget::__init__(), Vispa.Views.PropertyView.Property::__init__(), addDaughter(), applyRoles(), and reco::modules::RoleNames::set().

{ name_ = name;}

void reco::CompositeCandidate::setRoles ( const role_collection &  roles )

inline

set the roles

Definition at line 47 of file CompositeCandidate.h.

References roles(), and roles_.

Referenced by reco::modules::RoleNames::set().

{ roles_.clear(); roles_ = roles; }

Member Data Documentation

daughters reco::CompositeCandidate::dau

private

collection of daughters

Definition at line 76 of file CompositeCandidate.h.

Referenced by addDaughter(), clearDaughters(), daughter(), and numberOfDaughters().

std::string reco::CompositeCandidate::name_

private

candidate name

Definition at line 80 of file CompositeCandidate.h.

Referenced by name(), and setName().

role_collection reco::CompositeCandidate::roles_

private

candidate roles

Definition at line 82 of file CompositeCandidate.h.

Referenced by addDaughter(), applyRoles(), clearRoles(), CompositeCandidate(), daughter(), roles(), and setRoles().