reco::NamedCompositeCandidate Class Reference

#include <NamedCompositeCandidate.h>

Inheritance diagram for reco::NamedCompositeCandidate:

Public Types
typedef std::vector< std::string >	role_collection
Public Types inherited from reco::CompositeCandidate
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)
void	addDaughter (std::unique_ptr< Candidate >, const std::string &s)
void	applyRoles ()
void	clearDaughters ()
void	clearRoles ()
NamedCompositeCandidate *	clone () const override
	returns a clone of the candidate 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...
Candidate *	daughter (size_type i) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
const Candidate *	daughter (size_type i) const override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
std::string	name () const
	NamedCompositeCandidate (std::string name="")
	default constructor More...
	NamedCompositeCandidate (std::string name, const role_collection &roles)
	NamedCompositeCandidate (std::string name, const role_collection &roles, 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...
	NamedCompositeCandidate (std::string name, const role_collection &roles, const Candidate &p)
	constructor from values More...
const NamedCompositeCandidate::role_collection &	roles () const
void	setName (std::string n)
void	setRoles (const NamedCompositeCandidate::role_collection &roles)
	~NamedCompositeCandidate () override
	destructor More...
Public Member Functions inherited from reco::CompositeCandidate
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 ()
	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...
const Candidate *	mother (size_type i=0) const override
	return pointer to mother More...
std::string	name () const
	get the name of the candidate More...
size_type	numberOfDaughters () const override
	number of daughters More...
size_type	numberOfMothers () const override
	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...
	~CompositeCandidate () override
	destructor More...
Public Member Functions inherited from reco::LeafCandidate
Vector	boostToCM () const final
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)
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 Attributes
std::string	name_
role_collection	roles_

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 NamedCompositeCandidate.h.

Member Typedef Documentation

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

Definition at line 23 of file NamedCompositeCandidate.h.

Constructor & Destructor Documentation

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

inline

default constructor

Definition at line 26 of file NamedCompositeCandidate.h.

Referenced by clone(), and NamedCompositeCandidate().

: CompositeCandidate(), name_(name) { }

reco::NamedCompositeCandidate::NamedCompositeCandidate ( std::string  name, const role_collection &  roles  )

inline

Definition at line 27 of file NamedCompositeCandidate.h.

                                                 : 
      CompositeCandidate(), name_(name), roles_(roles) { }

reco::NamedCompositeCandidate::NamedCompositeCandidate ( std::string  name, const role_collection &  roles, 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 31 of file NamedCompositeCandidate.h.

References clone(), NamedCompositeCandidate(), reco::LeafCandidate::p(), AlCaHLTBitMon_QueryRunRegistry::string, and ~NamedCompositeCandidate().

                                                                            :
      CompositeCandidate( q, p4, vtx, pdgId, status, integerCharge ), 
      name_ (name), roles_(roles) { }

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

constructor from values

Definition at line 8 of file NamedCompositeCandidate.cc.

References Exception, reco::CompositeCandidate::numberOfDaughters(), and roles_.

                                              :
  CompositeCandidate(c),
  name_(name),
  roles_(roles)
{

  // 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")
      << "NamedCompositeCandidate constructor: Number of roles and daughters differ, this is an error. Name = " << name << "\n";
  }
}

NamedCompositeCandidate::~NamedCompositeCandidate ( )

override

destructor

Definition at line 26 of file NamedCompositeCandidate.cc.

References clearDaughters(), and clearRoles().

Referenced by NamedCompositeCandidate().

{ clearDaughters(); clearRoles(); }

Member Function Documentation

void NamedCompositeCandidate::addDaughter	(	const Candidate &	cand,
		const std::string &	s
	)

Definition at line 92 of file NamedCompositeCandidate.cc.

References reco::CompositeCandidate::addDaughter(), reco::Candidate::begin(), EnergyCorrector::c, alignmentValidation::c1, reco::Candidate::clone(), reco::Candidate::end(), Exception, spr::find(), eostools::move(), roles_, and setName().

Referenced by daughter().

{

  role_collection::iterator begin = roles_.begin(), end = roles_.end();
  bool isFound = ( find( begin, end, s) != end );
  if ( isFound ) {
    throw cms::Exception("InvalidReference")
      << "NamedCompositeCandidate::addDaughter: Already have role with name " << s 
      << ", please clearDaughters, or use a new name\n";
  }

  roles_.push_back( s );
  std::unique_ptr<Candidate> c( cand.clone() );
  NamedCompositeCandidate * c1 =  dynamic_cast<NamedCompositeCandidate*>(&*c);
  if ( c1 != nullptr ) {
    c1->setName( s );
  }
  CompositeCandidate::addDaughter( std::move(c) );
}

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

Definition at line 112 of file NamedCompositeCandidate.cc.

References reco::CompositeCandidate::addDaughter(), reco::Candidate::begin(), alignmentValidation::c1, reco::Candidate::end(), Exception, spr::find(), eostools::move(), roles_, and setName().

{
  role_collection::iterator begin = roles_.begin(), end = roles_.end();
  bool isFound = ( find( begin, end, s) != end );
  if ( isFound ) {
    throw cms::Exception("InvalidReference")
      << "NamedCompositeCandidate::addDaughter: Already have role with name " << s 
      << ", please clearDaughters, or use a new name\n";
  }

  roles_.push_back( s );
  NamedCompositeCandidate * c1 = dynamic_cast<NamedCompositeCandidate*>(&*cand);
  if ( c1 != nullptr ) {
    c1->setName( s );
  }
  CompositeCandidate::addDaughter( std::move(cand) );
}

void NamedCompositeCandidate::applyRoles

(

)

Definition at line 30 of file NamedCompositeCandidate.cc.

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

Referenced by clearRoles().

{

  // 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")
      << "NamedCompositeCandidate::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 );

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

void reco::NamedCompositeCandidate::clearDaughters ( )

inline

Definition at line 64 of file NamedCompositeCandidate.h.

References reco::CompositeCandidate::clearDaughters().

Referenced by ~NamedCompositeCandidate().

{ CompositeCandidate::clearDaughters(); }

void reco::NamedCompositeCandidate::clearRoles ( )

inline

Definition at line 65 of file NamedCompositeCandidate.h.

References applyRoles(), and roles_.

Referenced by ~NamedCompositeCandidate().

{ roles_.clear(); }

NamedCompositeCandidate * NamedCompositeCandidate::clone ( void  ) const

overridevirtual

returns a clone of the candidate

Reimplemented from reco::CompositeCandidate.

Definition at line 28 of file NamedCompositeCandidate.cc.

References NamedCompositeCandidate().

Referenced by NamedCompositeCandidate().

{ return new NamedCompositeCandidate( * this ); }

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

overridevirtual

return daughter with a specified role name

Reimplemented from reco::CompositeCandidate.

Definition at line 52 of file NamedCompositeCandidate.cc.

References Exception, runEdmFileComparison::found, mps_fire::i, N, and roles_.

Referenced by daughter(), and setRoles().

{
  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")
      << "NamedCompositeCandidate::daughter: Cannot find role " << s << "\n";
  }
  
  return daughter(ret);
}

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

overridevirtual

return daughter with a specified role name

Reimplemented from reco::CompositeCandidate.

Definition at line 72 of file NamedCompositeCandidate.cc.

References daughter(), Exception, runEdmFileComparison::found, mps_fire::i, N, 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")
      << "NamedCompositeCandidate::daughter: Cannot find role " << s << "\n";
  }
  
  return daughter(ret);
}

Candidate* reco::NamedCompositeCandidate::daughter ( size_type  i )

inlineoverridevirtual

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

Reimplemented from reco::CompositeCandidate.

Definition at line 58 of file NamedCompositeCandidate.h.

References reco::CompositeCandidate::daughter().

{ return CompositeCandidate::daughter(i); }

const Candidate* reco::NamedCompositeCandidate::daughter ( size_type  i ) const

inlineoverridevirtual

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

Reimplemented from reco::CompositeCandidate.

Definition at line 59 of file NamedCompositeCandidate.h.

References addDaughter(), reco::CompositeCandidate::daughter(), and AlCaHLTBitMon_QueryRunRegistry::string.

{ return CompositeCandidate::daughter(i); }

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

inline

Definition at line 47 of file NamedCompositeCandidate.h.

References name_.

Referenced by config.CFG::__str__(), validation.Sample::digest(), VIDSelectorBase.VIDSelectorBase::initialize(), and Vispa.Views.PropertyView.Property::valueChanged().

{ return name_; }

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

inline

Definition at line 51 of file NamedCompositeCandidate.h.

References roles_.

Referenced by setRoles().

{ return roles_;}

void reco::NamedCompositeCandidate::setName ( std::string  n )

inline

Definition at line 49 of file NamedCompositeCandidate.h.

References gen::n, and name_.

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

{ name_ = n; }

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

inline

Definition at line 53 of file NamedCompositeCandidate.h.

References daughter(), roles(), roles_, alignCSCRings::s, and AlCaHLTBitMon_QueryRunRegistry::string.

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

Member Data Documentation

std::string reco::NamedCompositeCandidate::name_

private

Definition at line 69 of file NamedCompositeCandidate.h.

Referenced by name(), and setName().

role_collection reco::NamedCompositeCandidate::roles_

private

Definition at line 70 of file NamedCompositeCandidate.h.

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