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::auto_ptr< Candidate >, const std::string &s)
void	applyRoles ()
void	clearDaughters ()
void	clearRoles ()
virtual NamedCompositeCandidate *	clone () const
	returns a clone of the candidate 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 Candidate *	daughter (size_type i)
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
virtual const Candidate *	daughter (size_type i) const
	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)
virtual	~NamedCompositeCandidate ()
	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::auto_ptr< Candidate >, const std::string &s="")
	add a clone of the passed candidate as daughter More...
void	applyRoles ()
virtual const_iterator	begin () const
	first daughter const_iterator More...
virtual iterator	begin ()
	first daughter iterator More...
void	clearDaughters ()
	clear daughters More...
void	clearRoles ()
	CompositeCandidate (std::string name="")
	default constructor More...
	CompositeCandidate (Charge q, const LorentzVector &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 (Charge q, const PolarLorentzVector &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_iterator	end () const
	last daughter const_iterator More...
virtual iterator	end ()
	last daughter const_iterator 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
template<typename S >
daughter_iterator< S >::type	beginFilter (const S &s) const
virtual Vector	boostToCM () const
virtual int	charge () const
	electric charge 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 double	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)
	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...
virtual bool	longLived () const
	is long lived? More...
virtual double	mass () const
	mass More...
virtual bool	massConstraint () const
	do mass constraint? More...
virtual double	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 size_t	numberOfSourceCandidatePtrs () const
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 double	phi () const
	momentum azimuthal angle More...
virtual const PolarLorentzVector &	polarP4 () const
	four-momentum Lorentz vector More...
virtual double	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 CandidatePtr	sourceCandidatePtr (size_type i) const
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 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 Attributes
std::string	name_
role_collection	roles_

Additional Inherited Members
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 Candidate composed of daughters. The daughters are owned by the composite candidate.

Author

Luca Lista, INFN

Version

Id:

NamedCompositeCandidate.h,v 1.5 2008/12/05 12:15:18 hegner Exp

Definition at line 23 of file NamedCompositeCandidate.h.

Member Typedef Documentation

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

Definition at line 25 of file NamedCompositeCandidate.h.

Constructor & Destructor Documentation

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

inline

default constructor

Definition at line 28 of file NamedCompositeCandidate.h.

Referenced by clone().

: CompositeCandidate(), name_(name) { }

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

inline

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

                                                                            :
      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 9 of file NamedCompositeCandidate.cc.

References edm::hlt::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 ( )

virtual

destructor

Definition at line 27 of file NamedCompositeCandidate.cc.

References clearDaughters(), and clearRoles().

{ clearDaughters(); clearRoles(); }

Member Function Documentation

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

Definition at line 93 of file NamedCompositeCandidate.cc.

References reco::CompositeCandidate::addDaughter(), reco::CompositeCandidate::begin(), trackerHits::c, alignmentValidation::c1, reco::Candidate::clone(), reco::CompositeCandidate::end(), edm::hlt::Exception, spr::find(), 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 );
  std::auto_ptr<Candidate> c( cand.clone() );
  NamedCompositeCandidate * c1 =  dynamic_cast<NamedCompositeCandidate*>(&*c);
  if ( c1 != 0 ) {
    c1->setName( s );
  }
  CompositeCandidate::addDaughter( c );
}

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

Definition at line 113 of file NamedCompositeCandidate.cc.

References reco::CompositeCandidate::addDaughter(), reco::CompositeCandidate::begin(), alignmentValidation::c1, reco::CompositeCandidate::end(), edm::hlt::Exception, spr::find(), 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 != 0 ) {
    c1->setName( s );
  }
  CompositeCandidate::addDaughter( cand );
}

void NamedCompositeCandidate::applyRoles

(

)

Definition at line 31 of file NamedCompositeCandidate.cc.

References trackerHits::c, alignmentValidation::c1, reco::CompositeCandidate::daughter(), edm::hlt::Exception, i, reco::CompositeCandidate::numberOfDaughters(), roles_, and setName().

{

  // 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 != 0 ) {
      c1->setName( role );
    }
  }
}

void reco::NamedCompositeCandidate::clearDaughters ( )

inline

Definition at line 66 of file NamedCompositeCandidate.h.

References reco::CompositeCandidate::clearDaughters().

Referenced by ~NamedCompositeCandidate().

{ CompositeCandidate::clearDaughters(); }

void reco::NamedCompositeCandidate::clearRoles ( )

inline

Definition at line 67 of file NamedCompositeCandidate.h.

References roles_.

Referenced by ~NamedCompositeCandidate().

{ roles_.clear(); }

NamedCompositeCandidate * NamedCompositeCandidate::clone ( void  ) const

virtual

returns a clone of the candidate

Reimplemented from reco::CompositeCandidate.

Definition at line 29 of file NamedCompositeCandidate.cc.

References NamedCompositeCandidate().

{ return new NamedCompositeCandidate( * this ); }

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

virtual

return daughter with a specified role name

Reimplemented from reco::CompositeCandidate.

Definition at line 53 of file NamedCompositeCandidate.cc.

References edm::hlt::Exception, newFWLiteAna::found, i, N, run_regression::ret, and roles_.

Referenced by daughter().

{
  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

virtual

return daughter with a specified role name

Reimplemented from reco::CompositeCandidate.

Definition at line 73 of file NamedCompositeCandidate.cc.

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

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

inlinevirtual

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

Reimplemented from reco::CompositeCandidate.

Definition at line 60 of file NamedCompositeCandidate.h.

References reco::CompositeCandidate::daughter().

{ return CompositeCandidate::daughter(i); }

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

inlinevirtual

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

Reimplemented from reco::CompositeCandidate.

Definition at line 61 of file NamedCompositeCandidate.h.

References reco::CompositeCandidate::daughter().

{ return CompositeCandidate::daughter(i); }

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

inline

Definition at line 49 of file NamedCompositeCandidate.h.

References name_.

Referenced by BeautifulSoup.Tag::_invert(), and Vispa.Views.PropertyView.Property::valueChanged().

{ return name_; }

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

inline

Definition at line 53 of file NamedCompositeCandidate.h.

References roles_.

Referenced by setRoles().

{ return roles_;}

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

inline

Definition at line 51 of file NamedCompositeCandidate.h.

References 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 55 of file NamedCompositeCandidate.h.

References roles(), and roles_.

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

Member Data Documentation

std::string reco::NamedCompositeCandidate::name_

private

Definition at line 71 of file NamedCompositeCandidate.h.

Referenced by name(), and setName().

role_collection reco::NamedCompositeCandidate::roles_

private

Definition at line 72 of file NamedCompositeCandidate.h.

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