Analysis-level lepton class. More...

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

Inheritance diagram for pat::Lepton< LeptonType >:

Public Member Functions
float	caloIso () const

float	chargedHadronIso () const

Lepton< LeptonType > *	clone () const override

float	ecalIso () const

const IsoDeposit *	ecalIsoDeposit () const

void	ecalIsoDeposit (const IsoDeposit &dep)

const reco::GenParticle *	genLepton () const

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

	Lepton ()
	default constructor More...

	Lepton (const edm::Ptr< LeptonType > &aLeptonRef)
	constructor from ref to LeptonType More...

	Lepton (const edm::RefToBase< LeptonType > &aLeptonRef)
	constructor from ref to LeptonType More...

	Lepton (const LeptonType &aLepton)
	constructor from LeptonType More...

const PFIsolation &	miniPFIsolation () const

float	neutralHadronIso () const

float	particleIso () const

float	photonIso () const

float	puChargedHadronIso () const

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

void	setGenLepton (const reco::GenParticleRef &gl, bool embed=false)

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	setMiniPFIsolation (PFIsolation const &iso)

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

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

float	trackIso () const

const IsoDeposit *	trackIsoDeposit () const

void	trackIsoDeposit (const IsoDeposit &dep)

float	userIso (uint8_t index=0) const

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

	~Lepton () override
	destructor More...

Public Member Functions inherited from pat::PATObject< LeptonType >
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< LeptonType > &ref)
	constructor from reference More...

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

	PATObject (const LeptonType &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...

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

Protected Attributes
IsoDepositPairs	isoDeposits_

std::vector< float >	isolations_

PFIsolation	miniPFIsolation_

Protected Attributes inherited from pat::PATObject< LeptonType >
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< LeptonType >
typedef LeptonType	base_type

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

Detailed Description

template<class LeptonType>
class pat::Lepton< LeptonType >

Analysis-level lepton class.

Lepton implements the analysis-level charged lepton class within the 'pat' namespace. It currently provides the link to the generated lepton and the isolation information.

Please post comments and questions to the Physics Tools hypernews: https://hypernews.cern.ch/HyperNews/CMS/get/physTools.html

Author: Steven Lowette, Giovanni Petrucciani, Frederic Ronga

Definition at line 29 of file Lepton.h.

Member Typedef Documentation

◆ IsoDepositPairs

template<class LeptonType>

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

protected

Definition at line 221 of file Lepton.h.

Constructor & Destructor Documentation

◆ Lepton() [1/4]

template<class LeptonType >

Lepton::Lepton ( )

default constructor

Definition at line 230 of file Lepton.h.

                              : PATObject<LeptonType>(LeptonType()) {
     // no common constructor, so initialize the candidate manually
     this->setCharge(0);
     this->setP4(reco::Particle::LorentzVector(0, 0, 0, 0));
     this->setVertex(reco::Particle::Point(0, 0, 0));
     this->setMiniPFIsolation(pat::PFIsolation());
   }

◆ Lepton() [2/4]

template<class LeptonType>

Lepton::Lepton ( const LeptonType & aLepton )

constructor from LeptonType

Definition at line 240 of file Lepton.h.

                                                       : PATObject<LeptonType>(aLepton) {
     this->setMiniPFIsolation(pat::PFIsolation());
   }

◆ Lepton() [3/4]

template<class LeptonType>

Lepton::Lepton ( const edm::RefToBase< LeptonType > & aLeptonRef )

constructor from ref to LeptonType

Definition at line 246 of file Lepton.h.

                                                                        : PATObject<LeptonType>(aLeptonRef) {
     this->setMiniPFIsolation(pat::PFIsolation());
   }

◆ Lepton() [4/4]

template<class LeptonType>

Lepton::Lepton ( const edm::Ptr< LeptonType > & aLeptonRef )

constructor from ref to LeptonType

Definition at line 252 of file Lepton.h.

                                                                  : PATObject<LeptonType>(aLeptonRef) {
     this->setMiniPFIsolation(pat::PFIsolation());
   }

◆ ~Lepton()

template<class LeptonType >

Lepton::~Lepton ( )

override

destructor

Definition at line 258 of file Lepton.h.

258 {}

Member Function Documentation

◆ caloIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::caloIso ( ) const

inline

Returns 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 (overloaded if specific isolation functions are available from the derived objects)

Definition at line 139 of file Lepton.h.

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

Referenced by pat::Lepton< reco::Muon >::setEcalIso(), and pat::Lepton< reco::Muon >::setHcalIso().

◆ chargedHadronIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::chargedHadronIso ( ) const

inline

Returns the isolation calculated with only the charged hadron PFCandidates

Definition at line 156 of file Lepton.h.

156 { return userIsolation(pat::PfChargedHadronIso); }

Referenced by Lepton.Lepton::absIsoFromEA(), and Photon.Photon::passPhotonIso().

◆ clone()

template<class LeptonType>

Lepton<LeptonType>* pat::Lepton< LeptonType >::clone ( void ) const

inlineoverride

Definition at line 37 of file Lepton.h.

37 { return new Lepton<LeptonType>(*this); }

◆ ecalIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::ecalIso ( ) const

inline

Returns the ecal isolation variable that was stored in this object when produced, or -1.0 if there is none (overloaded if specific isolation functions are available from the derived objects)

Definition at line 144 of file Lepton.h.

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

◆ ecalIsoDeposit() [1/2]

template<class LeptonType>

const IsoDeposit* pat::Lepton< LeptonType >::ecalIsoDeposit ( ) const

inline

Definition at line 204 of file Lepton.h.

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

◆ ecalIsoDeposit() [2/2]

template<class LeptonType>

void pat::Lepton< LeptonType >::ecalIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 210 of file Lepton.h.

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

◆ genLepton()

template<class LeptonType>

const reco::GenParticle* pat::Lepton< LeptonType >::genLepton ( ) const

inline

Definition at line 39 of file Lepton.h.

39 { return PATObject<LeptonType>::genParticle(); }

Referenced by ZMuMu_Radiative_analyzer::analyze(), and gamma_radiative_analyzer::analyze().

◆ hcalIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::hcalIso ( ) const

inline

Returns the hcal isolation variable that was stored in this object when produced, or -1.0 if there is none (overloaded if specific isolation functions are available from the derived objects)

Definition at line 149 of file Lepton.h.

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

◆ hcalIsoDeposit() [1/2]

template<class LeptonType>

const IsoDeposit* pat::Lepton< LeptonType >::hcalIsoDeposit ( ) const

inline

Definition at line 205 of file Lepton.h.

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

◆ hcalIsoDeposit() [2/2]

template<class LeptonType>

void pat::Lepton< LeptonType >::hcalIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 211 of file Lepton.h.

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

◆ isoDeposit()

template<class LeptonType>

const IsoDeposit* pat::Lepton< LeptonType >::isoDeposit ( IsolationKeys key ) const

inline

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

Definition at line 182 of file Lepton.h.

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

Referenced by ZMuMuIsolationAnalyzer::analyze(), ZMuMu_Radiative_analyzer::analyze(), pat::Lepton< reco::Muon >::ecalIsoDeposit(), pat::Lepton< reco::Muon >::hcalIsoDeposit(), pat::Lepton< reco::Muon >::trackIsoDeposit(), and pat::Lepton< reco::Muon >::userIsoDeposit().

◆ miniPFIsolation()

template<class LeptonType>

const PFIsolation& pat::Lepton< LeptonType >::miniPFIsolation ( ) const

inline

Definition at line 216 of file Lepton.h.

216 { return miniPFIsolation_; }

◆ neutralHadronIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::neutralHadronIso ( ) const

inline

Returns the isolation calculated with only the neutral hadron PFCandidates

Definition at line 159 of file Lepton.h.

159 { return userIsolation(pat::PfNeutralHadronIso); }

Referenced by Lepton.Lepton::absIsoFromEA(), and Photon.Photon::passPhotonIso().

◆ particleIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::particleIso ( ) const

inline

PARTICLE FLOW ISOLATION Returns the isolation calculated with all the PFCandidates

Definition at line 153 of file Lepton.h.

153 { return userIsolation(pat::PfAllParticleIso); }

◆ photonIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::photonIso ( ) const

inline

Returns the isolation calculated with only the gamma PFCandidates

Definition at line 162 of file Lepton.h.

162 { return userIsolation(pat::PfGammaIso); }

Referenced by Lepton.Lepton::absIsoFromEA(), and Photon.Photon::passPhotonIso().

◆ puChargedHadronIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::puChargedHadronIso ( ) const

inline

Returns the isolation calculated with only the pile-up charged hadron PFCandidates

Definition at line 165 of file Lepton.h.

165 { return userIsolation(pat::PfPUChargedHadronIso); }

◆ setEcalIso()

template<class LeptonType>

void pat::Lepton< LeptonType >::setEcalIso ( float caloIso )

inline

Sets ecal isolation variable.

Definition at line 174 of file Lepton.h.

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

Referenced by aod2patFilterZee::filter().

◆ setGenLepton()

template<class LeptonType>

void pat::Lepton< LeptonType >::setGenLepton	(	const reco::GenParticleRef &	gl,
		bool	embed = `false`
	)

inline

Definition at line 41 of file Lepton.h.

                                                                         {
       PATObject<LeptonType>::setGenParticleRef(gl, embed);
     }

◆ setHcalIso()

template<class LeptonType>

void pat::Lepton< LeptonType >::setHcalIso ( float caloIso )

inline

Sets hcal isolation variable.

Definition at line 176 of file Lepton.h.

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

Referenced by aod2patFilterZee::filter().

◆ setIsoDeposit()

template<class LeptonType>

void pat::Lepton< LeptonType >::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 191 of file Lepton.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));
     }

Referenced by pat::Lepton< reco::Muon >::ecalIsoDeposit(), pat::PATElectronProducer::fillElectron(), pat::PATElectronProducer::fillElectron2(), pat::PATMuonProducer::fillMuon(), pat::Lepton< reco::Muon >::hcalIsoDeposit(), pat::PATElectronProducer::produce(), pat::PATTauProducer::produce(), pat::Lepton< reco::Muon >::trackIsoDeposit(), and pat::Lepton< reco::Muon >::userIsoDeposit().

◆ setIsolation()

template<class LeptonType>

void pat::Lepton< LeptonType >::setIsolation	(	IsolationKeys	key,
		float	value
	)

inline

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

Definition at line 115 of file Lepton.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";
       }
     }

Referenced by pat::PATElectronProducer::fillElectron(), pat::PATElectronProducer::fillElectron2(), pat::PATMuonProducer::fillMuon(), PatElectronEAIsoCorrectionProducer::produce(), pat::PATElectronProducer::produce(), pat::PATTauProducer::produce(), pat::PATMuonProducer::produce(), pat::Lepton< reco::Muon >::setEcalIso(), pat::Lepton< reco::Muon >::setHcalIso(), pat::Lepton< reco::Muon >::setTrackIso(), and pat::Lepton< reco::Muon >::setUserIso().

◆ setMiniPFIsolation()

template<class LeptonType>

void pat::Lepton< LeptonType >::setMiniPFIsolation ( PFIsolation const & iso )

inline

Definition at line 217 of file Lepton.h.

217 { miniPFIsolation_ = iso; }

Referenced by pat::PATElectronProducer::setElectronMiniIso(), and pat::PATMuonProducer::setMuonMiniIso().

◆ setTrackIso()

template<class LeptonType>

void pat::Lepton< LeptonType >::setTrackIso ( float trackIso )

inline

Sets tracker isolation variable.

Definition at line 172 of file Lepton.h.

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

Referenced by aod2patFilterZee::filter().

◆ setUserIso()

template<class LeptonType>

void pat::Lepton< LeptonType >::setUserIso	(	float	value,
		uint8_t	index = `0`
	)

inline

Sets user isolation variable #index.

Definition at line 178 of file Lepton.h.

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

◆ trackIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::trackIso ( ) const

inline

Returns the tracker isolation variable that was stored in this object when produced, or -1.0 if there is none (overloaded if specific isolation functions are available from the derived objects)

Definition at line 134 of file Lepton.h.

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

Referenced by pat::Lepton< reco::Muon >::setTrackIso().

◆ trackIsoDeposit() [1/2]

template<class LeptonType>

const IsoDeposit* pat::Lepton< LeptonType >::trackIsoDeposit ( ) const

inline

Definition at line 203 of file Lepton.h.

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

◆ trackIsoDeposit() [2/2]

template<class LeptonType>

void pat::Lepton< LeptonType >::trackIsoDeposit ( const IsoDeposit & dep )

inline

Definition at line 209 of file Lepton.h.

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

◆ userIso()

template<class LeptonType>

float pat::Lepton< LeptonType >::userIso ( uint8_t index = 0 ) const

inline

Returns the user defined isolation variable #index that was stored in this object when produced, or -1.0 if there is none

Definition at line 168 of file Lepton.h.

168 { return userIsolation(IsolationKeys(UserBaseIso + index)); }

◆ userIsoDeposit() [1/2]

template<class LeptonType>

void pat::Lepton< LeptonType >::userIsoDeposit	(	const IsoDeposit &	dep,
		uint8_t	index = `0`
	)

inline

Definition at line 212 of file Lepton.h.

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

◆ userIsoDeposit() [2/2]

template<class LeptonType>

const IsoDeposit* pat::Lepton< LeptonType >::userIsoDeposit ( uint8_t index = 0 ) const

inline

Definition at line 206 of file Lepton.h.

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

◆ userIsolation() [1/2]

template<class LeptonType>

float pat::Lepton< LeptonType >::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 74 of file Lepton.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);
       if (prunedKey == "PfPUChargedHadronIso")
         return userIsolation(pat::PfPUChargedHadronIso);
       //throw cms::Excepton("Missing Data")
       //<< "Isolation corresponding to key "
       //<< key << " was not stored for this particle.";
       return -1.0;
     }

◆ userIsolation() [2/2]

template<class LeptonType>

float pat::Lepton< LeptonType >::userIsolation ( IsolationKeys key ) const

inline

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

Definition at line 48 of file Lepton.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")
             //<< "CaloIso 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.";
         }
     }

Member Data Documentation

◆ isoDeposits_

template<class LeptonType>

IsoDepositPairs pat::Lepton< LeptonType >::isoDeposits_

protected

Definition at line 222 of file Lepton.h.

Referenced by pat::Lepton< reco::Muon >::isoDeposit(), and pat::Lepton< reco::Muon >::setIsoDeposit().

◆ isolations_

template<class LeptonType>

std::vector<float> pat::Lepton< LeptonType >::isolations_

protected

Definition at line 223 of file Lepton.h.

Referenced by pat::Lepton< reco::Muon >::setIsolation(), and pat::Lepton< reco::Muon >::userIsolation().

◆ miniPFIsolation_

template<class LeptonType>

PFIsolation pat::Lepton< LeptonType >::miniPFIsolation_

protected

Definition at line 225 of file Lepton.h.

Referenced by pat::Lepton< reco::Muon >::miniPFIsolation(), and pat::Lepton< reco::Muon >::setMiniPFIsolation().

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

template<class LeptonType> class pat::Lepton< LeptonType >

Member Typedef Documentation

◆ IsoDepositPairs

Constructor & Destructor Documentation

◆ Lepton() [1/4]

◆ Lepton() [2/4]

◆ Lepton() [3/4]

◆ Lepton() [4/4]

◆ ~Lepton()

Member Function Documentation

◆ caloIso()

◆ chargedHadronIso()

◆ clone()

◆ ecalIso()

◆ ecalIsoDeposit() [1/2]

◆ ecalIsoDeposit() [2/2]

◆ genLepton()

◆ hcalIso()

◆ hcalIsoDeposit() [1/2]

◆ hcalIsoDeposit() [2/2]

◆ isoDeposit()

◆ miniPFIsolation()

◆ neutralHadronIso()

◆ particleIso()

◆ photonIso()

◆ puChargedHadronIso()

◆ setEcalIso()

◆ setGenLepton()

◆ setHcalIso()

◆ setIsoDeposit()

◆ setIsolation()

◆ setMiniPFIsolation()

◆ setTrackIso()

◆ setUserIso()

◆ trackIso()

◆ trackIsoDeposit() [1/2]

◆ trackIsoDeposit() [2/2]

◆ userIso()

◆ userIsoDeposit() [1/2]

◆ userIsoDeposit() [2/2]

◆ userIsolation() [1/2]

◆ userIsolation() [2/2]

Member Data Documentation

◆ isoDeposits_

◆ isolations_

◆ miniPFIsolation_

template<class LeptonType>
class pat::Lepton< LeptonType >