pat::PackedCandidate Class Reference

#include <PackedCandidate.h>

Inheritance diagram for pat::PackedCandidate:

Classes
struct	PackedCovariance
	Flag isolation (as in particle flow, i.e. at calorimeter surface rather than at PV) flag for charged hadrons. More...

Public Types
typedef reco::CandidateCollection	daughters
	collection of daughter candidates More...
typedef unsigned int	index
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...
enum	LostInnerHits { validHitInFirstPixelBarrelLayer =-1, noLostInnerHits =0, oneLostInnerHit =1, moreLostInnerHits =2 }
	Enumerator specifying the. More...
typedef math::XYZPoint	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
enum	PVAssoc { NoPV =0, PVLoose =1, PVTight =2, PVUsedInFit =3 }
	This refers to the association to PV=ipv. >=PVLoose corresponds to JME definition, >=PVTight to isolation definition. More...
enum	PVAssociationQuality {   NotReconstructedPrimary =0, OtherDeltaZ =1, CompatibilityBTag =4, CompatibilityDz =5,   UsedInFitLoose =6, UsedInFitTight =7 }
enum	trackHitShiftsAndMasks { trackPixelHitsMask = 7, trackStripHitsMask = 31, trackStripHitsShift = 3 }
	set impact parameters covariance 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
const reco::Track *	bestTrack () const override
	return a pointer to the track if present. otherwise, return a null pointer More...
Vector	boostToCM () const override
int	charge () const override
	electric charge More...
PackedCandidate *	clone () const override
	returns a clone of the Candidate object More...
int	covarianceSchema () const
int	covarianceVersion () const
const reco::Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
reco::Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
reco::Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const reco::Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...
virtual float	dtime (size_t ipv=0) const
	dtime with respect to the PV[ipv] More...
virtual float	dtimeAssociatedPV () const
	dtime with respect to the PV ref More...
virtual float	dxy () const
	dxy with respect to the PV ref More...
virtual float	dxy (const Point &p) const
	dxy with respect to another point More...
float	dxyError () const override
	uncertainty on dxy More...
virtual float	dz (size_t ipv=0) const
	dz with respect to the PV[ipv] More...
virtual float	dz (const Point &p) const
	dz with respect to another point More...
virtual float	dzAssociatedPV () const
	dz with respect to the PV ref More...
float	dzError () const override
	uncertainty on dz More...
double	energy () const override
	energy More...
double	et () const override
	transverse energy More...
double	et2 () const override
	transverse energy squared (use this for cuts)! More...
double	eta () const override
	momentum pseudorapidity More...
virtual float	etaAtVtx () const
	eta from the track (normally identical to eta()) More...
void	fillVertexCovariance (CovarianceMatrix &v) const override
	fill SMatrix More...
uint16_t	firstHit () const
	Return first hit from HitPattern for tracks with high level details. More...
const PVAssoc	fromPV (size_t ipv=0) const
bool	hasMasterClone () const override
bool	hasMasterClonePtr () const override
bool	hasTrackDetails () const
	Return true if a bestTrack can be extracted from this Candidate. More...
float	hcalFraction () const
	Set the fraction of Hcal needed for HF and neutral hadrons and isolated charged hadrons. More...
bool	isCaloMuon () const override
bool	isConvertedPhoton () const override
bool	isElectron () const override
bool	isGlobalMuon () const override
bool	isGoodEgamma () const
bool	isIsolatedChargedHadron () const
	Set isolation (as in particle flow, i.e. at calorimeter surface rather than at PV) flat for charged hadrons. More...
bool	isJet () const override
bool	isMuon () const override
bool	isPhoton () const override
bool	isStandAloneMuon () const override
bool	isTrackerMuon () const override
bool	longLived () const override
	is long lived? More...
LostInnerHits	lostInnerHits () const
double	mass () const override
	mass More...
bool	massConstraint () const override
	do mass constraint? More...
double	massSqr () const override
	mass squared More...
const reco::CandidateBaseRef &	masterClone () const override
const reco::CandidatePtr &	masterClonePtr () const override
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
Vector	momentum () const override
	spatial momentum vector More...
const reco::Candidate *	mother (size_type) const override
	return mother at a given position (throws an exception) More...
double	mt () const override
	transverse mass More...
double	mtSqr () const override
	transverse mass squared More...
size_t	numberOfDaughters () const override
	number of daughters More...
int	numberOfHits () const
size_t	numberOfMothers () const override
	number of mothers More...
int	numberOfPixelHits () const
size_t	numberOfSourceCandidatePtrs () const override
PackedCandidate &	operator= (const PackedCandidate &iOther)
PackedCandidate &	operator= (PackedCandidate &&iOther)
double	p () const override
	magnitude of momentum vector More...
const LorentzVector &	p4 () const override
	four-momentum Lorentz vecto r More...
	PackedCandidate ()
	default constructor More...
	PackedCandidate (const reco::Candidate &c, const reco::VertexRefProd &pvRefProd, reco::VertexRef::key_type pvRefKey)
	PackedCandidate (const PolarLorentzVector &p4, const Point &vtx, float trkPt, float etaAtVtx, float phiAtVtx, int pdgId, const reco::VertexRefProd &pvRefProd, reco::VertexRef::key_type pvRefKey)
	PackedCandidate (const LorentzVector &p4, const Point &vtx, float trkPt, float etaAtVtx, float phiAtVtx, int pdgId, const reco::VertexRefProd &pvRefProd, reco::VertexRef::key_type pvRefKey)
	PackedCandidate (const PackedCandidate &iOther)
	PackedCandidate (PackedCandidate &&iOther)
int	pdgId () const override
	PDG identifier. More...
double	phi () const override
	momentum azimuthal angle More...
virtual float	phiAtVtx () const
	momentum azimuthal angle from the track (normally identical to phi()) More...
int	pixelLayersWithMeasurement () const
const PolarLorentzVector &	polarP4 () const override
	four-momentum Lorentz vector More...
virtual const reco::Track &	pseudoTrack () const
	Return reference to a pseudo track made with candidate kinematics, parameterized error for eta,phi,pt and full IP covariance. More...
double	pt () const override
	transverse momentum More...
virtual double	ptTrk () const
	pt from the track (normally identical to pt()) More...
float	puppiWeight () const
	Set both weights at once (with option for only full PUPPI) More...
float	puppiWeightNoLep () const
	Weight from full PUPPI. More...
const PVAssociationQuality	pvAssociationQuality () const
double	px () const override
	x coordinate of momentum vector More...
double	py () const override
	y coordinate of momentum vector More...
double	pz () const override
	z coordinate of momentum vector More...
double	rapidity () const override
	rapidity More...
float	rawCaloFraction () const
	Set the raw ECAL+HCAL energy over candidate energy for isolated charged hadrons. More...
void	setAssociationQuality (PVAssociationQuality q)
void	setCharge (int charge) override
	set electric charge More...
virtual void	setCovarianceVersion (int v)
void	setDTimeAssociatedPV (float aTime, float aTimeError=0)
	set time measurement More...
void	setFirstHit (uint16_t pattern)
	Set first hit from HitPattern. More...
void	setGoodEgamma (bool isGoodEgamma=true)
void	setHcalFraction (float p)
	Raw ECAL+HCAL energy over candidate energy for isolated charged hadrons. More...
virtual void	setHits (const reco::Track &tk)
void	setIsIsolatedChargedHadron (bool p)
	Fraction of Ecal and Hcal for HF and neutral hadrons and isolated charged hadrons. More...
void	setLongLived () override
	set long lived flag More...
void	setLostInnerHits (LostInnerHits hits)
void	setMass (double m) override
	set particle mass More...
void	setMassConstraint () override
	set mass constraint flag More...
void	setMuonID (bool isStandAlone, bool isGlobal)
void	setP4 (const LorentzVector &p4) override
	set 4-momentum More...
void	setP4 (const PolarLorentzVector &p4) override
	set 4-momentum More...
void	setPdgId (int pdgId) override
void	setPuppiWeight (float p, float p_nolep=0.0)
void	setPz (double pz) override
void	setRawCaloFraction (float p)
	Weight from PUPPI removing leptons. More...
void	setStatus (int status) override
	set status word More...
void	setThreeCharge (int threecharge) override
	set electric charge More...
void	setTime (float aTime, float aTimeError=0)
	set time measurement More...
void	setTrackHighPurity (bool highPurity)
	set to true if the track had the highPurity quality bit More...
virtual void	setTrackProperties (const reco::Track &tk, const reco::Track::CovarianceMatrix &covariance, int quality, int covarianceVersion)
virtual void	setTrackProperties (const reco::Track &tk, int quality, int covarianceVersion)
void	setVertex (const Point &vertex) override
	set vertex More...
reco::CandidatePtr	sourceCandidatePtr (size_type i) const override
int	status () const override
	status word More...
int	stripLayersWithMeasurement () const
double	theta () const override
	momentum polar angle More...
int	threeCharge () const override
	electric charge More...
virtual float	time () const
	time (wrt nominal zero of the collision) More...
virtual float	timeError () const
	time measurement uncertainty (-1 if not available) More...
int	trackerLayersWithMeasurement () const
bool	trackHighPurity () const
	true if the track had the highPurity quality bit More...
const Point &	vertex () const override
	vertex position 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 override
	return SMatrix More...
double	vertexNdof () const override
double	vertexNormalizedChi2 () const override
	chi-squared divided by n.d.o.f. More...
const reco::VertexRef	vertexRef () const
double	vx () const override
	x coordinate of vertex position More...
double	vy () const override
	y coordinate of vertex position More...
double	vz () const override
	z coordinate of vertex position More...
double	y () const override
	rapidity More...
	~PackedCandidate () 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	setP4 (const PolarLorentzVector &p4)=0
	set 4-momentum More...
virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate. More...
virtual void	setVertex (const Point &vertex)=0
	set vertex More...
virtual	~Candidate ()
	destructor More...

Public Attributes
uint16_t	firstHit_

Static Public Attributes
static const unsigned int	longLivedTag = 0
	long lived flag More...
static const unsigned int	massConstraintTag = 0
	do mass constraint flag More...

Protected Types
enum	qualityFlagsShiftsAndMasks {   assignmentQualityMask = 0x7, assignmentQualityShift = 0, trackHighPurityMask = 0x8, trackHighPurityShift =3,   lostInnerHitsMask = 0x30, lostInnerHitsShift =4, muonFlagsMask = 0x0600, muonFlagsShift =9,   egammaFlagsMask = 0x0800, egammaFlagsShift =11 }

Protected Member Functions
const CovarianceParameterization &	covarianceParameterization () const
void	maybeUnpackBoth () const
void	maybeUnpackCovariance () const
void	maybeUnpackTrack () const
bool	overlap (const reco::Candidate &) const override
	check overlap with another Candidate More...
void	pack (bool unpackAfterwards=true)
void	packBoth ()
void	packCovariance (const reco::TrackBase::CovarianceMatrix &m, bool unpackAfterwards=true)
void	packVtx (bool unpackAfterwards=true)
void	unpack () const
void	unpackCovariance () const
void	unpackTrk () const
void	unpackVtx () const

Static Protected Member Functions
static uint8_t	packTimeError (float timeError)
	static to allow unit testing More...
static int16_t	packTimeNoError (float time)
static int16_t	packTimeWithError (float time, float timeError)
static float	unpackTimeError (uint8_t timeError)
static float	unpackTimeNoError (int16_t time)
static float	unpackTimeWithError (int16_t time, uint8_t timeError)

Protected Attributes
uint16_t	covarianceSchema_
uint16_t	covarianceVersion_
float	deta_
float	dphi_
float	dtrkpt_
float	dxy_
float	dz_
int8_t	hcalFraction_
bool	isIsolatedChargedHadron_
std::atomic< reco::TrackBase::CovarianceMatrix * >	m_
	IP covariance. More...
uint8_t	normalizedChi2_
	track quality information More...
std::atomic< PolarLorentzVector * >	p4_
	the four vector More...
std::atomic< LorentzVector * >	p4c_
PackedCovariance	packedCovariance_
uint16_t	packedDEta_
uint16_t	packedDPhi_
uint16_t	packedDTrkPt_
uint16_t	packedDxy_
uint16_t	packedDz_
uint16_t	packedEta_
uint8_t	packedHits_
uint8_t	packedLayers_
uint16_t	packedM_
uint16_t	packedPhi_
uint16_t	packedPt_
uint8_t	packedPuppiweight_
int8_t	packedPuppiweightNoLepDiff_
int16_t	packedTime_
uint8_t	packedTimeError_
int	pdgId_
	PDG identifier. More...
reco::VertexRef::key_type	pvRefKey_
reco::VertexRefProd	pvRefProd_
	Use these to build a Ref to primary vertex. More...
uint16_t	qualityFlags_
uint8_t	rawCaloFraction_
std::atomic< reco::Track * >	track_
	reco::Track More...
std::atomic< Point * >	vertex_
	vertex position More...

Static Protected Attributes
static std::once_flag	covariance_load_flag
static CovarianceParameterization	covarianceParameterization_
static int	EXPO_TIME_NOERROR = 6
static int	EXPO_TIME_WITHERROR = -6
static int	EXPO_TIMEERROR = 5
static float	kMinDEtaToStore_ =0.001
static float	kMinDTrkPtToStore_ =0.001
static float	MIN_TIME_NOERROR = 0.0002f
static float	MIN_TIMEERROR = 0.002f

Private Member Functions
uint16_t	packCovarianceElement (const reco::TrackBase::CovarianceMatrix &m, int i, int j) const
void	unpackCovarianceElement (reco::TrackBase::CovarianceMatrix &m, uint16_t packed, int i, int j) const

Friends
class	::OverlapChecker
class	::testPackedCandidate
template<typename , typename , typename >
struct	component
class	ShallowCloneCandidate
class	ShallowClonePtrCandidate

Detailed Description

Definition at line 22 of file PackedCandidate.h.

Member Typedef Documentation

typedef reco::CandidateCollection pat::PackedCandidate::daughters

collection of daughter candidates

Definition at line 25 of file PackedCandidate.h.

typedef unsigned int pat::PackedCandidate::index

Definition at line 35 of file PackedCandidate.h.

typedef math::XYZTLorentzVector pat::PackedCandidate::LorentzVector

Lorentz vector.

Definition at line 27 of file PackedCandidate.h.

typedef math::XYZPoint pat::PackedCandidate::Point

point in the space

Definition at line 31 of file PackedCandidate.h.

typedef math::PtEtaPhiMLorentzVector pat::PackedCandidate::PolarLorentzVector

Lorentz vector.

Definition at line 29 of file PackedCandidate.h.

typedef math::XYZVector pat::PackedCandidate::Vector

point in the space

Definition at line 33 of file PackedCandidate.h.

Member Enumeration Documentation

enum pat::PackedCandidate::LostInnerHits

Enumerator specifying the.

Enumerator
validHitInFirstPixelBarrelLayer
noLostInnerHits
oneLostInnerHit
moreLostInnerHits

Definition at line 532 of file PackedCandidate.h.

                       {
        validHitInFirstPixelBarrelLayer=-1,
        noLostInnerHits=0,   // it could still not have a hit in the first layer, e.g. if it crosses an inactive sensor
        oneLostInnerHit=1,   
        moreLostInnerHits=2
    };

enum pat::PackedCandidate::PVAssoc

This refers to the association to PV=ipv. >=PVLoose corresponds to JME definition, >=PVTight to isolation definition.

Enumerator
NoPV
PVLoose
PVTight
PVUsedInFit

Definition at line 475 of file PackedCandidate.h.

{ NoPV=0, PVLoose=1, PVTight=2, PVUsedInFit=3 } ;

enum pat::PackedCandidate::PVAssociationQuality

The following contains information about how the association to the PV, given in vertexRef, is obtained.

Enumerator
NotReconstructedPrimary
OtherDeltaZ
CompatibilityBTag
CompatibilityDz
UsedInFitLoose
UsedInFitTight

Definition at line 487 of file PackedCandidate.h.

{ NotReconstructedPrimary=0,OtherDeltaZ=1,CompatibilityBTag=4,CompatibilityDz=5,UsedInFitLoose=6,UsedInFitTight=7};

enum pat::PackedCandidate::qualityFlagsShiftsAndMasks

protected

Enumerator
assignmentQualityMask
assignmentQualityShift
trackHighPurityMask
trackHighPurityShift
lostInnerHitsMask
lostInnerHitsShift
muonFlagsMask
muonFlagsShift
egammaFlagsMask
egammaFlagsShift

Definition at line 766 of file PackedCandidate.h.

                                    {
        assignmentQualityMask = 0x7, assignmentQualityShift = 0,
        trackHighPurityMask  = 0x8, trackHighPurityShift=3,
        lostInnerHitsMask = 0x30, lostInnerHitsShift=4,
        muonFlagsMask = 0x0600, muonFlagsShift=9,
    egammaFlagsMask = 0x0800, egammaFlagsShift=11
    };

enum pat::PackedCandidate::trackHitShiftsAndMasks

set impact parameters covariance

Enumerator
trackPixelHitsMask
trackStripHitsMask
trackStripHitsShift

Definition at line 417 of file PackedCandidate.h.

                                {
      trackPixelHitsMask = 7,
      trackStripHitsMask = 31, trackStripHitsShift = 3
    };

Constructor & Destructor Documentation

pat::PackedCandidate::PackedCandidate ( )

inline

default constructor

Definition at line 37 of file PackedCandidate.h.

Referenced by clone().

                      : 
      packedPt_(0), packedEta_(0),
      packedPhi_(0), packedM_(0),
      packedDxy_(0), packedDz_(0), packedDPhi_(0), packedDEta_(0),packedDTrkPt_(0),
      packedCovariance_(),
      packedPuppiweight_(0),
      packedPuppiweightNoLepDiff_(0),
      rawCaloFraction_(0),
      hcalFraction_(0),
      packedTime_(0),
      packedTimeError_(0),
      isIsolatedChargedHadron_(false),
      p4_(new PolarLorentzVector(0,0,0,0)), p4c_( new LorentzVector(0,0,0,0)), 
      vertex_(new Point(0,0,0)), dphi_(0), deta_(0), dtrkpt_(0),track_(nullptr), pdgId_(0),
      qualityFlags_(0), pvRefKey_(reco::VertexRef::invalidKey()),
      m_(nullptr), packedHits_(0), packedLayers_(0), normalizedChi2_(0),covarianceVersion_(0),covarianceSchema_(0),firstHit_(0) { }

pat::PackedCandidate::PackedCandidate ( const reco::Candidate &  c, const reco::VertexRefProd &  pvRefProd, reco::VertexRef::key_type  pvRefKey  )

inlineexplicit

Definition at line 54 of file PackedCandidate.h.

References packBoth().

                                                              :
      packedPuppiweight_(0), packedPuppiweightNoLepDiff_(0), rawCaloFraction_(0), hcalFraction_(0),
      packedTime_(0), packedTimeError_(0), isIsolatedChargedHadron_(false),
      p4_( new PolarLorentzVector(c.pt(), c.eta(), c.phi(), c.mass())), 
      p4c_( new LorentzVector(*p4_)), vertex_( new Point(c.vertex())), 
      dphi_(0), deta_(0), dtrkpt_(0),
      track_(nullptr), pdgId_(c.pdgId()), qualityFlags_(0), pvRefProd_(pvRefProd),
      pvRefKey_(pvRefKey),m_(nullptr), packedHits_(0), packedLayers_(0),
      normalizedChi2_(0),covarianceVersion_(0), covarianceSchema_(0),firstHit_(0) {
      packBoth();
    }

pat::PackedCandidate::PackedCandidate ( const PolarLorentzVector &  p4, const Point &  vtx, float  trkPt, float  etaAtVtx, float  phiAtVtx, int  pdgId, const reco::VertexRefProd &  pvRefProd, reco::VertexRef::key_type  pvRefKey  )

inlineexplicit

Definition at line 68 of file PackedCandidate.h.

References packBoth().

                                                              :
      packedPuppiweight_(0), packedPuppiweightNoLepDiff_(0), rawCaloFraction_(0), hcalFraction_(0),
      packedTime_(0), packedTimeError_(0), isIsolatedChargedHadron_(false),
      p4_( new PolarLorentzVector(p4) ), p4c_( new LorentzVector(*p4_)), 
      vertex_( new Point(vtx) ), 
      dphi_(reco::deltaPhi(phiAtVtx,p4_.load()->phi())), 
      deta_(std::abs(etaAtVtx-p4_.load()->eta())>=kMinDEtaToStore_ ? etaAtVtx-p4_.load()->eta() : 0.), 
      dtrkpt_(std::abs(trkPt-p4_.load()->pt())>=kMinDTrkPtToStore_ ? trkPt-p4_.load()->pt() : 0.),
      track_(nullptr), pdgId_(pdgId),
      qualityFlags_(0), pvRefProd_(pvRefProd), pvRefKey_(pvRefKey),
      m_(nullptr),packedHits_(0), packedLayers_(0),normalizedChi2_(0),covarianceVersion_(0),covarianceSchema_(0),firstHit_(0) {
      packBoth();
    }

pat::PackedCandidate::PackedCandidate ( const LorentzVector &  p4, const Point &  vtx, float  trkPt, float  etaAtVtx, float  phiAtVtx, int  pdgId, const reco::VertexRefProd &  pvRefProd, reco::VertexRef::key_type  pvRefKey  )

inlineexplicit

Definition at line 85 of file PackedCandidate.h.

References packBoth().

                                                              :
      packedPuppiweight_(0), packedPuppiweightNoLepDiff_(0), rawCaloFraction_(0), hcalFraction_(0),
      packedTime_(0), packedTimeError_(0), isIsolatedChargedHadron_(false),
      p4_(new PolarLorentzVector(p4.Pt(), p4.Eta(), p4.Phi(), p4.M())), 
      p4c_( new LorentzVector(p4)), vertex_( new Point(vtx) ) ,
      dphi_(reco::deltaPhi(phiAtVtx,p4_.load()->phi())), 
      deta_(std::abs(etaAtVtx-p4_.load()->eta())>=kMinDEtaToStore_ ? etaAtVtx-p4_.load()->eta() : 0.), 
      dtrkpt_(std::abs(trkPt-p4_.load()->pt())>=kMinDTrkPtToStore_ ? trkPt-p4_.load()->pt() : 0.),
      track_(nullptr), pdgId_(pdgId), qualityFlags_(0),
      pvRefProd_(pvRefProd), pvRefKey_(pvRefKey),
      m_(nullptr),packedHits_(0),packedLayers_(0),normalizedChi2_(0),covarianceVersion_(0),covarianceSchema_(0),firstHit_(0)  {
      packBoth();
    }

pat::PackedCandidate::PackedCandidate ( const PackedCandidate &  iOther )

inline

Definition at line 102 of file PackedCandidate.h.

                                                    :
      packedPt_(iOther.packedPt_), packedEta_(iOther.packedEta_),
      packedPhi_(iOther.packedPhi_), packedM_(iOther.packedM_),
      packedDxy_(iOther.packedDxy_), packedDz_(iOther.packedDz_), 
      packedDPhi_(iOther.packedDPhi_),packedDEta_(iOther.packedDEta_),packedDTrkPt_(iOther.packedDTrkPt_),
      packedCovariance_(iOther.packedCovariance_),
      packedPuppiweight_(iOther.packedPuppiweight_), 
      packedPuppiweightNoLepDiff_(iOther.packedPuppiweightNoLepDiff_),
      rawCaloFraction_(iOther.rawCaloFraction_),
      hcalFraction_(iOther.hcalFraction_),
      packedTime_(iOther.packedTime_),
      packedTimeError_(iOther.packedTimeError_),
      isIsolatedChargedHadron_(iOther.isIsolatedChargedHadron_),
      //Need to trigger unpacking in iOther
      p4_( new PolarLorentzVector(iOther.polarP4() ) ),
      p4c_( new LorentzVector(iOther.p4())), vertex_( new Point(iOther.vertex())),
      dxy_(iOther.dxy_), dz_(iOther.dz_),
      dphi_(iOther.dphi_), deta_(iOther.deta_), dtrkpt_(iOther.dtrkpt_),
      track_( iOther.track_ ? new reco::Track(*iOther.track_) : nullptr),
      pdgId_(iOther.pdgId_), qualityFlags_(iOther.qualityFlags_), 
      pvRefProd_(iOther.pvRefProd_),pvRefKey_(iOther.pvRefKey_),
      m_(iOther.m_? new reco::TrackBase::CovarianceMatrix(*iOther.m_) : nullptr),
      packedHits_(iOther.packedHits_),packedLayers_(iOther.packedLayers_),  normalizedChi2_(iOther.normalizedChi2_),
      covarianceVersion_(iOther.covarianceVersion_), covarianceSchema_(iOther.covarianceSchema_),firstHit_(iOther.firstHit_)  {
      }

pat::PackedCandidate::PackedCandidate ( PackedCandidate &&  iOther )

inline

Definition at line 128 of file PackedCandidate.h.

                                               :
      packedPt_(iOther.packedPt_), packedEta_(iOther.packedEta_),
      packedPhi_(iOther.packedPhi_), packedM_(iOther.packedM_),
      packedDxy_(iOther.packedDxy_), packedDz_(iOther.packedDz_), 
      packedDPhi_(iOther.packedDPhi_), packedDEta_(iOther.packedDEta_), packedDTrkPt_(iOther.packedDTrkPt_),  
      packedCovariance_(iOther.packedCovariance_),
      packedPuppiweight_(iOther.packedPuppiweight_), 
      packedPuppiweightNoLepDiff_(iOther.packedPuppiweightNoLepDiff_),
      rawCaloFraction_(iOther.rawCaloFraction_),
      hcalFraction_(iOther.hcalFraction_),
      packedTime_(iOther.packedTime_),
      packedTimeError_(iOther.packedTimeError_),
      isIsolatedChargedHadron_(iOther.isIsolatedChargedHadron_),
      p4_( iOther.p4_.exchange(nullptr) ) ,
      p4c_( iOther.p4c_.exchange(nullptr)), vertex_(iOther.vertex_.exchange(nullptr)),
      dxy_(iOther.dxy_), dz_(iOther.dz_),
      dphi_(iOther.dphi_), deta_(iOther.deta_), dtrkpt_(iOther.dtrkpt_),
      track_( iOther.track_.exchange(nullptr) ),
      pdgId_(iOther.pdgId_), qualityFlags_(iOther.qualityFlags_), 
      pvRefProd_(std::move(iOther.pvRefProd_)),pvRefKey_(iOther.pvRefKey_),
      m_( iOther.m_.exchange(nullptr)),
      packedHits_(iOther.packedHits_), packedLayers_(iOther.packedLayers_),normalizedChi2_(iOther.normalizedChi2_),
      covarianceVersion_(iOther.covarianceVersion_), covarianceSchema_(iOther.covarianceSchema_),firstHit_(iOther.firstHit_)  {
      }

pat::PackedCandidate::~PackedCandidate ( )

override

destructor

Definition at line 136 of file PackedCandidate.cc.

Referenced by operator=().

                                     { 
  delete p4_.load();
  delete p4c_.load();
  delete vertex_.load();
  delete track_.load();
  delete m_.load();
}

Member Function Documentation

const reco::Track* pat::PackedCandidate::bestTrack ( ) const

inlineoverridevirtual

return a pointer to the track if present. otherwise, return a null pointer

Reimplemented from reco::Candidate.

Definition at line 514 of file PackedCandidate.h.

References maybeUnpackTrack(), packedHits_, packedLayers_, and track_.

Referenced by Muon.Muon::ptErr().

                                                 {
      if (packedHits_!=0 || packedLayers_ !=0) {
        maybeUnpackTrack();
        return track_.load();
      }
      else
        return nullptr;
    }

Vector pat::PackedCandidate::boostToCM ( ) const

inlineoverridevirtual

boost vector to boost a Lorentz vector to the particle center of mass system

Implements reco::Candidate.

Definition at line 325 of file PackedCandidate.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->BoostToCM(); }

int pat::PackedCandidate::charge ( ) const

inlineoverridevirtual

electric charge

Implements reco::Candidate.

Definition at line 301 of file PackedCandidate.h.

References funct::abs(), and pdgId_.

Referenced by pat::PATPackedCandidateProducer::candsOrdering(), MuonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithMapBasedVeto::isInIsolationCone(), PhotonPFIsolationWithMapBasedVeto::isInIsolationCone(), pat::PATTrackAndVertexUnpacker::produce(), pat::PATIsolatedTrackProducer::produce(), and threeCharge().

                                {
      switch (abs(pdgId_)) {
      case 211: return (pdgId_>0)-(pdgId_<0);
      case 11:  return (-1)*(pdgId_>0)+(pdgId_<0); //e
      case 13:  return (-1)*(pdgId_>0)+(pdgId_<0); //mu
      case 15:  return (-1)*(pdgId_>0)+(pdgId_<0); //tau
      case 24:  return (pdgId_>0)-(pdgId_<0); //W
      default:  return 0;  //FIXME: charge is not defined
      }
    }

PackedCandidate* pat::PackedCandidate::clone ( void  ) const

inlineoverridevirtual

returns a clone of the Candidate object

Implements reco::Candidate.

Definition at line 586 of file PackedCandidate.h.

References mps_fire::i, PackedCandidate(), vertexChi2(), vertexCovariance(), vertexNdof(), and vertexNormalizedChi2().

                                              {
      return new PackedCandidate( *this );
    }

const CovarianceParameterization& pat::PackedCandidate::covarianceParameterization ( ) const

inlineprotected

Definition at line 748 of file PackedCandidate.h.

References covarianceParameterization_, covarianceVersion_, Exception, hasTrackDetails(), edm::errors::InvalidReference, overlap(), and edm::errors::UnimplementedFeature.

Referenced by packCovarianceElement(), and unpackCovarianceElement().

                                                                          {
    if (!hasTrackDetails()) throw edm::Exception(edm::errors::InvalidReference, "Trying to access covariance matrix for a PackedCandidate for which it's not available. Check hasTrackDetails() before!\n");
    std::call_once(covariance_load_flag,[](int v) { covarianceParameterization_.load(v); } ,covarianceVersion_ );
        if(covarianceParameterization_.loadedVersion() != covarianceVersion_ )
        {
          throw edm::Exception(edm::errors::UnimplementedFeature)
           << "Attempting to load multiple covariance version in same process. This is not supported.";
        }
        return  covarianceParameterization_;
    }

int pat::PackedCandidate::covarianceSchema ( ) const

inline

Definition at line 460 of file PackedCandidate.h.

References covarianceSchema_.

Referenced by pat::PATPackedCandidateProducer::candsOrdering().

{ return covarianceSchema_;}

int pat::PackedCandidate::covarianceVersion ( ) const

inline

Definition at line 459 of file PackedCandidate.h.

References covarianceVersion_.

Referenced by setTrackProperties().

{ return covarianceVersion_;}

const reco::Candidate * pat::PackedCandidate::daughter ( size_type  ) const

overridevirtual

return daughter at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 301 of file PackedCandidate.cc.

Referenced by operator=().

                                                                    {
  return nullptr;
}

reco::Candidate * pat::PackedCandidate::daughter ( size_type  )

overridevirtual

return daughter at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 323 of file PackedCandidate.cc.

                                                        {
  return nullptr;
}

reco::Candidate * pat::PackedCandidate::daughter ( const std::string &  s )

overridevirtual

return daughter with a specified role name

Implements reco::Candidate.

Definition at line 315 of file PackedCandidate.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                             {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "This Candidate type does not implement daughter(std::string). "
    << "Please use CompositeCandidate or NamedCompositeCandidate.\n";
}

const reco::Candidate * pat::PackedCandidate::daughter ( const std::string &  s ) const

overridevirtual

return daughter with a specified role name

Implements reco::Candidate.

Definition at line 309 of file PackedCandidate.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                                         {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "This Candidate type does not implement daughter(std::string). "
    << "Please use CompositeCandidate or NamedCompositeCandidate.\n";
}

virtual float pat::PackedCandidate::dtime ( size_t  ipv = 0 ) const

inlinevirtual

dtime with respect to the PV[ipv]

Definition at line 669 of file PackedCandidate.h.

References dtimeAssociatedPV(), and pvRefKey_.

{ return dtimeAssociatedPV() + (*pvRefProd_)[pvRefKey_].t()-(*pvRefProd_)[ipv].t(); }

virtual float pat::PackedCandidate::dtimeAssociatedPV ( ) const

inlinevirtual

dtime with respect to the PV ref

Definition at line 671 of file PackedCandidate.h.

References packedTime_, packedTimeError_, unpackTimeNoError(), and unpackTimeWithError().

Referenced by dtime(), and time().

                                             {
        if (packedTime_ == 0) return 0.f;
        if (packedTimeError_ > 0) return unpackTimeWithError(packedTime_,packedTimeError_);
        else return unpackTimeNoError(packedTime_);
    }

virtual float pat::PackedCandidate::dxy ( ) const

inlinevirtual

dxy with respect to the PV ref

Definition at line 494 of file PackedCandidate.h.

References dxy_, and maybeUnpackBoth().

Referenced by PileupJetIdAlgo::computeIdVariables(), Electron.Electron::cutBasedId(), ntupleDataFormat.Track::dxyPull(), dzAssociatedPV(), PhotonIDValueMapProducer::getImpactParameters(), PuppiProducer::produce(), and pat::PATIsolatedTrackProducer::produce().

{ maybeUnpackBoth(); return dxy_; }

float pat::PackedCandidate::dxy ( const Point &  p ) const

virtual

dxy with respect to another point

Definition at line 145 of file PackedCandidate.cc.

References funct::cos(), objects.autophobj::float, and funct::sin().

Referenced by Electron.Electron::cutBasedId(), and ntupleDataFormat.Track::dxyPull().

                                                  {
    maybeUnpackBoth();
    const float phi = float(p4_.load()->Phi())+dphi_;
    return -(vertex_.load()->X()-p.X()) * std::sin(phi) + (vertex_.load()->Y()-p.Y()) * std::cos(phi);
}

float pat::PackedCandidate::dxyError ( ) const

inlineoverridevirtual

uncertainty on dxy

Reimplemented from reco::Candidate.

Definition at line 507 of file PackedCandidate.h.

References m_, maybeUnpackCovariance(), and mathSSE::sqrt().

Referenced by pat::PATIsolatedTrackProducer::produce().

{ maybeUnpackCovariance(); return sqrt((*m_.load())(3,3)); }

virtual float pat::PackedCandidate::dz ( size_t  ipv = 0 ) const

inlinevirtual

dz with respect to the PV[ipv]

Definition at line 496 of file PackedCandidate.h.

References dz_, maybeUnpackBoth(), and pvRefKey_.

Referenced by reco::PFMETProducerMVA::chargedFracInCone(), PileupJetIdAlgo::computeIdVariables(), reco::PFMETProducerMVA::computePFCandidateInfo(), Electron.Electron::cutBasedId(), dzAssociatedPV(), ntupleDataFormat.Track::dzPull(), fromPV(), PhotonIDValueMapProducer::getImpactParameters(), PuppiProducer::produce(), and pat::PATIsolatedTrackProducer::produce().

{ maybeUnpackBoth(); return dz_ + (*pvRefProd_)[pvRefKey_].position().z()-(*pvRefProd_)[ipv].position().z(); }

float pat::PackedCandidate::dz ( const Point &  p ) const

virtual

dz with respect to another point

Definition at line 150 of file PackedCandidate.cc.

References funct::cos(), objects.autophobj::float, and funct::sin().

Referenced by Electron.Electron::cutBasedId(), and ntupleDataFormat.Track::dzPull().

                                                 {
    maybeUnpackBoth();
    const float phi = float(p4_.load()->Phi())+dphi_;
    const float pzpt = deta_ ? std::sinh(etaAtVtx()) : p4_.load()->Pz()/p4_.load()->Pt();
    return (vertex_.load()->Z()-p.Z())  - ((vertex_.load()->X()-p.X()) * std::cos(phi) + (vertex_.load()->Y()-p.Y()) * std::sin(phi)) * pzpt;
}

virtual float pat::PackedCandidate::dzAssociatedPV ( ) const

inlinevirtual

dz with respect to the PV ref

Definition at line 498 of file PackedCandidate.h.

References dxy(), dz(), dz_, maybeUnpackBoth(), and p().

Referenced by fromPV().

{ maybeUnpackBoth(); return dz_; }

float pat::PackedCandidate::dzError ( ) const

inlineoverridevirtual

uncertainty on dz

Reimplemented from reco::Candidate.

Definition at line 505 of file PackedCandidate.h.

References m_, maybeUnpackCovariance(), and mathSSE::sqrt().

Referenced by pat::PATIsolatedTrackProducer::produce().

{ maybeUnpackCovariance(); return sqrt((*m_.load())(4,4)); }

double pat::PackedCandidate::energy ( ) const

inlineoverridevirtual

energy

Implements reco::Candidate.

Definition at line 329 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by PuppiProducer::produce(), and Jet.Jet::rawEnergy().

{ if (!p4c_) unpack(); return p4c_.load()->E(); }

double pat::PackedCandidate::et ( ) const

inlineoverridevirtual

transverse energy

Implements reco::Candidate.

Definition at line 331 of file PackedCandidate.h.

References p4c_, and pt().

{ return (pt()<=0) ? 0 : p4c_.load()->Et(); }  

double pat::PackedCandidate::et2 ( ) const

inlineoverridevirtual

transverse energy squared (use this for cuts)!

Implements reco::Candidate.

Definition at line 333 of file PackedCandidate.h.

References p4c_, and pt().

{ return (pt()<=0) ? 0 : p4c_.load()->Et2(); }   

double pat::PackedCandidate::eta ( ) const

inlineoverridevirtual

momentum pseudorapidity

Implements reco::Candidate.

Definition at line 376 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), DQMPFCandidateAnalyzer::analyze(), pat::PATPackedCandidateProducer::candsOrdering(), Jet.Jet::jetID(), packCovarianceElement(), Jet.Jet::puJetId(), and unpackCovarianceElement().

{ if (!p4c_) unpack(); return p4_.load()->Eta(); }

virtual float pat::PackedCandidate::etaAtVtx ( ) const

inlinevirtual

eta from the track (normally identical to eta())

Definition at line 368 of file PackedCandidate.h.

References deta_, maybeUnpackBoth(), and p4_.

                                   { 
        maybeUnpackBoth(); 
        return p4_.load()->eta() + deta_; 
    }

void pat::PackedCandidate::fillVertexCovariance ( CovarianceMatrix &  v ) const

overridevirtual

fill SMatrix

Implements reco::Candidate.

Definition at line 344 of file PackedCandidate.cc.

References Exception, and edm::errors::UnimplementedFeature.

Referenced by vertexCovariance().

                                                                          {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "reco::ConcreteCandidate does not implement vertex covariant matrix.\n";
}

uint16_t pat::PackedCandidate::firstHit ( ) const

inline

Return first hit from HitPattern for tracks with high level details.

Definition at line 552 of file PackedCandidate.h.

References firstHit_.

{ return    firstHit_;}

const PVAssoc pat::PackedCandidate::fromPV ( size_t  ipv = 0 ) const

inline

Definition at line 476 of file PackedCandidate.h.

References funct::abs(), CompatibilityBTag, dz(), dzAssociatedPV(), edm::Ref< C, T, F >::key(), NoPV, or, pdgId(), pvAssociationQuality(), PVLoose, PVTight, PVUsedInFit, UsedInFitLoose, UsedInFitTight, and vertexRef().

Referenced by PileupJetIdAlgo::computeIdVariables(), MuonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithConeVeto::isInIsolationCone(), PhotonPFIsolationWithConeVeto::isInIsolationCone(), ElectronPFIsolationWithMapBasedVeto::isInIsolationCone(), PhotonPFIsolationWithMapBasedVeto::isInIsolationCone(), pat::PATTrackAndVertexUnpacker::produce(), PuppiProducer::produce(), pat::PATIsolatedTrackProducer::produce(), and BoostedDoubleSVProducer::setTracksPV().

                                             {
        reco::VertexRef pvRef = vertexRef();
        if(pvAssociationQuality()==UsedInFitTight and pvRef.key()==ipv) return PVUsedInFit;
        if(pvRef.key()==ipv or abs(pdgId())==13 or abs(pdgId())==11 ) return PVTight;
        if(pvAssociationQuality() == CompatibilityBTag and std::abs(dzAssociatedPV()) >  std::abs(dz(ipv))) return PVTight; // it is not closest, but at least prevents the B assignment stealing
        if(pvAssociationQuality() < UsedInFitLoose or pvRef->ndof() < 4.0 ) return PVLoose;
        return NoPV;
    }

bool pat::PackedCandidate::hasMasterClone ( ) const

overridevirtual

returns true if this candidate has a reference to a master clone. This only happens if the concrete Candidate type is ShallowCloneCandidate

Implements reco::Candidate.

Definition at line 273 of file PackedCandidate.cc.

Referenced by vertexCovariance().

                                              {
  return false;
}

bool pat::PackedCandidate::hasMasterClonePtr ( ) const

overridevirtual

returns true if this candidate has a ptr to a master clone. This only happens if the concrete Candidate type is ShallowClonePtrCandidate

Implements reco::Candidate.

Definition at line 277 of file PackedCandidate.cc.

Referenced by vertexCovariance().

                                                 {
  return false;
}

bool pat::PackedCandidate::hasTrackDetails ( ) const

inline

Return true if a bestTrack can be extracted from this Candidate.

Definition at line 523 of file PackedCandidate.h.

References packedHits_, and packedLayers_.

Referenced by pat::PATPackedCandidateProducer::candsOrdering(), covarianceParameterization(), btagbtvdeep::packedCandidateToFeatures(), pat::PATTrackAndVertexUnpacker::produce(), and pat::PATIsolatedTrackProducer::produce().

{return  (packedHits_!=0 || packedLayers_ !=0); }

float pat::PackedCandidate::hcalFraction ( ) const

inline

Set the fraction of Hcal needed for HF and neutral hadrons and isolated charged hadrons.

Definition at line 645 of file PackedCandidate.h.

References hcalFraction_, and setIsIsolatedChargedHadron().

Referenced by btagbtvdeep::packedCandidateToFeatures().

{ return (hcalFraction_/100.); }    

bool pat::PackedCandidate::isCaloMuon ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 630 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isConvertedPhoton ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 632 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isElectron ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 625 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isGlobalMuon ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 628 of file PackedCandidate.h.

References muonFlagsMask, muonFlagsShift, and qualityFlags_.

Referenced by Muon.Muon::muonID().

{ return ((qualityFlags_ & muonFlagsMask) >> muonFlagsShift) & 2; }

bool pat::PackedCandidate::isGoodEgamma ( ) const

inline

Definition at line 634 of file PackedCandidate.h.

References egammaFlagsMask, puppiWeight(), puppiWeightNoLep(), qualityFlags_, setPuppiWeight(), and setRawCaloFraction().

Referenced by setGoodEgamma().

{ return (qualityFlags_ & egammaFlagsMask) !=0; }

bool pat::PackedCandidate::isIsolatedChargedHadron ( ) const

inline

Set isolation (as in particle flow, i.e. at calorimeter surface rather than at PV) flat for charged hadrons.

Definition at line 649 of file PackedCandidate.h.

References isIsolatedChargedHadron_.

{ return isIsolatedChargedHadron_; }    

bool pat::PackedCandidate::isJet ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 633 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isMuon ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 626 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isPhoton ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 631 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::isStandAloneMuon ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 627 of file PackedCandidate.h.

References muonFlagsMask, muonFlagsShift, and qualityFlags_.

{ return ((qualityFlags_ & muonFlagsMask) >> muonFlagsShift) & 1; }

bool pat::PackedCandidate::isTrackerMuon ( ) const

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 629 of file PackedCandidate.h.

{ return false; }

bool pat::PackedCandidate::longLived ( ) const

overridevirtual

is long lived?

Implements reco::Candidate.

Definition at line 350 of file PackedCandidate.cc.

Referenced by setLongLived().

{return false;}

LostInnerHits pat::PackedCandidate::lostInnerHits ( ) const

inline

Definition at line 538 of file PackedCandidate.h.

References lostInnerHitsMask, lostInnerHitsShift, and qualityFlags_.

                                        {
         return LostInnerHits(int16_t((qualityFlags_ & lostInnerHitsMask)>>lostInnerHitsShift)-1);
    }

double pat::PackedCandidate::mass ( ) const

inlineoverridevirtual

mass

Implements reco::Candidate.

Definition at line 335 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), and DiObject.DiMuon::__str__().

{ if (!p4c_) unpack(); return p4_.load()->M(); }

bool pat::PackedCandidate::massConstraint ( ) const

overridevirtual

do mass constraint?

Implements reco::Candidate.

Definition at line 352 of file PackedCandidate.cc.

Referenced by setMassConstraint().

{return false;}

double pat::PackedCandidate::massSqr ( ) const

inlineoverridevirtual

mass squared

Implements reco::Candidate.

Definition at line 337 of file PackedCandidate.h.

References funct::m, p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); auto m = p4_.load()->M(); return m*m;}

const reco::CandidateBaseRef & pat::PackedCandidate::masterClone ( ) const

overridevirtual

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowCloneCandidate

Implements reco::Candidate.

Definition at line 267 of file PackedCandidate.cc.

References Exception.

Referenced by masterRef(), and vertexCovariance().

                                                                   {
  throw cms::Exception("Invalid Reference")
    << "this Candidate has no master clone reference."
    << "Can't call masterClone() method.\n";
}

const reco::CandidatePtr & pat::PackedCandidate::masterClonePtr ( ) const

overridevirtual

returns ptr to master clone, if existing. Throws an exception unless the concrete Candidate type is ShallowClonePtrCandidate

Implements reco::Candidate.

Definition at line 282 of file PackedCandidate.cc.

References Exception.

Referenced by vertexCovariance().

                                                                  {
  throw cms::Exception("Invalid Reference")
    << "this Candidate has no master clone ptr."
    << "Can't call masterClonePtr() method.\n";
}

template<typename Ref >

Ref pat::PackedCandidate::masterRef ( ) const

inline

cast master clone reference to a concrete type

Definition at line 623 of file PackedCandidate.h.

References masterClone().

{ return masterClone().template castTo<Ref>(); }

void pat::PackedCandidate::maybeUnpackBoth ( ) const

inlineprotected

Definition at line 707 of file PackedCandidate.h.

References p4c_, unpack(), unpackVtx(), and vertex_.

Referenced by dxy(), dz(), dzAssociatedPV(), etaAtVtx(), phiAtVtx(), ptTrk(), setP4(), setPz(), setVertex(), vertex(), vx(), vy(), and vz().

{ if (!p4c_) unpack(); if (!vertex_) unpackVtx(); }

void pat::PackedCandidate::maybeUnpackCovariance ( ) const

inlineprotected

Definition at line 709 of file PackedCandidate.h.

References m_, and unpackCovariance().

Referenced by dxyError(), and dzError().

{ if (!m_) unpackCovariance(); }

void pat::PackedCandidate::maybeUnpackTrack ( ) const

inlineprotected

Definition at line 708 of file PackedCandidate.h.

References track_, and unpackTrk().

Referenced by bestTrack().

{ if (!track_) unpackTrk(); }

Vector pat::PackedCandidate::momentum ( ) const

inlineoverridevirtual

spatial momentum vector

Implements reco::Candidate.

Definition at line 322 of file PackedCandidate.h.

References p4c_, and unpack().

{ if (!p4c_) unpack(); return p4c_.load()->Vect(); }

const reco::Candidate * pat::PackedCandidate::mother ( size_type  ) const

overridevirtual

return mother at a given position (throws an exception)

Implements reco::Candidate.

Definition at line 305 of file PackedCandidate.cc.

Referenced by operator=().

                                                                  {
  return nullptr;
}

double pat::PackedCandidate::mt ( ) const

inlineoverridevirtual

transverse mass

Implements reco::Candidate.

Definition at line 340 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Mt(); }

double pat::PackedCandidate::mtSqr ( ) const

inlineoverridevirtual

transverse mass squared

Implements reco::Candidate.

Definition at line 342 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Mt2(); }

size_t pat::PackedCandidate::numberOfDaughters ( ) const

overridevirtual

number of daughters

Implements reco::Candidate.

Definition at line 288 of file PackedCandidate.cc.

Referenced by operator=().

                                                   { 
  return 0; 
}

int pat::PackedCandidate::numberOfHits ( ) const

inline

Definition at line 454 of file PackedCandidate.h.

References numberOfPixelHits(), packedHits_, stripLayersWithMeasurement(), and trackStripHitsShift.

Referenced by packCovarianceElement(), pat::PATTrackAndVertexUnpacker::produce(), and unpackCovarianceElement().

{ return (packedHits_ >> trackStripHitsShift) + stripLayersWithMeasurement() + numberOfPixelHits(); }

size_t pat::PackedCandidate::numberOfMothers ( ) const

overridevirtual

number of mothers

Implements reco::Candidate.

Definition at line 292 of file PackedCandidate.cc.

Referenced by operator=().

                                                 { 
  return 0; 
}

int pat::PackedCandidate::numberOfPixelHits ( ) const

inline

Definition at line 453 of file PackedCandidate.h.

References packedHits_, pixelLayersWithMeasurement(), and trackPixelHitsMask.

Referenced by numberOfHits(), packCovarianceElement(), and unpackCovarianceElement().

{ return (packedHits_ & trackPixelHitsMask) + pixelLayersWithMeasurement(); }

size_t pat::PackedCandidate::numberOfSourceCandidatePtrs ( ) const

inlineoverridevirtual

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

Implements reco::Candidate.

Definition at line 293 of file PackedCandidate.h.

{return 0;}

PackedCandidate& pat::PackedCandidate::operator= ( const PackedCandidate &  iOther )

inline

Definition at line 154 of file PackedCandidate.h.

References covarianceSchema_, covarianceVersion_, deta_, dphi_, dtrkpt_, dxy_, dz_, firstHit_, hcalFraction_, isIsolatedChargedHadron_, m_, normalizedChi2_, p4(), p4_, p4c_, packedCovariance_, packedDEta_, packedDPhi_, packedDTrkPt_, packedDxy_, packedDz_, packedEta_, packedHits_, packedLayers_, packedM_, packedPhi_, packedPt_, packedPuppiweight_, packedPuppiweightNoLepDiff_, packedTime_, packedTimeError_, pdgId_, polarP4(), pvRefKey_, pvRefProd_, qualityFlags_, rawCaloFraction_, track_, vertex(), and vertex_.

                                                              {
      if(this == &iOther) {
        return *this;
      }
      packedPt_ =iOther.packedPt_;
      packedEta_=iOther.packedEta_;
      packedPhi_=iOther.packedPhi_; 
      packedM_=iOther.packedM_;
      packedDxy_=iOther.packedDxy_; 
      packedDz_=iOther.packedDz_; 
      packedDPhi_=iOther.packedDPhi_;
      packedDEta_=iOther.packedDEta_;
      packedDTrkPt_=iOther.packedDTrkPt_;
      packedCovariance_=iOther.packedCovariance_;
      packedPuppiweight_=iOther.packedPuppiweight_; 
      packedPuppiweightNoLepDiff_=iOther.packedPuppiweightNoLepDiff_;
      rawCaloFraction_=iOther.rawCaloFraction_;
      hcalFraction_=iOther.hcalFraction_;
      packedTime_=iOther.packedTime_;
      packedTimeError_=iOther.packedTimeError_;
      isIsolatedChargedHadron_=iOther.isIsolatedChargedHadron_;
      //Need to trigger unpacking in iOther
      if(p4_) {
        *p4_ = iOther.polarP4();
      } else {
        p4_.store( new PolarLorentzVector(iOther.polarP4() ) ) ;
      }
      if(p4c_) {
        *p4c_ = iOther.p4();
      } else {
        p4c_.store( new LorentzVector(iOther.p4()));
      }
      if(vertex_) {
        *vertex_ = iOther.vertex();
      } else {
        vertex_.store( new Point(iOther.vertex()));
      }
      dxy_=iOther.dxy_;
      dz_ = iOther.dz_;
      dphi_=iOther.dphi_; 
      deta_=iOther.deta_; 
      dtrkpt_=iOther.dtrkpt_; 
      
      if(!iOther.track_) {
        delete track_.exchange(nullptr);
      } else {
        if(!track_) {
          track_.store( new reco::Track(*iOther.track_));
        } else {
          *track_ = *(iOther.track_);
        }
      }

      pdgId_=iOther.pdgId_; 
      qualityFlags_=iOther.qualityFlags_; 
      pvRefProd_=iOther.pvRefProd_;
      pvRefKey_=iOther.pvRefKey_;
      if(!iOther.m_) {
        delete m_.exchange(nullptr);
       } else {
        if(!m_) {
          m_.store( new reco::Track::CovarianceMatrix(*iOther.m_));
        } else {
          *m_ = *(iOther.m_);
        }
      }
      
    
      packedHits_=iOther.packedHits_; 
      packedLayers_=iOther.packedLayers_; 
      normalizedChi2_=iOther.normalizedChi2_;
      covarianceVersion_=iOther.covarianceVersion_;
      covarianceSchema_=iOther.covarianceSchema_;
      firstHit_=iOther.firstHit_;
      return *this;
    }

PackedCandidate& pat::PackedCandidate::operator= ( PackedCandidate &&  iOther )

inline

Definition at line 231 of file PackedCandidate.h.

References covarianceSchema_, covarianceVersion_, daughter(), deta_, dphi_, dtrkpt_, dxy_, dz_, firstHit_, hcalFraction_, isIsolatedChargedHadron_, m_, mother(), normalizedChi2_, numberOfDaughters(), numberOfMothers(), p4_, p4c_, packedCovariance_, packedDEta_, packedDPhi_, packedDTrkPt_, packedDxy_, packedDz_, packedEta_, packedHits_, packedLayers_, packedM_, packedPhi_, packedPt_, packedPuppiweight_, packedPuppiweightNoLepDiff_, packedTime_, packedTimeError_, pdgId_, pvRefKey_, pvRefProd_, qualityFlags_, rawCaloFraction_, alignCSCRings::s, AlCaHLTBitMon_QueryRunRegistry::string, track_, vertex_, and ~PackedCandidate().

                                                         {
      if(this == &iOther) {
        return *this;
      }
      packedPt_ =iOther.packedPt_;
      packedEta_=iOther.packedEta_;
      packedPhi_=iOther.packedPhi_; 
      packedM_=iOther.packedM_;
      packedDxy_=iOther.packedDxy_; 
      packedDz_=iOther.packedDz_; 
      packedDPhi_=iOther.packedDPhi_;
      packedDEta_=iOther.packedDEta_;
      packedDTrkPt_=iOther.packedDTrkPt_;
      packedCovariance_=iOther.packedCovariance_;
      packedPuppiweight_=iOther.packedPuppiweight_; 
      packedPuppiweightNoLepDiff_=iOther.packedPuppiweightNoLepDiff_;
      rawCaloFraction_=iOther.rawCaloFraction_;
      hcalFraction_=iOther.hcalFraction_;
      packedTime_=iOther.packedTime_;
      packedTimeError_=iOther.packedTimeError_;
      isIsolatedChargedHadron_=iOther.isIsolatedChargedHadron_;
      delete p4_.exchange(iOther.p4_.exchange(nullptr));
      delete p4c_.exchange(iOther.p4c_.exchange(nullptr));
      delete vertex_.exchange(iOther.vertex_.exchange(nullptr));
      dxy_=iOther.dxy_;
      dz_ = iOther.dz_;
      dphi_=iOther.dphi_;      
      deta_=iOther.deta_; 
      dtrkpt_=iOther.dtrkpt_;
      delete track_.exchange(iOther.track_.exchange( nullptr));
      pdgId_=iOther.pdgId_; 
      qualityFlags_=iOther.qualityFlags_; 
      pvRefProd_=iOther.pvRefProd_;
      pvRefKey_=iOther.pvRefKey_;
      delete m_.exchange(iOther.m_.exchange(nullptr));
      packedHits_=iOther.packedHits_; 
      packedLayers_=iOther.packedLayers_; 
      normalizedChi2_=iOther.normalizedChi2_;
      covarianceVersion_=iOther.covarianceVersion_;
      covarianceSchema_=iOther.covarianceSchema_;
      firstHit_=iOther.firstHit_;
      return *this;
    }

bool pat::PackedCandidate::overlap ( const reco::Candidate &  o ) const

overrideprotectedvirtual

check overlap with another Candidate

Implements reco::Candidate.

Definition at line 296 of file PackedCandidate.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, reco::Candidate::charge(), reco::Candidate::p4(), p4, and reco::Candidate::vertex().

Referenced by covarianceParameterization().

                                                                { 
  return  p4() == o.p4() && vertex() == o.vertex() && charge() == o.charge();
//  return  p4() == o.p4() && charge() == o.charge();
}

double pat::PackedCandidate::p ( ) const

inlineoverridevirtual

magnitude of momentum vector

Implements reco::Candidate.

Definition at line 327 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by dzAssociatedPV(), and Electron.Electron::ptErr().

{ if (!p4c_) unpack(); return p4c_.load()->P(); }

const LorentzVector& pat::PackedCandidate::p4 ( ) const

inlineoverridevirtual

four-momentum Lorentz vecto r

Implements reco::Candidate.

Definition at line 318 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by Tau.Tau::dxy_approx(), Tau.Tau::dz(), operator=(), Lepton.Lepton::p4WithFSR(), pat::PATIsolatedTrackProducer::produce(), and setP4().

{ if (!p4c_) unpack(); return *p4c_; }  

void pat::PackedCandidate::pack ( bool  unpackAfterwards = true )

protected

Definition at line 13 of file PackedCandidate.cc.

References MiniFloatConverter::float32to16(), SiStripPI::max, and timeUnitHelper::unpack().

Referenced by pyrootRender.interactiveRender::draw(), packBoth(), and setMass().

                                                   {
    packedPt_  =  MiniFloatConverter::float32to16(p4_.load()->Pt());
    packedEta_ =  int16_t(std::round(p4_.load()->Eta()/6.0f*std::numeric_limits<int16_t>::max()));
    packedPhi_ =  int16_t(std::round(p4_.load()->Phi()/3.2f*std::numeric_limits<int16_t>::max()));
    packedM_   =  MiniFloatConverter::float32to16(p4_.load()->M());
    if (unpackAfterwards) {
      delete p4_.exchange(nullptr);
      delete p4c_.exchange(nullptr);
      unpack(); // force the values to match with the packed ones
    }
}

void pat::PackedCandidate::packBoth ( )

inlineprotected

Definition at line 710 of file PackedCandidate.h.

References p4_, p4c_, pack(), packVtx(), unpack(), unpackTrk(), unpackVtx(), and vertex_.

Referenced by PackedCandidate(), setP4(), setPz(), and setTrackProperties().

{ pack(false); packVtx(false); delete p4_.exchange(nullptr); delete p4c_.exchange(nullptr); delete vertex_.exchange(nullptr); unpack(); unpackVtx(); } // do it this way, so that we don't loose precision on the angles before computing dxy,dz

void pat::PackedCandidate::packCovariance ( const reco::TrackBase::CovarianceMatrix &  m, bool  unpackAfterwards = true  )

protected

Definition at line 71 of file PackedCandidate.cc.

Referenced by setTrackProperties().

                                                                                                    {
    packedCovariance_.dptdpt = packCovarianceElement(m,0,0);
    packedCovariance_.detadeta = packCovarianceElement(m,1,1);
    packedCovariance_.dphidphi = packCovarianceElement(m,2,2); 
    packedCovariance_.dxydxy =packCovarianceElement(m,3,3);
    packedCovariance_.dzdz = packCovarianceElement(m,4,4);
    packedCovariance_.dxydz = packCovarianceElement(m,3,4);
    packedCovariance_.dlambdadz = packCovarianceElement(m,1,4);
    packedCovariance_.dphidxy = packCovarianceElement(m,2,3);
   //unpack afterwards
   if(unpackAfterwards) unpackCovariance();
}

uint16_t pat::PackedCandidate::packCovarianceElement ( const reco::TrackBase::CovarianceMatrix &  m, int  i, int  j  ) const

inlineprivate

Definition at line 687 of file PackedCandidate.h.

References covarianceParameterization(), covarianceSchema_, eta(), funct::m, numberOfHits(), numberOfPixelHits(), CovarianceParameterization::pack(), and pt().

                                                                                             {
      return covarianceParameterization().pack(m(i,j),covarianceSchema_,i,j,pt(),eta(),numberOfHits(), numberOfPixelHits());
    }

uint8_t pat::PackedCandidate::packTimeError ( float  timeError )

staticprotected

static to allow unit testing

Definition at line 394 of file PackedCandidate.cc.

References f, and min().

                                                         {
    if (timeError <= 0) return 0;
    // log-scale packing.
    // for MIN_TIMEERROR = 0.002, EXPO_TIMEERROR = 5:
    //      minimum value 0.002 = 2ps (packed as 1)
    //      maximum value 0.5 ns      (packed as 255)
    //      constant *relative* precision of about 2%
    return std::max<uint8_t>( std::min(std::round(std::ldexp(std::log2(timeError/MIN_TIMEERROR), +EXPO_TIMEERROR)), 255.f), 1);
}

int16_t pat::PackedCandidate::packTimeNoError ( float  time )

staticprotected

Definition at line 410 of file PackedCandidate.cc.

References funct::abs(), f, and min().

                                                      {
    // encoding in log scale to store times in a large range with few bits.
    // for MIN_TIME_NOERROR = 0.0002 and EXPO_TIME_NOERROR = 6:
    //    smallest non-zero time = 0.2 ps (encoded as +/-1)
    //    one BX, +/- 12.5 ns, is fully covered with 11 bits (+/- 1023)
    //    12 bits cover by far any plausible value (+/-2047 corresponds to about +/- 0.8 ms!)
    //    constant *relative* ~1% precision
    if (std::abs(time) < MIN_TIME_NOERROR) return 0; // prevent underflows
    float fpacked = std::ldexp(std::log2(std::abs(time/MIN_TIME_NOERROR)),+EXPO_TIME_NOERROR);
    return (time > 0 ? +1 : -1)*std::min(std::round(fpacked), 2047.f);
}

int16_t pat::PackedCandidate::packTimeWithError ( float  time, float  timeError  )

staticprotected

Definition at line 430 of file PackedCandidate.cc.

References funct::abs(), and f.

                                                                             {
    // Encode in units of timeError * 2^EXPO_TIME_WITHERROR (~1.6% if EXPO_TIME_WITHERROR = -6)
    // the largest value that can be stored in 14 bits + sign bit + overflow bit is about 260 sigmas
    // values larger than that will be stored using the no-timeError packing (with less precision).
    // overflows of these kinds should happen only for particles that are late arriving, out-of-time,
    // or mis-reconstructed, as timeError is O(20ps) and the beam spot witdth is O(200ps)
    float fpacked = std::round(time/std::ldexp(timeError, EXPO_TIME_WITHERROR));
    if (std::abs(fpacked) < 16383.f) { // 16383 = (2^14 - 1) = largest absolute value for a signed 15 bit integer
        return int16_t(fpacked) * 2; // make it even, and fit in a signed 16 bit int
    } else {
        int16_t packed = packTimeNoError(time); // encode
        return packed * 2 + (time > 0 ? +1 : -1); // make it odd, to signal that there was an overlow
    }
}

void pat::PackedCandidate::packVtx ( bool  unpackAfterwards = true )

protected

Definition at line 25 of file PackedCandidate.cc.

References EnergyCorrector::c, funct::cos(), f, MiniFloatConverter::float32to16(), edm::Ref< C, T, F >::isNonnull(), SiStripPI::max, MetAnalyzer::pv(), alignCSCRings::s, and funct::sin().

Referenced by packBoth(), and setVertex().

                                                      {
    reco::VertexRef pvRef = vertexRef();
    Point pv = pvRef.isNonnull() ? pvRef->position() : Point();
    float dxPV = vertex_.load()->X() - pv.X(), dyPV = vertex_.load()->Y() - pv.Y(); //, rPV = std::hypot(dxPV, dyPV);
    float s = std::sin(float(p4_.load()->Phi())+dphi_), c = std::cos(float(p4_.load()->Phi()+dphi_)); // not the fastest option, but we're in reduced precision already, so let's avoid more roundoffs
    dxy_  = - dxPV * s + dyPV * c;    
    // if we want to go back to the full x,y,z we need to store also
    // float dl = dxPV * c + dyPV * s; 
    // float xRec = - dxy_ * s + dl * c, yRec = dxy_ * c + dl * s;
    float pzpt = p4_.load()->Pz()/p4_.load()->Pt();
    dz_ = vertex_.load()->Z() - pv.Z() - (dxPV*c + dyPV*s) * pzpt;
    packedDxy_ = MiniFloatConverter::float32to16(dxy_*100);
    packedDz_   = pvRef.isNonnull() ? MiniFloatConverter::float32to16(dz_*100) : int16_t(std::round(dz_/40.f*std::numeric_limits<int16_t>::max()));
    packedDPhi_ =  int16_t(std::round(dphi_/3.2f*std::numeric_limits<int16_t>::max()));
    packedDEta_ =  MiniFloatConverter::float32to16(deta_);
    packedDTrkPt_ = MiniFloatConverter::float32to16(dtrkpt_);
 
    if (unpackAfterwards) {
      delete vertex_.exchange(nullptr);
      unpackVtx();
    }
}

int pat::PackedCandidate::pdgId ( ) const

inlineoverridevirtual

PDG identifier.

Implements reco::Candidate.

Definition at line 565 of file PackedCandidate.h.

References pdgId_.

Referenced by Particle.Particle::__str__(), DQMPFCandidateAnalyzer::analyze(), PATTauDiscriminationAgainstElectronMVA6::discriminate(), fromPV(), AntiElectronIDMVA6::MVAValue(), PATPuppiJetSpecificProducer::produce(), pat::PATIsolatedTrackProducer::produce(), and setPdgId().

{ return pdgId_; }

double pat::PackedCandidate::phi ( ) const

inlineoverridevirtual

momentum azimuthal angle

Implements reco::Candidate.

Definition at line 352 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), DQMPFCandidateAnalyzer::analyze(), and ntupleDataFormat.Track::phiPull().

{ if (!p4c_) unpack(); return p4_.load()->Phi(); }

virtual float pat::PackedCandidate::phiAtVtx ( ) const

inlinevirtual

momentum azimuthal angle from the track (normally identical to phi())

Definition at line 360 of file PackedCandidate.h.

References dphi_, objects.autophobj::float, M_PI, maybeUnpackBoth(), and p4_.

                                   { 
        maybeUnpackBoth(); 
        float ret = p4_.load()->Phi() + dphi_; 
        while (ret >  float(M_PI)) ret -= 2*float(M_PI); 
        while (ret < -float(M_PI)) ret += 2*float(M_PI); 
        return ret; 
    } 

int pat::PackedCandidate::pixelLayersWithMeasurement ( ) const

inline

Definition at line 455 of file PackedCandidate.h.

References packedLayers_, and trackPixelHitsMask.

Referenced by numberOfPixelHits(), and trackerLayersWithMeasurement().

{ return packedLayers_ & trackPixelHitsMask; }

const PolarLorentzVector& pat::PackedCandidate::polarP4 ( ) const

inlineoverridevirtual

four-momentum Lorentz vector

Implements reco::Candidate.

Definition at line 320 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by operator=(), setP4(), and setPz().

{ if (!p4c_) unpack(); return *p4_; }

virtual const reco::Track& pat::PackedCandidate::pseudoTrack ( ) const

inlinevirtual

Return reference to a pseudo track made with candidate kinematics, parameterized error for eta,phi,pt and full IP covariance.

Definition at line 511 of file PackedCandidate.h.

References track_, and unpackTrk().

Referenced by BPHTrackReference::getFromPC(), btagbtvdeep::packedCandidateToFeatures(), and pat::PATTrackAndVertexUnpacker::produce().

{ if (!track_) unpackTrk(); return *track_; }

double pat::PackedCandidate::pt ( ) const

inlineoverridevirtual

transverse momentum

Implements reco::Candidate.

Definition at line 350 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), DQMPFCandidateAnalyzer::analyze(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), et(), et2(), MuonPFIsolationWithConeVeto::isInIsolationCone(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), packCovarianceElement(), Electron.Electron::ptErr(), ntupleDataFormat.Track::ptPull(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), Jet.Jet::setCorrP4(), and unpackCovarianceElement().

{ if (!p4c_) unpack(); return p4_.load()->Pt();}

virtual double pat::PackedCandidate::ptTrk ( ) const

inlinevirtual

pt from the track (normally identical to pt())

Definition at line 355 of file PackedCandidate.h.

References dtrkpt_, maybeUnpackBoth(), and p4_.

                                 {
        maybeUnpackBoth(); 
    return p4_.load()->pt() + dtrkpt_;
    }

float pat::PackedCandidate::puppiWeight

(

)

const

Set both weights at once (with option for only full PUPPI)

Definition at line 361 of file PackedCandidate.cc.

References SiStripPI::max.

Referenced by DQMPFCandidateAnalyzer::analyze(), isGoodEgamma(), btagbtvdeep::packedCandidateToFeatures(), PATPuppiJetSpecificProducer::produce(), and PuppiProducer::produce().

{ return 1.f*packedPuppiweight_/std::numeric_limits<uint8_t>::max();}

float pat::PackedCandidate::puppiWeightNoLep

(

)

const

Weight from full PUPPI.

Definition at line 363 of file PackedCandidate.cc.

References SiStripPI::max.

Referenced by DQMPFCandidateAnalyzer::analyze(), isGoodEgamma(), and PuppiProducer::produce().

{ return 1.f*packedPuppiweightNoLepDiff_/std::numeric_limits<int8_t>::max() + 1.f*packedPuppiweight_/std::numeric_limits<uint8_t>::max();}

const PVAssociationQuality pat::PackedCandidate::pvAssociationQuality ( ) const

inline

Definition at line 488 of file PackedCandidate.h.

References assignmentQualityMask, assignmentQualityShift, and qualityFlags_.

Referenced by fromPV(), and btagbtvdeep::packedCandidateToFeatures().

{ return PVAssociationQuality((qualityFlags_ & assignmentQualityMask)>>assignmentQualityShift); }

double pat::PackedCandidate::px ( ) const

inlineoverridevirtual

x coordinate of momentum vector

Implements reco::Candidate.

Definition at line 344 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by PuppiProducer::produce().

{ if (!p4c_) unpack(); return p4c_.load()->Px(); }

double pat::PackedCandidate::py ( ) const

inlineoverridevirtual

y coordinate of momentum vector

Implements reco::Candidate.

Definition at line 346 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by PuppiProducer::produce().

{ if (!p4c_) unpack(); return p4c_.load()->Py(); }

double pat::PackedCandidate::pz ( ) const

inlineoverridevirtual

z coordinate of momentum vector

Implements reco::Candidate.

Definition at line 348 of file PackedCandidate.h.

References p4c_, and unpack().

Referenced by PuppiProducer::produce(), and setPz().

{ if (!p4c_) unpack(); return p4c_.load()->Pz(); }

double pat::PackedCandidate::rapidity ( ) const

inlineoverridevirtual

rapidity

Implements reco::Candidate.

Definition at line 378 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

{ if (!p4c_) unpack(); return p4_.load()->Rapidity(); }

float pat::PackedCandidate::rawCaloFraction ( ) const

inline

Set the raw ECAL+HCAL energy over candidate energy for isolated charged hadrons.

Definition at line 643 of file PackedCandidate.h.

References rawCaloFraction_, and setHcalFraction().

{ return (rawCaloFraction_/100.); }    

void pat::PackedCandidate::setAssociationQuality ( PVAssociationQuality  q )

inline

Definition at line 489 of file PackedCandidate.h.

References assignmentQualityMask, assignmentQualityShift, and qualityFlags_.

{  qualityFlags_ = (qualityFlags_ & ~assignmentQualityMask) | ((q << assignmentQualityShift) & assignmentQualityMask);  }

void pat::PackedCandidate::setCharge ( int  charge )

inlineoverridevirtual

set electric charge

Implements reco::Candidate.

Definition at line 312 of file PackedCandidate.h.

{}

virtual void pat::PackedCandidate::setCovarianceVersion ( int  v )

inlinevirtual

Definition at line 458 of file PackedCandidate.h.

References covarianceVersion_, and findQualityFiles::v.

{covarianceVersion_=v;}

void pat::PackedCandidate::setDTimeAssociatedPV	(	float	aTime,
		float	aTimeError = 0
	)

set time measurement

Definition at line 380 of file PackedCandidate.cc.

Referenced by setTime(), and timeError().

                                                                           {
    if (aTime == 0 && aTimeError == 0) {
        packedTime_ = 0; packedTimeError_ = 0;
    } else if (aTimeError == 0) {
        packedTimeError_ = 0;
        packedTime_ = packTimeNoError(aTime);
    } else {
        packedTimeError_ = packTimeError(aTimeError);
        aTimeError = unpackTimeError(packedTimeError_); // for reproducibility
        packedTime_ = packTimeWithError(aTime, aTimeError);
    }
}

void pat::PackedCandidate::setFirstHit ( uint16_t  pattern )

inline

Set first hit from HitPattern.

Definition at line 548 of file PackedCandidate.h.

References firstHit_, and listBenchmarks::pattern.

                                       {
    firstHit_=pattern;
    }

void pat::PackedCandidate::setGoodEgamma ( bool  isGoodEgamma = true )

inline

Definition at line 559 of file PackedCandidate.h.

References egammaFlagsMask, egammaFlagsShift, isGoodEgamma(), and qualityFlags_.

                                                 {
        int16_t egFlags = (isGoodEgamma << egammaFlagsShift) & egammaFlagsMask;
        qualityFlags_ = (qualityFlags_& ~egammaFlagsMask) | egFlags;
    }

void pat::PackedCandidate::setHcalFraction

(

float

p

)

Raw ECAL+HCAL energy over candidate energy for isolated charged hadrons.

Definition at line 372 of file PackedCandidate.cc.

References AlCaHLTBitMon_ParallelJobs::p.

Referenced by rawCaloFraction().

                                                {
  hcalFraction_ = 100*p;
}

virtual void pat::PackedCandidate::setHits ( const reco::Track &  tk )

inlinevirtual

Definition at line 423 of file PackedCandidate.h.

References reco::TrackBase::hitPattern(), reco::HitPattern::numberOfValidHits(), reco::HitPattern::numberOfValidPixelHits(), packedHits_, packedLayers_, reco::HitPattern::pixelLayersWithMeasurement(), reco::HitPattern::stripLayersWithMeasurement(), trackPixelHitsMask, trackStripHitsMask, and trackStripHitsShift.

Referenced by setTrackProperties().

                                                {
      // first we count the number of layers with hits
      int numberOfPixelLayers_ = tk.hitPattern().pixelLayersWithMeasurement();
      if (numberOfPixelLayers_ > trackPixelHitsMask) numberOfPixelLayers_ = trackPixelHitsMask;
      int numberOfStripLayers_ = tk.hitPattern().stripLayersWithMeasurement();
      if (numberOfStripLayers_ > trackStripHitsMask) numberOfStripLayers_ = trackStripHitsMask;
      packedLayers_ = (numberOfPixelLayers_&trackPixelHitsMask) | (numberOfStripLayers_ << trackStripHitsShift);
      // now we count number of additional hits, beyond the one-per-layer implied by packedLayers_
      int numberOfPixelHits_ = tk.hitPattern().numberOfValidPixelHits() - numberOfPixelLayers_;
      if (numberOfPixelHits_ > trackPixelHitsMask) numberOfPixelHits_ = trackPixelHitsMask;
      int numberOfStripHits_ = tk.hitPattern().numberOfValidHits() - numberOfPixelHits_ - numberOfPixelLayers_ - numberOfStripLayers_;
      if (numberOfStripHits_ > trackStripHitsMask) numberOfStripHits_ = trackStripHitsMask;

      packedHits_ = (numberOfPixelHits_&trackPixelHitsMask) | (numberOfStripHits_ << trackStripHitsShift);
    }

void pat::PackedCandidate::setIsIsolatedChargedHadron

(

bool

p

)

Fraction of Ecal and Hcal for HF and neutral hadrons and isolated charged hadrons.

Definition at line 376 of file PackedCandidate.cc.

References AlCaHLTBitMon_ParallelJobs::p.

Referenced by hcalFraction().

                                                          {
  isIsolatedChargedHadron_ = p;
}

void pat::PackedCandidate::setLongLived ( )

inlineoverridevirtual

set long lived flag

Implements reco::Candidate.

Definition at line 575 of file PackedCandidate.h.

References longLived().

{} /*FIXME*/

void pat::PackedCandidate::setLostInnerHits ( LostInnerHits  hits )

inline

Definition at line 541 of file PackedCandidate.h.

References hfClusterShapes_cfi::hits, lostInnerHitsMask, lostInnerHitsShift, and qualityFlags_.

                                              {
        int lost = hits; if (lost > 2) lost = 2; // protection against misuse
        lost++; // shift so it's 0 .. 3 instead of (-1) .. 2
        qualityFlags_ = (qualityFlags_ & ~lostInnerHitsMask) | ((lost << lostInnerHitsShift) & lostInnerHitsMask); 
    }

void pat::PackedCandidate::setMass ( double  m )

inlineoverridevirtual

set particle mass

Implements reco::Candidate.

Definition at line 400 of file PackedCandidate.h.

References funct::m, p4_, p4c_, pack(), and unpack().

                                      {
      if (!p4c_) unpack(); 
      *p4_ = PolarLorentzVector(p4_.load()->Pt(), p4_.load()->Eta(), p4_.load()->Phi(), m); 
      pack();
    }

void pat::PackedCandidate::setMassConstraint ( )

inlineoverridevirtual

set mass constraint flag

Implements reco::Candidate.

Definition at line 581 of file PackedCandidate.h.

References massConstraint().

{} /*FIXME*/

void pat::PackedCandidate::setMuonID ( bool  isStandAlone, bool  isGlobal  )

inline

Definition at line 554 of file PackedCandidate.h.

References muonFlagsMask, muonFlagsShift, and qualityFlags_.

                                                     {
        int16_t muonFlags = isStandAlone | (2*isGlobal);
        qualityFlags_ = (qualityFlags_ & ~muonFlagsMask) | ((muonFlags << muonFlagsShift) & muonFlagsMask);
    }

void pat::PackedCandidate::setP4 ( const LorentzVector &  p4 )

inlineoverridevirtual

set 4-momentum

Implements reco::Candidate.

Definition at line 382 of file PackedCandidate.h.

References deta_, dphi_, dtrkpt_, maybeUnpackBoth(), p4_, packBoth(), and polarP4().

Referenced by Jet.Jet::setCorrP4().

                                                    { 
        maybeUnpackBoth(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
    dphi_+=polarP4().Phi()-p4.Phi();
    deta_+=polarP4().Eta()-p4.Eta();
    dtrkpt_+=polarP4().Pt()-p4.Pt();
        *p4_ = PolarLorentzVector(p4.Pt(), p4.Eta(), p4.Phi(), p4.M());
        packBoth();
    }

void pat::PackedCandidate::setP4 ( const PolarLorentzVector &  p4 )

inlineoverride

set 4-momentum

Definition at line 391 of file PackedCandidate.h.

References deta_, dphi_, dtrkpt_, maybeUnpackBoth(), p4(), p4_, packBoth(), and polarP4().

Referenced by Jet.Jet::setCorrP4().

                                                         { 
        maybeUnpackBoth(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
    dphi_+=polarP4().Phi()-p4.Phi();
    deta_+=polarP4().Eta()-p4.Eta();
    dtrkpt_+=polarP4().Pt()-p4.Pt();
        *p4_ = p4; 
        packBoth();
    }

void pat::PackedCandidate::setPdgId ( int  pdgId )

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 567 of file PackedCandidate.h.

References pdgId(), and pdgId_.

{ pdgId_ = pdgId; }

void pat::PackedCandidate::setPuppiWeight	(	float	p,
		float	p_nolep = 0.0
	)

Definition at line 355 of file PackedCandidate.cc.

References SiStripPI::max, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by isGoodEgamma().

                                                              {
  // Set both weights at once to avoid misconfigured weights if called in the wrong order
  packedPuppiweight_ = std::numeric_limits<uint8_t>::max()*p;
  packedPuppiweightNoLepDiff_ = std::numeric_limits<int8_t>::max()*(p_nolep-p);
}

void pat::PackedCandidate::setPz ( double  pz )

inlineoverridevirtual

Implements reco::Candidate.

Definition at line 405 of file PackedCandidate.h.

References deta_, dphi_, dtrkpt_, maybeUnpackBoth(), p4_, p4c_, packBoth(), polarP4(), and pz().

                                     {
      maybeUnpackBoth(); // changing px,py,pz changes also mapping between dxy,dz and x,y,z
      *p4c_ = LorentzVector(p4c_.load()->Px(), p4c_.load()->Py(), pz, p4c_.load()->E());
      dphi_+=polarP4().Phi()- p4c_.load()->Phi();
      deta_+=polarP4().Eta()- p4c_.load()->Eta();
      dtrkpt_+=polarP4().Pt()- p4c_.load()->Pt();
      *p4_  = PolarLorentzVector(p4c_.load()->Pt(), p4c_.load()->Eta(), p4c_.load()->Phi(), p4c_.load()->M());
      packBoth();
    }

void pat::PackedCandidate::setRawCaloFraction

(

float

p

)

Weight from PUPPI removing leptons.

Definition at line 365 of file PackedCandidate.cc.

References SiStripPI::max, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by isGoodEgamma().

                                                   {
  if(100*p>std::numeric_limits<uint8_t>::max())
    rawCaloFraction_ = std::numeric_limits<uint8_t>::max(); // Set to overflow value
  else
    rawCaloFraction_ = 100*p;
}

void pat::PackedCandidate::setStatus ( int  status )

inlineoverridevirtual

set status word

Implements reco::Candidate.

Definition at line 571 of file PackedCandidate.h.

{} /*FIXME*/

void pat::PackedCandidate::setThreeCharge ( int  threecharge )

inlineoverridevirtual

set electric charge

Implements reco::Candidate.

Definition at line 316 of file PackedCandidate.h.

{}

void pat::PackedCandidate::setTime ( float  aTime, float  aTimeError = 0  )

inline

set time measurement

Definition at line 681 of file PackedCandidate.h.

References setDTimeAssociatedPV(), lumiQTWidget::t, and vertexRef().

{ setDTimeAssociatedPV(aTime - vertexRef()->t(), aTimeError); }

void pat::PackedCandidate::setTrackHighPurity ( bool  highPurity )

inline

set to true if the track had the highPurity quality bit

Definition at line 529 of file PackedCandidate.h.

References qualityFlags_, trackHighPurityMask, and trackHighPurityShift.

{  qualityFlags_ = (qualityFlags_ & ~trackHighPurityMask) | ((highPurity << trackHighPurityShift) & trackHighPurityMask);  }

virtual void pat::PackedCandidate::setTrackProperties ( const reco::Track &  tk, const reco::Track::CovarianceMatrix &  covariance, int  quality, int  covarianceVersion  )

inlinevirtual

Definition at line 439 of file PackedCandidate.h.

References covarianceSchema_, covarianceVersion(), covarianceVersion_, reco::TrackBase::normalizedChi2(), normalizedChi2_, packBoth(), packCovariance(), jets_cff::quality, and setHits().

Referenced by setTrackProperties().

                                                                                                                                           {
      covarianceVersion_ = covarianceVersion ;
      covarianceSchema_ = quality ;
      normalizedChi2_ = tk.normalizedChi2();
      setHits(tk);
      packBoth();
      packCovariance(covariance,false); 
    }

virtual void pat::PackedCandidate::setTrackProperties ( const reco::Track &  tk, int  quality, int  covarianceVersion  )

inlinevirtual

Definition at line 449 of file PackedCandidate.h.

References reco::TrackBase::covariance(), covarianceVersion(), jets_cff::quality, and setTrackProperties().

                                                                                              {
    setTrackProperties(tk,tk.covariance(), quality,covarianceVersion );
    }   

void pat::PackedCandidate::setVertex ( const Point &  vertex )

inlineoverride

set vertex

Definition at line 472 of file PackedCandidate.h.

References maybeUnpackBoth(), packVtx(), vertex(), and vertex_.

{ maybeUnpackBoth(); *vertex_ = vertex; packVtx(); }

reco::CandidatePtr pat::PackedCandidate::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::Candidate.

Definition at line 296 of file PackedCandidate.h.

                                                                      {
      return reco::CandidatePtr();
    }

int pat::PackedCandidate::status ( ) const

inlineoverridevirtual

status word

Implements reco::Candidate.

Definition at line 569 of file PackedCandidate.h.

References qualityFlags_.

{ return qualityFlags_; } /*FIXME*/

int pat::PackedCandidate::stripLayersWithMeasurement ( ) const

inline

Definition at line 456 of file PackedCandidate.h.

References packedLayers_, and trackStripHitsShift.

Referenced by numberOfHits(), and trackerLayersWithMeasurement().

{ return (packedLayers_ >> trackStripHitsShift); }

double pat::PackedCandidate::theta ( ) const

inlineoverridevirtual

momentum polar angle

Implements reco::Candidate.

Definition at line 374 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by Tau.Tau::zImpact().

{ if (!p4c_) unpack(); return p4_.load()->Theta(); }

int pat::PackedCandidate::threeCharge ( ) const

inlineoverridevirtual

electric charge

Implements reco::Candidate.

Definition at line 314 of file PackedCandidate.h.

References charge().

{return charge()*3;}

virtual float pat::PackedCandidate::time ( ) const

inlinevirtual

time (wrt nominal zero of the collision)

Definition at line 667 of file PackedCandidate.h.

References dtimeAssociatedPV(), and vertexRef().

Referenced by TransientTrackBuilder::build().

{ return vertexRef()->t() + dtimeAssociatedPV(); }

virtual float pat::PackedCandidate::timeError ( ) const

inlinevirtual

time measurement uncertainty (-1 if not available)

Definition at line 677 of file PackedCandidate.h.

References packedTimeError_, setDTimeAssociatedPV(), and unpackTimeError().

Referenced by TransientTrackBuilder::build().

{ return unpackTimeError(packedTimeError_); }

int pat::PackedCandidate::trackerLayersWithMeasurement ( ) const

inline

Definition at line 457 of file PackedCandidate.h.

References pixelLayersWithMeasurement(), and stripLayersWithMeasurement().

{ return stripLayersWithMeasurement() + pixelLayersWithMeasurement(); }

bool pat::PackedCandidate::trackHighPurity ( ) const

inline

true if the track had the highPurity quality bit

Definition at line 527 of file PackedCandidate.h.

References qualityFlags_, trackHighPurityMask, and trackHighPurityShift.

{ return (qualityFlags_ & trackHighPurityMask)>>trackHighPurityShift; }

void pat::PackedCandidate::unpack ( ) const

protected

Definition at line 48 of file PackedCandidate.cc.

References MiniFloatConverter::float16to32(), createfilelist::int, SiStripPI::max, p4, EnergyCorrector::pt, edm::shift, and Validation_hcalonly_cfi::sign.

Referenced by boostToCM(), energy(), eta(), mass(), massSqr(), maybeUnpackBoth(), momentum(), mt(), mtSqr(), p(), p4(), packBoth(), phi(), polarP4(), pt(), px(), py(), pz(), rapidity(), setMass(), theta(), and y().

                                      {
    float pt = MiniFloatConverter::float16to32(packedPt_);
    double shift = (pt<1. ? 0.1*pt : 0.1/pt); // shift particle phi to break degeneracies in angular separations
    double sign = ( ( int(pt*10) % 2 == 0 ) ? 1 : -1 ); // introduce a pseudo-random sign of the shift
    double phi = int16_t(packedPhi_)*3.2f/std::numeric_limits<int16_t>::max() + sign*shift*3.2/std::numeric_limits<int16_t>::max();
    auto p4 = std::make_unique<PolarLorentzVector>(pt,
                             int16_t(packedEta_)*6.0f/std::numeric_limits<int16_t>::max(),
                             phi,
                             MiniFloatConverter::float16to32(packedM_));
    auto p4c = std::make_unique<LorentzVector>( *p4 );
    PolarLorentzVector* expectp4= nullptr;
    if( p4_.compare_exchange_strong(expectp4,p4.get()) ) {
      p4.release();
    }

    //p4c_ works as the guard for unpacking so it
    // must be set last
    LorentzVector* expectp4c = nullptr;
    if(p4c_.compare_exchange_strong(expectp4c, p4c.get()) ) {
      p4c.release();
    }
}

void pat::PackedCandidate::unpackCovariance ( ) const

protected

Definition at line 84 of file PackedCandidate.cc.

References Exception, mps_fire::i, CovarianceParameterization::isValid(), funct::m, AlCaHLTBitMon_ParallelJobs::p, and edm::errors::UnimplementedFeature.

Referenced by maybeUnpackCovariance().

                                                {
    const CovarianceParameterization & p=covarianceParameterization();
    if(p.isValid()) 
    {
      auto m = std::make_unique<reco::TrackBase::CovarianceMatrix>() ;
      for(int i=0;i<5;i++)
        for(int j=0;j<5;j++){
          (*m)(i,j)=0;
      }
      unpackCovarianceElement(*m,packedCovariance_.dptdpt,0,0);
      unpackCovarianceElement(*m,packedCovariance_.detadeta,1,1);
      unpackCovarianceElement(*m,packedCovariance_.dphidphi,2,2);
      unpackCovarianceElement(*m,packedCovariance_.dxydxy,3,3);
      unpackCovarianceElement(*m,packedCovariance_.dzdz,4,4);
      unpackCovarianceElement(*m,packedCovariance_.dxydz,3,4);
      unpackCovarianceElement(*m,packedCovariance_.dlambdadz,1,4);
      unpackCovarianceElement(*m,packedCovariance_.dphidxy,2,3);
      reco::TrackBase::CovarianceMatrix* expected = nullptr;
      if( m_.compare_exchange_strong(expected,m.get()) ) {
         m.release();
      }

    } else {
     throw edm::Exception(edm::errors::UnimplementedFeature)
     << "You do not have a valid track parameters file loaded. "
     << "Please check that the release version is compatible with your input data"
     <<"or avoid accessing track parameter uncertainties. ";
    }
}

void pat::PackedCandidate::unpackCovarianceElement ( reco::TrackBase::CovarianceMatrix &  m, uint16_t  packed, int  i, int  j  ) const

inlineprivate

Definition at line 684 of file PackedCandidate.h.

References covarianceParameterization(), covarianceSchema_, eta(), funct::m, numberOfHits(), numberOfPixelHits(), pt(), and CovarianceParameterization::unpack().

                                                                                                        {
      m(i,j)= covarianceParameterization().unpack(packed,covarianceSchema_,i,j,pt(),eta(),numberOfHits(), numberOfPixelHits());
    }

float pat::PackedCandidate::unpackTimeError ( uint8_t  timeError )

staticprotected

Definition at line 403 of file PackedCandidate.cc.

Referenced by timeError().

                                                           {
    return timeError > 0 ? MIN_TIMEERROR * std::exp2(std::ldexp(float(timeError),-EXPO_TIMEERROR)) : -1.0f;
}

float pat::PackedCandidate::unpackTimeNoError ( int16_t  time )

staticprotected

Definition at line 406 of file PackedCandidate.cc.

References funct::abs().

Referenced by dtimeAssociatedPV(), and unpackTimeWithError().

                                                        {
    if (time == 0) return 0.f;
    return (time > 0 ? MIN_TIME_NOERROR : -MIN_TIME_NOERROR) * std::exp2(std::ldexp(float(std::abs(time)),-EXPO_TIME_NOERROR));
}

float pat::PackedCandidate::unpackTimeWithError ( int16_t  time, uint8_t  timeError  )

staticprotected

Definition at line 421 of file PackedCandidate.cc.

References objects.autophobj::float, and unpackTimeNoError().

Referenced by dtimeAssociatedPV().

                                                                             {
    if (time % 2 == 0) {
        // no overflow: drop rightmost bit and unpack in units of timeError
        return std::ldexp(unpackTimeError(timeError), EXPO_TIME_WITHERROR) * float(time/2);
    } else {
        // overflow: drop rightmost bit, unpack using the noError encoding
        return pat::PackedCandidate::unpackTimeNoError(time/2);
    }
}

void pat::PackedCandidate::unpackTrk ( ) const

protected

Definition at line 157 of file PackedCandidate.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, reco::HitPattern::getLayer(), reco::HitPattern::getSubStructure(), reco::TrackBase::highPurity, mps_fire::i, reco::TrackBase::loose, TrackingRecHit::missing_inner, ndof, p3, PixelSubdetector::PixelBarrel, PixelSubdetector::PixelEndcap, reco::HitPattern::pixelHitFilter(), reco::HitPattern::stripHitFilter(), StripSubdetector::TEC, StripSubdetector::TIB, StripSubdetector::TID, StripSubdetector::TOB, HiIsolationCommonParameters_cff::track, reco::TrackBase::undefAlgorithm, and TrackingRecHit::valid.

Referenced by maybeUnpackTrack(), packBoth(), and pseudoTrack().

                                         {
    maybeUnpackBoth();
    math::RhoEtaPhiVector p3(ptTrk(),etaAtVtx(),phiAtVtx());
    maybeUnpackCovariance();
    int numberOfStripLayers = stripLayersWithMeasurement(), numberOfPixelLayers = pixelLayersWithMeasurement();
    int numberOfPixelHits = this->numberOfPixelHits();
    int numberOfHits = this->numberOfHits();

    int ndof = numberOfHits+numberOfPixelHits-5;
    LostInnerHits innerLost = lostInnerHits();
    
    auto track = std::make_unique<reco::Track>(normalizedChi2_*ndof,ndof,*vertex_,math::XYZVector(p3.x(),p3.y(),p3.z()),charge(),*(m_.load()),reco::TrackBase::undefAlgorithm,reco::TrackBase::loose);
    int i=0;
    if ( firstHit_ == 0) { //Backward compatible 
       if(innerLost == validHitInFirstPixelBarrelLayer){
          track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, 1, 0, TrackingRecHit::valid);       
          i=1;
       } 
    } else {
       track->appendHitPattern(firstHit_,TrackingRecHit::valid);
    }

    if(firstHit_!=0 && reco::HitPattern::pixelHitFilter(firstHit_)) i=1;

    // add hits to match the number of laters and validHitInFirstPixelBarrelLayer
    if(innerLost == validHitInFirstPixelBarrelLayer){
        // then to encode the number of layers, we add more hits on distinct layers (B2, B3, B4, F1, ...)
        for(; i<numberOfPixelLayers; i++) {
            if (i <= 3) { 
                track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, i+1, 0, TrackingRecHit::valid); 
            } else {    
                track->appendTrackerHitPattern(PixelSubdetector::PixelEndcap, i-3, 0, TrackingRecHit::valid); 
            }
        }
    } else {
        // to encode the information on the layers, we add one valid hits per layer but skipping PXB1
        int iOffset=0;  
        if(firstHit_!=0 && reco::HitPattern::pixelHitFilter(firstHit_)) {
         iOffset=reco::HitPattern::getLayer(firstHit_);
         if(reco::HitPattern::getSubStructure(firstHit_)==PixelSubdetector::PixelEndcap) iOffset+=3;
    } else {iOffset=1; }
        for(;i<numberOfPixelLayers; i++) {
            if (i+iOffset <= 2 ) { track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, i+iOffset+1, 0, TrackingRecHit::valid);   }
        else {track->appendTrackerHitPattern(PixelSubdetector::PixelEndcap, i+iOffset-3+1, 0, TrackingRecHit::valid);  }

        }
    }
    // add extra hits (overlaps, etc), all on the first layer with a hit - to avoid increasing the layer count
    for(;i<numberOfPixelHits; i++) { 
       if(firstHit_ !=0 && reco::HitPattern::pixelHitFilter(firstHit_)) { 
          track->appendTrackerHitPattern(reco::HitPattern::getSubStructure(firstHit_), reco::HitPattern::getLayer(firstHit_), 0, TrackingRecHit::valid); 
    } else {
          track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, (innerLost == validHitInFirstPixelBarrelLayer ? 1 : 2), 0, TrackingRecHit::valid); 
    }
    }
    // now start adding strip layers, putting one hit on each layer so that the hitPattern.stripLayersWithMeasurement works.
    // we don't know what the layers where, so we just start with TIB (4 layers), then TOB (6 layers), then TEC (9)
    // and then TID(3), so that we can get a number of valid strip layers up to 4+6+9+3
    if(firstHit_!=0 && reco::HitPattern::stripHitFilter(firstHit_)) i+=1;
    int slOffset=0; 
    if(firstHit_!=0 && reco::HitPattern::stripHitFilter(firstHit_)) { 
         slOffset=reco::HitPattern::getLayer(firstHit_)-1;
         if(reco::HitPattern::getSubStructure(firstHit_)==StripSubdetector::TID) slOffset+=4;
         if(reco::HitPattern::getSubStructure(firstHit_)==StripSubdetector::TOB) slOffset+=7;
         if(reco::HitPattern::getSubStructure(firstHit_)==StripSubdetector::TEC) slOffset+=13;
    }
    for(int sl=slOffset; sl < numberOfStripLayers+slOffset; ++sl, ++i) {
        if      (sl < 4)    track->appendTrackerHitPattern(StripSubdetector::TIB,   sl   +1, 1, TrackingRecHit::valid);
        else if (sl < 4+3)  track->appendTrackerHitPattern(StripSubdetector::TID, (sl- 4)+1, 1, TrackingRecHit::valid);
        else if (sl < 7+6) track->appendTrackerHitPattern(StripSubdetector::TOB, (sl-7)+1, 1, TrackingRecHit::valid);
        else if (sl < 13+9) track->appendTrackerHitPattern(StripSubdetector::TEC, (sl-13)+1, 1, TrackingRecHit::valid);
        else break; // wtf?
    }
    // finally we account for extra strip hits beyond the one-per-layer added above. we put them all on TIB1,
    // to avoid incrementing the number of layersWithMeasurement.
    for(;i<numberOfHits;i++) {
      if(reco::HitPattern::stripHitFilter(firstHit_)) { 
              track->appendTrackerHitPattern(reco::HitPattern::getSubStructure(firstHit_),  reco::HitPattern::getLayer(firstHit_), 1, TrackingRecHit::valid);
      } else {
              track->appendTrackerHitPattern(StripSubdetector::TIB, 1, 1, TrackingRecHit::valid);
      }
    }


    switch (innerLost) {
        case validHitInFirstPixelBarrelLayer:
            break;
        case noLostInnerHits:
            break;
        case oneLostInnerHit:
            track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, 1, 0, TrackingRecHit::missing_inner);
            break;
        case moreLostInnerHits:
            track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, 1, 0, TrackingRecHit::missing_inner);
            track->appendTrackerHitPattern(PixelSubdetector::PixelBarrel, 2, 0, TrackingRecHit::missing_inner);
            break;
    };

    if (trackHighPurity()) track->setQuality(reco::TrackBase::highPurity);
    
    reco::Track* expected = nullptr;
    if( track_.compare_exchange_strong(expected,track.get()) ) {
      track.release();
    }


}

void pat::PackedCandidate::unpackVtx ( ) const

protected

Definition at line 114 of file PackedCandidate.cc.

References EnergyCorrector::c, funct::cos(), MiniFloatConverter::float16to32(), edm::Ref< C, T, F >::isNonnull(), SiStripPI::max, MetAnalyzer::pv(), alignCSCRings::s, and funct::sin().

Referenced by maybeUnpackBoth(), and packBoth().

                                         {
    reco::VertexRef pvRef = vertexRef();
    dphi_ = int16_t(packedDPhi_)*3.2f/std::numeric_limits<int16_t>::max(),
    deta_ = MiniFloatConverter::float16to32(packedDEta_);
    dtrkpt_ = MiniFloatConverter::float16to32(packedDTrkPt_);
    dxy_ = MiniFloatConverter::float16to32(packedDxy_)/100.;
    dz_   = pvRef.isNonnull() ? MiniFloatConverter::float16to32(packedDz_)/100. : int16_t(packedDz_)*40.f/std::numeric_limits<int16_t>::max();
    Point pv = pvRef.isNonnull() ? pvRef->position() : Point();
    float phi = p4_.load()->Phi()+dphi_, s = std::sin(phi), c = std::cos(phi);
    auto vertex = std::make_unique<Point>(pv.X() - dxy_ * s,
                    pv.Y() + dxy_ * c,
                    pv.Z() + dz_ ); // for our choice of using the PCA to the PV, by definition the remaining term -(dx*cos(phi) + dy*sin(phi))*(pz/pt) is zero

     

 
    Point* expected = nullptr;
    if( vertex_.compare_exchange_strong(expected,vertex.get()) ) {
      vertex.release();
    }
}

const Point& pat::PackedCandidate::vertex ( ) const

inlineoverridevirtual

vertex position

Implements reco::Candidate.

Definition at line 464 of file PackedCandidate.h.

References maybeUnpackBoth(), and vertex_.

Referenced by Tau.Tau::dxy(), operator=(), and setVertex().

{ maybeUnpackBoth(); return *vertex_; }//{ if (fromPV_) return Point(0,0,0); else return Point(0,0,100); }

double pat::PackedCandidate::vertexChi2 ( ) const

overridevirtual

chi-squares

Implements reco::Candidate.

Definition at line 327 of file PackedCandidate.cc.

Referenced by clone().

                                            {
  return 0;
}

double pat::PackedCandidate::vertexCovariance ( int  i, int  j  ) const

overridevirtual

(i, j)-th element of error matrix, i, j = 0, ... 2

Implements reco::Candidate.

Definition at line 339 of file PackedCandidate.cc.

References Exception, and edm::errors::UnimplementedFeature.

                                                              {
  throw edm::Exception(edm::errors::UnimplementedFeature)
    << "reco::ConcreteCandidate does not implement vertex covariant matrix.\n";
}

CovarianceMatrix pat::PackedCandidate::vertexCovariance ( ) const

inlineoverridevirtual

return SMatrix

Reimplemented from reco::Candidate.

Definition at line 604 of file PackedCandidate.h.

References fillVertexCovariance(), hasMasterClone(), hasMasterClonePtr(), funct::m, masterClone(), masterClonePtr(), and findQualityFiles::v.

Referenced by clone().

{ CovarianceMatrix m; fillVertexCovariance(m); return m; }

double pat::PackedCandidate::vertexNdof ( ) const

overridevirtual

Number of degrees of freedom Meant to be Double32_t for soft-assignment fitters: tracks may contribute to the vertex with fractional weights. The ndof is then = to the sum of the track weights. see e.g. CMS NOTE-2006/032, CMS NOTE-2004/002

Implements reco::Candidate.

Definition at line 331 of file PackedCandidate.cc.

Referenced by clone().

                                            {
  return 0;
}

double pat::PackedCandidate::vertexNormalizedChi2 ( ) const

overridevirtual

chi-squared divided by n.d.o.f.

Implements reco::Candidate.

Definition at line 335 of file PackedCandidate.cc.

Referenced by clone().

                                                      {
  return 0;
}

const reco::VertexRef pat::PackedCandidate::vertexRef ( ) const

inline

Definition at line 491 of file PackedCandidate.h.

References pvRefKey_, and pvRefProd_.

Referenced by pat::PATPackedCandidateProducer::candsOrdering(), fromPV(), PuppiProducer::produce(), setTime(), and time().

{ return reco::VertexRef(pvRefProd_, pvRefKey_); }

double pat::PackedCandidate::vx ( ) const

inlineoverridevirtual

x coordinate of vertex position

Implements reco::Candidate.

Definition at line 466 of file PackedCandidate.h.

References maybeUnpackBoth(), and vertex_.

{ maybeUnpackBoth(); return vertex_.load()->X(); }//{ return 0; }

double pat::PackedCandidate::vy ( ) const

inlineoverridevirtual

y coordinate of vertex position

Implements reco::Candidate.

Definition at line 468 of file PackedCandidate.h.

References maybeUnpackBoth(), and vertex_.

{ maybeUnpackBoth(); return vertex_.load()->Y(); }//{ return 0; }

double pat::PackedCandidate::vz ( ) const

inlineoverridevirtual

z coordinate of vertex position

Implements reco::Candidate.

Definition at line 470 of file PackedCandidate.h.

References maybeUnpackBoth(), and vertex_.

{ maybeUnpackBoth(); return vertex_.load()->Z(); }//{ if (fromPV_) return 0; else return 100; }

double pat::PackedCandidate::y ( ) const

inlineoverridevirtual

rapidity

Implements reco::Candidate.

Definition at line 380 of file PackedCandidate.h.

References p4_, p4c_, and unpack().

Referenced by svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), geometryXMLparser.Alignable::pos(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

{ if (!p4c_) unpack(); return p4_.load()->Rapidity(); }

Friends And Related Function Documentation

friend class ::OverlapChecker

friend

Definition at line 762 of file PackedCandidate.h.

friend class ::testPackedCandidate

friend

Definition at line 692 of file PackedCandidate.h.

template<typename , typename , typename >

friend struct component

friend

Definition at line 761 of file PackedCandidate.h.

friend class ShallowCloneCandidate

friend

Definition at line 763 of file PackedCandidate.h.

friend class ShallowClonePtrCandidate

friend

Definition at line 764 of file PackedCandidate.h.

Member Data Documentation

std::once_flag pat::PackedCandidate::covariance_load_flag

staticprotected

Definition at line 747 of file PackedCandidate.h.

CovarianceParameterization pat::PackedCandidate::covarianceParameterization_

staticprotected

Definition at line 745 of file PackedCandidate.h.

Referenced by covarianceParameterization().

uint16_t pat::PackedCandidate::covarianceSchema_

protected

Definition at line 744 of file PackedCandidate.h.

Referenced by covarianceSchema(), operator=(), packCovarianceElement(), setTrackProperties(), and unpackCovarianceElement().

uint16_t pat::PackedCandidate::covarianceVersion_

protected

Definition at line 743 of file PackedCandidate.h.

Referenced by covarianceParameterization(), covarianceVersion(), operator=(), setCovarianceVersion(), and setTrackProperties().

float pat::PackedCandidate::deta_

mutableprotected

Definition at line 727 of file PackedCandidate.h.

Referenced by etaAtVtx(), operator=(), setP4(), and setPz().

float pat::PackedCandidate::dphi_

mutableprotected

Definition at line 727 of file PackedCandidate.h.

Referenced by operator=(), phiAtVtx(), setP4(), and setPz().

float pat::PackedCandidate::dtrkpt_

mutableprotected

Definition at line 727 of file PackedCandidate.h.

Referenced by operator=(), ptTrk(), setP4(), and setPz().

float pat::PackedCandidate::dxy_

mutableprotected

Definition at line 727 of file PackedCandidate.h.

Referenced by dxy(), and operator=().

float pat::PackedCandidate::dz_

mutableprotected

Definition at line 727 of file PackedCandidate.h.

Referenced by dz(), dzAssociatedPV(), and operator=().

int pat::PackedCandidate::EXPO_TIME_NOERROR = 6

staticprotected

Definition at line 784 of file PackedCandidate.h.

int pat::PackedCandidate::EXPO_TIME_WITHERROR = -6

staticprotected

Definition at line 785 of file PackedCandidate.h.

int pat::PackedCandidate::EXPO_TIMEERROR = 5

staticprotected

Definition at line 783 of file PackedCandidate.h.

uint16_t pat::PackedCandidate::firstHit_

Definition at line 787 of file PackedCandidate.h.

Referenced by firstHit(), operator=(), and setFirstHit().

int8_t pat::PackedCandidate::hcalFraction_

protected

Definition at line 716 of file PackedCandidate.h.

Referenced by hcalFraction(), and operator=().

bool pat::PackedCandidate::isIsolatedChargedHadron_

protected

Definition at line 720 of file PackedCandidate.h.

Referenced by isIsolatedChargedHadron(), and operator=().

float pat::PackedCandidate::kMinDEtaToStore_ =0.001

staticprotected

Definition at line 693 of file PackedCandidate.h.

float pat::PackedCandidate::kMinDTrkPtToStore_ =0.001

staticprotected

Definition at line 694 of file PackedCandidate.h.

const unsigned int pat::PackedCandidate::longLivedTag = 0

static

long lived flag

Definition at line 573 of file PackedCandidate.h.

std::atomic<reco::TrackBase::CovarianceMatrix *> pat::PackedCandidate::m_

mutableprotected

IP covariance.

Definition at line 738 of file PackedCandidate.h.

Referenced by dxyError(), dzError(), maybeUnpackCovariance(), and operator=().

const unsigned int pat::PackedCandidate::massConstraintTag = 0

static

do mass constraint flag

Definition at line 579 of file PackedCandidate.h.

float pat::PackedCandidate::MIN_TIME_NOERROR = 0.0002f

staticprotected

Definition at line 782 of file PackedCandidate.h.

float pat::PackedCandidate::MIN_TIMEERROR = 0.002f

staticprotected

Definition at line 781 of file PackedCandidate.h.

uint8_t pat::PackedCandidate::normalizedChi2_

protected

track quality information

Definition at line 742 of file PackedCandidate.h.

Referenced by operator=(), and setTrackProperties().

std::atomic<PolarLorentzVector*> pat::PackedCandidate::p4_

mutableprotected

the four vector

Definition at line 723 of file PackedCandidate.h.

Referenced by eta(), etaAtVtx(), mass(), massSqr(), mt(), mtSqr(), operator=(), packBoth(), phi(), phiAtVtx(), polarP4(), pt(), ptTrk(), rapidity(), setMass(), setP4(), setPz(), theta(), and y().

std::atomic<LorentzVector*> pat::PackedCandidate::p4c_

mutableprotected

Definition at line 724 of file PackedCandidate.h.

Referenced by boostToCM(), energy(), et(), et2(), eta(), mass(), massSqr(), maybeUnpackBoth(), momentum(), mt(), mtSqr(), operator=(), p(), p4(), packBoth(), phi(), polarP4(), pt(), px(), py(), pz(), rapidity(), setMass(), setPz(), theta(), and y().

PackedCovariance pat::PackedCandidate::packedCovariance_

protected

Definition at line 699 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedDEta_

protected

Definition at line 698 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedDPhi_

protected

Definition at line 698 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedDTrkPt_

protected

Definition at line 698 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedDxy_

protected

Definition at line 698 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedDz_

protected

Definition at line 698 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedEta_

protected

Definition at line 697 of file PackedCandidate.h.

Referenced by operator=().

uint8_t pat::PackedCandidate::packedHits_

protected

Definition at line 739 of file PackedCandidate.h.

Referenced by bestTrack(), hasTrackDetails(), numberOfHits(), numberOfPixelHits(), operator=(), and setHits().

uint8_t pat::PackedCandidate::packedLayers_

protected

Definition at line 739 of file PackedCandidate.h.

Referenced by bestTrack(), hasTrackDetails(), operator=(), pixelLayersWithMeasurement(), setHits(), and stripLayersWithMeasurement().

uint16_t pat::PackedCandidate::packedM_

protected

Definition at line 697 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedPhi_

protected

Definition at line 697 of file PackedCandidate.h.

Referenced by operator=().

uint16_t pat::PackedCandidate::packedPt_

protected

Definition at line 697 of file PackedCandidate.h.

Referenced by operator=().

uint8_t pat::PackedCandidate::packedPuppiweight_

protected

Definition at line 713 of file PackedCandidate.h.

Referenced by operator=().

int8_t pat::PackedCandidate::packedPuppiweightNoLepDiff_

protected

Definition at line 714 of file PackedCandidate.h.

Referenced by operator=().

int16_t pat::PackedCandidate::packedTime_

protected

Definition at line 717 of file PackedCandidate.h.

Referenced by dtimeAssociatedPV(), and operator=().

uint8_t pat::PackedCandidate::packedTimeError_

protected

Definition at line 718 of file PackedCandidate.h.

Referenced by dtimeAssociatedPV(), operator=(), and timeError().

int pat::PackedCandidate::pdgId_

protected

PDG identifier.

Definition at line 731 of file PackedCandidate.h.

Referenced by charge(), operator=(), pdgId(), and setPdgId().

reco::VertexRef::key_type pat::PackedCandidate::pvRefKey_

protected

Definition at line 735 of file PackedCandidate.h.

Referenced by dtime(), dz(), operator=(), and vertexRef().

reco::VertexRefProd pat::PackedCandidate::pvRefProd_

protected

Use these to build a Ref to primary vertex.

Definition at line 734 of file PackedCandidate.h.

Referenced by operator=(), and vertexRef().

uint16_t pat::PackedCandidate::qualityFlags_

protected

Definition at line 732 of file PackedCandidate.h.

Referenced by isGlobalMuon(), isGoodEgamma(), isStandAloneMuon(), lostInnerHits(), operator=(), pvAssociationQuality(), setAssociationQuality(), setGoodEgamma(), setLostInnerHits(), setMuonID(), setTrackHighPurity(), status(), and trackHighPurity().

uint8_t pat::PackedCandidate::rawCaloFraction_

protected

Definition at line 715 of file PackedCandidate.h.

Referenced by operator=(), and rawCaloFraction().

std::atomic<reco::Track*> pat::PackedCandidate::track_

mutableprotected

reco::Track

Definition at line 729 of file PackedCandidate.h.

Referenced by bestTrack(), maybeUnpackTrack(), operator=(), and pseudoTrack().

std::atomic<Point*> pat::PackedCandidate::vertex_

mutableprotected

vertex position

Definition at line 726 of file PackedCandidate.h.

Referenced by maybeUnpackBoth(), operator=(), packBoth(), setVertex(), vertex(), vx(), vy(), and vz().