Particle reconstructed by the particle flow algorithm. More...

#include <PFCandidate.h>

Inheritance diagram for reco::PFCandidate:

Public Types
typedef edm::RefVector < reco::PFBlockCollection >	Blocks

typedef std::pair < reco::PFBlockRef, unsigned >	ElementInBlock
	return indices of elements used in the block More...

typedef std::vector< unsigned >	Elements

typedef std::vector < ElementInBlock >	ElementsInBlocks

enum	Flags { NORMAL =0, E_PHI_SMODULES, E_ETA_0, E_ETA_MODULES, E_BARREL_ENDCAP, E_PRESHOWER_EDGE, E_PRESHOWER, E_ENDCAP_EDGE, H_ETA_0, H_BARREL_ENDCAP, H_ENDCAP_VFCAL, H_VFCAL_EDGE, T_TO_DISP, T_FROM_DISP, T_FROM_V0, T_FROM_GAMMACONV, GAMMA_TO_GAMMACONV }

enum	ParticleType { X =0, h, e, mu, gamma, h0, h_HF, egamma_HF }
	particle types More...

enum	PFVertexType { kCandVertex =0, kTrkVertex =1, kComMuonVertex =2, kSAMuonVertex =3, kTrkMuonVertex =4, kGSFVertex =5 }

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	addElementInBlock (const reco::PFBlockRef &blockref, unsigned elementIndex)
	add an element to the current PFCandidate More...

virtual PFCandidate *	clone () const
	return a clone More...

reco::ConversionRef	conversionRef () const
	return a reference to the original conversion More...

double	deltaP () const
	uncertainty on 3-momentum More...

reco::PFDisplacedVertexRef	displacedVertexRef (Flags type) const

double	ecalEnergy () const
	return corrected Ecal energy More...

reco::PFCandidateElectronExtraRef	electronExtraRef () const
	return a reference to the electron extra More...

const ElementsInBlocks &	elementsInBlocks () const

bool	flag (Flags theFlag) const
	return a given flag More...

reco::GsfElectronRef	gsfElectronRef () const
	return a reference to the corresponding GsfElectron if any More...

reco::GsfTrackRef	gsfTrackRef () const

double	hcalEnergy () const
	return corrected Hcal energy More...

double	hoEnergy () const
	return corrected Hcal energy More...

reco::MuonRef	muonRef () const

float	mva_e_mu () const
	mva for electron-muon discrimination More...

float	mva_e_pi () const
	mva for electron-pion discrimination More...

float	mva_gamma_nh () const
	mva for neutral hadron - gamma discrimination More...

float	mva_nothing_gamma () const
	mva for gamma detection More...

float	mva_nothing_nh () const
	mva for neutral hadron detection More...

float	mva_pi_mu () const
	mva for pi-muon discrimination More...

size_t	numberOfSourceCandidatePtrs () const

virtual ParticleType	particleId () const

	PFCandidate ()
	default constructor More...

	PFCandidate (const PFCandidatePtr &sourcePtr)
	constructor from a reference (keeps track of source relationship) More...

	PFCandidate (Charge q, const LorentzVector &p4, ParticleType particleId)

reco::PFCandidatePhotonExtraRef	photonExtraRef () const
	return a reference to the photon extra More...

reco::PhotonRef	photonRef () const
	return a reference to the corresponding Photon if any More...

const math::XYZPointF &	positionAtECALEntrance () const

double	pS1Energy () const
	return corrected PS1 energy More...

double	pS2Energy () const
	return corrected PS2 energy More...

double	rawEcalEnergy () const
	return corrected Ecal energy More...

double	rawHcalEnergy () const
	return raw Hcal energy More...

double	rawHoEnergy () const
	return raw Hcal energy More...

void	rescaleMomentum (double rescaleFactor)
	particle momentum *= rescaleFactor More...

void	set_mva_e_mu (float mva)
	set mva for electron-muon discrimination More...

void	set_mva_e_pi (float mva)

void	set_mva_gamma_nh (float mva)
	set mva for neutral hadron - gamma discrimination More...

void	set_mva_nothing_gamma (float mva)
	set mva for gamma detection More...

void	set_mva_nothing_nh (float mva)
	set mva for neutral hadron detection More...

void	set_mva_pi_mu (float mva)
	set mva for pi-muon discrimination More...

void	setConversionRef (const reco::ConversionRef &ref)
	set ref to original reco conversion More...

void	setDeltaP (double dp)
	set uncertainty on momentum More...

void	setDisplacedVertexRef (const reco::PFDisplacedVertexRef &ref, Flags flag)
	set displaced vertex reference More...

void	setEcalEnergy (float eeRaw, float eeCorr)
	set corrected Ecal energy More...

void	setFlag (Flags theFlag, bool value)
	set a given flag More...

void	setGsfElectronRef (const reco::GsfElectronRef &ref)
	set GsfElectronRef More...

void	setGsfTrackRef (const reco::GsfTrackRef &ref)
	set gsftrack reference More...

void	setHcalEnergy (float ehRaw, float ehCorr)
	set corrected Hcal energy More...

void	setHoEnergy (float eoRaw, float eoCorr)
	set corrected Hcal energy More...

void	setMuonRef (const reco::MuonRef &ref)
	set muon reference More...

void	setParticleType (ParticleType type)
	set Particle Type More...

void	setPFElectronExtraRef (const reco::PFCandidateElectronExtraRef &ref)
	set the PF Electron Extra Ref More...

void	setPFPhotonExtraRef (const reco::PFCandidatePhotonExtraRef &ref)
	set the PF Photon Extra Ref More...

void	setPhotonRef (const reco::PhotonRef &phRef)
	set ref to the corresponding reco::Photon if any More...

void	setPositionAtECALEntrance (const math::XYZPointF &pos)
	set position at ECAL entrance More...

void	setPs1Energy (float e1)
	set corrected PS1 energy More...

void	setPs2Energy (float e2)
	set corrected PS2 energy More...

void	setSourceCandidatePtr (const PFCandidatePtr &ptr)

void	setSuperClusterRef (const reco::SuperClusterRef &scRef)

void	setTrackRef (const reco::TrackRef &ref)
	set track reference More...

void	setV0Ref (const reco::VertexCompositeCandidateRef &ref)
	set ref to original reco conversion More...

virtual void	setVertex (math::XYZPoint p)

void	setVertexSource (PFVertexType vt)

CandidatePtr	sourceCandidatePtr (size_type i) const

reco::SuperClusterRef	superClusterRef () const
	return a reference to the corresponding SuperCluster if any More...

reco::TrackRef	trackRef () const

ParticleType	translatePdgIdToType (int pdgid) const

int	translateTypeToPdgId (ParticleType type) const

reco::VertexCompositeCandidateRef	v0Ref () const
	return a reference to the original conversion More...

virtual const Point &	vertex () const
	vertex position 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	~PFCandidate ()
	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 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_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 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 int	status () const
	status word More...

virtual double	theta () const
	momentum polar angle More...

virtual int	threeCharge () const
	electric charge 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	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...

Static Public Attributes
static const float	bigMva_ = -999.

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

Private Member Functions
bool	flag (unsigned shift, unsigned flag) const

bool	getRefInfo (unsigned int iMask, unsigned int iBit, edm::ProductID &oProdID, size_t &oIndex, size_t &aIndex) const

virtual bool	overlap (const Candidate &) const
	Polymorphic overlap. More...

void	setFlag (unsigned shift, unsigned flag, bool value)

void	storeRefInfo (unsigned int iMask, unsigned int iBit, bool iIsValid, const edm::RefCore &iCore, size_t iKey, const edm::EDProductGetter *)

Private Attributes
Blocks	blocksStorage_

float	deltaP_
	uncertainty on 3-momentum More...

float	ecalERatio_
	corrected ECAL energy ratio (corrected/raw) More...

ElementsInBlocks	elementsInBlocks_

Elements	elementsStorage_

unsigned	flags_
	all flags, packed (ecal regional, hcal regional, tracking) More...

const edm::EDProductGetter *	getter_

float	hcalERatio_
	corrected HCAL energy ratio (corrected/raw) More...

float	hoERatio_
	corrected HO energy ratio (corrected/raw) More...

float	mva_e_mu_
	mva for electron-muon discrimination More...

float	mva_e_pi_
	mva for electron-pion discrimination More...

float	mva_gamma_nh_
	mva for neutral hadron - gamma discrimination More...

float	mva_nothing_gamma_
	mva for gamma detection More...

float	mva_nothing_nh_
	mva for neutral hadron detection More...

float	mva_pi_mu_
	mva for pi-muon discrimination More...

math::XYZPointF	positionAtECALEntrance_
	position at ECAL entrance, from the PFRecTrack More...

float	ps1Energy_
	corrected PS1 energy More...

float	ps2Energy_
	corrected PS2 energy More...

float	rawEcalEnergy_
	raw ECAL energy More...

float	rawHcalEnergy_
	raw HCAL energy More...

float	rawHoEnergy_
	raw HO energy More...

std::vector< const void * >	refsCollectionCache_

std::vector< unsigned long long >	refsInfo_

PFCandidatePtr	sourcePtr_
	reference to the source PFCandidate, if any More...

unsigned short	storedRefsBitPattern_

PFVertexType	vertexType_

Friends
std::ostream &	operator<< (std::ostream &out, const PFCandidate &c)

Additional Inherited Members
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

Particle reconstructed by the particle flow algorithm.

particle candidate from particle flow

Author: Colin Bernet

Date: February 2007

Definition at line 33 of file PFCandidate.h.

Member Typedef Documentation

typedef edm::RefVector<reco::PFBlockCollection> reco::PFCandidate::Blocks

Definition at line 339 of file PFCandidate.h.

typedef std::pair<reco::PFBlockRef, unsigned> reco::PFCandidate::ElementInBlock

return indices of elements used in the block

return elements return elements in blocks

Definition at line 336 of file PFCandidate.h.

typedef std::vector<unsigned> reco::PFCandidate::Elements

Definition at line 340 of file PFCandidate.h.

typedef std::vector< ElementInBlock > reco::PFCandidate::ElementsInBlocks

Definition at line 337 of file PFCandidate.h.

Member Enumeration Documentation

enum reco::PFCandidate::Flags

Enumerator
NORMAL
E_PHI_SMODULES
E_ETA_0
E_ETA_MODULES
E_BARREL_ENDCAP
E_PRESHOWER_EDGE
E_PRESHOWER
E_ENDCAP_EDGE
H_ETA_0
H_BARREL_ENDCAP
H_ENDCAP_VFCAL
H_VFCAL_EDGE
T_TO_DISP
T_FROM_DISP
T_FROM_V0
T_FROM_GAMMACONV
GAMMA_TO_GAMMACONV

Definition at line 49 of file PFCandidate.h.

                {
       NORMAL=0,
       E_PHI_SMODULES,
       E_ETA_0,
       E_ETA_MODULES,
       E_BARREL_ENDCAP,
       E_PRESHOWER_EDGE,
       E_PRESHOWER,
       E_ENDCAP_EDGE,
       H_ETA_0,
       H_BARREL_ENDCAP,
       H_ENDCAP_VFCAL,
       H_VFCAL_EDGE,  
       T_TO_DISP,
       T_FROM_DISP,
       T_FROM_V0,
       T_FROM_GAMMACONV,
       GAMMA_TO_GAMMACONV
     };

enum reco::PFCandidate::ParticleType

particle types

Enumerator
X
h
e
mu
gamma
h0
h_HF
egamma_HF

Definition at line 38 of file PFCandidate.h.

                       {
       X=0,     // undefined
       h,       // charged hadron
       e,       // electron 
       mu,      // muon 
       gamma,   // photon
       h0,      // neutral hadron
       h_HF,        // HF tower identified as a hadron
       egamma_HF    // HF tower identified as an EM particle
     };

enum reco::PFCandidate::PFVertexType

Enumerator
kCandVertex
kTrkVertex
kComMuonVertex
kSAMuonVertex
kTrkMuonVertex
kGSFVertex

Definition at line 70 of file PFCandidate.h.

                       {
       kCandVertex=0, 
       kTrkVertex=1,
       kComMuonVertex=2,
       kSAMuonVertex=3,
       kTrkMuonVertex=4,
       kGSFVertex=5
     };

Constructor & Destructor Documentation

PFCandidate::PFCandidate ( )

default constructor

Definition at line 30 of file PFCandidate.cc.

References refsInfo_, reco::LeafCandidate::setPdgId(), translateTypeToPdgId(), and X.

Referenced by clone().

                          : 
   ecalERatio_(1.),
   hcalERatio_(1.),
   hoERatio_(1.),
   rawEcalEnergy_(0.),
   rawHcalEnergy_(0.),
   rawHoEnergy_(0.),
   ps1Energy_(0.),
   ps2Energy_(0.),
   flags_(0), 
   deltaP_(0.), 
   vertexType_(kCandVertex),
   mva_e_pi_(bigMva_),
   mva_e_mu_(bigMva_),
   mva_pi_mu_(bigMva_),
   mva_nothing_gamma_(bigMva_),
   mva_nothing_nh_(bigMva_),
   mva_gamma_nh_(bigMva_),
   getter_(0),storedRefsBitPattern_(0)
 {
   
   setPdgId( translateTypeToPdgId( X ) );
   refsInfo_.reserve(3);
 }

PFCandidate::PFCandidate ( const PFCandidatePtr & sourcePtr )

constructor from a reference (keeps track of source relationship)

Definition at line 56 of file PFCandidate.cc.

References sourcePtr_.

                                                           {
   *this = *sourcePtr;
   sourcePtr_ = sourcePtr;
 }

PFCandidate::PFCandidate	(	Charge	q,
		const LorentzVector &	p4,
		ParticleType	particleId
	)

Definition at line 62 of file PFCandidate.cc.

References blocksStorage_, e, elementsStorage_, edm::hlt::Exception, h, mu, refsInfo_, edm::RefVector< C, T, F >::reserve(), reco::LeafCandidate::setPdgId(), and translateTypeToPdgId().

                                     : 
   
   CompositeCandidate(charge, p4), 
   ecalERatio_(1.),
   hcalERatio_(1.),
   hoERatio_(1.),
   rawEcalEnergy_(0.),
   rawHcalEnergy_(0.),
   rawHoEnergy_(0.),
   ps1Energy_(0.),
   ps2Energy_(0.),
   flags_(0),
   deltaP_(0.),
   vertexType_(kCandVertex),
   mva_e_pi_(bigMva_),
   mva_e_mu_(bigMva_),
   mva_pi_mu_(bigMva_),
   mva_nothing_gamma_(bigMva_),
   mva_nothing_nh_(bigMva_),
   mva_gamma_nh_(bigMva_),
   getter_(0),storedRefsBitPattern_(0)
 {
   refsInfo_.reserve(3);
   blocksStorage_.reserve(10);
   elementsStorage_.reserve(10);
 
   // proceed with various consistency checks
 
   // charged candidate: track ref and charge must be non null
   if(  partId == h || 
        partId == e || 
        partId == mu ) {
     
     if( charge == 0 ) {
       string err;
       err+="Attempt to construct a charged PFCandidate with a zero charge";
       throw cms::Exception("InconsistentValue",
                            err.c_str() );
     } 
   }
   else {
     if( charge ) { 
       string err;
       err += "Attempt to construct a neutral PFCandidate ";
       err += "with a non-zero charge";
       throw cms::Exception("InconsistentValue",
                err.c_str() );
     } 
   }  
   setPdgId( translateTypeToPdgId( partId ) );
 }

PFCandidate::~PFCandidate ( )

virtual

destructor

Definition at line 116 of file PFCandidate.cc.

116 {}

Member Function Documentation

void PFCandidate::addElementInBlock	(	const reco::PFBlockRef &	blockref,
		unsigned	elementIndex
	)

add an element to the current PFCandidate

add element in block

Definition at line 123 of file PFCandidate.cc.

References blocksStorage_, elementsStorage_, edm::Ref< C, T, F >::id(), edm::RefVector< C, T, F >::push_back(), and edm::RefVector< C, T, F >::size().

Referenced by PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

                                                              {
   //elementsInBlocks_.push_back( make_pair(blockref.key(), elementIndex) );
   if (blocksStorage_.size()==0)
     blocksStorage_ =Blocks(blockref.id());
   blocksStorage_.push_back(blockref);
   elementsStorage_.push_back(elementIndex);
 }

PFCandidate * PFCandidate::clone ( void ) const

virtual

return a clone

Reimplemented from reco::CompositeCandidate.

Reimplemented in pat::PFParticle, reco::IsolatedPFCandidate, and reco::PileUpPFCandidate.

Definition at line 118 of file PFCandidate.cc.

References PFCandidate().

Referenced by DistortedPFCandProducer::produce().

                                        {
   return new PFCandidate( * this );
 }

reco::ConversionRef PFCandidate::conversionRef ( ) const

return a reference to the original conversion

Definition at line 459 of file PFCandidate.cc.

References GETREF, kRefConversionBit, and kRefConversionMask.

                                                    {
     GETREF(reco::Conversion, kRefConversionMask, kRefConversionBit); 
 }

double reco::PFCandidate::deltaP ( ) const

inline

uncertainty on 3-momentum

Definition at line 260 of file PFCandidate.h.

References deltaP_.

Referenced by PFElectronTranslator::createGsfElectrons().

260 { return deltaP_;}

reco::PFCandidate::deltaP_

float deltaP_

uncertainty on 3-momentum

Definition: PFCandidate.h:425

reco::PFDisplacedVertexRef PFCandidate::displacedVertexRef ( Flags type ) const

return a reference to the corresponding displaced vertex, otherwise, return a null reference

Definition at line 424 of file PFCandidate.cc.

References GETREF, kRefDisplacedVertexDauBit, kRefDisplacedVertexDauMask, kRefDisplacedVertexMotBit, kRefDisplacedVertexMotMask, T_FROM_DISP, and T_TO_DISP.

Referenced by PFCandConnector::analyseNuclearWPrim(), PFCandConnector::isPrimaryNucl(), and PFCandConnector::isSecondaryNucl().

                                                                          {
   if (type == T_TO_DISP) {
     GETREF(reco::PFDisplacedVertex, kRefDisplacedVertexDauMask, kRefDisplacedVertexDauBit); 
   }
   else if (type == T_FROM_DISP) {
     GETREF(reco::PFDisplacedVertex, kRefDisplacedVertexMotMask, kRefDisplacedVertexMotBit); 
   }
   return reco::PFDisplacedVertexRef();
 }

double reco::PFCandidate::ecalEnergy ( ) const

inline

return corrected Ecal energy

Definition at line 189 of file PFCandidate.h.

References ecalERatio_, and rawEcalEnergy_.

Referenced by PFCandConnector::analyseNuclearWPrim(), and PFCandidateBenchmark::fillOne().

189 { return ecalERatio_*rawEcalEnergy_;}

reco::PFCandidate::ecalERatio_

float ecalERatio_

corrected ECAL energy ratio (corrected/raw)

Definition: PFCandidate.h:398

reco::PFCandidate::rawEcalEnergy_

float rawEcalEnergy_

raw ECAL energy

Definition: PFCandidate.h:407

reco::PFCandidateElectronExtraRef PFCandidate::electronExtraRef ( ) const

return a reference to the electron extra

Definition at line 489 of file PFCandidate.cc.

References GETREF, kRefPFElectronExtraBit, and kRefPFElectronExtraMask.

Referenced by PFElectronTranslator::createGsfElectrons(), reco::operator<<(), and PFElectronTranslator::produce().

                                                                     {
   GETREF(reco::PFCandidateElectronExtra, kRefPFElectronExtraMask, kRefPFElectronExtraBit); 
 }

const ElementsInBlocks& reco::PFCandidate::elementsInBlocks ( ) const

inline

Definition at line 342 of file PFCandidate.h.

References blocksStorage_, elementsInBlocks_, elementsStorage_, and edm::RefVector< C, T, F >::size().

Referenced by FWPFCandidateWithHitsProxyBuilder::addHitsForCandidate(), PFElectronTranslator::correspondingDaughterCandidate(), PFPhotonTranslator::correspondingDaughterCandidate(), PFPhotonAlgo::EvaluateGCorrMVA(), PFPhotonAlgo::EvaluateResMVA(), PFCandidateBenchmark::fillOne(), reco::modules::HICaloCompatibleTrackSelector::matchPFCandToTrack(), PFRootEventManager::mcTruthMatching(), reco::operator<<(), PFAlgo::postMuonCleaning(), PFCandidateChecker::printElementsInBlocks(), PFAlgo::processBlock(), PFElectronTranslator::produce(), and PFPhotonTranslator::produce().

                                                      { 
       
       if (elementsInBlocks_.size()!=blocksStorage_.size())
     {
       elementsInBlocks_.resize(blocksStorage_.size());
       for(unsigned int icopy=0;icopy!=blocksStorage_.size();++icopy)
         elementsInBlocks_[icopy]=std::make_pair(blocksStorage_[icopy],elementsStorage_[icopy]);
     }
       return elementsInBlocks_;
     }

bool PFCandidate::flag ( Flags theFlag ) const

return a given flag

Definition at line 205 of file PFCandidate.cc.

References flags_.

Referenced by PFCandConnector::isPrimaryNucl(), PFCandConnector::isSecondaryNucl(), reco::operator<<(), setConversionRef(), and setDisplacedVertexRef().

                                           {
 
   return (flags_>>theFlag) & 1;
 }

bool reco::PFCandidate::flag	(	unsigned	shift,
		unsigned	flag
	)		const

private

bool PFCandidate::getRefInfo	(	unsigned int	iMask,
		unsigned int	iBit,
		edm::ProductID &	oProdID,
		size_t &	oIndex,
		size_t &	aIndex
	)		const

private

Definition at line 307 of file PFCandidate.cc.

References refsInfo_, s_refsBefore, and storedRefsBitPattern_.

                                                                                  {
 
   if( 0 == (iBit & storedRefsBitPattern_) ) {
     return false;
   }
   aIndex = s_refsBefore[storedRefsBitPattern_ & iMask];
   unsigned long long bitPacked = refsInfo_[aIndex];
   oIndex = bitPacked & 0xFFFFFFFFULL; //low 32 bits are the index
   unsigned short productIndex = (bitPacked & 0x0000FFFF00000000ULL)>>32;
   unsigned short processIndex = (bitPacked & 0xFFFF000000000000ULL)>>48;
   oProductID = edm::ProductID(processIndex,productIndex);
   return true;
 }

reco::GsfElectronRef PFCandidate::gsfElectronRef ( ) const

return a reference to the corresponding GsfElectron if any

Definition at line 479 of file PFCandidate.cc.

References GETREF, kRefGsfElectronBit, and kRefGsfElectronMask.

Referenced by SoftPFElectronTagInfoProducer::fillElecProperties().

                                                      {
   GETREF(reco::GsfElectron, kRefGsfElectronMask, kRefGsfElectronBit); 
 }

reco::GsfTrackRef PFCandidate::gsfTrackRef ( ) const

return a reference to the corresponding GSF track, if an electron. otherwise, return a null reference

Definition at line 376 of file PFCandidate.cc.

References GETREF, kRefGsfTrackBit, and kRefGsfTrackMask.

Referenced by SoftPFElectronTagInfoProducer::fillElecProperties(), PFElectronTranslator::fillMVAValueMap(), LeptonRecoSkim::filter(), reco::tau::getTrack(), SoftPFElectronTagInfoProducer::isElecClean(), PFElectronTranslator::produce(), PFLinker::produce(), and vertex().

376 { GETREF(reco::GsfTrack, kRefGsfTrackMask, kRefGsfTrackBit); }

kRefGsfTrackBit

Definition: CountBits.h:4117

reco::GsfTrack

Definition: GsfTrack.h:11

kRefGsfTrackMask

Definition: CountBits.h:4131

GETREF

#define GETREF(_class_, _mask_, _bit_)

Definition: CountBits.h:4145

double reco::PFCandidate::hcalEnergy ( ) const

inline

return corrected Hcal energy

Definition at line 199 of file PFCandidate.h.

References hcalERatio_, and rawHcalEnergy_.

Referenced by PFCandConnector::analyseNuclearWPrim(), and PFCandidateBenchmark::fillOne().

199 { return hcalERatio_*rawHcalEnergy_;}

reco::PFCandidate::hcalERatio_

float hcalERatio_

corrected HCAL energy ratio (corrected/raw)

Definition: PFCandidate.h:401

reco::PFCandidate::rawHcalEnergy_

float rawHcalEnergy_

raw HCAL energy

Definition: PFCandidate.h:410

double reco::PFCandidate::hoEnergy ( ) const

inline

return corrected Hcal energy

Definition at line 209 of file PFCandidate.h.

References hoERatio_, and rawHoEnergy_.

209 { return hoERatio_*rawHoEnergy_;}

reco::PFCandidate::hoERatio_

float hoERatio_

corrected HO energy ratio (corrected/raw)

Definition: PFCandidate.h:404

reco::PFCandidate::rawHoEnergy_

float rawHoEnergy_

raw HO energy

Definition: PFCandidate.h:413

reco::MuonRef PFCandidate::muonRef ( ) const

return a reference to the corresponding muon, if a muon. otherwise, return a null reference

Definition at line 355 of file PFCandidate.cc.

References GETREF, kRefMuonBit, and kRefMuonMask.

Referenced by SoftPFMuonTagInfoProducer::fillMuonProperties(), GreedyMuonPFCandidateFilter::filter(), InconsistentMuonPFCandidateFilter::filter(), SoftPFMuonTagInfoProducer::isMuonClean(), PFAlgo::postMuonCleaning(), DistortedPFCandProducer::produce(), PFLinker::produce(), MuonProducer::produce(), pat::PATMuonProducer::produce(), and vertex().

355 { GETREF(reco::Muon, kRefMuonMask, kRefMuonBit); }

kRefMuonMask

Definition: CountBits.h:4132

kRefMuonBit

Definition: CountBits.h:4118

reco::Muon

Definition: Muon.h:28

GETREF

#define GETREF(_class_, _mask_, _bit_)

Definition: CountBits.h:4145

float reco::PFCandidate::mva_e_mu ( ) const

inline

mva for electron-muon discrimination

Definition at line 281 of file PFCandidate.h.

References mva_e_mu_.

281 { return mva_e_mu_;}

reco::PFCandidate::mva_e_mu_

float mva_e_mu_

mva for electron-muon discrimination

Definition: PFCandidate.h:433

float reco::PFCandidate::mva_e_pi ( ) const

inline

mva for electron-pion discrimination

Definition at line 274 of file PFCandidate.h.

References mva_e_pi_.

Referenced by PFElectronTranslator::createGsfElectrons(), PFElectronTranslator::fillMVAValueMap(), PFCandidateBenchmark::fillOne(), and PFElectronTranslator::produce().

274 { return mva_e_pi_;}

reco::PFCandidate::mva_e_pi_

float mva_e_pi_

mva for electron-pion discrimination

Definition: PFCandidate.h:430

float reco::PFCandidate::mva_gamma_nh ( ) const

inline

mva for neutral hadron - gamma discrimination

Definition at line 307 of file PFCandidate.h.

References mva_gamma_nh_.

307 { return mva_gamma_nh_;}

reco::PFCandidate::mva_gamma_nh_

float mva_gamma_nh_

mva for neutral hadron - gamma discrimination

Definition: PFCandidate.h:445

float reco::PFCandidate::mva_nothing_gamma ( ) const

inline

mva for gamma detection

Definition at line 294 of file PFCandidate.h.

References mva_nothing_gamma_.

Referenced by PFIsolationEstimator::isPhotonParticleVetoed(), PFLinker::produce(), and PFPhotonTranslator::produce().

294 { return mva_nothing_gamma_;}

reco::PFCandidate::mva_nothing_gamma_

float mva_nothing_gamma_

mva for gamma detection

Definition: PFCandidate.h:439

float reco::PFCandidate::mva_nothing_nh ( ) const

inline

mva for neutral hadron detection

Definition at line 300 of file PFCandidate.h.

References mva_nothing_nh_.

300 { return mva_nothing_nh_;}

reco::PFCandidate::mva_nothing_nh_

float mva_nothing_nh_

mva for neutral hadron detection

Definition: PFCandidate.h:442

float reco::PFCandidate::mva_pi_mu ( ) const

inline

mva for pi-muon discrimination

Definition at line 287 of file PFCandidate.h.

References mva_pi_mu_.

287 { return mva_pi_mu_;}

reco::PFCandidate::mva_pi_mu_

float mva_pi_mu_

mva for pi-muon discrimination

Definition: PFCandidate.h:436

size_t reco::PFCandidate::numberOfSourceCandidatePtrs ( ) const

inlinevirtual

return the number of source Candidates ( the candidates used to construct this Candidate)

Reimplemented from reco::LeafCandidate.

Definition at line 113 of file PFCandidate.h.

                                                { 
       return 1;
     }

bool PFCandidate::overlap ( const Candidate & other ) const

privatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositeCandidate.

Definition at line 171 of file PFCandidate.cc.

References i, edm::Ptr< T >::isNonnull(), edm::Ptr< T >::isNull(), n, reco::Candidate::numberOfSourceCandidatePtrs(), sourceCandidatePtr(), reco::Candidate::sourceCandidatePtr(), and sourcePtr_.

                                                            {
     CandidatePtr myPtr = sourceCandidatePtr(0);
     if (myPtr.isNull()) return false;
     for (size_t i = 0, n = other.numberOfSourceCandidatePtrs(); i < n; ++i) {
         CandidatePtr otherPtr = other.sourceCandidatePtr(i);
         if ((otherPtr == myPtr) || 
             (sourcePtr_.isNonnull() && otherPtr.isNonnull() && sourcePtr_->overlap(*otherPtr))) {
                 return true;
         }
     }
     return false;
 }

virtual ParticleType reco::PFCandidate::particleId ( ) const

inlinevirtual

particle identification code

Definition at line 324 of file PFCandidate.h.

References reco::LeafCandidate::pdgId_, and translatePdgIdToType().

324 { return translatePdgIdToType(pdgId_);}

reco::LeafCandidate::pdgId_

int pdgId_

PDG identifier.

Definition: LeafCandidate.h:316

reco::PFCandidate::translatePdgIdToType

ParticleType translatePdgIdToType(int pdgid) const

Definition: PFCandidate.cc:134

reco::PFCandidatePhotonExtraRef PFCandidate::photonExtraRef ( ) const

return a reference to the photon extra

Definition at line 498 of file PFCandidate.cc.

References GETREF, kRefPFPhotonExtraBit, and kRefPFPhotonExtraMask.

Referenced by PFPhotonTranslator::produce().

                                                                 {
   GETREF(reco::PFCandidatePhotonExtra, kRefPFPhotonExtraMask, kRefPFPhotonExtraBit); 
 }

reco::PhotonRef PFCandidate::photonRef ( ) const

return a reference to the corresponding Photon if any

Definition at line 494 of file PFCandidate.cc.

References GETREF, kRefPhotonBit, and kRefPhotonMask.

                                            {
   GETREF(reco::Photon, kRefPhotonMask, kRefPhotonBit); 
 }

const math::XYZPointF& reco::PFCandidate::positionAtECALEntrance ( ) const

inline

Returns: position at ECAL entrance

Definition at line 318 of file PFCandidate.h.

References positionAtECALEntrance_.

Referenced by PFCandIsolatorFromDeposits::SingleDeposit::compute(), PFIsolationEstimator::fGetIsolationInRings(), and reco::tau::RecoTauIsolationMasking::inCone().

                                                         {
       return positionAtECALEntrance_;
     }

double reco::PFCandidate::pS1Energy ( ) const

inline

return corrected PS1 energy

Definition at line 239 of file PFCandidate.h.

References ps1Energy_.

239 { return ps1Energy_;}

reco::PFCandidate::ps1Energy_

float ps1Energy_

corrected PS1 energy

Definition: PFCandidate.h:416

double reco::PFCandidate::pS2Energy ( ) const

inline

return corrected PS2 energy

Definition at line 245 of file PFCandidate.h.

References ps2Energy_.

245 { return ps2Energy_;}

reco::PFCandidate::ps2Energy_

float ps2Energy_

corrected PS2 energy

Definition: PFCandidate.h:419

double reco::PFCandidate::rawEcalEnergy ( ) const

inline

return corrected Ecal energy

Definition at line 192 of file PFCandidate.h.

References rawEcalEnergy_.

Referenced by PFElectronTranslator::createBasicCluster(), GreedyMuonPFCandidateFilter::filter(), and PFAlgo::postMuonCleaning().

192 { return rawEcalEnergy_;}

reco::PFCandidate::rawEcalEnergy_

float rawEcalEnergy_

raw ECAL energy

Definition: PFCandidate.h:407

double reco::PFCandidate::rawHcalEnergy ( ) const

inline

return raw Hcal energy

Definition at line 202 of file PFCandidate.h.

References rawHcalEnergy_.

Referenced by GreedyMuonPFCandidateFilter::filter(), and PFAlgo::postMuonCleaning().

202 { return rawHcalEnergy_;}

reco::PFCandidate::rawHcalEnergy_

float rawHcalEnergy_

raw HCAL energy

Definition: PFCandidate.h:410

double reco::PFCandidate::rawHoEnergy ( ) const

inline

return raw Hcal energy

Definition at line 212 of file PFCandidate.h.

References rawHoEnergy_.

212 { return rawHoEnergy_;}

reco::PFCandidate::rawHoEnergy_

float rawHoEnergy_

raw HO energy

Definition: PFCandidate.h:413

void PFCandidate::rescaleMomentum ( double rescaleFactor )

particle momentum *= rescaleFactor

Definition at line 188 of file PFCandidate.cc.

References reco::LeafCandidate::p4(), and reco::LeafCandidate::setP4().

                                                         {
   LorentzVector rescaledp4 = p4();
   rescaledp4 *= rescaleFactor;
   setP4( rescaledp4 );
 }

void reco::PFCandidate::set_mva_e_mu ( float mva )

inline

set mva for electron-muon discrimination

Definition at line 278 of file PFCandidate.h.

References mva_e_mu_.

278 { mva_e_mu_=mva;}

reco::PFCandidate::mva_e_mu_

float mva_e_mu_

mva for electron-muon discrimination

Definition: PFCandidate.h:433

void reco::PFCandidate::set_mva_e_pi ( float mva )

inline

set mva for electron-pion discrimination. For charged particles, this variable is set to 0 for particles that are not preided to 1 otherwise For neutral particles, it is set to the default value

Definition at line 271 of file PFCandidate.h.

References mva_e_pi_.

Referenced by PFElectronAlgo::SetCandidates().

271 { mva_e_pi_=mva;}

reco::PFCandidate::mva_e_pi_

float mva_e_pi_

mva for electron-pion discrimination

Definition: PFCandidate.h:430

void reco::PFCandidate::set_mva_gamma_nh ( float mva )

inline

set mva for neutral hadron - gamma discrimination

Definition at line 304 of file PFCandidate.h.

References mva_gamma_nh_.

304 { mva_gamma_nh_=mva;}

reco::PFCandidate::mva_gamma_nh_

float mva_gamma_nh_

mva for neutral hadron - gamma discrimination

Definition: PFCandidate.h:445

void reco::PFCandidate::set_mva_nothing_gamma ( float mva )

inline

set mva for gamma detection

Definition at line 291 of file PFCandidate.h.

References mva_nothing_gamma_.

Referenced by PFPhotonAlgo::RunPFPhoton().

291 { mva_nothing_gamma_=mva;}

reco::PFCandidate::mva_nothing_gamma_

float mva_nothing_gamma_

mva for gamma detection

Definition: PFCandidate.h:439

void reco::PFCandidate::set_mva_nothing_nh ( float mva )

inline

set mva for neutral hadron detection

Definition at line 297 of file PFCandidate.h.

References mva_nothing_nh_.

297 { mva_nothing_nh_=mva;}

reco::PFCandidate::mva_nothing_nh_

float mva_nothing_nh_

mva for neutral hadron detection

Definition: PFCandidate.h:442

void reco::PFCandidate::set_mva_pi_mu ( float mva )

inline

set mva for pi-muon discrimination

Definition at line 284 of file PFCandidate.h.

References mva_pi_mu_.

284 { mva_pi_mu_=mva;}

reco::PFCandidate::mva_pi_mu_

float mva_pi_mu_

mva for pi-muon discrimination

Definition: PFCandidate.h:436

void PFCandidate::setConversionRef ( const reco::ConversionRef & ref )

set ref to original reco conversion

Definition at line 435 of file PFCandidate.cc.

References edm::hlt::Exception, flag(), gamma, GAMMA_TO_GAMMACONV, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefConversionBit, kRefConversionMask, particleId(), edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

                                                                  {
   if( particleId() != gamma ) {
     string err;
     err += "PFCandidate::setConversionRef: this is not a (converted) photon ! particleId_=";
     char num[4];
     sprintf( num, "%d", particleId());
     err += num;
 
     throw cms::Exception("InconsistentReference",
                          err.c_str() );
   }
   else if(  !flag( GAMMA_TO_GAMMACONV ) ) {
     string err;
     err += "PFCandidate::setConversionRef: particule flag is not GAMMA_TO_GAMMACONV";
 
     throw cms::Exception("InconsistentReference",
                          err.c_str() );
   }
 
   storeRefInfo(kRefConversionMask, kRefConversionBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void reco::PFCandidate::setDeltaP ( double dp )

inline

set uncertainty on momentum

Definition at line 257 of file PFCandidate.h.

References deltaP_.

257 {deltaP_ = dp;}

reco::PFCandidate::deltaP_

float deltaP_

uncertainty on 3-momentum

Definition: PFCandidate.h:425

void PFCandidate::setDisplacedVertexRef	(	const reco::PFDisplacedVertexRef &	ref,
		Flags	flag
	)

set displaced vertex reference

Definition at line 380 of file PFCandidate.cc.

References edm::hlt::Exception, flag(), h, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefDisplacedVertexDauBit, kRefDisplacedVertexDauMask, kRefDisplacedVertexMotBit, kRefDisplacedVertexMotMask, particleId(), edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), storeRefInfo(), T_FROM_DISP, and T_TO_DISP.

                                                                                         {
 
   if( particleId() != h ) {
     string err;
     err += "PFCandidate::setDisplacedVertexRef: this is not a hadron! particleId_=";
     char num[4];
     sprintf( num, "%d", particleId());
     err += num;
 
     throw cms::Exception("InconsistentReference",
                          err.c_str() );
   }
   else if(  !flag( T_FROM_DISP ) && !flag( T_TO_DISP ) ) {
     string err;
     err += "PFCandidate::setDisplacedVertexRef: particule flag is neither T_FROM_DISP nor T_TO_DISP";
 
     throw cms::Exception("InconsistentReference",
                          err.c_str() );
   }
 
 
   if (type == T_TO_DISP && flag( T_TO_DISP )) 
     storeRefInfo(kRefDisplacedVertexDauMask, kRefDisplacedVertexDauBit, 
          iRef.isNonnull(), 
          iRef.refCore(), iRef.key(),iRef.productGetter());
   else if (type == T_FROM_DISP && flag( T_FROM_DISP )) 
     storeRefInfo(kRefDisplacedVertexMotMask, kRefDisplacedVertexMotBit, 
          iRef.isNonnull(), 
          iRef.refCore(), iRef.key(),iRef.productGetter());
   else if ( (type == T_FROM_DISP && !flag( T_FROM_DISP )) 
         || 
         (type == T_TO_DISP && !flag( T_TO_DISP )) ){
     string err;
     err += "PFCandidate::setDisplacedVertexRef: particule flag is not switched on";
 
     throw cms::Exception("InconsistentReference",
                          err.c_str() );
   }
 
 }

void reco::PFCandidate::setEcalEnergy	(	float	eeRaw,
		float	eeCorr
	)

inline

set corrected Ecal energy

Definition at line 185 of file PFCandidate.h.

References abs, ecalERatio_, and rawEcalEnergy_.

Referenced by PFAlgo::processBlock(), PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

185 {

186 rawEcalEnergy_ = eeRaw; ecalERatio_= std::abs(eeRaw)<1.e-6 ? 1.0 : eeCorr/eeRaw;}

abs

#define abs(x)

Definition: mlp_lapack.h:159

reco::PFCandidate::ecalERatio_

float ecalERatio_

corrected ECAL energy ratio (corrected/raw)

Definition: PFCandidate.h:398

reco::PFCandidate::rawEcalEnergy_

float rawEcalEnergy_

raw ECAL energy

Definition: PFCandidate.h:407

void PFCandidate::setFlag	(	Flags	theFlag,
		bool	value
	)

set a given flag

Definition at line 195 of file PFCandidate.cc.

References flags_.

Referenced by PFPhotonAlgo::RunPFPhoton().

                                                    {
   
   if(value)
     flags_ = flags_ | (1<<theFlag);
   else 
     flags_ = flags_ ^ (1<<theFlag);
 }

void reco::PFCandidate::setFlag	(	unsigned	shift,
		unsigned	flag,
		bool	value
	)

private

void PFCandidate::setGsfElectronRef ( const reco::GsfElectronRef & ref )

set GsfElectronRef

Definition at line 474 of file PFCandidate.cc.

References edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefGsfElectronBit, kRefGsfElectronMask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

Referenced by PFLinker::produce().

                                                                    {
   storeRefInfo(kRefGsfElectronMask, kRefGsfElectronBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void PFCandidate::setGsfTrackRef ( const reco::GsfTrackRef & ref )

set gsftrack reference

Definition at line 359 of file PFCandidate.cc.

References edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefGsfTrackBit, kRefGsfTrackMask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

Referenced by PFElectronAlgo::SetCandidates().

                                                              {
 //  Removed by F. Beaudette. Would like to be able to save the GsfTrackRef even for charged pions
 //  if( particleId() != e ) {
 //    string err;
 //    err += "PFCandidate::setGsfTrackRef: this is not an electron ! particleId_=";
 //    char num[4];
 //    sprintf( num, "%d", particleId());
 //    err += num;
 //
 //    throw cms::Exception("InconsistentReference",
 //                         err.c_str() );
 //  }
 
   storeRefInfo(kRefGsfTrackMask, kRefGsfTrackBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void reco::PFCandidate::setHcalEnergy	(	float	ehRaw,
		float	ehCorr
	)

inline

set corrected Hcal energy

Definition at line 195 of file PFCandidate.h.

References abs, hcalERatio_, and rawHcalEnergy_.

Referenced by PFAlgo::processBlock(), PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

195 {

196 rawHcalEnergy_ = ehRaw; hcalERatio_= std::abs(ehRaw)<1.e-6 ? 1.0 : ehCorr/ehRaw;}

reco::PFCandidate::hcalERatio_

float hcalERatio_

corrected HCAL energy ratio (corrected/raw)

Definition: PFCandidate.h:401

reco::PFCandidate::rawHcalEnergy_

float rawHcalEnergy_

raw HCAL energy

Definition: PFCandidate.h:410

abs

#define abs(x)

Definition: mlp_lapack.h:159

void reco::PFCandidate::setHoEnergy	(	float	eoRaw,
		float	eoCorr
	)

inline

set corrected Hcal energy

Definition at line 205 of file PFCandidate.h.

References abs, hoERatio_, and rawHoEnergy_.

Referenced by PFAlgo::processBlock().

205 {

206 rawHoEnergy_ = eoRaw; hoERatio_= std::abs(eoRaw)<1.e-6 ? 1.0 : eoCorr/eoRaw;}

abs

#define abs(x)

Definition: mlp_lapack.h:159

reco::PFCandidate::hoERatio_

float hoERatio_

corrected HO energy ratio (corrected/raw)

Definition: PFCandidate.h:404

reco::PFCandidate::rawHoEnergy_

float rawHoEnergy_

raw HO energy

Definition: PFCandidate.h:413

void PFCandidate::setMuonRef ( const reco::MuonRef & ref )

set muon reference

Definition at line 342 of file PFCandidate.cc.

References edm::hlt::Exception, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefMuonBit, kRefMuonMask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), storeRefInfo(), and trackRef().

Referenced by PFLinker::produce().

                                                      {
   if(  trackRef() != iRef->track() ) {
     string err;
     err += "PFCandidate::setMuonRef: inconsistent track references!";
     
     throw cms::Exception("InconsistentReference",
              err.c_str() );
   }
 
   storeRefInfo(kRefMuonMask, kRefMuonBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void PFCandidate::setParticleType ( ParticleType type )

set Particle Type

Definition at line 166 of file PFCandidate.cc.

References reco::LeafCandidate::setPdgId(), and translateTypeToPdgId().

                                                      {
   setPdgId( translateTypeToPdgId( type ) );
 }

void PFCandidate::setPFElectronExtraRef ( const reco::PFCandidateElectronExtraRef & ref )

set the PF Electron Extra Ref

Definition at line 484 of file PFCandidate.cc.

References edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefPFElectronExtraBit, kRefPFElectronExtraMask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

                                                                                     {
   storeRefInfo(kRefPFElectronExtraMask, kRefPFElectronExtraBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void PFCandidate::setPFPhotonExtraRef ( const reco::PFCandidatePhotonExtraRef & ref )

set the PF Photon Extra Ref

Definition at line 538 of file PFCandidate.cc.

References edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefPFPhotonExtraBit, kRefPFPhotonExtraMask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

                                                                                {
   storeRefInfo(kRefPFPhotonExtraMask, kRefPFPhotonExtraBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void PFCandidate::setPhotonRef ( const reco::PhotonRef & phRef )

set ref to the corresponding reco::Photon if any

Definition at line 506 of file PFCandidate.cc.

References e, edm::hlt::Exception, gamma, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefPhotonBit, kRefPhotonMask, particleId(), edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

Referenced by PFLinker::produce().

                                                         {
   if( particleId() != gamma && particleId() != e) {
     string err;
     err += "PFCandidate::setSuperClusterRef: this is not an electron neither a photon ! particleId_=";
     char num[4];
     sprintf( num, "%d", particleId());
     err += num;
     
     throw cms::Exception("InconsistentReference", err.c_str() );
   }
 
   storeRefInfo(kRefPhotonMask, kRefPhotonBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 
 }

void reco::PFCandidate::setPositionAtECALEntrance ( const math::XYZPointF & pos )

inline

set position at ECAL entrance

Definition at line 310 of file PFCandidate.h.

References pos, and positionAtECALEntrance_.

Referenced by PFElectronAlgo::SetCandidates().

                                                              {
       positionAtECALEntrance_ = pos;
     } 

void reco::PFCandidate::setPs1Energy ( float e1 )

inline

set corrected PS1 energy

Definition at line 236 of file PFCandidate.h.

References ps1Energy_.

Referenced by PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

236 {ps1Energy_ = e1;}

reco::PFCandidate::ps1Energy_

float ps1Energy_

corrected PS1 energy

Definition: PFCandidate.h:416

void reco::PFCandidate::setPs2Energy ( float e2 )

inline

set corrected PS2 energy

Definition at line 242 of file PFCandidate.h.

References ps2Energy_.

Referenced by PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

242 {ps2Energy_ = e2;}

reco::PFCandidate::ps2Energy_

float ps2Energy_

corrected PS2 energy

Definition: PFCandidate.h:419

void reco::PFCandidate::setSourceCandidatePtr ( const PFCandidatePtr & ptr )

inline

Definition at line 111 of file PFCandidate.h.

References sourcePtr_.

Referenced by FFTJetPFPileupCleaner::produce().

111 { sourcePtr_ = ptr; }

reco::PFCandidate::sourcePtr_

PFCandidatePtr sourcePtr_

reference to the source PFCandidate, if any

Definition: PFCandidate.h:394

void PFCandidate::setSuperClusterRef ( const reco::SuperClusterRef & scRef )

Definition at line 522 of file PFCandidate.cc.

References e, edm::hlt::Exception, gamma, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefSuperClusterBit, kRefSuperClusterMask, particleId(), edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

Referenced by PFLinker::produce(), PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

                                                                     {
   if( particleId() != gamma && particleId() != e) {
     string err;
     err += "PFCandidate::setSuperClusterRef: this is not an electron neither a photon ! particleId_=";
     char num[4];
     sprintf( num, "%d", particleId());
     err += num;
     
     throw cms::Exception("InconsistentReference", err.c_str() );
   }
 
   storeRefInfo(kRefSuperClusterMask, kRefSuperClusterBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 
 }

void PFCandidate::setTrackRef ( const reco::TrackRef & ref )

set track reference

Definition at line 322 of file PFCandidate.cc.

References reco::LeafCandidate::charge(), edm::hlt::Exception, edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefTrackBit, kRefTrackMask, particleId(), edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

Referenced by PFCandidateMixer::produce(), and PFElectronAlgo::SetCandidates().

                                                       {
   if(!charge()) {
     string err;
     err += "PFCandidate::setTrackRef: this is a neutral candidate! ";
     err += "particleId_=";
     char num[4];
     sprintf( num, "%d", particleId());
     err += num;
     
     throw cms::Exception("InconsistentReference",
              err.c_str() );
   }
 
   storeRefInfo(kRefTrackMask, kRefTrackBit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

void PFCandidate::setV0Ref ( const reco::VertexCompositeCandidateRef & ref )

set ref to original reco conversion

Definition at line 464 of file PFCandidate.cc.

References edm::Ref< C, T, F >::isNonnull(), edm::Ref< C, T, F >::key(), kRefV0Bit, kRefV0Mask, edm::Ref< C, T, F >::productGetter(), edm::Ref< C, T, F >::refCore(), and storeRefInfo().

                                                                        {
   storeRefInfo(kRefV0Mask, kRefV0Bit, iRef.isNonnull(), 
            iRef.refCore(), iRef.key(),iRef.productGetter());
 }

virtual void reco::PFCandidate::setVertex ( math::XYZPoint p )

inlinevirtual

Definition at line 370 of file PFCandidate.h.

References kCandVertex, reco::LeafCandidate::p(), reco::LeafCandidate::vertex_, and vertexType_.

Referenced by PFConcretePFCandidateProducer::produce(), and PFPhotonAlgo::RunPFPhoton().

                                             {
       vertex_=p; vertexType_ = kCandVertex;
     }

void reco::PFCandidate::setVertexSource ( PFVertexType vt )

inline

Definition at line 368 of file PFCandidate.h.

References kCandVertex, reco::LeafCandidate::vertex_, and vertexType_.

Referenced by PFElectronAlgo::SetCandidates().

368 { vertexType_=vt; if (vertexType_!=kCandVertex) vertex_=Point(0.,0.,0.);}

reco::LeafCandidate::vertex_

Point vertex_

vertex position

Definition: LeafCandidate.h:314

reco::PFCandidate::kCandVertex

Definition: PFCandidate.h:71

reco::PFCandidate::vertexType_

PFVertexType vertexType_

Definition: PFCandidate.h:427

reco::LeafCandidate::Point

math::XYZPoint Point

point in the space

Definition: LeafCandidate.h:29

CandidatePtr reco::PFCandidate::sourceCandidatePtr ( size_type i ) const

inlinevirtual

return a Ptr to one of the source Candidates ( the candidates used to construct this Candidate)

Reimplemented from reco::LeafCandidate.

Definition at line 117 of file PFCandidate.h.

References sourcePtr_.

Referenced by overlap().

                                                          {
       return sourcePtr_;
     }

void PFCandidate::storeRefInfo	(	unsigned int	iMask,
		unsigned int	iBit,
		bool	iIsValid,
		const edm::RefCore &	iCore,
		size_t	iKey,
		const edm::EDProductGetter *	iGetter
	)

private

Definition at line 271 of file PFCandidate.cc.

References bitPackRefInfo(), getter_, edm::RefCore::productPtr(), refsCollectionCache_, refsInfo_, s_refsBefore, and storedRefsBitPattern_.

Referenced by setConversionRef(), setDisplacedVertexRef(), setGsfElectronRef(), setGsfTrackRef(), setMuonRef(), setPFElectronExtraRef(), setPFPhotonExtraRef(), setPhotonRef(), setSuperClusterRef(), setTrackRef(), and setV0Ref().

                                                   {
 
   size_t index = s_refsBefore[storedRefsBitPattern_ & iMask];
   if ( 0 == getter_) {
     getter_ = iGetter;
   }
 
   if(iIsValid) {
     if(0 == (storedRefsBitPattern_ & iBit) ) {
       refsInfo_.insert(refsInfo_.begin()+index, bitPackRefInfo(iCore,iKey));
       if (iGetter==0)
     refsCollectionCache_.insert(refsCollectionCache_.begin()+index,(void*)iCore.productPtr());
       else
     refsCollectionCache_.insert(refsCollectionCache_.begin()+index,0);
     } else {
       assert(refsInfo_.size()>index);
       *(refsInfo_.begin()+index)=bitPackRefInfo(iCore,iKey);
       if (iGetter==0)
     *(refsCollectionCache_.begin()+index)=(void*)iCore.productPtr();
       else
     *(refsCollectionCache_.begin()+index)=0;
 
     }
     storedRefsBitPattern_ |= iBit;
   } else{
     if( storedRefsBitPattern_ & iBit) {
       refsInfo_.erase(refsInfo_.begin()+index);
       refsCollectionCache_.erase(refsCollectionCache_.begin()+index);
       storedRefsBitPattern_ ^= iBit;
     }
   }
 
 }

reco::SuperClusterRef PFCandidate::superClusterRef ( ) const

return a reference to the corresponding SuperCluster if any

Definition at line 502 of file PFCandidate.cc.

References GETREF, kRefSuperClusterBit, and kRefSuperClusterMask.

Referenced by PFCandWithSuperClusterExtractor::depositFromObject(), PFPhotonAlgo::EvaluateGCorrMVA(), PFPhotonAlgo::EvaluateResMVA(), PFIsolationEstimator::fGetIsolationInRings(), PFIsolationEstimator::isPhotonParticleVetoed(), PFIsolationEstimator::matchPFObject(), PFLinker::produce(), and PFPhotonTranslator::produce().

                                                        {
   GETREF(reco::SuperCluster, kRefSuperClusterMask, kRefSuperClusterBit); 
 }

reco::TrackRef PFCandidate::trackRef ( ) const

return a reference to the corresponding track, if charged. otherwise, return a null reference

Definition at line 339 of file PFCandidate.cc.

References GETREF, kRefTrackBit, and kRefTrackMask.

Referenced by PFPileUpAlgo::chargedHadronVertex(), PFIsolationEstimator::chargedHadronVertex(), metsig::SignAlgoResolutions::evalPF(), PFCandCommonVertexFitterBase::fill(), SoftPFMuonTagInfoProducer::fillMuonProperties(), FFTJetPFPileupCleaner::findSomeVertex(), reco::tau::getTrack(), pat::helper::VertexingHelper::getTrack_(), PFIsolationEstimator::isChargedParticleVetoed(), reco::modules::HICaloCompatibleTrackSelector::matchPFCandToTrack(), PFAlgo::postMuonCleaning(), MuonWithPFIsoProducer::produce(), PFElectronTranslator::produce(), setMuonRef(), PFRecoTauDiscriminationByFlightPathSignificance::threeProngFlightPathSig(), and vertex().

339 { GETREF(reco::Track, kRefTrackMask, kRefTrackBit); }

kRefTrackMask

Definition: CountBits.h:4130

reco::Track

Definition: Track.h:27

kRefTrackBit

Definition: CountBits.h:4116

GETREF

#define GETREF(_class_, _mask_, _bit_)

Definition: CountBits.h:4145

PFCandidate::ParticleType PFCandidate::translatePdgIdToType ( int pdgid ) const

Definition at line 134 of file PFCandidate.cc.

References abs, e, egamma_HF, gamma, h, h0, h_HF, mu, and X.

Referenced by particleId().

                                                                          {
   switch (std::abs(pdgid)) {
   case 211: return h;
   case 11: return e;
   case 13: return mu;
   case 22: return gamma;
   case 130: return h0;
   case 1: return h_HF;
   case 2: return egamma_HF;
   case 0: return X;  
   default: return X;
   }
 }

int PFCandidate::translateTypeToPdgId ( ParticleType type ) const

returns the pdg id corresponding to the particle type. the particle type could be removed at some point to gain some space. low priority

Definition at line 148 of file PFCandidate.cc.

References reco::LeafCandidate::charge(), e, egamma_HF, gamma, h, h0, h_HF, mu, and X.

Referenced by PFCandidate(), and setParticleType().

                                                                {
   
   int thecharge = charge();
 
   switch( type ) {
   case h:     return thecharge*211; // pi+
   case e:     return thecharge*(-11);
   case mu:    return thecharge*(-13);
   case gamma: return 22;
   case h0:    return 130; // K_L0
   case h_HF:         return 1; // dummy pdg code 
   case egamma_HF:    return 2;  // dummy pdg code
   case X: 
   default:    return 0;  
   }
 }

reco::VertexCompositeCandidateRef PFCandidate::v0Ref ( ) const

return a reference to the original conversion

Definition at line 469 of file PFCandidate.cc.

References GETREF, kRefV0Bit, and kRefV0Mask.

                                                          {
   GETREF(reco::VertexCompositeCandidate, kRefV0Mask, kRefV0Bit); 
 }

const math::XYZPoint & PFCandidate::vertex ( ) const

virtual

vertex position

Reimplemented from reco::LeafCandidate.

Definition at line 546 of file PFCandidate.cc.

References gsfTrackRef(), kCandVertex, kComMuonVertex, kGSFVertex, kSAMuonVertex, kTrkMuonVertex, kTrkVertex, muonRef(), trackRef(), reco::LeafCandidate::vertex_, and vertexType_.

Referenced by FWPFCandidateWithHitsProxyBuilder::build(), FWPFCandidate3DProxyBuilder::build(), PFPileUpAlgo::chargedHadronVertex(), PFIsolationEstimator::chargedHadronVertex(), PFCandWithSuperClusterExtractor::depositFromObject(), FFTJetPFPileupCleaner::findSomeVertex(), PFConcretePFCandidateProducer::produce(), vx(), vy(), and vz().

                                                {
   switch (vertexType_) {
   case kCandVertex:
     return vertex_;
     break;
   case kTrkVertex:
     return trackRef()->vertex();
     break;
   case kComMuonVertex:
     return muonRef()->combinedMuon()->vertex();
     break;
   case kSAMuonVertex:
     return muonRef()->standAloneMuon()->vertex();
     break;
   case kTrkMuonVertex:
     return muonRef()->track()->vertex();
     break;
   case kGSFVertex:
     return gsfTrackRef()->vertex();
     break;
   }
   return vertex_;
 }