Analysis-level Generic Particle class (e.g. for hadron or muon not fully reconstructed) More...

#include "DataFormats/PatCandidates/interface/GenericParticle.h"

Inheritance diagram for pat::GenericParticle:

Public Member Functions
float	caloIso () const

CaloTowerRef	caloTower () const override

GenericParticle *	clone () const override
	required reimplementation of the Candidate's clone method More...

reco::TrackRef	combinedMuon () const override

float	ecalIso () const

const IsoDeposit *	ecalIsoDeposit () const

void	ecalIsoDeposit (const IsoDeposit &dep)

void	embedCaloTower ()
	embeds the calotower instead of keeping a reference to it More...

void	embedCombined ()
	embeds the combined track instead of keeping a reference to it More...

void	embedGsfTrack ()
	embeds the gsf track instead of keeping a reference to it More...

void	embedStandalone ()
	embeds the stand-alone track instead of keeping a reference to it More...

void	embedSuperCluster ()
	embeds the supercluster instead of keeping a reference to it More...

void	embedTrack ()
	embeds the master track instead of keeping a reference to it More...

void	embedTracks ()
	embeds the other tracks instead of keeping references More...

	GenericParticle ()
	default constructor More...

	GenericParticle (const edm::Ptr< reco::Candidate > &aGenericParticleRef)
	constructor from ref to Candidate More...

	GenericParticle (const edm::RefToBase< reco::Candidate > &aGenericParticleRef)
	constructor from ref to Candidate More...

	GenericParticle (const reco::Candidate &aGenericParticle)
	constructor from Candidate More...

reco::GsfTrackRef	gsfTrack () const override

float	hcalIso () const

const IsoDeposit *	hcalIsoDeposit () const

void	hcalIsoDeposit (const IsoDeposit &dep)

const IsoDeposit *	isoDeposit (IsolationKeys key) const
	Returns the IsoDeposit associated with some key, or a null pointer if it is not available. More...

size_t	numberOfTracks () const override
	number of multiple tracks (not including the master one) More...

bool	overlap (const Candidate &) const override

float	quality ()
	returns a user defined quality value, if set by the user to some meaningful value More...

virtual void	setCaloTower (const CaloTowerRef &ref, bool embed=false)
	sets calotower reference (or even embed it into the object) More...

virtual void	setCombinedMuon (const reco::TrackRef &ref, bool embed=false)
	sets combined muon track reference (or even embed it into the object) More...

void	setEcalIso (float caloIso)
	Sets ecal isolation variable. More...

virtual void	setGsfTrack (const reco::GsfTrackRef &ref, bool embed=false)
	sets gsf track reference (or even embed it into the object) More...

void	setHcalIso (float caloIso)
	Sets hcal isolation variable. More...

void	setIsoDeposit (IsolationKeys key, const IsoDeposit &dep)
	Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten. More...

void	setIsolation (IsolationKeys key, float value)

void	setQuality (float quality)
	sets a user defined quality value More...

virtual void	setStandAloneMuon (const reco::TrackRef &ref, bool embed=false)
	sets stand-alone muon track reference (or even embed it into the object) More...

virtual void	setSuperCluster (const reco::SuperClusterRef &ref, bool embed=false)
	sets supercluster reference (or even embed it into the object) More...

virtual void	setTrack (const reco::TrackRef &ref, bool embed=false)
	sets master track reference (or even embed it into the object) More...

void	setTrackIso (float trackIso)
	Sets tracker isolation variable. More...

virtual void	setTracks (const reco::TrackRefVector &refs, bool embed=false)
	sets multiple track references (or even embed the tracks into the object - whatch out for disk size issues!) More...

void	setUserIso (float value, uint8_t index=0)
	Sets user isolation variable index. More...

void	setVertexAssociation (const pat::VertexAssociation &assoc)
	Set a single vertex association. More...

void	setVertexAssociations (const std::vector< pat::VertexAssociation > &assocs)
	Set multiple vertex associations. More...

reco::TrackRef	standAloneMuon () const override

reco::SuperClusterRef	superCluster () const override

reco::TrackRef	track () const override

reco::TrackRef	track (size_t idx) const override

float	trackIso () const

const IsoDeposit *	trackIsoDeposit () const

void	trackIsoDeposit (const IsoDeposit &dep)

void	userIsoDeposit (const IsoDeposit &dep, uint8_t index=0)

const IsoDeposit *	userIsoDeposit (uint8_t index=0) const

float	userIsolation (const std::string &key) const

float	userIsolation (IsolationKeys key) const

const pat::VertexAssociation *	vertexAssociation (size_t index=0) const
	Vertex association (or associations, if any). Return null pointer if none has been set. More...

const std::vector< pat::VertexAssociation > &	vertexAssociations () const
	Vertex associations. Can be empty if it was not enabled in the config file. More...

	~GenericParticle () override
	destructor More...

Public Member Functions inherited from pat::PATObject< reco::RecoCandidate >
void	addGenParticleRef (const reco::GenParticleRef &ref)

void	addTriggerObjectMatch (const TriggerObjectStandAlone &trigObj)
	add a trigger match More...

void	addUserCand (const std::string &label, const reco::CandidatePtr &data, const bool overwrite=false)
	Set user-defined int. More...

void	addUserData (const std::string &label, const T &data, bool transientOnly=false, bool overwrite=false)

void	addUserDataFromPtr (const std::string &label, const edm::Ptr< pat::UserData > &data, bool overwrite=false)

void	addUserFloat (const std::string &label, float data, const bool overwrite=false)
	Set user-defined float. More...

void	addUserInt (const std::string &label, int32_t data, const bool overwrite=false)
	Set user-defined int. More...

std::vector< std::pair< std::string, pat::LookupTableRecord > >	efficiencies () const
	Returns the efficiencies as <name,value> pairs (by value) More...

const pat::LookupTableRecord &	efficiency (const std::string &name) const
	Returns an efficiency given its name. More...

const std::vector< std::string > &	efficiencyNames () const
	Returns the list of the names of the stored efficiencies. More...

const std::vector< pat::LookupTableRecord > &	efficiencyValues () const
	Returns the list of the values of the stored efficiencies (the ordering is the same as in efficiencyNames()) More...

void	embedGenParticle ()

const reco::GenParticle *	genParticle (size_t idx=0) const

reco::GenParticleRef	genParticleById (int pdgId, int status, uint8_t autoCharge=0) const

reco::GenParticleRef	genParticleRef (size_t idx=0) const

std::vector< reco::GenParticleRef >	genParticleRefs () const

size_t	genParticlesSize () const
	Number of generator level particles stored as ref or embedded. More...

const pat::CandKinResolution &	getKinResolution (const std::string &label="") const

bool	hasKinResolution (const std::string &label="") const
	Check if the kinematic resolutions are stored into this object (possibly specifying a label for them) More...

bool	hasOverlaps (const std::string &label) const
	Returns true if there was at least one overlap for this test label. More...

bool	hasUserCand (const std::string &key) const
	Return true if there is a user-defined int with a given name. More...

bool	hasUserData (const std::string &key) const
	Check if user data with a specific type is present. More...

bool	hasUserFloat (const char *key) const
	a CINT-friendly interface More...

bool	hasUserFloat (const std::string &key) const
	Return true if there is a user-defined float with a given name. More...

bool	hasUserInt (const std::string &key) const
	Return true if there is a user-defined int with a given name. More...

const reco::Candidate *	originalObject () const
	access to the original object; returns zero for null Ref and throws for unavailable collection More...

const edm::Ptr< reco::Candidate > &	originalObjectRef () const
	reference to original object. Returns a null reference if not available More...

const std::vector< std::string > &	overlapLabels () const
	Returns the labels of the overlap tests that found at least one overlap. More...

const reco::CandidatePtrVector &	overlaps (const std::string &label) const

	PATObject ()
	default constructor More...

	PATObject (const edm::Ptr< reco::RecoCandidate > &ref)
	constructor from reference More...

	PATObject (const edm::RefToBase< reco::RecoCandidate > &ref)
	constructor from reference More...

	PATObject (const reco::RecoCandidate &obj)
	constructor from a base object (leaves invalid reference to original object!) More...

double	resolE (const std::string &label="") const
	Resolution on energy, possibly with a label to specify which resolution to use. More...

double	resolEt (const std::string &label="") const
	Resolution on et, possibly with a label to specify which resolution to use. More...

double	resolEta (const std::string &label="") const
	Resolution on eta, possibly with a label to specify which resolution to use. More...

double	resolM (const std::string &label="") const

double	resolP (const std::string &label="") const
	Resolution on p, possibly with a label to specify which resolution to use. More...

double	resolPhi (const std::string &label="") const
	Resolution on phi, possibly with a label to specify which resolution to use. More...

double	resolPInv (const std::string &label="") const
	Resolution on 1/p, possibly with a label to specify which resolution to use. More...

double	resolPt (const std::string &label="") const
	Resolution on pt, possibly with a label to specify which resolution to use. More...

double	resolPx (const std::string &label="") const
	Resolution on px, possibly with a label to specify which resolution to use. More...

double	resolPy (const std::string &label="") const
	Resolution on py, possibly with a label to specify which resolution to use. More...

double	resolPz (const std::string &label="") const
	Resolution on pz, possibly with a label to specify which resolution to use. More...

double	resolTheta (const std::string &label="") const
	Resolution on theta, possibly with a label to specify which resolution to use. More...

void	setEfficiency (const std::string &name, const pat::LookupTableRecord &value)

void	setGenParticle (const reco::GenParticle &particle)
	Set the generator level particle from a particle not in the Event (embedding it, of course) More...

void	setGenParticleRef (const reco::GenParticleRef &ref, bool embed=false)
	Set the generator level particle reference. More...

void	setKinResolution (const pat::CandKinResolution &resol, const std::string &label="")
	Add a kinematic resolution to this object (possibly with a label) More...

void	setOverlaps (const std::string &label, const reco::CandidatePtrVector &overlaps)

const TriggerObjectStandAlone *	triggerObjectMatch (const size_t idx=0) const
	get one matched trigger object by index More...

const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByCollection (const char *coll, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByCollection (const std::string &coll, const size_t idx=0) const
	get one matched trigger object from a certain collection by index More...

const TriggerObjectStandAlone *	triggerObjectMatchByCondition (const char *nameCondition, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByCondition (const std::string &nameCondition, const size_t idx=0) const
	get one matched L1 object used in a succeeding object combination of a certain L1 condition by index More...

const TriggerObjectStandAlone *	triggerObjectMatchByFilter (const char *labelFilter, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByFilter (const std::string &labelFilter, const size_t idx=0) const
	get one matched HLT object used in a certain HLT filter by index More...

const TriggerObjectStandAlone *	triggerObjectMatchByFilterID (const unsigned triggerObjectType, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const

const TriggerObjectStandAlone *	triggerObjectMatchByType (const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
	get one matched trigger object of a certain type by index More...

const TriggerObjectStandAlone *	triggerObjectMatchByType (const unsigned triggerObjectType, const size_t idx=0) const

const TriggerObjectStandAloneCollection &	triggerObjectMatches () const
	get all matched trigger objects More...

const TriggerObjectStandAloneCollection	triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByCollection (const char *coll) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByCollection (const std::string &coll) const
	get all matched trigger objects from a certain collection More...

const TriggerObjectStandAloneCollection	triggerObjectMatchesByCondition (const char *nameCondition) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByCondition (const std::string &nameCondition) const
	get all matched L1 objects used in a succeeding object combination of a certain L1 condition More...

const TriggerObjectStandAloneCollection	triggerObjectMatchesByFilter (const char *labelFilter) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByFilter (const std::string &labelFilter) const
	get all matched HLT objects used in a certain HLT filter More...

const TriggerObjectStandAloneCollection	triggerObjectMatchesByFilterID (const unsigned triggerObjectType) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByType (const trigger::TriggerObjectType triggerObjectType) const

const TriggerObjectStandAloneCollection	triggerObjectMatchesByType (const unsigned triggerObjectType) const

void	unpackTriggerObjectPathNames (const edm::TriggerNames &names)
	unpack path names of matched trigger objects (if they were packed before embedding, which is not normally the case) More...

reco::CandidatePtr	userCand (const std::string &key) const

const std::vector< std::string > &	userCandNames () const
	Get list of user-defined cand names. More...

const T *	userData (const std::string &key) const
	Returns user-defined data. Returns NULL if the data is not present, or not of type T. More...

const void *	userDataBare (const std::string &key) const

const std::vector< std::string > &	userDataNames () const
	Get list of user data object names. More...

const std::string &	userDataObjectType (const std::string &key) const
	Get human-readable type of user data object, for debugging. More...

float	userFloat (const char *key) const
	a CINT-friendly interface More...

float	userFloat (const std::string &key) const

const std::vector< std::string > &	userFloatNames () const
	Get list of user-defined float names. More...

std::vector< float >	userFloatRange (const std::string &key) const
	return a range of values corresponding to key More...

int32_t	userInt (const std::string &key) const

const std::vector< std::string > &	userIntNames () const
	Get list of user-defined int names. More...

std::vector< int >	userIntRange (const std::string &key) const
	returns a range of values corresponding to key More...

	~PATObject () override
	destructor More...

Public Member Functions inherited from reco::RecoCandidate
const Track *	bestTrack () const override
	best track pointer More...

virtual TrackBaseRef	bestTrackRef () const
	best track RefToBase More...

virtual TrackType	bestTrackType () const
	track type More...

RecoCandidate *	clone () const override
	returns a clone of the Candidate object More...

float	dxyError () const override
	uncertainty on dxy More...

float	dzError () const override
	uncertainty on dz More...

bool	overlap (const Candidate &) const override=0
	check overlap with another candidate More...

	RecoCandidate ()
	default constructor More...

template<typename P4 >
	RecoCandidate (Charge q, const P4 &p4, const Point &vtx=Point(0, 0, 0), int pdgId=0, int status=0)
	constructor from values More...

	~RecoCandidate () override
	destructor More...

Public Member Functions inherited from reco::LeafCandidate
Vector	boostToCM () const final

int	charge () const final
	electric charge More...

void	construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)

const Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...

Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...

const Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...

Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...

double	energy () const final
	energy More...

double	et () const final
	transverse energy More...

double	et2 () const final
	transverse energy squared (use this for cut!) More...

double	eta () const final
	momentum pseudorapidity More...

void	fillVertexCovariance (CovarianceMatrix &v) const override
	fill SMatrix More...

template<typename T >
T	get () const
	get a component More...

template<typename T , typename Tag >
T	get () const
	get a component More...

template<typename T >
T	get (size_type i) const
	get a component More...

template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...

bool	hasMasterClone () const override

bool	hasMasterClonePtr () const override

bool	isCaloMuon () const override

bool	isConvertedPhoton () const override

bool	isElectron () const override

bool	isGlobalMuon () const override

bool	isJet () const override

bool	isMuon () const override

bool	isPhoton () const override

bool	isStandAloneMuon () const override

bool	isTrackerMuon () const override

	LeafCandidate ()

template<typename... Args>
	LeafCandidate (Args &&... args)

	LeafCandidate (const Candidate &c)

	LeafCandidate (LeafCandidate &&)=default

	LeafCandidate (LeafCandidate &rh)

	LeafCandidate (LeafCandidate const &)=default

bool	longLived () const final
	is long lived? More...

double	mass () const final
	mass More...

bool	massConstraint () const final
	do mass constraint? More...

double	massSqr () const final
	mass squared More...

const CandidateBaseRef &	masterClone () const override

const CandidatePtr &	masterClonePtr () const override

template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...

Vector	momentum () const final
	spatial momentum vector More...

const Candidate *	mother (size_type) const override
	return mother at a given position (throws an exception) More...

double	mt () const final
	transverse mass More...

double	mtSqr () const final
	transverse mass squared More...

template<typename T >
size_type	numberOf () const
	number of components More...

template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...

size_t	numberOfDaughters () const override
	number of daughters More...

size_t	numberOfMothers () const override
	number of mothers More...

size_t	numberOfSourceCandidatePtrs () const override

LeafCandidate &	operator= (LeafCandidate &&)=default

LeafCandidate &	operator= (LeafCandidate const &)=default

double	p () const final
	magnitude of momentum vector More...

const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...

int	pdgId () const final
	PDG identifier. More...

double	phi () const final
	momentum azimuthal angle More...

const PolarLorentzVector &	polarP4 () const final
	four-momentum Lorentz vector More...

double	pt () const final
	transverse momentum More...

double	px () const final
	x coordinate of momentum vector More...

double	py () const final
	y coordinate of momentum vector More...

double	pz () const final
	z coordinate of momentum vector More...

double	rapidity () const final
	rapidity More...

void	setCharge (Charge q) final
	set electric charge More...

void	setLongLived () final

void	setMass (double m) final
	set particle mass More...

void	setMassConstraint () final

void	setP4 (const LorentzVector &p4) final
	set 4-momentum More...

void	setP4 (const PolarLorentzVector &p4) final
	set 4-momentum More...

void	setPdgId (int pdgId) final

void	setPz (double pz) final

void	setStatus (int status) final
	set status word More...

void	setThreeCharge (Charge qx3) final
	set electric charge More...

void	setVertex (const Point &vertex) override
	set vertex More...

CandidatePtr	sourceCandidatePtr (size_type i) const override

int	status () const final
	status word More...

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

int	threeCharge () const final
	electric charge More...

const Point &	vertex () const override
	vertex position (overwritten by PF...) More...

double	vertexChi2 () const override
	chi-squares More...

CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...

double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...

double	vertexNdof () const override

double	vertexNormalizedChi2 () const override
	chi-squared divided by n.d.o.f. More...

double	vx () const override
	x coordinate of vertex position More...

double	vy () const override
	y coordinate of vertex position More...

double	vz () const override
	z coordinate of vertex position More...

double	y () const final
	rapidity More...

	~LeafCandidate () override
	destructor More...

Public Member Functions inherited from reco::Candidate
iterator	begin ()
	first daughter iterator More...

const_iterator	begin () const
	first daughter const_iterator More...

	Candidate ()
	default constructor More...

iterator	end ()
	last daughter iterator More...

const_iterator	end () const
	last daughter const_iterator More...

template<typename T >
T	get () const
	get a component More...

template<typename T , typename Tag >
T	get () const
	get a component More...

template<typename T >
T	get (size_type i) const
	get a component More...

template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...

template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...

template<typename T >
size_type	numberOf () const
	number of components More...

template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...

virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate. More...

virtual	~Candidate ()
	destructor More...

Protected Types
typedef std::vector< std::pair< IsolationKeys, pat::IsoDeposit > >	IsoDepositPairs

Protected Member Functions
void	fillInFrom (const reco::Candidate &cand)

Protected Member Functions inherited from pat::PATObject< reco::RecoCandidate >
void	addUserDataObject_ (const std::string &label, std::unique_ptr< pat::UserData > value, bool overwrite=false)

Protected Member Functions inherited from reco::RecoCandidate
template<typename R >
bool	checkOverlap (const R &r1, const R &r2) const
	check if two components overlap More...

Protected Attributes
CaloTowerCollection	caloTower_

CaloTowerRef	caloTowerRef_

reco::TrackCollection	combinedTrack_

reco::TrackRef	combinedTrackRef_

reco::GsfTrackCollection	gsfTrack_

reco::GsfTrackRef	gsfTrackRef_

IsoDepositPairs	isoDeposits_

std::vector< float >	isolations_

float	quality_

reco::TrackCollection	standaloneTrack_

reco::TrackRef	standaloneTrackRef_

reco::SuperClusterCollection	superCluster_

reco::SuperClusterRef	superClusterRef_

reco::TrackCollection	track_

reco::TrackRef	trackRef_

reco::TrackRefVector	trackRefs_

reco::TrackCollection	tracks_

std::vector< pat::VertexAssociation >	vtxAss_

Protected Attributes inherited from pat::PATObject< reco::RecoCandidate >
std::vector< std::string >	efficiencyNames_
	vector of the efficiencies (names) More...

std::vector< pat::LookupTableRecord >	efficiencyValues_
	vector of the efficiencies (values) More...

std::vector< reco::GenParticle >	genParticleEmbedded_
	vector to hold an embedded generator level particle More...

std::vector< reco::GenParticleRef >	genParticleRef_
	Reference to a generator level particle. More...

std::vector< std::string >	kinResolutionLabels_

std::vector< pat::CandKinResolution >	kinResolutions_
	Kinematic resolutions. More...

std::vector< reco::CandidatePtrVector >	overlapItems_
	Overlapping items (sorted by distance) More...

std::vector< std::string >	overlapLabels_
	Overlapping test labels (only if there are any overlaps) More...

edm::Ptr< reco::Candidate >	refToOrig_

TriggerObjectStandAloneCollection	triggerObjectMatchesEmbedded_
	vector of trigger matches More...

std::vector< std::string >	userCandLabels_

std::vector< reco::CandidatePtr >	userCands_

std::vector< std::string >	userDataLabels_
	User data object. More...

pat::UserDataCollection	userDataObjects_

std::vector< std::string >	userFloatLabels_

std::vector< float >	userFloats_

std::vector< std::string >	userIntLabels_

std::vector< int32_t >	userInts_

Additional Inherited Members
Public Types inherited from pat::PATObject< reco::RecoCandidate >
typedef reco::RecoCandidate	base_type

Public Types inherited from reco::RecoCandidate
enum	TrackType { noTrackType, recoTrackType, gsfTrackType }
	track type More...

Public Types inherited from reco::LeafCandidate
typedef int	Charge
	electric charge type More...

typedef CandidateCollection	daughters
	collection of daughter candidates More...

typedef unsigned int	index

typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...

typedef math::XYZPoint	Point
	point in the space More...

typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...

typedef math::XYZVector	Vector
	point in the space More...

Public Types inherited from reco::Candidate
enum	{ dimension = 3 }

enum	{ size = dimension * (dimension + 1) / 2 }
	matix size More...

typedef int	Charge
	electric charge type More...

typedef candidate::const_iterator	const_iterator

typedef math::Error< dimension >::type	CovarianceMatrix
	covariance error matrix (3x3) More...

typedef unsigned int	index
	index type More...

typedef candidate::iterator	iterator

typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...

typedef math::XYZPoint	Point
	point in the space More...

typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...

typedef size_t	size_type

typedef math::XYZVector	Vector
	point in the space More...

Detailed Description

Analysis-level Generic Particle class (e.g. for hadron or muon not fully reconstructed)

GenericParticle implements the analysis-level generic particle class within the 'pat' namespace.

Author: Giovanni Petrucciani

Definition at line 38 of file GenericParticle.h.

Member Typedef Documentation

◆ IsoDepositPairs

typedef std::vector<std::pair<IsolationKeys, pat::IsoDeposit> > pat::GenericParticle::IsoDepositPairs

protected

Definition at line 315 of file GenericParticle.h.

Constructor & Destructor Documentation

◆ GenericParticle() [1/4]

GenericParticle::GenericParticle ( )

default constructor

Definition at line 9 of file GenericParticle.cc.

9 : PATObject<reco::RecoCandidate>() {}

Referenced by clone().

◆ GenericParticle() [2/4]

pat::GenericParticle::GenericParticle ( const reco::Candidate & aGenericParticle )

constructor from Candidate

◆ GenericParticle() [3/4]

pat::GenericParticle::GenericParticle ( const edm::RefToBase< reco::Candidate > & aGenericParticleRef )

constructor from ref to Candidate

◆ GenericParticle() [4/4]

pat::GenericParticle::GenericParticle ( const edm::Ptr< reco::Candidate > & aGenericParticleRef )

constructor from ref to Candidate

◆ ~GenericParticle()

GenericParticle::~GenericParticle ( )

override

destructor

Definition at line 27 of file GenericParticle.cc.

27 {}

Member Function Documentation

◆ caloIso()

float pat::GenericParticle::caloIso ( ) const

inline

Return the sum of ecal and hcal isolation variable that were stored in this object when produced, or -1.0 if at least one is missing

Definition at line 222 of file GenericParticle.h.

222 { return userIsolation(pat::CaloIso); }

References pat::CaloIso, and userIsolation().

Referenced by setEcalIso(), setHcalIso(), and ZToMuMuIsolationSelector< Isolator >::ZToMuMuIsolationSelector().

◆ caloTower()

CaloTowerRef pat::GenericParticle::caloTower ( ) const

inlineoverridevirtual

reference to a CaloTower (might be transient ref if CaloTower is embedded) returns null ref if there is no calotower

Reimplemented from reco::RecoCandidate.

Definition at line 95 of file GenericParticle.h.

                                             {
       return caloTower_.empty() ? caloTowerRef_ : CaloTowerRef(&caloTower_, 0);
     }

References caloTower_, caloTowerRef_, and edm::SortedCollection< T, SORT >::empty().

Referenced by overlap().

◆ clone()

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

inlineoverridevirtual

required reimplementation of the Candidate's clone method

Reimplemented from reco::LeafCandidate.

Definition at line 52 of file GenericParticle.h.

52 { return new GenericParticle(*this); }

References GenericParticle().

◆ combinedMuon()

reco::TrackRef pat::GenericParticle::combinedMuon ( ) const

inlineoverridevirtual

reference to a combined muon Track (might be transient ref if SuperCluster is embedded) returns null ref if there is no combined muon track

Reimplemented from reco::RecoCandidate.

Definition at line 85 of file GenericParticle.h.

                                                {
       return (combinedTrack_.empty() ? combinedTrackRef_ : reco::TrackRef(&combinedTrack_, 0));
     }

References combinedTrack_, and combinedTrackRef_.

Referenced by overlap().

◆ ecalIso()

float pat::GenericParticle::ecalIso ( ) const

inline

Return the ecal isolation variable that was stored in this object when produced, or -1.0 if there is none

Definition at line 225 of file GenericParticle.h.

225 { return userIsolation(pat::EcalIso); }

References pat::EcalIso, and userIsolation().

Referenced by ZToMuMuIsolationSelector< Isolator >::ZToMuMuIsolationSelector().

◆ ecalIsoDeposit() [1/2]

const IsoDeposit* pat::GenericParticle::ecalIsoDeposit ( ) const

inline

Definition at line 264 of file GenericParticle.h.

264 { return isoDeposit(pat::EcalIso); }

References pat::EcalIso, and isoDeposit().

◆ ecalIsoDeposit() [2/2]

void pat::GenericParticle::ecalIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 270 of file GenericParticle.h.

270 { setIsoDeposit(pat::EcalIso, dep); }

References pat::EcalIso, and setIsoDeposit().

◆ embedCaloTower()

void GenericParticle::embedCaloTower ( )

embeds the calotower instead of keeping a reference to it

Definition at line 142 of file GenericParticle.cc.

                                      {
   if (!caloTower_.empty())
     CaloTowerCollection().swap(caloTower_);
   if (caloTowerRef_.isNonnull())
     caloTower_.push_back(*caloTowerRef_);  // import
   caloTowerRef_ = CaloTowerRef();          // clear, to save space (zeroes compress better)
 }

References caloTower_, caloTowerRef_, edm::SortedCollection< T, SORT >::empty(), edm::Ref< C, T, F >::isNonnull(), edm::SortedCollection< T, SORT >::push_back(), and edm::SortedCollection< T, SORT >::swap().

Referenced by pat::PATGenericParticleProducer::produce(), and setCaloTower().

◆ embedCombined()

void GenericParticle::embedCombined ( )

embeds the combined track instead of keeping a reference to it

Definition at line 120 of file GenericParticle.cc.

                                     {
   combinedTrack_.clear();
   if (combinedTrackRef_.isNonnull())
     combinedTrack_.push_back(*combinedTrackRef_);  // import
   combinedTrackRef_ = reco::TrackRef();            // clear, to save space (zeroes compress better)
 }

References combinedTrack_, combinedTrackRef_, and edm::Ref< C, T, F >::isNonnull().

Referenced by pat::PATGenericParticleProducer::produce(), and setCombinedMuon().

◆ embedGsfTrack()

void GenericParticle::embedGsfTrack ( )

embeds the gsf track instead of keeping a reference to it

Definition at line 127 of file GenericParticle.cc.

                                     {
   gsfTrack_.clear();
   if (gsfTrackRef_.isNonnull())
     gsfTrack_.push_back(*gsfTrackRef_);  // import
   gsfTrackRef_ = reco::GsfTrackRef();    // clear, to save space (zeroes compress better)
 }

References gsfTrack_, gsfTrackRef_, and edm::Ref< C, T, F >::isNonnull().

Referenced by pat::PATGenericParticleProducer::produce(), and setGsfTrack().

◆ embedStandalone()

void GenericParticle::embedStandalone ( )

embeds the stand-alone track instead of keeping a reference to it

Definition at line 113 of file GenericParticle.cc.

                                       {
   standaloneTrack_.clear();
   if (standaloneTrackRef_.isNonnull())
     standaloneTrack_.push_back(*standaloneTrackRef_);  // import
   standaloneTrackRef_ = reco::TrackRef();              // clear, to save space (zeroes compress better)
 }

References edm::Ref< C, T, F >::isNonnull(), standaloneTrack_, and standaloneTrackRef_.

Referenced by pat::PATGenericParticleProducer::produce(), and setStandAloneMuon().

◆ embedSuperCluster()

void GenericParticle::embedSuperCluster ( )

embeds the supercluster instead of keeping a reference to it

Definition at line 135 of file GenericParticle.cc.

                                         {
   superCluster_.clear();
   if (superClusterRef_.isNonnull())
     superCluster_.push_back(*superClusterRef_);  // import
   superClusterRef_ = reco::SuperClusterRef();    // clear, to save space (zeroes compress better)
 }

References edm::Ref< C, T, F >::isNonnull(), superCluster_, and superClusterRef_.

Referenced by pat::PATGenericParticleProducer::produce(), and setSuperCluster().

◆ embedTrack()

void GenericParticle::embedTrack ( )

embeds the master track instead of keeping a reference to it

Definition at line 96 of file GenericParticle.cc.

                                  {
   track_.clear();
   if (trackRef_.isNonnull())
     track_.push_back(*trackRef_);  // import
   trackRef_ = reco::TrackRef();    // clear, to save space (zeroes compress better)
 }

References edm::Ref< C, T, F >::isNonnull(), track_, and trackRef_.

Referenced by pat::PATGenericParticleProducer::produce(), and setTrack().

◆ embedTracks()

void GenericParticle::embedTracks ( )

embeds the other tracks instead of keeping references

Definition at line 103 of file GenericParticle.cc.

                                   {
   tracks_.clear();
   tracks_.reserve(trackRefs_.size());
   for (reco::TrackRefVector::const_iterator it = trackRefs_.begin(); it != trackRefs_.end(); ++it) {
     if (it->isNonnull())
       tracks_.push_back(**it);  // embed track
   }
   trackRefs_ = reco::TrackRefVector();  // clear, to save space
 }

References edm::RefVector< C, T, F >::begin(), edm::RefVector< C, T, F >::end(), edm::RefVector< C, T, F >::size(), trackRefs_, and tracks_.

Referenced by pat::PATGenericParticleProducer::produce(), and setTracks().

◆ fillInFrom()

void GenericParticle::fillInFrom ( const reco::Candidate & cand )

protected

Definition at line 150 of file GenericParticle.cc.

                                                           {
   // first, kinematics & status
   setCharge(cand.charge());
   setP4(cand.polarP4());
   setVertex(cand.vertex());
   setPdgId(cand.pdgId());
   setStatus(cand.status());
   // then RECO part, if available
   const reco::RecoCandidate *rc = dynamic_cast<const reco::RecoCandidate *>(&cand);
   if (rc != nullptr) {
     setTrack(rc->track());
     setGsfTrack(rc->gsfTrack());
     setStandAloneMuon(rc->standAloneMuon());
     setCombinedMuon(rc->combinedMuon());
     setSuperCluster(rc->superCluster());
     setCaloTower(rc->caloTower());
     size_t ntracks = rc->numberOfTracks();
     if (ntracks > 0) {
       reco::TrackRefVector tracks;
       for (size_t i = 0; i < ntracks; ++i) {
         tracks.push_back(rc->track(i));
       }
       setTracks(tracks);
     }
   }
 }

References mps_fire::i, setCaloTower(), reco::LeafCandidate::setCharge(), setCombinedMuon(), setGsfTrack(), reco::LeafCandidate::setP4(), reco::LeafCandidate::setPdgId(), setStandAloneMuon(), reco::LeafCandidate::setStatus(), setSuperCluster(), setTrack(), setTracks(), reco::LeafCandidate::setVertex(), and PDWG_EXOHSCP_cff::tracks.

◆ gsfTrack()

reco::GsfTrackRef pat::GenericParticle::gsfTrack ( ) const

inlineoverridevirtual

reference to a GsfTrack (might be transient ref if SuperCluster is embedded) returns null ref if there is no gsf track

Reimplemented from reco::RecoCandidate.

Definition at line 75 of file GenericParticle.h.

                                               {
       return (gsfTrack_.empty() ? gsfTrackRef_ : reco::GsfTrackRef(&gsfTrack_, 0));
     }

References gsfTrack_, and gsfTrackRef_.

Referenced by Electron.Electron::dxy(), Electron.Electron::dz(), Electron.Electron::edxy(), Electron.Electron::edz(), Electron.Electron::lostInner(), and overlap().

◆ hcalIso()

float pat::GenericParticle::hcalIso ( ) const

inline

Return the hcal isolation variable that was stored in this object when produced, or -1.0 if there is none

Definition at line 228 of file GenericParticle.h.

228 { return userIsolation(pat::HcalIso); }

References pat::HcalIso, and userIsolation().

Referenced by ZToMuMuIsolationSelector< Isolator >::ZToMuMuIsolationSelector().

◆ hcalIsoDeposit() [1/2]

const IsoDeposit* pat::GenericParticle::hcalIsoDeposit ( ) const

inline

Definition at line 265 of file GenericParticle.h.

265 { return isoDeposit(pat::HcalIso); }

References pat::HcalIso, and isoDeposit().

◆ hcalIsoDeposit() [2/2]

void pat::GenericParticle::hcalIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 271 of file GenericParticle.h.

271 { setIsoDeposit(pat::HcalIso, dep); }

References pat::HcalIso, and setIsoDeposit().

◆ isoDeposit()

const IsoDeposit* pat::GenericParticle::isoDeposit ( IsolationKeys key ) const

inline

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition at line 242 of file GenericParticle.h.

                                                           {
       for (IsoDepositPairs::const_iterator it = isoDeposits_.begin(), ed = isoDeposits_.end(); it != ed; ++it) {
         if (it->first == key)
           return &it->second;
       }
       return nullptr;
     }

References isoDeposits_, and crabWrapper::key.

Referenced by ZMuMu_Radiative_analyzer::analyze(), ecalIsoDeposit(), hcalIsoDeposit(), trackIsoDeposit(), and userIsoDeposit().

◆ numberOfTracks()

size_t pat::GenericParticle::numberOfTracks ( ) const

inlineoverridevirtual

number of multiple tracks (not including the master one)

Reimplemented from reco::RecoCandidate.

Definition at line 72 of file GenericParticle.h.

72 { return tracks_.empty() ? trackRefs_.size() : tracks_.size(); }

References edm::RefVector< C, T, F >::size(), trackRefs_, and tracks_.

Referenced by track().

◆ overlap()

bool GenericParticle::overlap ( const Candidate & ) const

override

Checks for overlap with another candidate. It will return 'true' if the other candidate is a RecoCandidate, and if they reference to at least one same non null track, supercluster or calotower (except for the multiple tracks) NOTE: It won't work with embedded references

Definition at line 177 of file GenericParticle.cc.

                                                              {
   const reco::RecoCandidate *rc = dynamic_cast<const reco::RecoCandidate *>(&cand);
   if (rc != nullptr) {
     if (rc->track().isNonnull() && (track() == rc->track()))
       return true;
     if (rc->gsfTrack().isNonnull() && (gsfTrack() == rc->gsfTrack()))
       return true;
     if (rc->standAloneMuon().isNonnull() && (standAloneMuon() == rc->standAloneMuon()))
       return true;
     if (rc->combinedMuon().isNonnull() && (combinedMuon() == rc->combinedMuon()))
       return true;
     if (rc->superCluster().isNonnull() && (superCluster() == rc->superCluster()))
       return true;
     if (rc->caloTower().isNonnull() && (caloTower() == rc->caloTower()))
       return true;
   }
   const GenericParticle *rc2 = dynamic_cast<const GenericParticle *>(&cand);
   if (rc2 != nullptr) {
     if (rc2->track().isNonnull() && (track() == rc2->track()))
       return true;
     if (rc2->gsfTrack().isNonnull() && (gsfTrack() == rc2->gsfTrack()))
       return true;
     if (rc2->standAloneMuon().isNonnull() && (standAloneMuon() == rc2->standAloneMuon()))
       return true;
     if (rc2->combinedMuon().isNonnull() && (combinedMuon() == rc2->combinedMuon()))
       return true;
     if (rc2->superCluster().isNonnull() && (superCluster() == rc2->superCluster()))
       return true;
     if (rc2->caloTower().isNonnull() && (caloTower() == rc2->caloTower()))
       return true;
   }
   return false;
 }

References reco::RecoCandidate::caloTower(), caloTower(), reco::RecoCandidate::combinedMuon(), combinedMuon(), reco::RecoCandidate::gsfTrack(), gsfTrack(), edm::Ref< C, T, F >::isNonnull(), reco::RecoCandidate::standAloneMuon(), standAloneMuon(), reco::RecoCandidate::superCluster(), superCluster(), reco::RecoCandidate::track(), and track().

◆ quality()

float pat::GenericParticle::quality ( )

inline

returns a user defined quality value, if set by the user to some meaningful value

Definition at line 130 of file GenericParticle.h.

130 { return quality_; }

References quality_.

Referenced by setQuality().

◆ setCaloTower()

void GenericParticle::setCaloTower	(	const CaloTowerRef &	ref,
		bool	embed = `false`
	)

virtual

sets calotower reference (or even embed it into the object)

Definition at line 85 of file GenericParticle.cc.

                                                                       {
   caloTowerRef_ = ref;
   if (embed) {
     embedCaloTower();
   } else if (!caloTower_.empty()) {
     CaloTowerCollection().swap(caloTower_);
   }
 }

References caloTower_, caloTowerRef_, embed, embedCaloTower(), edm::SortedCollection< T, SORT >::empty(), and edm::SortedCollection< T, SORT >::swap().

Referenced by fillInFrom().

◆ setCombinedMuon()

void GenericParticle::setCombinedMuon	(	const reco::TrackRef &	ref,
		bool	embed = `false`
	)

virtual

sets combined muon track reference (or even embed it into the object)

Definition at line 58 of file GenericParticle.cc.

                                                                          {
   combinedTrackRef_ = ref;
   if (embed)
     embedCombined();
   else
     combinedTrack_.clear();
 }

References combinedTrack_, combinedTrackRef_, embed, and embedCombined().

Referenced by fillInFrom().

◆ setEcalIso()

void pat::GenericParticle::setEcalIso ( float caloIso )

inline

Sets ecal isolation variable.

Definition at line 234 of file GenericParticle.h.

234 { setIsolation(pat::EcalIso, caloIso); }

References caloIso(), pat::EcalIso, and setIsolation().

◆ setGsfTrack()

void GenericParticle::setGsfTrack	(	const reco::GsfTrackRef &	ref,
		bool	embed = `false`
	)

virtual

sets gsf track reference (or even embed it into the object)

Definition at line 67 of file GenericParticle.cc.

                                                                         {
   gsfTrackRef_ = ref;
   if (embed)
     embedGsfTrack();
   else
     gsfTrack_.clear();
 }

References embed, embedGsfTrack(), gsfTrack_, and gsfTrackRef_.

Referenced by fillInFrom().

◆ setHcalIso()

void pat::GenericParticle::setHcalIso ( float caloIso )

inline

Sets hcal isolation variable.

Definition at line 236 of file GenericParticle.h.

236 { setIsolation(pat::HcalIso, caloIso); }

References caloIso(), pat::HcalIso, and setIsolation().

◆ setIsoDeposit()

void pat::GenericParticle::setIsoDeposit	(	IsolationKeys	key,
		const IsoDeposit &	dep
	)

inline

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition at line 251 of file GenericParticle.h.

                                                                  {
       IsoDepositPairs::iterator it = isoDeposits_.begin(), ed = isoDeposits_.end();
       for (; it != ed; ++it) {
         if (it->first == key) {
           it->second = dep;
           return;
         }
       }
       isoDeposits_.push_back(std::make_pair(key, dep));
     }

References isoDeposits_, and crabWrapper::key.

Referenced by ecalIsoDeposit(), hcalIsoDeposit(), pat::PATGenericParticleProducer::produce(), trackIsoDeposit(), and userIsoDeposit().

◆ setIsolation()

void pat::GenericParticle::setIsolation	(	IsolationKeys	key,
		float	value
	)

inline

Sets the isolation variable for a specifc key. Note that you can't set isolation for a pseudo-key like CaloIso

Definition at line 201 of file GenericParticle.h.

                                                       {
       if (key >= 0) {
         if (size_t(key) >= isolations_.size())
           isolations_.resize(key + 1, -1.0);
         isolations_[key] = value;
       } else {
         throw cms::Exception("Illegal Argument")
             << "The key for which you're setting isolation does not correspond "
             << "to an individual isolation but to the sum of more independent isolations "
             << "(e.g. Calo = Ecal + Hcal), so you can't SET the value, just GET it.\n"
             << "Please set up each component independly.\n";
       }
     }

References Exception, isolations_, crabWrapper::key, and relativeConstraints::value.

Referenced by ZMuMuTrackUserData::produce(), pat::PATGenericParticleProducer::produce(), setEcalIso(), setHcalIso(), setTrackIso(), and setUserIso().

◆ setQuality()

void pat::GenericParticle::setQuality ( float quality )

inline

sets a user defined quality value

Definition at line 132 of file GenericParticle.h.

132 { quality_ = quality; }

References quality(), and quality_.

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

◆ setStandAloneMuon()

void GenericParticle::setStandAloneMuon	(	const reco::TrackRef &	ref,
		bool	embed = `false`
	)

virtual

sets stand-alone muon track reference (or even embed it into the object)

Definition at line 49 of file GenericParticle.cc.

                                                                            {
   standaloneTrackRef_ = ref;
   if (embed)
     embedStandalone();
   else
     standaloneTrack_.clear();
 }

References embed, embedStandalone(), standaloneTrack_, and standaloneTrackRef_.

Referenced by fillInFrom().

◆ setSuperCluster()

void GenericParticle::setSuperCluster	(	const reco::SuperClusterRef &	ref,
		bool	embed = `false`
	)

virtual

sets supercluster reference (or even embed it into the object)

Definition at line 76 of file GenericParticle.cc.

                                                                                 {
   superClusterRef_ = ref;
   if (embed)
     embedSuperCluster();
   else
     superCluster_.clear();
 }

References embed, embedSuperCluster(), superCluster_, and superClusterRef_.

Referenced by fillInFrom().

◆ setTrack()

void GenericParticle::setTrack	(	const reco::TrackRef &	ref,
		bool	embed = `false`
	)

virtual

sets master track reference (or even embed it into the object)

Definition at line 31 of file GenericParticle.cc.

                                                                   {
   trackRef_ = ref;
   if (embed)
     embedTrack();
   else
     track_.clear();
 }

References embed, embedTrack(), track_, and trackRef_.

Referenced by fillInFrom().

◆ setTrackIso()

void pat::GenericParticle::setTrackIso ( float trackIso )

inline

Sets tracker isolation variable.

Definition at line 232 of file GenericParticle.h.

232 { setIsolation(pat::TrackIso, trackIso); }

References setIsolation(), pat::TrackIso, and trackIso().

◆ setTracks()

void GenericParticle::setTracks	(	const reco::TrackRefVector &	refs,
		bool	embed = `false`
	)

virtual

sets multiple track references (or even embed the tracks into the object - whatch out for disk size issues!)

Definition at line 40 of file GenericParticle.cc.

                                                                           {
   trackRefs_ = refs;
   if (embed)
     embedTracks();
   else
     tracks_.clear();
 }

References embed, embedTracks(), trackRefs_, and tracks_.

Referenced by fillInFrom().

◆ setUserIso()

void pat::GenericParticle::setUserIso	(	float	value,
		uint8_t	index = `0`
	)

inline

Sets user isolation variable index.

Definition at line 238 of file GenericParticle.h.

238 { setIsolation(IsolationKeys(UserBaseIso + index), value); }

References setIsolation(), and pat::UserBaseIso.

◆ setVertexAssociation()

void pat::GenericParticle::setVertexAssociation ( const pat::VertexAssociation & assoc )

inline

Set a single vertex association.

Definition at line 283 of file GenericParticle.h.

                                                                  {
       vtxAss_ = std::vector<pat::VertexAssociation>(1, assoc);
     }

References trackingPlots::assoc, and vtxAss_.

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

◆ setVertexAssociations()

void pat::GenericParticle::setVertexAssociations ( const std::vector< pat::VertexAssociation > & assocs )

inline

Set multiple vertex associations.

Definition at line 287 of file GenericParticle.h.

287 { vtxAss_ = assocs; }

References vtxAss_.

◆ standAloneMuon()

reco::TrackRef pat::GenericParticle::standAloneMuon ( ) const

inlineoverridevirtual

reference to a stand-alone muon Track (might be transient ref if SuperCluster is embedded) returns null ref if there is no stand-alone muon track

Reimplemented from reco::RecoCandidate.

Definition at line 80 of file GenericParticle.h.

                                                  {
       return (standaloneTrack_.empty() ? standaloneTrackRef_ : reco::TrackRef(&standaloneTrack_, 0));
     }

References standaloneTrack_, and standaloneTrackRef_.

Referenced by overlap().

◆ superCluster()

reco::SuperClusterRef pat::GenericParticle::superCluster ( ) const

inlineoverridevirtual

reference to a SuperCluster (might be transient ref if SuperCluster is embedded) returns null ref if there is no supercluster

Reimplemented from reco::RecoCandidate.

Definition at line 90 of file GenericParticle.h.

                                                       {
       return superCluster_.empty() ? superClusterRef_ : reco::SuperClusterRef(&superCluster_, 0);
     }

References superCluster_, and superClusterRef_.

Referenced by Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), and overlap().

◆ track() [1/2]

reco::TrackRef pat::GenericParticle::track ( ) const

inlineoverridevirtual

reference to a master track (might be transient refs if Tracks are embedded) returns null ref if there is no master track

Reimplemented from reco::RecoCandidate.

Definition at line 62 of file GenericParticle.h.

62 { return track_.empty() ? trackRef_ : reco::TrackRef(&track_, 0); }

References track_, and trackRef_.

Referenced by ZMuMu_vtxAnalyzer::analyze(), overlap(), ZMuMuTrackUserData::produce(), and ZToLLEdmNtupleDumper::produce().

◆ track() [2/2]

reco::TrackRef pat::GenericParticle::track ( size_t idx ) const

inlineoverridevirtual

reference to one of a set of multiple tracks (might be transient refs if Tracks are embedded) throws exception if idx >= numberOfTracks()

Reimplemented from reco::RecoCandidate.

Definition at line 65 of file GenericParticle.h.

                                                   {
       if (idx >= numberOfTracks())
         throw cms::Exception("Index out of bounds")
             << "Requested track " << idx << " out of " << numberOfTracks() << ".\n";
       return (tracks_.empty() ? trackRefs_[idx] : reco::TrackRef(&tracks_, idx));
     }

References Exception, training_settings::idx, numberOfTracks(), trackRefs_, and tracks_.

◆ trackIso()

float pat::GenericParticle::trackIso ( ) const

inline

Return the tracker isolation variable that was stored in this object when produced, or -1.0 if there is none

Definition at line 218 of file GenericParticle.h.

218 { return userIsolation(pat::TrackIso); }

References pat::TrackIso, and userIsolation().

Referenced by ZMuMu_vtxAnalyzer::analyze(), ZMuMu_efficiencyAnalyzer::analyze(), setTrackIso(), and ZToMuMuIsolationSelector< Isolator >::ZToMuMuIsolationSelector().

◆ trackIsoDeposit() [1/2]

const IsoDeposit* pat::GenericParticle::trackIsoDeposit ( ) const

inline

Definition at line 263 of file GenericParticle.h.

263 { return isoDeposit(pat::TrackIso); }

References isoDeposit(), and pat::TrackIso.

◆ trackIsoDeposit() [2/2]

void pat::GenericParticle::trackIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 269 of file GenericParticle.h.

269 { setIsoDeposit(pat::TrackIso, dep); }

References setIsoDeposit(), and pat::TrackIso.

◆ userIsoDeposit() [1/2]

void pat::GenericParticle::userIsoDeposit	(	const IsoDeposit &	dep,
		uint8_t	index = `0`
	)

inline

Definition at line 272 of file GenericParticle.h.

                                                                   {
       setIsoDeposit(IsolationKeys(UserBaseIso + index), dep);
     }

References setIsoDeposit(), and pat::UserBaseIso.

◆ userIsoDeposit() [2/2]

const IsoDeposit* pat::GenericParticle::userIsoDeposit ( uint8_t index = 0 ) const

inline

Definition at line 266 of file GenericParticle.h.

266 { return isoDeposit(IsolationKeys(UserBaseIso + index)); }

References isoDeposit(), and pat::UserBaseIso.

◆ userIsolation() [1/2]

float pat::GenericParticle::userIsolation ( const std::string & key ) const

inline

Returns the isolation variable for string type function arguments (to be used with the cut-string parser); the possible values of the strings are the enums defined in DataFormats/PatCandidates/interface/Isolation.h

Definition at line 163 of file GenericParticle.h.

                                                     {
       // remove leading namespace specifier
       std::string prunedKey = (key.find("pat::") == 0) ? std::string(key, 5) : key;
       if (prunedKey == "TrackIso")
         return userIsolation(pat::TrackIso);
       if (prunedKey == "EcalIso")
         return userIsolation(pat::EcalIso);
       if (prunedKey == "HcalIso")
         return userIsolation(pat::HcalIso);
       if (prunedKey == "PfAllParticleIso")
         return userIsolation(pat::PfAllParticleIso);
       if (prunedKey == "PfChargedHadronIso")
         return userIsolation(pat::PfChargedHadronIso);
       if (prunedKey == "PfNeutralHadronIso")
         return userIsolation(pat::PfNeutralHadronIso);
       if (prunedKey == "PfGammaIso")
         return userIsolation(pat::PfGammaIso);
       if (prunedKey == "User1Iso")
         return userIsolation(pat::User1Iso);
       if (prunedKey == "User2Iso")
         return userIsolation(pat::User2Iso);
       if (prunedKey == "User3Iso")
         return userIsolation(pat::User3Iso);
       if (prunedKey == "User4Iso")
         return userIsolation(pat::User4Iso);
       if (prunedKey == "User5Iso")
         return userIsolation(pat::User5Iso);
       if (prunedKey == "UserBaseIso")
         return userIsolation(pat::UserBaseIso);
       if (prunedKey == "CaloIso")
         return userIsolation(pat::CaloIso);
       //throw cms::Excepton("Missing Data")
       //<< "Isolation corresponding to key "
       //<< key << " was not stored for this particle.";
       return -1.0;
     }

References pat::CaloIso, pat::EcalIso, pat::HcalIso, crabWrapper::key, pat::PfAllParticleIso, pat::PfChargedHadronIso, pat::PfGammaIso, pat::PfNeutralHadronIso, AlCaHLTBitMon_QueryRunRegistry::string, pat::TrackIso, pat::User1Iso, pat::User2Iso, pat::User3Iso, pat::User4Iso, pat::User5Iso, pat::UserBaseIso, and userIsolation().

◆ userIsolation() [2/2]

float pat::GenericParticle::userIsolation ( IsolationKeys key ) const

inline

Returns the isolation variable for a specifc key (or pseudo-key like CaloIso), or -1.0 if not available

Definition at line 137 of file GenericParticle.h.

                                                  {
       if (key >= 0) {
         //if (key >= isolations_.size()) throw cms::Excepton("Missing Data")
         //<< "Isolation corresponding to key "
         //<< key << " was not stored for this particle.";
         if (size_t(key) >= isolations_.size())
           return -1.0;
         return isolations_[key];
       } else
         switch (key) {
           case pat::CaloIso:
             //if (isolations_.size() <= pat::HcalIso) throw cms::Excepton("Missing Data")
             //<< "CalIsoo Isolation was not stored for this particle.";
             if (isolations_.size() <= pat::HcalIso)
               return -1.0;
             return isolations_[pat::EcalIso] + isolations_[pat::HcalIso];
           default:
             return -1.0;
             //throw cms::Excepton("Missing Data") << "Isolation corresponding to key "
             //<< key << " was not stored for this particle.";
         }
     }

References pat::CaloIso, pat::EcalIso, pat::HcalIso, isolations_, and crabWrapper::key.

Referenced by caloIso(), ecalIso(), hcalIso(), trackIso(), and userIsolation().

◆ vertexAssociation()

const pat::VertexAssociation* pat::GenericParticle::vertexAssociation ( size_t index = 0 ) const

inline

Vertex association (or associations, if any). Return null pointer if none has been set.

Definition at line 277 of file GenericParticle.h.

                                                                           {
       return vtxAss_.size() > index ? &vtxAss_[index] : nullptr;
     }

References vtxAss_.

◆ vertexAssociations()

const std::vector<pat::VertexAssociation>& pat::GenericParticle::vertexAssociations ( ) const

inline

Vertex associations. Can be empty if it was not enabled in the config file.

Definition at line 281 of file GenericParticle.h.

281 { return vtxAss_; }

References vtxAss_.

Member Data Documentation

◆ caloTower_

CaloTowerCollection pat::GenericParticle::caloTower_

protected

Definition at line 300 of file GenericParticle.h.

Referenced by caloTower(), embedCaloTower(), and setCaloTower().

◆ caloTowerRef_

CaloTowerRef pat::GenericParticle::caloTowerRef_

protected

Definition at line 299 of file GenericParticle.h.

Referenced by caloTower(), embedCaloTower(), and setCaloTower().

◆ combinedTrack_

reco::TrackCollection pat::GenericParticle::combinedTrack_

protected

Definition at line 292 of file GenericParticle.h.

Referenced by combinedMuon(), embedCombined(), and setCombinedMuon().

◆ combinedTrackRef_

reco::TrackRef pat::GenericParticle::combinedTrackRef_

protected

Definition at line 291 of file GenericParticle.h.

Referenced by combinedMuon(), embedCombined(), and setCombinedMuon().

◆ gsfTrack_

reco::GsfTrackCollection pat::GenericParticle::gsfTrack_

protected

Definition at line 296 of file GenericParticle.h.

Referenced by embedGsfTrack(), gsfTrack(), and setGsfTrack().

◆ gsfTrackRef_

reco::GsfTrackRef pat::GenericParticle::gsfTrackRef_

protected

Definition at line 295 of file GenericParticle.h.

Referenced by embedGsfTrack(), gsfTrack(), and setGsfTrack().

◆ isoDeposits_

IsoDepositPairs pat::GenericParticle::isoDeposits_

protected

Definition at line 316 of file GenericParticle.h.

Referenced by isoDeposit(), and setIsoDeposit().

◆ isolations_

std::vector<float> pat::GenericParticle::isolations_

protected

Definition at line 317 of file GenericParticle.h.

Referenced by setIsolation(), and userIsolation().

◆ quality_

float pat::GenericParticle::quality_

protected

Definition at line 312 of file GenericParticle.h.

Referenced by quality(), and setQuality().

◆ standaloneTrack_

reco::TrackCollection pat::GenericParticle::standaloneTrack_

protected

Definition at line 292 of file GenericParticle.h.

Referenced by embedStandalone(), setStandAloneMuon(), and standAloneMuon().

◆ standaloneTrackRef_

reco::TrackRef pat::GenericParticle::standaloneTrackRef_

protected

Definition at line 291 of file GenericParticle.h.

Referenced by embedStandalone(), setStandAloneMuon(), and standAloneMuon().

◆ superCluster_

reco::SuperClusterCollection pat::GenericParticle::superCluster_

protected

Definition at line 304 of file GenericParticle.h.

Referenced by embedSuperCluster(), setSuperCluster(), and superCluster().

◆ superClusterRef_

reco::SuperClusterRef pat::GenericParticle::superClusterRef_

protected

Definition at line 303 of file GenericParticle.h.

Referenced by embedSuperCluster(), setSuperCluster(), and superCluster().

◆ track_

reco::TrackCollection pat::GenericParticle::track_

protected

Definition at line 292 of file GenericParticle.h.

Referenced by embedTrack(), setTrack(), and track().

◆ trackRef_

reco::TrackRef pat::GenericParticle::trackRef_

protected

Definition at line 291 of file GenericParticle.h.

Referenced by embedTrack(), setTrack(), and track().

◆ trackRefs_

reco::TrackRefVector pat::GenericParticle::trackRefs_

protected

Definition at line 307 of file GenericParticle.h.

Referenced by embedTracks(), numberOfTracks(), setTracks(), and track().

◆ tracks_

reco::TrackCollection pat::GenericParticle::tracks_

protected

Definition at line 308 of file GenericParticle.h.

Referenced by embedTracks(), numberOfTracks(), setTracks(), and track().

◆ vtxAss_

std::vector<pat::VertexAssociation> pat::GenericParticle::vtxAss_

protected

Definition at line 320 of file GenericParticle.h.

Referenced by setVertexAssociation(), setVertexAssociations(), vertexAssociation(), and vertexAssociations().

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IsoDepositPairs

Constructor & Destructor Documentation

◆ GenericParticle() [1/4]

◆ GenericParticle() [2/4]

◆ GenericParticle() [3/4]

◆ GenericParticle() [4/4]

◆ ~GenericParticle()

Member Function Documentation

◆ caloIso()

◆ caloTower()

◆ clone()

◆ combinedMuon()

◆ ecalIso()

◆ ecalIsoDeposit() [1/2]

◆ ecalIsoDeposit() [2/2]

◆ embedCaloTower()

◆ embedCombined()

◆ embedGsfTrack()

◆ embedStandalone()

◆ embedSuperCluster()

◆ embedTrack()

◆ embedTracks()

◆ fillInFrom()

◆ gsfTrack()

◆ hcalIso()

◆ hcalIsoDeposit() [1/2]

◆ hcalIsoDeposit() [2/2]

◆ isoDeposit()

◆ numberOfTracks()

◆ overlap()

◆ quality()

◆ setCaloTower()

◆ setCombinedMuon()

◆ setEcalIso()

◆ setGsfTrack()

◆ setHcalIso()

◆ setIsoDeposit()

◆ setIsolation()

◆ setQuality()

◆ setStandAloneMuon()

◆ setSuperCluster()

◆ setTrack()

◆ setTrackIso()

◆ setTracks()

◆ setUserIso()

◆ setVertexAssociation()

◆ setVertexAssociations()

◆ standAloneMuon()

◆ superCluster()

◆ track() [1/2]

◆ track() [2/2]

◆ trackIso()

◆ trackIsoDeposit() [1/2]

◆ trackIsoDeposit() [2/2]

◆ userIsoDeposit() [1/2]

◆ userIsoDeposit() [2/2]

◆ userIsolation() [1/2]

◆ userIsolation() [2/2]

◆ vertexAssociation()

◆ vertexAssociations()

Member Data Documentation

◆ caloTower_

◆ caloTowerRef_

◆ combinedTrack_

◆ combinedTrackRef_

◆ gsfTrack_

◆ gsfTrackRef_

◆ isoDeposits_

◆ isolations_

◆ quality_

◆ standaloneTrack_

◆ standaloneTrackRef_

◆ superCluster_