reco::PFCandidate Class Reference

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, kTPFMSMuonVertex =6, kPickyMuonVertex =7,   kDYTMuonVertex =8 }
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...
const reco::Muon::MuonTrackType	bestMuonTrackType () const
	get the Best Muon Track Ref More...
const reco::Track *	bestTrack () const override
PFCandidate *	clone () const override
	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
float	dxyError () const override
	uncertainty on dxy More...
float	dzError () const override
	uncertainty on dz More...
double	ecalEnergy () const
	return corrected Ecal energy More...
reco::PFCandidateEGammaExtraRef	egammaExtraRef () const
	return a reference to the EGamma extra 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
float	hcalDepthEnergyFraction (unsigned int depth) const
	fraction of hcal energy at a given depth (depth = 1 .. 7) More...
const std::array< float, 7 > &	hcalDepthEnergyFractions () const
	fraction of hcal energy at a given depth (index 0..6 for depth 1..7) More...
double	hcalEnergy () const
	return corrected Hcal energy More...
double	hoEnergy () const
	return corrected Hcal energy More...
bool	isTimeValid () const
	do we have a valid time information 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_Isolated () const
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 override
PFCandidate &	operator= (PFCandidate 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)
	PFCandidate (const PFCandidate &)
	copy constructor More...
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 mvaNI)
void	set_mva_gamma_nh (float mva)
	set mva for neutral hadron - gamma discrimination More...
void	set_mva_Isolated (float mvaI)
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	setHcalDepthEnergyFractions (const std::array< float, 7 > &fracs)
	set the fraction of hcal energy as function of depth (index 0..6 for depth 1..7) 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	setMuonTrackType (const reco::Muon::MuonTrackType &type)
	set the Best Muon Track Ref More...
void	setParticleType (ParticleType type)
	set Particle Type More...
void	setPFEGammaExtraRef (const reco::PFCandidateEGammaExtraRef &ref)
	set the PF EGamma Extra Ref 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	setTime (float time, float timeError=0.f)
	the timing information More...
void	setTrackRef (const reco::TrackRef &ref)
	set track reference More...
void	setV0Ref (const reco::VertexCompositeCandidateRef &ref)
	set ref to original reco conversion More...
void	setVertex (const math::XYZPoint &p) override
	set vertex More...
void	setVertexSource (PFVertexType vt)
CandidatePtr	sourceCandidatePtr (size_type i) const override
reco::SuperClusterRef	superClusterRef () const
	return a reference to the corresponding SuperCluster if any More...
float	time () const
float	timeError () const
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...
const Point &	vertex () const override
	vertex position (overwritten by PF...) 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...
	~PFCandidate () 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 *	daughter (size_type) const override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 (read only mode) More...
Candidate *	daughter (size_type) override
	return daughter at a given position, i = 0, ... numberOfDaughters() - 1 More...
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...
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)
const Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...
double	energy () const final
	energy More...
double	et () const final
	transverse energy More...
double	et2 () const final
	transverse energy squared (use this for cut!) More...
double	eta () const final
	momentum pseudorapidity More...
void	fillVertexCovariance (CovarianceMatrix &v) const override
	fill SMatrix More...
template<typename T >
T	get () const
	get a component More...
template<typename T , typename Tag >
T	get () const
	get a component More...
template<typename T >
T	get (size_type i) const
	get a component More...
template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...
bool	hasMasterClone () const override
bool	hasMasterClonePtr () const override
bool	isCaloMuon () const override
bool	isConvertedPhoton () const override
bool	isElectron () const override
bool	isGlobalMuon () const override
bool	isJet () const override
bool	isMuon () const override
bool	isPhoton () const override
bool	isStandAloneMuon () const override
bool	isTrackerMuon () const override
	LeafCandidate ()
	LeafCandidate (const Candidate &c)
template<typename... Args>
	LeafCandidate (Args &&...args)
	LeafCandidate (LeafCandidate &rh)
	LeafCandidate (LeafCandidate &&)=default
	LeafCandidate (LeafCandidate const &)=default
bool	longLived () const final
	is long lived? More...
double	mass () const final
	mass More...
bool	massConstraint () const final
	do mass constraint? More...
double	massSqr () const final
	mass squared More...
const CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () const override
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
Vector	momentum () const final
	spatial momentum vector More...
const Candidate *	mother (size_type) const override
	return mother at a given position (throws an exception) More...
double	mt () const final
	transverse mass More...
double	mtSqr () const final
	transverse mass squared More...
template<typename T >
size_type	numberOf () const
	number of components More...
template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...
size_t	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers More...
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...
int	status () const final
	status word More...
double	theta () const final
	momentum polar angle More...
int	threeCharge () const final
	electric charge 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	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...
	Candidate ()
	default constructor 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...

Static Public Attributes
static const float	bigMva_ = -999.

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
bool	overlap (const Candidate &) const override
	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...
std::atomic< ElementsInBlocks * >	elementsInBlocks_
Elements	elementsStorage_
unsigned	flags_
	all flags, packed (ecal regional, hcal regional, tracking) More...
const edm::EDProductGetter *	getter_
std::array< float, 7 >	hcalDepthEnergyFractions_
float	hcalERatio_
	corrected HCAL energy ratio (corrected/raw) More...
float	hoERatio_
	corrected HO energy ratio (corrected/raw) More...
reco::Muon::MuonTrackType	muonTrackType_
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_Isolated_
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_
float	time_
	timing information (valid if timeError_ >= 0) More...
float	timeError_
	timing information uncertainty (<0 if timing not available) More...
PFVertexType	vertexType_

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

Additional Inherited Members

Detailed Description

Particle reconstructed by the particle flow algorithm.

particle candidate from particle flow

Author

Colin Bernet

Date

February 2007

Definition at line 40 of file PFCandidate.h.

Member Typedef Documentation

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

Definition at line 389 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 386 of file PFCandidate.h.

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

Definition at line 390 of file PFCandidate.h.

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

Definition at line 387 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 56 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 45 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
kTPFMSMuonVertex
kPickyMuonVertex
kDYTMuonVertex

Definition at line 77 of file PFCandidate.h.

                      {
      kCandVertex=0, 
      kTrkVertex=1,
      kComMuonVertex=2,
      kSAMuonVertex=3,
      kTrkMuonVertex=4,
      kGSFVertex=5,
      kTPFMSMuonVertex=6,
      kPickyMuonVertex=7,
      kDYTMuonVertex=8
    };

Constructor & Destructor Documentation

PFCandidate::PFCandidate

(

)

default constructor

Definition at line 31 of file PFCandidate.cc.

References lumiContext::fill, hcalDepthEnergyFractions_, muonTrackType_, reco::Muon::None, refsInfo_, reco::LeafCandidate::setPdgId(), translateTypeToPdgId(), and X.

Referenced by clone(), and PFCandidate().

                         : 
  elementsInBlocks_(nullptr),
  ecalERatio_(1.),
  hcalERatio_(1.),
  hoERatio_(1.),
  rawEcalEnergy_(0.),
  rawHcalEnergy_(0.),
  rawHoEnergy_(0.),
  ps1Energy_(0.),
  ps2Energy_(0.),
  flags_(0), 
  deltaP_(0.), 
  vertexType_(kCandVertex),
  mva_Isolated_(bigMva_),
  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_(nullptr),storedRefsBitPattern_(0),
  time_(0.f),timeError_(-1.f)
{

  muonTrackType_ = reco::Muon::None;
  
  setPdgId( translateTypeToPdgId( X ) );
  refsInfo_.reserve(3);
  std::fill(hcalDepthEnergyFractions_.begin(), hcalDepthEnergyFractions_.end(), 0.f);
}

PFCandidate::PFCandidate

(

const PFCandidatePtr &

sourcePtr

)

constructor from a reference (keeps track of source relationship)

Definition at line 63 of file PFCandidate.cc.

References hcalDepthEnergyFractions_, and sourcePtr_.

                                                         :
  PFCandidate(*sourcePtr)
{
  sourcePtr_ = sourcePtr;
  hcalDepthEnergyFractions_ = sourcePtr->hcalDepthEnergyFractions_; // GP not sure it's needed
}

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

Definition at line 71 of file PFCandidate.cc.

References blocksStorage_, reco::CompositeCandidate::CompositeCandidate(), deltaP_, e, ecalERatio_, elementsInBlocks_, elementsStorage_, Exception, lumiContext::fill, flags_, getter_, hcalDepthEnergyFractions_, hcalERatio_, hoERatio_, mu, muonTrackType_, mva_e_mu_, mva_e_pi_, mva_gamma_nh_, mva_Isolated_, mva_nothing_gamma_, mva_nothing_nh_, mva_pi_mu_, reco::Muon::None, PFCandidate(), positionAtECALEntrance_, ps1Energy_, ps2Energy_, rawEcalEnergy_, rawHcalEnergy_, rawHoEnergy_, refsCollectionCache_, refsInfo_, edm::RefVector< C, T, F >::reserve(), reco::LeafCandidate::setPdgId(), sourcePtr_, storedRefsBitPattern_, time_, timeError_, tmp, translateTypeToPdgId(), and vertexType_.

                                    : 
  
  CompositeCandidate(charge, p4),
  elementsInBlocks_(nullptr),
  ecalERatio_(1.),
  hcalERatio_(1.),
  hoERatio_(1.),
  rawEcalEnergy_(0.),
  rawHcalEnergy_(0.),
  rawHoEnergy_(0.),
  ps1Energy_(0.),
  ps2Energy_(0.),
  flags_(0),
  deltaP_(0.),
  vertexType_(kCandVertex),
  mva_Isolated_(bigMva_),
  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_(nullptr),storedRefsBitPattern_(0),
  time_(0.f),timeError_(-1.f)
{
  refsInfo_.reserve(3);
  blocksStorage_.reserve(10);
  elementsStorage_.reserve(10);
  std::fill(hcalDepthEnergyFractions_.begin(), hcalDepthEnergyFractions_.end(), 0.f);

  muonTrackType_ = reco::Muon::None;

  // 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 ) );
}

reco::PFCandidate::PFCandidate

(

const PFCandidate &

)

copy constructor

PFCandidate::~PFCandidate ( )

override

destructor

Definition at line 211 of file PFCandidate.cc.

References elementsInBlocks_.

                          {
  delete elementsInBlocks_.load(std::memory_order_acquire);
}

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 220 of file PFCandidate.cc.

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

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

                                                             {
  //elementsInBlocks_.push_back( make_pair(blockref.key(), elementIndex) );
  if (blocksStorage_.empty())
    blocksStorage_ =Blocks(blockref.id());
  blocksStorage_.push_back(blockref);
  elementsStorage_.push_back(elementIndex);
  auto ptr = elementsInBlocks_.exchange(nullptr);
  delete ptr;
}

const reco::Muon::MuonTrackType reco::PFCandidate::bestMuonTrackType ( ) const

inline

get the Best Muon Track Ref

Definition at line 363 of file PFCandidate.h.

References muonTrackType_.

                                                            {
      return muonTrackType_;
    }

const reco::Track* reco::PFCandidate::bestTrack ( ) const

inlineoverridevirtual

return a pointer to the best track, if available. otherwise, return a null pointer

Reimplemented from reco::Candidate.

Definition at line 162 of file PFCandidate.h.

References funct::abs(), gsfTrackRef(), edm::Ref< C, T, F >::isAvailable(), edm::Ref< C, T, F >::isNonnull(), reco::LeafCandidate::pdgId(), and trackRef().

Referenced by pat::MuonMvaEstimator::computeMva(), dxyError(), dzError(), and Muon.Muon::ptErr().

                                                 {
      if ( (abs(pdgId()) == 11 || pdgId() == 22) && gsfTrackRef().isNonnull() && gsfTrackRef().isAvailable() )
        return &(*gsfTrackRef());
      else if ( trackRef().isNonnull() && trackRef().isAvailable() )
        return &(*trackRef());
      else
        return nullptr;
    }

PFCandidate * PFCandidate::clone ( void  ) const

overridevirtual

return a clone

Reimplemented from reco::CompositeCandidate.

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

Definition at line 215 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 563 of file PFCandidate.cc.

References GETREF, kRefConversionBit, and kRefConversionMask.

Referenced by dxyError().

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

double reco::PFCandidate::deltaP ( ) const

inline

uncertainty on 3-momentum

Definition at line 298 of file PFCandidate.h.

References deltaP_.

Referenced by PFElectronTranslator::createGsfElectrons().

{ return deltaP_;}

reco::PFDisplacedVertexRef PFCandidate::displacedVertexRef

(

Flags

type

)

const

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

Definition at line 528 of file PFCandidate.cc.

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

Referenced by PFCandConnector::analyseNuclearWPrim(), dxyError(), 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();
}

float reco::PFCandidate::dxyError ( ) const

inlineoverridevirtual

uncertainty on dxy

Reimplemented from reco::Candidate.

Definition at line 173 of file PFCandidate.h.

References bestTrack(), conversionRef(), displacedVertexRef(), reco::TrackBase::dxyError(), electronExtraRef(), flag(), gsfElectronRef(), gsfTrackRef(), muonRef(), setConversionRef(), setDisplacedVertexRef(), setGsfTrackRef(), setMuonRef(), setV0Ref(), and v0Ref().

{ const Track * tr=bestTrack(); if(tr!=nullptr) return tr->dxyError(); else return 0; }

float reco::PFCandidate::dzError ( ) const

inlineoverridevirtual

uncertainty on dz

Reimplemented from reco::Candidate.

Definition at line 171 of file PFCandidate.h.

References bestTrack(), and reco::TrackBase::dzError().

{ const Track * tr=bestTrack(); if(tr!=nullptr) return tr->dzError(); else return 0; }

double reco::PFCandidate::ecalEnergy ( ) const

inline

return corrected Ecal energy

Definition at line 222 of file PFCandidate.h.

References ecalERatio_, and rawEcalEnergy_.

Referenced by PFCandConnector::analyseNuclearWPrim(), HPSPFRecoTauAlgorithm::applyElectronRejection(), PFCandidateBenchmark::fillOne(), FWECalPFCandidateProxyBuilder::getEt(), pat::PATPackedCandidateProducer::produce(), and pat::PATMuonProducer::produce().

{ return ecalERatio_*rawEcalEnergy_;}

reco::PFCandidateEGammaExtraRef PFCandidate::egammaExtraRef

(

)

const

return a reference to the EGamma extra

Definition at line 605 of file PFCandidate.cc.

References GETREF, kRefPFEGammaExtraBit, and kRefPFEGammaExtraMask.

Referenced by PFEGammaFilters::isElectronSafeForJetMET(), PFEGammaFilters::isPhotonSafeForJetMET(), PFAlgo::processBlock(), GEDGsfElectronCoreProducer::produceElectronCore(), and rawHoEnergy().

                                                                {
 GETREF(reco::PFCandidateEGammaExtra, kRefPFEGammaExtraMask, kRefPFEGammaExtraBit); 
}

reco::PFCandidateElectronExtraRef PFCandidate::electronExtraRef

(

)

const

return a reference to the electron extra

Definition at line 593 of file PFCandidate.cc.

References GETREF, kRefPFElectronExtraBit, and kRefPFElectronExtraMask.

Referenced by PFElectronTranslator::createGsfElectrons(), dxyError(), flag(), and PFElectronTranslator::produce().

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

const PFCandidate::ElementsInBlocks & PFCandidate::elementsInBlocks

(

)

const

Definition at line 691 of file PFCandidate.cc.

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

Referenced by FWPFCandidateWithHitsProxyBuilder::addHitsForCandidate(), DQMPFCandidateAnalyzer::analyze(), reco::tau::PFRecoTauChargedHadronFromPFCandidatePlugin::beginEvent(), PFMuonAlgo::cleanPunchThroughAndFakes(), PFElectronTranslator::correspondingDaughterCandidate(), PFPhotonTranslator::correspondingDaughterCandidate(), PFPhotonAlgo::EvaluateGCorrMVA(), PFPhotonAlgo::EvaluateResMVA(), PFCandidateBenchmark::fillOne(), flag(), PFBlockBasedIsolation::getHighestEtECALCluster(), reco::modules::HICaloCompatibleTrackSelector::matchPFCandToTrack(), PFCandidateChecker::printElementsInBlocks(), PFAlgo::processBlock(), PFElectronTranslator::produce(), and PFPhotonTranslator::produce().

                                    { 
      
  if (nullptr == elementsInBlocks_.load(std::memory_order_acquire))
    {
      std::unique_ptr<ElementsInBlocks> temp( new ElementsInBlocks(blocksStorage_.size()));
      for(unsigned int icopy=0;icopy!=blocksStorage_.size();++icopy)
    (*temp)[icopy]=std::make_pair(blocksStorage_[icopy],elementsStorage_[icopy]);
      ElementsInBlocks* expected=nullptr;
      if(elementsInBlocks_.compare_exchange_strong(expected,temp.get(),std::memory_order_acq_rel)) {
    temp.release();
      }
    }
  return *(elementsInBlocks_.load(std::memory_order_acquire));
}

bool PFCandidate::flag

(

Flags

theFlag

)

const

return a given flag

Definition at line 304 of file PFCandidate.cc.

References EnergyCorrector::c, e, electronExtraRef(), elementsInBlocks(), reco::LeafCandidate::energy(), reco::LeafCandidate::eta(), alignBH_cfg::fixed, flag(), flags_, GAMMA_TO_GAMMACONV, mps_fire::i, edm::Ptr< T >::id(), edm::Ref< C, T, F >::isAvailable(), edm::Ref< C, T, F >::isNonnull(), edm::Ptr< T >::key(), edm::Ref< C, T, F >::key(), reco::operator<<(), MillePedeFileConverter_cfg::out, particleId(), reco::LeafCandidate::phi(), reco::LeafCandidate::pt(), sourcePtr_, T_FROM_DISP, T_FROM_GAMMACONV, and T_TO_DISP.

Referenced by dxyError(), flag(), PFCandConnector::isPrimaryNucl(), PFCandConnector::isSecondaryNucl(), pS2Energy(), setConversionRef(), setDisplacedVertexRef(), and setHcalDepthEnergyFractions().

                                          {

  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 410 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 583 of file PFCandidate.cc.

References GETREF, kRefGsfElectronBit, and kRefGsfElectronMask.

Referenced by dxyError(), and SelectionStep< Object >::select().

                                                     {
  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 480 of file PFCandidate.cc.

References GETREF, kRefGsfTrackBit, and kRefGsfTrackMask.

Referenced by reco::tau::RecoTauPiZeroStripPlugin2::addCandsToStrip(), reco::tau::RecoTauPiZeroStripPlugin3::addCandsToStrip(), bestTrack(), reco::PFMETProducerMVA::chargedFracInCone(), PrimaryVertexAssignment::chargedHadronVertex(), PileupJetIdAlgo::computeIdVariables(), reco::PFMETProducerMVA::computePFCandidateInfo(), dxyError(), PFElectronTranslator::fillMVAValueMap(), LeptonRecoSkim::filter(), reco::tau::RecoTauQualityCuts::filterCand(), PFElectronTranslator::produce(), PuppiProducer::produce(), PFLinker::produce(), pat::PATPackedCandidateProducer::produce(), GEDGsfElectronCoreProducer::produceElectronCore(), PFRecoTauDiscriminationByFlightPathSignificance::threeProngFlightPathSig(), toTrackRef(), and vertex().

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

float reco::PFCandidate::hcalDepthEnergyFraction ( unsigned int  depth ) const

inline

fraction of hcal energy at a given depth (depth = 1 .. 7)

Definition at line 428 of file PFCandidate.h.

References hcalDepthEnergyFractions_.

{ return hcalDepthEnergyFractions_[depth-1]; }

const std::array<float,7>& reco::PFCandidate::hcalDepthEnergyFractions ( ) const

inline

fraction of hcal energy at a given depth (index 0..6 for depth 1..7)

Definition at line 430 of file PFCandidate.h.

References hcalDepthEnergyFractions_.

{ return hcalDepthEnergyFractions_; }

double reco::PFCandidate::hcalEnergy ( ) const

inline

return corrected Hcal energy

Definition at line 232 of file PFCandidate.h.

References hcalERatio_, and rawHcalEnergy_.

Referenced by PFCandConnector::analyseNuclearWPrim(), DQMPFCandidateAnalyzer::analyze(), HPSPFRecoTauAlgorithm::applyElectronRejection(), PFCandidateBenchmark::fillOne(), FWHCalPFCandidateProxyBuilder::getEt(), and pat::PATPackedCandidateProducer::produce().

{ return hcalERatio_*rawHcalEnergy_;}

double reco::PFCandidate::hoEnergy ( ) const

inline

return corrected Hcal energy

Definition at line 242 of file PFCandidate.h.

References hoERatio_, and rawHoEnergy_.

Referenced by Jet.Jet::hoEnergyFraction(), and reco::makeSpecific().

{ return hoERatio_*rawHoEnergy_;}

bool reco::PFCandidate::isTimeValid ( ) const

inline

do we have a valid time information

Definition at line 419 of file PFCandidate.h.

References timeError_.

Referenced by TransientTrackBuilder::build(), PrimaryVertexAssignment::chargedHadronVertex(), and pat::PATPackedCandidateProducer::produce().

{ return timeError_ >= 0.f; }

reco::MuonRef PFCandidate::muonRef

(

)

const

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

Definition at line 459 of file PFCandidate.cc.

References GETREF, kRefMuonBit, and kRefMuonMask.

Referenced by PFMuonAlgo::addMissingMuons(), HPSPFRecoTauAlgorithm::applyMuonRejection(), PFMuonAlgo::cleanMismeasured(), PFMuonAlgo::cleanPunchThroughAndFakes(), PileupJetIdAlgo::computeIdVariables(), dxyError(), GreedyMuonPFCandidateFilter::filter(), InconsistentMuonPFCandidateFilter::filter(), MuonBadTrackFilter::filter(), PFMuonAlgo::getMinMaxMET2(), PFMuonAlgo::postClean(), DistortedPFCandProducer::produce(), pat::PATMuonSlimmer::produce(), SoftPFMuonTagInfoProducer::produce(), pat::PATPackedCandidateProducer::produce(), PFLinker::produce(), pat::PATMuonProducer::produce(), JetCleanerForType1METT< T, Textractor >::produce(), PFJetMETcorrInputProducerT< T, Textractor >::produce(), SelectionStep< Object >::select(), and vertex().

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

float reco::PFCandidate::mva_e_mu ( ) const

inline

mva for electron-muon discrimination

Definition at line 320 of file PFCandidate.h.

References mva_e_mu_.

{ return mva_e_mu_;}

float reco::PFCandidate::mva_e_pi ( ) const

inline

mva for electron-pion discrimination

Definition at line 314 of file PFCandidate.h.

References mva_e_pi_.

Referenced by HPSPFRecoTauAlgorithm::applyElectronRejection(), PFRecoTauAlgorithm::buildPFTau(), PFElectronTranslator::createGsfElectrons(), PFElectronTranslator::fillMVAValueMap(), PFCandidateBenchmark::fillOne(), PFAlgo::processBlock(), and PFElectronTranslator::produce().

{ return mva_e_pi_;}

float reco::PFCandidate::mva_gamma_nh ( ) const

inline

mva for neutral hadron - gamma discrimination

Definition at line 346 of file PFCandidate.h.

References mva_gamma_nh_.

{ return mva_gamma_nh_;}

float reco::PFCandidate::mva_Isolated ( ) const

inline

Definition at line 310 of file PFCandidate.h.

References mva_Isolated_.

{ return mva_Isolated_;}

float reco::PFCandidate::mva_nothing_gamma ( ) const

inline

mva for gamma detection

Definition at line 333 of file PFCandidate.h.

References mva_nothing_gamma_.

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

{ return mva_nothing_gamma_;}

float reco::PFCandidate::mva_nothing_nh ( ) const

inline

mva for neutral hadron detection

Definition at line 339 of file PFCandidate.h.

References mva_nothing_nh_.

{ return mva_nothing_nh_;}

float reco::PFCandidate::mva_pi_mu ( ) const

inline

mva for pi-muon discrimination

Definition at line 326 of file PFCandidate.h.

References mva_pi_mu_.

{ return mva_pi_mu_;}

size_t reco::PFCandidate::numberOfSourceCandidatePtrs ( ) const

inlineoverridevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 128 of file PFCandidate.h.

Referenced by reco::PFCandidateFwdPtrFactory::operator()().

                                                        { 
      return 1;
    }

PFCandidate & PFCandidate::operator=

(

PFCandidate const &

iOther

)

Definition at line 170 of file PFCandidate.cc.

References blocksStorage_, deltaP_, ecalERatio_, elementsInBlocks_, elementsStorage_, flags_, getter_, hcalDepthEnergyFractions_, hcalERatio_, hoERatio_, muonTrackType_, mva_e_mu_, mva_e_pi_, mva_gamma_nh_, mva_Isolated_, mva_nothing_gamma_, mva_nothing_nh_, mva_pi_mu_, reco::LeafCandidate::operator=(), positionAtECALEntrance_, ps1Energy_, ps2Energy_, rawEcalEnergy_, rawHcalEnergy_, rawHoEnergy_, refsCollectionCache_, refsInfo_, sourcePtr_, storedRefsBitPattern_, time_, timeError_, tmp, and vertexType_.

                                                             {
  CompositeCandidate::operator=(iOther);
  auto tmp = iOther.elementsInBlocks_.load(std::memory_order_acquire);
  if(nullptr != tmp) {
    delete elementsInBlocks_.exchange( new ElementsInBlocks{*tmp}, std::memory_order_acq_rel);
  } else {
    delete elementsInBlocks_.exchange(nullptr, std::memory_order_acq_rel);
  }
  blocksStorage_=iOther.blocksStorage_;
  elementsStorage_=iOther.elementsStorage_;
  sourcePtr_=iOther.sourcePtr_;
  muonTrackType_=iOther.muonTrackType_;
  ecalERatio_=iOther.ecalERatio_;
  hcalERatio_=iOther.hcalERatio_;
  hoERatio_=iOther.hoERatio_;
  rawEcalEnergy_=iOther.rawEcalEnergy_;
  rawHcalEnergy_=iOther.rawHcalEnergy_;
  rawHoEnergy_=iOther.rawHoEnergy_;
  ps1Energy_=iOther.ps1Energy_;
  ps2Energy_=iOther.ps2Energy_;
  flags_=iOther.flags_; 
  deltaP_=iOther.deltaP_; 
  vertexType_=iOther.vertexType_;
  mva_Isolated_=iOther.mva_Isolated_;
  mva_e_pi_=iOther.mva_e_pi_;
  mva_e_mu_=iOther.mva_e_mu_;
  mva_pi_mu_=iOther.mva_pi_mu_;
  mva_nothing_gamma_=iOther.mva_nothing_gamma_;
  mva_nothing_nh_=iOther.mva_nothing_nh_;
  mva_gamma_nh_=iOther.mva_gamma_nh_;
  positionAtECALEntrance_=iOther.positionAtECALEntrance_;
  getter_=iOther.getter_;
  storedRefsBitPattern_=iOther.storedRefsBitPattern_;
  refsInfo_=iOther.refsInfo_;
  refsCollectionCache_=iOther.refsCollectionCache_;
  time_=iOther.time_;
  timeError_=iOther.timeError_;
  hcalDepthEnergyFractions_=iOther.hcalDepthEnergyFractions_;
  return *this;
}

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

overrideprivatevirtual

Polymorphic overlap.

Reimplemented from reco::CompositeCandidate.

Definition at line 270 of file PFCandidate.cc.

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

Referenced by overlap(), and setHcalDepthEnergyFractions().

                                                           {
    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 374 of file PFCandidate.h.

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

Referenced by PFTester::analyze(), JetTester_HeavyIons::analyze(), DQMPFCandidateAnalyzer::analyze(), JetAnalyzer_HeavyIons::analyze(), BoostedTauSeedsProducer::BoostedTauSeedsProducer(), PFMuonAlgo::cleanPunchThroughAndFakes(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::color(), metsig::SignAlgoResolutions::evalPF(), METAnalyzer::fillMonitorElement(), PFElectronTranslator::fillMVAValueMap(), PFCandidateBenchmark::fillOne(), GreedyMuonPFCandidateFilter::filter(), InconsistentMuonPFCandidateFilter::filter(), LeptonRecoSkim::filter(), reco::tau::RecoTauQualityCuts::filterCandByType(), flag(), reco::tau::RecoTauIsolationMasking::inCone(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isBoson(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isGluon(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isHiggs(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isLepton(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isPhoton(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::isQuark(), Vispa.Plugins.EdmBrowser.EdmDataAccessor.EdmDataAccessor::lineStyle(), reco::tau::qcuts::mapAndCutByType(), reco::modules::HICaloCompatibleTrackSelector::matchPFCandToTrack(), PFMuonAlgo::postClean(), PFAlgo::postCleaning(), reco::RecoTauPiZero::print(), PFPileUpAlgo::process(), MuonWithPFIsoProducer::produce(), DistortedPFCandProducer::produce(), PFElectronTranslator::produce(), EgammaHLTPFChargedIsolationProducer::produce(), EgammaHLTPFNeutralIsolationProducer::produce(), Type0PFMETcorrInputProducer::produce(), pf2pat::PFMETAlgo::produce(), PFLinker::produce(), pat::PATPackedCandidateProducer::produce(), PFPhotonTranslator::produce(), reco::tau::RecoTauIsolationMasking::resolution(), pf2pat::PFIsoDepositAlgo::sameParticle(), setConversionRef(), setDisplacedVertexRef(), setPhotonRef(), setSuperClusterRef(), and setTrackRef().

{ return translatePdgIdToType(pdgId());}

reco::PFCandidatePhotonExtraRef PFCandidate::photonExtraRef

(

)

const

return a reference to the photon extra

Definition at line 601 of file PFCandidate.cc.

References GETREF, kRefPFPhotonExtraBit, and kRefPFPhotonExtraMask.

Referenced by PFPhotonTranslator::produce(), and rawHoEnergy().

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

reco::PhotonRef PFCandidate::photonRef

(

)

const

return a reference to the corresponding Photon if any

Definition at line 597 of file PFCandidate.cc.

References GETREF, kRefPhotonBit, and kRefPhotonMask.

Referenced by rawHoEnergy().

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

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

inline

Returns

position at ECAL entrance

Definition at line 368 of file PFCandidate.h.

References positionAtECALEntrance_.

Referenced by HPSPFRecoTauAlgorithm::applyElectronRejection(), PFRecoTauAlgorithm::buildPFTau(), 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 277 of file PFCandidate.h.

References ps1Energy_.

{ return ps1Energy_;}

double reco::PFCandidate::pS2Energy ( ) const

inline

return corrected PS2 energy

Definition at line 283 of file PFCandidate.h.

References flag(), ps2Energy_, rescaleMomentum(), and setFlag().

{ return ps2Energy_;}

double reco::PFCandidate::rawEcalEnergy ( ) const

inline

return corrected Ecal energy

Definition at line 225 of file PFCandidate.h.

References rawEcalEnergy_.

Referenced by DQMPFCandidateAnalyzer::analyze(), PFMuonAlgo::cleanPunchThroughAndFakes(), PFElectronTranslator::createBasicCluster(), GreedyMuonPFCandidateFilter::filter(), and pat::PATPackedCandidateProducer::produce().

{ return rawEcalEnergy_;}

double reco::PFCandidate::rawHcalEnergy ( ) const

inline

return raw Hcal energy

Definition at line 235 of file PFCandidate.h.

References rawHcalEnergy_.

Referenced by DQMPFCandidateAnalyzer::analyze(), PFMuonAlgo::cleanPunchThroughAndFakes(), GreedyMuonPFCandidateFilter::filter(), and pat::PATPackedCandidateProducer::produce().

{ return rawHcalEnergy_;}

double reco::PFCandidate::rawHoEnergy ( ) const

inline

return raw Hcal energy

Definition at line 245 of file PFCandidate.h.

References egammaExtraRef(), photonExtraRef(), photonRef(), rawHoEnergy_, setGsfElectronRef(), setPFEGammaExtraRef(), setPFPhotonExtraRef(), setPhotonRef(), setSuperClusterRef(), and superClusterRef().

{ return rawHoEnergy_;}

void PFCandidate::rescaleMomentum

(

double

rescaleFactor

)

particle momentum *= rescaleFactor

Definition at line 287 of file PFCandidate.cc.

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

Referenced by pS2Energy().

                                                        {
  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 317 of file PFCandidate.h.

References DetachedQuadStep_cff::mva, and mva_e_mu_.

{ mva_e_mu_=mva;}

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

inline

Definition at line 312 of file PFCandidate.h.

References mva_e_pi_.

Referenced by PFEGammaAlgo::fillPFCandidates(), PFAlgo::processBlock(), and PFElectronAlgo::SetCandidates().

{ mva_e_pi_=mvaNI;}

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

inline

set mva for neutral hadron - gamma discrimination

Definition at line 343 of file PFCandidate.h.

References DetachedQuadStep_cff::mva, and mva_gamma_nh_.

{ mva_gamma_nh_=mva;}

void reco::PFCandidate::set_mva_Isolated ( float  mvaI )

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 308 of file PFCandidate.h.

References mva_Isolated_.

Referenced by PFAlgo::processBlock().

{ mva_Isolated_=mvaI;}

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

inline

set mva for gamma detection

Definition at line 330 of file PFCandidate.h.

References DetachedQuadStep_cff::mva, and mva_nothing_gamma_.

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

{ mva_nothing_gamma_=mva;}

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

inline

set mva for neutral hadron detection

Definition at line 336 of file PFCandidate.h.

References DetachedQuadStep_cff::mva, and mva_nothing_nh_.

{ mva_nothing_nh_=mva;}

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

inline

set mva for pi-muon discrimination

Definition at line 323 of file PFCandidate.h.

References DetachedQuadStep_cff::mva, and mva_pi_mu_.

{ mva_pi_mu_=mva;}

void PFCandidate::setConversionRef

(

const reco::ConversionRef &

ref

)

set ref to original reco conversion

Definition at line 539 of file PFCandidate.cc.

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

Referenced by dxyError().

                                                                 {
  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 295 of file PFCandidate.h.

References deltaP_, and reco::dp.

Referenced by PFLinker::produce().

{deltaP_ = dp;}

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

set displaced vertex reference

Definition at line 484 of file PFCandidate.cc.

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

Referenced by dxyError().

                                                                                        {

  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 218 of file PFCandidate.h.

References funct::abs(), ecalERatio_, and rawEcalEnergy_.

Referenced by PFEGammaAlgo::fillPFCandidates(), PFAlgo::processBlock(), PFLinker::produce(), PFPhotonAlgo::RunPFPhoton(), and PFElectronAlgo::SetCandidates().

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

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

set a given flag

Definition at line 294 of file PFCandidate.cc.

References flags_.

Referenced by pS2Energy(), PFPhotonAlgo::RunPFPhoton(), and setHcalDepthEnergyFractions().

                                                   {
  
  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 578 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(), and rawHoEnergy().

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

void PFCandidate::setGsfTrackRef

(

const reco::GsfTrackRef &

ref

)

set gsftrack reference

Definition at line 463 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 dxyError(), PFEGammaAlgo::fillPFCandidates(), and 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::setHcalDepthEnergyFractions ( const std::array< float, 7 > &  fracs )

inline

set the fraction of hcal energy as function of depth (index 0..6 for depth 1..7)

Definition at line 432 of file PFCandidate.h.

References flag(), hcalDepthEnergyFractions_, overlap(), setFlag(), and edm::shift.

Referenced by PFAlgo::setHcalDepthInfo().

{ hcalDepthEnergyFractions_ = fracs; }

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

inline

set corrected Hcal energy

Definition at line 228 of file PFCandidate.h.

References funct::abs(), hcalERatio_, and rawHcalEnergy_.

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

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

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

inline

set corrected Hcal energy

Definition at line 238 of file PFCandidate.h.

References funct::abs(), hoERatio_, and rawHoEnergy_.

Referenced by PFAlgo::processBlock().

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

void PFCandidate::setMuonRef

(

const reco::MuonRef &

ref

)

set muon reference

Definition at line 445 of file PFCandidate.cc.

References 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 dxyError(), PFLinker::produce(), and PFMuonAlgo::reconstructMuon().

                                                     {

    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 reco::PFCandidate::setMuonTrackType ( const reco::Muon::MuonTrackType &  type )

inline

set the Best Muon Track Ref

Definition at line 357 of file PFCandidate.h.

References muonTrackType_.

Referenced by PFMuonAlgo::changeTrack().

                                                               {
      muonTrackType_ = type;
    }

void PFCandidate::setParticleType

(

ParticleType

type

)

set Particle Type

Definition at line 265 of file PFCandidate.cc.

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

Referenced by PFMuonAlgo::changeTrack(), PFAlgo::processBlock(), DeltaBetaWeights::produce(), and sourceCandidatePtr().

                                                     {
  setPdgId( translateTypeToPdgId( type ) );
}

void PFCandidate::setPFEGammaExtraRef

(

const reco::PFCandidateEGammaExtraRef &

ref

)

set the PF EGamma Extra Ref

Definition at line 650 of file PFCandidate.cc.

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

Referenced by PFEGammaProducer::produce(), and rawHoEnergy().

                                                                                {
  //std::cout << " before storeRefInfo " << kRefPFEGammaExtraMask << " " <<  kRefPFEGammaExtraBit << " " <<  iRef.isNonnull() << " " <<  iRef.key() <<  " " << std::endl;
  storeRefInfo(kRefPFEGammaExtraMask, kRefPFEGammaExtraBit, iRef.isNonnull(), 
           iRef.refCore(), iRef.key(),iRef.productGetter());
}

void PFCandidate::setPFElectronExtraRef

(

const reco::PFCandidateElectronExtraRef &

ref

)

set the PF Electron Extra Ref

Definition at line 588 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().

Referenced by setPositionAtECALEntrance().

                                                                                    {
  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 645 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().

Referenced by rawHoEnergy().

                                                                               {
  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 613 of file PFCandidate.cc.

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

Referenced by PFLinker::produce(), and rawHoEnergy().

                                                        {
  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 349 of file PFCandidate.h.

References positionAtECALEntrance_, and setPFElectronExtraRef().

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

                                                             {
      positionAtECALEntrance_ = pos;
    } 

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

inline

set corrected PS1 energy

Definition at line 274 of file PFCandidate.h.

References reco::e1, and ps1Energy_.

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

{ps1Energy_ = e1;}

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

inline

set corrected PS2 energy

Definition at line 280 of file PFCandidate.h.

References reco::e2, and ps2Energy_.

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

{ps2Energy_ = e2;}

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

inline

Definition at line 126 of file PFCandidate.h.

References sourcePtr_.

Referenced by reco::PFCandidateWithSrcPtrFactory::operator()(), PuppiPhoton::produce(), and VirtualJetProducer::writeJetsWithConstituents().

{ sourcePtr_ = ptr; }

void PFCandidate::setSuperClusterRef

(

const reco::SuperClusterRef &

scRef

)

Definition at line 629 of file PFCandidate.cc.

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

Referenced by PFEGammaAlgo::fillPFCandidates(), PFLinker::produce(), PFEGammaProducer::produce(), rawHoEnergy(), 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 reco::PFCandidate::setTime ( float  time, float  timeError = 0.f  )

inline

the timing information

Definition at line 425 of file PFCandidate.h.

References time(), time_, timeError(), and timeError_.

Referenced by PFEGammaAlgo::fillPFCandidates().

{ time_ = time; timeError_ = timeError; }

void PFCandidate::setTrackRef

(

const reco::TrackRef &

ref

)

set track reference

Definition at line 425 of file PFCandidate.cc.

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

Referenced by PFEGammaAlgo::fillPFCandidates(), PFElectronAlgo::SetCandidates(), and sourceCandidatePtr().

                                                      {
  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 568 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().

Referenced by dxyError().

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

void reco::PFCandidate::setVertex ( const math::XYZPoint &  vertex )

inlineoverridevirtual

set vertex

Reimplemented from reco::LeafCandidate.

Definition at line 409 of file PFCandidate.h.

References kCandVertex, reco::LeafCandidate::setVertex(), vertex(), and vertexType_.

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

                                                    {
      LeafCandidate::setVertex(p); vertexType_ = kCandVertex;
    }

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

inline

Definition at line 407 of file PFCandidate.h.

References kCandVertex, reco::LeafCandidate::setVertex(), and vertexType_.

Referenced by PFMuonAlgo::changeTrack(), and PFElectronAlgo::SetCandidates().

{ vertexType_=vt; if (vertexType_!=kCandVertex) LeafCandidate::setVertex(Point(0.,0.,0.));}

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

inlineoverridevirtual

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

Reimplemented from reco::LeafCandidate.

Definition at line 132 of file PFCandidate.h.

References addElementInBlock(), BPhysicsValidation_cfi::pdgid, setParticleType(), setTrackRef(), sourcePtr_, trackRef(), translatePdgIdToType(), and translateTypeToPdgId().

Referenced by reco::PFCandidateFwdPtrFactory::operator()(), reco::operator<<(), and 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 370 of file PFCandidate.cc.

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

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

                                                      {

  size_t index = s_refsBefore[storedRefsBitPattern_ & iMask];
  if ( nullptr == getter_) {
    getter_ = iGetter;
  }

  if(iIsValid) {
    if(0 == (storedRefsBitPattern_ & iBit) ) {
      refsInfo_.insert(refsInfo_.begin()+index, bitPackRefInfo(iCore,iKey));
      if (iGetter==nullptr)
    refsCollectionCache_.insert(refsCollectionCache_.begin()+index,
                    static_cast<void const*>(iCore.productPtr()));
      else
    refsCollectionCache_.insert(refsCollectionCache_.begin()+index,nullptr);
    } else {
      assert(refsInfo_.size()>index);
      *(refsInfo_.begin()+index)=bitPackRefInfo(iCore,iKey);
      if (iGetter==nullptr)
    *(refsCollectionCache_.begin()+index)=static_cast<void const*>(iCore.productPtr());
      else
    *(refsCollectionCache_.begin()+index)=nullptr;

    }
    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 609 of file PFCandidate.cc.

References GETREF, kRefSuperClusterBit, and kRefSuperClusterMask.

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

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

float reco::PFCandidate::time ( ) const

inline

Returns

the timing

Definition at line 421 of file PFCandidate.h.

References time_.

Referenced by TransientTrackBuilder::build(), PrimaryVertexAssignment::chargedHadronVertex(), pat::PATPackedCandidateProducer::produce(), and setTime().

{ return time_; }

float reco::PFCandidate::timeError ( ) const

inline

Returns

the timing uncertainty

Definition at line 423 of file PFCandidate.h.

References timeError_.

Referenced by TransientTrackBuilder::build(), PrimaryVertexAssignment::chargedHadronVertex(), pat::PATPackedCandidateProducer::produce(), and setTime().

{ return timeError_; }

reco::TrackRef PFCandidate::trackRef

(

)

const

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

Definition at line 442 of file PFCandidate.cc.

References GETREF, kRefTrackBit, and kRefTrackMask.

Referenced by reco::tau::RecoTauPiZeroStripPlugin2::addCandsToStrip(), reco::tau::RecoTauPiZeroStripPlugin3::addCandsToStrip(), PFMuonAlgo::addMissingMuons(), HPSPFRecoTauAlgorithm::applyElectronRejection(), bestTrack(), PFRecoTauAlgorithm::buildPFTau(), HPSPFRecoTauAlgorithm::buildPFTau(), HPSPFRecoTauAlgorithm::buildThreeProngs(), reco::PFMETProducerMVA::chargedFracInCone(), PFPileUpAlgo::chargedHadronVertex(), PrimaryVertexAssignment::chargedHadronVertex(), PFIsolationEstimator::chargedHadronVertex(), PFPhotonIsolationCalculator::chargedHadronVertex(), PileupJetIdAlgo::computeIdVariables(), reco::PFMETProducerMVA::computePFCandidateInfo(), metsig::SignAlgoResolutions::evalPF(), PFCandCommonVertexFitterBase::fill(), ChargedHadronTrackResolutionFilter::filter(), MuonBadTrackFilter::filter(), reco::tau::RecoTauQualityCuts::filterCand(), FFTJetPFPileupCleaner::findSomeVertexWFakes(), BPHTrackReference::getFromPF(), pat::helper::VertexingHelper::getTrack_(), reco::PFJet::getTrackRefs(), PFPhotonIsolationCalculator::isChargedParticleVetoed(), PFIsolationEstimator::isChargedParticleVetoed(), reco::modules::HICaloCompatibleTrackSelector::matchPFCandToTrack(), MuonWithPFIsoProducer::produce(), reco::ParticleFlowForChargedMETProducer::produce(), PFElectronTranslator::produce(), EgammaHLTPFChargedIsolationProducer::produce(), PuppiProducer::produce(), pat::PATPackedCandidateProducer::produce(), pat::PATLostTracks::produce(), HPSPFRecoTauAlgorithm::refitThreeProng(), setMuonRef(), BoostedDoubleSVProducer::setTracksPV(), sourceCandidatePtr(), PFRecoTauDiscriminationByFlightPathSignificance::threeProngFlightPathSig(), toTrackRef(), and vertex().

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

PFCandidate::ParticleType PFCandidate::translatePdgIdToType

(

int

pdgid

)

const

Definition at line 233 of file PFCandidate.cc.

References funct::abs(), e, egamma_HF, gamma, h, h0, h_HF, mu, and X.

Referenced by particleId(), PuppiPhoton::produce(), DeltaBetaWeights::produce(), citk::PFIsolationSumProducerForPUPPI::produce(), PuppiProducer::produce(), citk::PFIsolationSumProducer::produce(), SoftKillerProducer::produce(), sourceCandidatePtr(), and VirtualJetProducer::writeJetsWithConstituents().

                                                                         {
  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 247 of file PFCandidate.cc.

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

Referenced by PFCandidate(), setParticleType(), and sourceCandidatePtr().

                                                               {
  
  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 573 of file PFCandidate.cc.

References GETREF, kRefV0Bit, and kRefV0Mask.

Referenced by dxyError().

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

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

overridevirtual

vertex position (overwritten by PF...)

Reimplemented from reco::LeafCandidate.

Definition at line 656 of file PFCandidate.cc.

References gsfTrackRef(), kCandVertex, kComMuonVertex, kDYTMuonVertex, kGSFVertex, kPickyMuonVertex, kSAMuonVertex, kTPFMSMuonVertex, kTrkMuonVertex, kTrkVertex, muonRef(), trackRef(), reco::LeafCandidate::vertex(), and vertexType_.

Referenced by FWPFCandidateWithHitsProxyBuilder::build(), FWPFCandidate3DProxyBuilder::build(), HPSPFRecoTauAlgorithm::buildOneProng(), HPSPFRecoTauAlgorithm::buildThreeProngs(), PFPileUpAlgo::chargedHadronVertex(), PFIsolationEstimator::chargedHadronVertex(), PFPhotonIsolationCalculator::chargedHadronVertex(), PFCandWithSuperClusterExtractor::depositFromObject(), Tau.Tau::dxy(), FFTJetPFPileupCleaner::findSomeVertexWFakes(), PFConcretePFCandidateProducer::produce(), L1THLTTauMatching::produce(), L1HLTTauMatching::produce(), EgammaHLTPFNeutralIsolationProducer::produce(), pat::PATPackedCandidateProducer::produce(), setVertex(), vx(), vy(), and vz().

                                               {
  switch (vertexType_) {
  case kCandVertex:
    return LeafCandidate::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 kTPFMSMuonVertex:
    return muonRef()->tpfmsTrack()->vertex();
    break;
  case kPickyMuonVertex:
    return muonRef()->pickyTrack()->vertex();
    break;
  case kDYTMuonVertex:
    return muonRef()->dytTrack()->vertex();
    break;

  case kGSFVertex:
    return gsfTrackRef()->vertex();
    break;
  }
  return LeafCandidate::vertex();
}

double reco::PFCandidate::vx ( ) const

inlineoverridevirtual

x coordinate of vertex position

Reimplemented from reco::LeafCandidate.

Definition at line 414 of file PFCandidate.h.

References vertex().

Referenced by PFIsolationEstimator::fGetIsolationInRings().

{return vertex().x();}

double reco::PFCandidate::vy ( ) const

inlineoverridevirtual

y coordinate of vertex position

Reimplemented from reco::LeafCandidate.

Definition at line 415 of file PFCandidate.h.

References vertex().

Referenced by PFIsolationEstimator::fGetIsolationInRings().

{return vertex().y();}

double reco::PFCandidate::vz ( ) const

inlineoverridevirtual

z coordinate of vertex position

Reimplemented from reco::LeafCandidate.

Definition at line 416 of file PFCandidate.h.

References vertex().

Referenced by PFCandWithSuperClusterExtractor::depositFromObject(), and PFIsolationEstimator::fGetIsolationInRings().

{return vertex().z();}

Friends And Related Function Documentation

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

friend

Member Data Documentation

const float PFCandidate::bigMva_ = -999.

static

Definition at line 394 of file PFCandidate.h.

Blocks reco::PFCandidate::blocksStorage_

private

Definition at line 447 of file PFCandidate.h.

Referenced by addElementInBlock(), elementsInBlocks(), operator=(), and PFCandidate().

float reco::PFCandidate::deltaP_

private

uncertainty on 3-momentum

Definition at line 487 of file PFCandidate.h.

Referenced by deltaP(), operator=(), PFCandidate(), and setDeltaP().

float reco::PFCandidate::ecalERatio_

private

corrected ECAL energy ratio (corrected/raw)

Definition at line 460 of file PFCandidate.h.

Referenced by ecalEnergy(), operator=(), PFCandidate(), and setEcalEnergy().

std::atomic<ElementsInBlocks*> reco::PFCandidate::elementsInBlocks_

mutableprivate

Definition at line 443 of file PFCandidate.h.

Referenced by addElementInBlock(), elementsInBlocks(), operator=(), PFCandidate(), and ~PFCandidate().

Elements reco::PFCandidate::elementsStorage_

private

Definition at line 448 of file PFCandidate.h.

Referenced by addElementInBlock(), elementsInBlocks(), operator=(), and PFCandidate().

unsigned reco::PFCandidate::flags_

private

all flags, packed (ecal regional, hcal regional, tracking)

Definition at line 484 of file PFCandidate.h.

Referenced by flag(), operator=(), PFCandidate(), and setFlag().

const edm::EDProductGetter* reco::PFCandidate::getter_

private

Definition at line 524 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), and storeRefInfo().

std::array<float,7> reco::PFCandidate::hcalDepthEnergyFractions_

private

Definition at line 534 of file PFCandidate.h.

Referenced by hcalDepthEnergyFraction(), hcalDepthEnergyFractions(), operator=(), PFCandidate(), and setHcalDepthEnergyFractions().

float reco::PFCandidate::hcalERatio_

private

corrected HCAL energy ratio (corrected/raw)

Definition at line 463 of file PFCandidate.h.

Referenced by hcalEnergy(), operator=(), PFCandidate(), and setHcalEnergy().

float reco::PFCandidate::hoERatio_

private

corrected HO energy ratio (corrected/raw)

Definition at line 466 of file PFCandidate.h.

Referenced by hoEnergy(), operator=(), PFCandidate(), and setHoEnergy().

reco::Muon::MuonTrackType reco::PFCandidate::muonTrackType_

private

Reference to the best track if it is a muon pF is allowed to switch the default muon track

Definition at line 457 of file PFCandidate.h.

Referenced by bestMuonTrackType(), operator=(), PFCandidate(), and setMuonTrackType().

float reco::PFCandidate::mva_e_mu_

private

mva for electron-muon discrimination

Definition at line 498 of file PFCandidate.h.

Referenced by mva_e_mu(), operator=(), PFCandidate(), and set_mva_e_mu().

float reco::PFCandidate::mva_e_pi_

private

mva for electron-pion discrimination

Definition at line 495 of file PFCandidate.h.

Referenced by mva_e_pi(), operator=(), PFCandidate(), and set_mva_e_pi().

float reco::PFCandidate::mva_gamma_nh_

private

mva for neutral hadron - gamma discrimination

Definition at line 510 of file PFCandidate.h.

Referenced by mva_gamma_nh(), operator=(), PFCandidate(), and set_mva_gamma_nh().

float reco::PFCandidate::mva_Isolated_

private

Definition at line 492 of file PFCandidate.h.

Referenced by mva_Isolated(), operator=(), PFCandidate(), and set_mva_Isolated().

float reco::PFCandidate::mva_nothing_gamma_

private

mva for gamma detection

Definition at line 504 of file PFCandidate.h.

Referenced by mva_nothing_gamma(), operator=(), PFCandidate(), and set_mva_nothing_gamma().

float reco::PFCandidate::mva_nothing_nh_

private

mva for neutral hadron detection

Definition at line 507 of file PFCandidate.h.

Referenced by mva_nothing_nh(), operator=(), PFCandidate(), and set_mva_nothing_nh().

float reco::PFCandidate::mva_pi_mu_

private

mva for pi-muon discrimination

Definition at line 501 of file PFCandidate.h.

Referenced by mva_pi_mu(), operator=(), PFCandidate(), and set_mva_pi_mu().

math::XYZPointF reco::PFCandidate::positionAtECALEntrance_

private

position at ECAL entrance, from the PFRecTrack

Definition at line 513 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), positionAtECALEntrance(), and setPositionAtECALEntrance().

float reco::PFCandidate::ps1Energy_

private

corrected PS1 energy

Definition at line 478 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), pS1Energy(), and setPs1Energy().

float reco::PFCandidate::ps2Energy_

private

corrected PS2 energy

Definition at line 481 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), pS2Energy(), and setPs2Energy().

float reco::PFCandidate::rawEcalEnergy_

private

raw ECAL energy

Definition at line 469 of file PFCandidate.h.

Referenced by ecalEnergy(), operator=(), PFCandidate(), rawEcalEnergy(), and setEcalEnergy().

float reco::PFCandidate::rawHcalEnergy_

private

raw HCAL energy

Definition at line 472 of file PFCandidate.h.

Referenced by hcalEnergy(), operator=(), PFCandidate(), rawHcalEnergy(), and setHcalEnergy().

float reco::PFCandidate::rawHoEnergy_

private

raw HO energy

Definition at line 475 of file PFCandidate.h.

Referenced by hoEnergy(), operator=(), PFCandidate(), rawHoEnergy(), and setHoEnergy().

std::vector<const void *> reco::PFCandidate::refsCollectionCache_

private

Definition at line 527 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), and storeRefInfo().

std::vector<unsigned long long> reco::PFCandidate::refsInfo_

private

Definition at line 526 of file PFCandidate.h.

Referenced by getRefInfo(), operator=(), PFCandidate(), and storeRefInfo().

PFCandidatePtr reco::PFCandidate::sourcePtr_

private

reference to the source PFCandidate, if any

Definition at line 452 of file PFCandidate.h.

Referenced by flag(), operator=(), overlap(), PFCandidate(), setSourceCandidatePtr(), and sourceCandidatePtr().

unsigned short reco::PFCandidate::storedRefsBitPattern_

private

Definition at line 525 of file PFCandidate.h.

Referenced by getRefInfo(), operator=(), PFCandidate(), and storeRefInfo().

float reco::PFCandidate::time_

private

timing information (valid if timeError_ >= 0)

Definition at line 530 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), setTime(), and time().

float reco::PFCandidate::timeError_

private

timing information uncertainty (<0 if timing not available)

Definition at line 532 of file PFCandidate.h.

Referenced by isTimeValid(), operator=(), PFCandidate(), setTime(), and timeError().

PFVertexType reco::PFCandidate::vertexType_

private

Definition at line 489 of file PFCandidate.h.

Referenced by operator=(), PFCandidate(), setVertex(), setVertexSource(), and vertex().