Muon.Muon Class Reference

Inheritance diagram for Muon.Muon:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	absIsoWithFSR (self, R=0.4, puCorr="deltaBeta", dBetaFactor=0.5)
def	chargedAllIso (self)
def	chargedAllIsoR (self, R=0.4)
def	chargedHadronIsoR (self, R=0.4)
def	dxy (self, vertex=None)
def	dz (self, vertex=None)
def	edxy (self)
def	edz (self)
def	looseId (self)
def	muonID (self, name, vertex=None)
def	mvaId (self)
def	neutralHadronIsoR (self, R=0.4)
def	photonIsoR (self, R=0.4)
def	ptErr (self)
def	puChargedHadronIsoR (self, R=0.4)
def	setTrackForDxyDz (self, what)
def	tightId (self)

Private Attributes
	_trackForDxyDz

Detailed Description

Definition at line 4 of file Muon.py.

Constructor & Destructor Documentation

__init__()

def Muon.Muon.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 6 of file Muon.py.

    def __init__(self, *args, **kwargs):
        super(Muon, self).__init__(*args, **kwargs)
        self._trackForDxyDz = "muonBestTrack"
 

Member Function Documentation

absIsoWithFSR()

def Muon.Muon.absIsoWithFSR	(		self,
			R = 0.4,
			puCorr = "deltaBeta",
			dBetaFactor = 0.5
	)

Calculate Isolation, subtract FSR, apply specific PU corrections" 

Definition at line 114 of file Muon.py.

    def absIsoWithFSR(self, R=0.4, puCorr="deltaBeta", dBetaFactor=0.5):
        '''
        Calculate Isolation, subtract FSR, apply specific PU corrections" 
        '''
        photonIso = self.photonIsoR(R)
        if hasattr(self,'fsrPhotons'):
            for gamma in self.fsrPhotons:
                dr = deltaR(gamma.eta(), gamma.phi(), self.physObj.eta(), self.physObj.phi())
                if dr > 0.01 and dr < R:
                    photonIso = max(photonIso-gamma.pt(),0.0)                
        if puCorr == "deltaBeta":
            offset = dBetaFactor * self.puChargedHadronIsoR(R)
        elif puCorr == "rhoArea":
            offset = self.rho*getattr(self,"EffectiveArea"+(str(R).replace(".","")))
        elif puCorr in ["none","None",None]:
            offset = 0
        else:
             raise RuntimeError("Unsupported PU correction scheme %s" % puCorr)
        return self.chargedHadronIsoR(R)+max(0.,photonIso+self.neutralHadronIsoR(R)-offset)            
 

References Muon.Muon.chargedHadronIsoR(), Electron.Electron.chargedHadronIsoR(), PbPb_ZMuSkimMuonDPG_cff.deltaR, PVValHelper.eta, SiStripPI.max, Muon.Muon.neutralHadronIsoR(), Electron.Electron.neutralHadronIsoR(), Muon.Muon.photonIsoR(), Electron.Electron.photonIsoR(), PhysicsObject.PhysicsObject.physObj, Muon.Muon.puChargedHadronIsoR(), Electron.Electron.puChargedHadronIsoR(), python.rootplot.root2matplotlib.replace(), Photon.Photon.rho, Electron.Electron.rho, CalorimeterProperties.rho(), PreshowerProperties.rho(), TauValidation.rho, ECALProperties.rho(), correctionValue_class.rho, HCALProperties.rho(), TangentCircle.rho(), MaterialEffectsSimulator.rho(), TangentHelix.rho(), FastCircle.rho(), RhoEtaPhi.rho(), reco::GhostTrackPrediction.rho(), QcdLowPtDQM::Pixel.rho(), fastjet::BackgroundEstimator.rho(), FastCircleFit.rho(), StoredPileupJetIdentifier.rho(), reco::CastorCell.rho(), CylindricalState.rho(), reco::CastorEgamma.rho(), reco::CastorJet.rho(), GeometricTimingDet.rho(), reco::CastorTower.rho(), reco::CastorCluster.rho(), GeometricDet.rho(), AlignmentMonitorMuonSystemMap1D::MyResidual.rho, HGCalImagingAlgo::Hexel.rho, HGCalCLUEAlgoT< TILE >::CellsOnLayer.rho, objects.JetAnalyzer.JetAnalyzer.rho, and str.

chargedAllIso()

def Muon.Muon.chargedAllIso

(

self

)

Definition at line 105 of file Muon.py.

    def chargedAllIso(self):
        return self.chargedAllIsoR()
 

References Muon.Muon.chargedAllIsoR(), and Electron.Electron.chargedAllIsoR().

chargedAllIsoR()

def Muon.Muon.chargedAllIsoR	(		self,
			R = 0.4
	)

Definition at line 100 of file Muon.py.

    def chargedAllIsoR(self,R=0.4):
        if   R == 0.3: return self.physObj.pfIsolationR03().sumChargedParticlePt 
        elif R == 0.4: return self.physObj.pfIsolationR04().sumChargedParticlePt 
        raise RuntimeError("Muon chargedAllIso missing for R=%s" % R)
 

References muons_cfi.pfIsolationR03, muons_cfi.pfIsolationR04, and PhysicsObject.PhysicsObject.physObj.

Referenced by Lepton.Lepton.absIsoR(), and Muon.Muon.chargedAllIso().

chargedHadronIsoR()

def Muon.Muon.chargedHadronIsoR	(		self,
			R = 0.4
	)

Definition at line 85 of file Muon.py.

    def chargedHadronIsoR(self,R=0.4):
        if   R == 0.3: return self.physObj.pfIsolationR03().sumChargedHadronPt 
        elif R == 0.4: return self.physObj.pfIsolationR04().sumChargedHadronPt 
        raise RuntimeError("Muon chargedHadronIso missing for R=%s" % R)
 

References muons_cfi.pfIsolationR03, muons_cfi.pfIsolationR04, and PhysicsObject.PhysicsObject.physObj.

Referenced by Lepton.Lepton.absIsoR(), and Muon.Muon.absIsoWithFSR().

dxy()

def Muon.Muon.dxy	(		self,
			vertex = None
	)

either pass the vertex, or set associatedVertex before calling the function.
note: the function does not work with standalone muons as innerTrack
is not available.

Definition at line 58 of file Muon.py.

    def dxy(self, vertex=None):
        '''either pass the vertex, or set associatedVertex before calling the function.
        note: the function does not work with standalone muons as innerTrack
        is not available.
        '''
        if vertex is None:
            vertex = self.associatedVertex
        return getattr(self,self._trackForDxyDz)().dxy( vertex.position() )
 

References Muon.Muon._trackForDxyDz, Electron.Electron.associatedVertex, and reco::tau::RecoTauVertexAssociator.associatedVertex().

Referenced by ntupleDataFormat.Track.dxyPull().

dz()

def Muon.Muon.dz	(		self,
			vertex = None
	)

either pass the vertex, or set associatedVertex before calling the function.
note: the function does not work with standalone muons as innerTrack
is not available.

Definition at line 72 of file Muon.py.

    def dz(self, vertex=None):
        '''either pass the vertex, or set associatedVertex before calling the function.
        note: the function does not work with standalone muons as innerTrack
        is not available.
        '''
        if vertex is None:
            vertex = self.associatedVertex
        return getattr(self,self._trackForDxyDz)().dz( vertex.position() )
 

References Muon.Muon._trackForDxyDz, Electron.Electron.associatedVertex, and reco::tau::RecoTauVertexAssociator.associatedVertex().

Referenced by ntupleDataFormat.Track.dzPull().

edxy()

def Muon.Muon.edxy

(

self

)

returns the uncertainty on dxy (from gsf track)

Definition at line 67 of file Muon.py.

    def edxy(self):
        '''returns the uncertainty on dxy (from gsf track)'''
        return getattr(self,self._trackForDxyDz)().dxyError()
 
 

References Muon.Muon._trackForDxyDz.

edz()

def Muon.Muon.edz

(

self

)

returns the uncertainty on dxz (from gsf track)

Definition at line 81 of file Muon.py.

    def edz(self):
        '''returns the uncertainty on dxz (from gsf track)'''
        return getattr(self,self._trackForDxyDz)().dzError()
 

References Muon.Muon._trackForDxyDz.

looseId()

def Muon.Muon.looseId

(

self

)

Loose ID as recommended by mu POG.

Definition at line 15 of file Muon.py.

    def looseId( self ):
        '''Loose ID as recommended by mu POG.'''
        return self.physObj.isLooseMuon()
 

References muon.isLooseMuon(), and PhysicsObject.PhysicsObject.physObj.

Referenced by Muon.Muon.muonID().

muonID()

def Muon.Muon.muonID	(		self,
			name,
			vertex = None
	)

Definition at line 28 of file Muon.py.

    def muonID(self, name, vertex=None):
        if name == "" or name is None: 
            return True
        if name.startswith("POG_"):
            if name == "POG_ID_Loose": return self.physObj.isLooseMuon()
            if vertex is None:
                vertex = getattr(self, 'associatedVertex', None)
            if name == "POG_ID_Tight":  return self.physObj.isTightMuon(vertex)
            if name == "POG_ID_HighPt": return self.physObj.isHighPtMuon(vertex)
            if name == "POG_ID_Soft":   return self.physObj.isSoftMuon(vertex)
            if name == "POG_ID_TightNoVtx":  return self.looseId() and \
                                                 self.isGlobalMuon() and \
                                                 self.globalTrack().normalizedChi2() < 10 and \
                                                 self.globalTrack().hitPattern().numberOfValidMuonHits() > 0 and \
                                                 self.numberOfMatchedStations()>1 and \
                                                 self.innerTrack().hitPattern().numberOfValidPixelHits()>0 and \
                                                 self.innerTrack().hitPattern().trackerLayersWithMeasurement() > 5
            if name == "POG_ID_Medium":
                if not self.looseId(): return False
                goodGlb = self.physObj.isGlobalMuon() and self.physObj.globalTrack().normalizedChi2() < 3 and self.physObj.combinedQuality().chi2LocalPosition < 12 and self.physObj.combinedQuality().trkKink < 20;
                return self.physObj.innerTrack().validFraction() > 0.8 and self.physObj.segmentCompatibility() >= (0.303 if goodGlb else 0.451)
            if name == "POG_Global_OR_TMArbitrated":
                return self.physObj.isGlobalMuon() or (self.physObj.isTrackerMuon() and self.physObj.numberOfMatchedStations() > 0)
        return self.physObj.muonID(name)
            

References reco::MuonTrackLinks.globalTrack(), reco::Muon.globalTrack(), pat::Muon.globalTrack(), cutBasedMuonId_MuonPOG_V0_cff.globalTrack, susybsm::HSCParticleType.innerTrack, reco::CaloMuon.innerTrack(), reco::ME0Muon.innerTrack(), reco::Muon.innerTrack(), pat::Muon.innerTrack(), HcalRaddamMuon.innerTrack, reco::ShallowClonePtrCandidate.isGlobalMuon(), reco::ShallowCloneCandidate.isGlobalMuon(), ScoutingMuon.isGlobalMuon(), reco::LeafRefCandidateT.isGlobalMuon(), Run3ScoutingMuon.isGlobalMuon(), reco::Candidate.isGlobalMuon(), reco::LeafCandidate.isGlobalMuon(), HGCalClusterT< C >.isGlobalMuon(), reco::Muon.isGlobalMuon(), pat::PackedGenParticle.isGlobalMuon(), pat::PackedCandidate.isGlobalMuon(), muon.isHighPtMuon(), muon.isLooseMuon(), muon.isSoftMuon(), muon.isTightMuon(), Muon.Muon.looseId(), TrackCollections2monitor_cff.normalizedChi2, L1Analysis::L1AnalysisRecoMuonDataFormat.numberOfMatchedStations, reco::Muon.numberOfMatchedStations(), TrackCollections2monitor_cff.numberOfValidPixelHits, PhysicsObject.PhysicsObject.physObj, and BadChargedCandidateFilter_cfi.segmentCompatibility.

Referenced by Muon.Muon.tightId().

mvaId()

def Muon.Muon.mvaId

(

self

)

For a transparent treatment of electrons and muons. Returns -99

Definition at line 53 of file Muon.py.

    def mvaId(self):
        '''For a transparent treatment of electrons and muons. Returns -99'''
        return -99
    
 

neutralHadronIsoR()

def Muon.Muon.neutralHadronIsoR	(		self,
			R = 0.4
	)

Definition at line 90 of file Muon.py.

    def neutralHadronIsoR(self,R=0.4):
        if   R == 0.3: return self.physObj.pfIsolationR03().sumNeutralHadronEt 
        elif R == 0.4: return self.physObj.pfIsolationR04().sumNeutralHadronEt 
        raise RuntimeError("Muon neutralHadronIso missing for R=%s" % R)
 

References muons_cfi.pfIsolationR03, muons_cfi.pfIsolationR04, and PhysicsObject.PhysicsObject.physObj.

Referenced by Lepton.Lepton.absIsoR(), and Muon.Muon.absIsoWithFSR().

photonIsoR()

def Muon.Muon.photonIsoR	(		self,
			R = 0.4
	)

Definition at line 95 of file Muon.py.

    def photonIsoR(self,R=0.4):
        if   R == 0.3: return self.physObj.pfIsolationR03().sumPhotonEt 
        elif R == 0.4: return self.physObj.pfIsolationR04().sumPhotonEt 
        raise RuntimeError("Muon photonIso missing for R=%s" % R)
 

References muons_cfi.pfIsolationR03, muons_cfi.pfIsolationR04, and PhysicsObject.PhysicsObject.physObj.

Referenced by Lepton.Lepton.absIsoR(), and Muon.Muon.absIsoWithFSR().

ptErr()

def Muon.Muon.ptErr

(

self

)

Definition at line 134 of file Muon.py.

    def ptErr(self):
        if "_ptErr" in self.__dict__: return self.__dict__['_ptErr']
        return self.bestTrack().ptError()

References reco::RecoChargedRefCandidate.bestTrack(), reco::RecoCandidate.bestTrack(), reco::Muon.bestTrack(), pat::Muon.bestTrack(), reco::PFCandidate.bestTrack(), reco::Candidate.bestTrack(), HGCalClusterT< C >.bestTrack(), and pat::PackedCandidate.bestTrack().

Referenced by ntupleDataFormat.Track.ptPull().

puChargedHadronIsoR()

def Muon.Muon.puChargedHadronIsoR	(		self,
			R = 0.4
	)

Definition at line 108 of file Muon.py.

    def puChargedHadronIsoR(self,R=0.4):
        if   R == 0.3: return self.physObj.pfIsolationR03().sumPUPt 
        elif R == 0.4: return self.physObj.pfIsolationR04().sumPUPt 
        raise RuntimeError("Muon chargedHadronIso missing for R=%s" % R)
 
 

References muons_cfi.pfIsolationR03, muons_cfi.pfIsolationR04, and PhysicsObject.PhysicsObject.physObj.

Referenced by Lepton.Lepton.absIsoR(), and Muon.Muon.absIsoWithFSR().

setTrackForDxyDz()

def Muon.Muon.setTrackForDxyDz	(		self,
			what
	)

Definition at line 10 of file Muon.py.

    def setTrackForDxyDz(self,what):
        if not hasattr(self,what):
            raise RuntimeError("I don't have a track called "+what)
        self._trackForDxyDz = what
 

References Muon.Muon._trackForDxyDz.

tightId()

def Muon.Muon.tightId

(

self

)

Tight ID as recommended by mu POG 
(unless redefined in the lepton analyzer).

If not using the LeptonAnalyzer, make sure to set self.associatedVertex, 
that is necessary for tight muon identification. 

Definition at line 19 of file Muon.py.

    def tightId( self ):
        '''Tight ID as recommended by mu POG 
        (unless redefined in the lepton analyzer).
 
        If not using the LeptonAnalyzer, make sure to set self.associatedVertex, 
        that is necessary for tight muon identification. 
        '''
        return getattr(self,"tightIdResult",self.muonID("POG_ID_Tight"))
 

References Muon.Muon.muonID(), and pat::Muon.muonID().

Member Data Documentation

_trackForDxyDz

Muon.Muon._trackForDxyDz

private

Definition at line 8 of file Muon.py.

Referenced by Muon.Muon.dxy(), Muon.Muon.dz(), Muon.Muon.edxy(), Muon.Muon.edz(), and Muon.Muon.setTrackForDxyDz().