CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Protected Attributes | Friends
pat::Muon Class Reference

Analysis-level muon class. More...

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

Inheritance diagram for pat::Muon:
pat::Lepton< reco::Muon > pat::PATObject< reco::Muon > reco::Muon reco::RecoCandidate reco::LeafCandidate reco::Candidate

Public Types

enum  IPTYPE {
  PV2D = 0, PV3D = 1, BS2D = 2, BS3D = 3,
  PVDZ = 4, IpTypeSize = 5
}
 
typedef enum pat::Muon::IPTYPE IpType
 
- Public Types inherited from pat::PATObject< reco::Muon >
typedef reco::Muon base_type
 
- Public Types inherited from reco::Muon
enum  ArbitrationType {
  NoArbitration, SegmentArbitration, SegmentAndTrackArbitration, SegmentAndTrackArbitrationCleaned,
  RPCHitAndTrackArbitration, GEMSegmentAndTrackArbitration, ME0SegmentAndTrackArbitration, GEMHitAndTrackArbitration
}
 define arbitration schemes More...
 
typedef std::map< MuonTrackType, reco::TrackRefMuonTrackRefMap
 
enum  MuonTrackType {
  None, InnerTrack, OuterTrack, CombinedTrack,
  TPFMS, Picky, DYT
}
 map for Global Muon refitters More...
 
typedef std::pair< TrackRef, Muon::MuonTrackTypeMuonTrackTypePair
 
enum  Selector {
  CutBasedIdLoose = 0, CutBasedIdMedium = 1, CutBasedIdMediumPrompt = 2, CutBasedIdTight = 3,
  CutBasedIdGlobalHighPt = 4, CutBasedIdTrkHighPt = 5, PFIsoVeryLoose = 6, PFIsoLoose = 7,
  PFIsoMedium = 8, PFIsoTight = 9, PFIsoVeryTight = 10, TkIsoLoose = 11,
  TkIsoTight = 12, SoftCutBasedId = 13, SoftMvaId = 14, MvaLoose = 15,
  MvaMedium = 16, MvaTight = 17, MiniIsoLoose = 18, MiniIsoMedium = 19,
  MiniIsoTight = 20, MiniIsoVeryTight = 21, TriggerIdLoose = 22, InTimeMuon = 23,
  PFIsoVeryVeryTight = 24, MultiIsoLoose = 25, MultiIsoMedium = 26, PuppiIsoLoose = 27,
  PuppiIsoMedium = 28, PuppiIsoTight = 29, MvaVTight = 30, MvaVVTight = 31,
  LowPtMvaLoose = 32, LowPtMvaMedium = 33, MvaIDwpMedium = 34, MvaIDwpTight = 35
}
 
- 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...
 

Public Member Functions

const reco::TrackbestTrack () const override
 Track selected to be the best measurement of the muon parameters (including PFlow global information) More...
 
float caloIso () const
 
reco::MuonMETCorrectionData caloMETMuonCorrs () const
 muon MET corrections for caloMET; returns the muon correction struct if embedded during pat tuple production or an empty element More...
 
Muonclone () const override
 required reimplementation of the Candidate's clone method More...
 
reco::TrackRef combinedMuon () const override
 reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) More...
 
double dB (IPTYPE type) const
 
double dB () const
 the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) More...
 
reco::TrackRef dytTrack () const override
 reference to Track reconstructed using DYT algorithm More...
 
float ecalIso () const
 
double edB (IPTYPE type) const
 
double edB () const
 the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) More...
 
void embedCaloMETMuonCorrs (const reco::MuonMETCorrectionData &t)
 
void embedCombinedMuon ()
 set reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) More...
 
void embedDytMuon ()
 embed reference to the above dyt Track More...
 
void embedMuonBestTrack (bool force=false)
 
void embedPFCandidate ()
 embed the IsolatedPFCandidate pointed to by pfCandidateRef_ More...
 
void embedPickyMuon ()
 embed reference to the above picky Track More...
 
void embedStandAloneMuon ()
 set reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon) More...
 
void embedTcMETMuonCorrs (const reco::MuonMETCorrectionData &t)
 
void embedTpfmsMuon ()
 embed reference to the above tpfms Track More...
 
void embedTrack ()
 set reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) More...
 
void embedTunePMuonBestTrack (bool force=false)
 
reco::TrackRef globalTrack () const override
 reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) More...
 
float hcalIso () const
 
const pat::TriggerObjectStandAlonehltObject (const size_t idx=0) const
 
void initImpactParameters (void)
 
void initSimInfo (void)
 
reco::TrackRef innerTrack () const override
 reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) More...
 
float inverseBeta () const
 (time is constraint to the bunch crossing time) More...
 
float inverseBetaErr () const
 
bool isGood (const std::string &name) const
 
bool isHighPtMuon (const reco::Vertex &) const
 
bool isLooseMuon () const
 
bool isMediumMuon () const
 
bool isSoftMuon (const reco::Vertex &) const
 
bool isTightMuon (const reco::Vertex &) const
 
float jetPtRatio () const
 near-by jet information More...
 
float jetPtRel () const
 
const pat::TriggerObjectStandAlonel1Object (const size_t idx=0) const
 Trigger information. More...
 
 Muon ()
 default constructor More...
 
 Muon (const reco::Muon &aMuon)
 constructor from a reco muon More...
 
 Muon (const edm::RefToBase< reco::Muon > &aMuonRef)
 constructor from a RefToBase to a reco muon (to be superseded by Ptr counterpart) More...
 
 Muon (const edm::Ptr< reco::Muon > &aMuonRef)
 constructor from a Ptr to a reco muon More...
 
reco::TrackRef muonBestTrack () const override
 Track selected to be the best measurement of the muon parameters (including PFlow global information) More...
 
bool muonID (const std::string &name) const
 
float mvaIDValue () const
 Muon MVA ID. More...
 
double normChi2 () const
 Norm chi2 gives the normalized chi2 of the global track. More...
 
size_t numberOfSourceCandidatePtrs () const override
 get the number of non-null PF candidates More...
 
unsigned int numberOfValidHits () const
 numberOfValidHits returns the number of valid hits on the global track. More...
 
reco::TrackRef outerTrack () const override
 reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon) More...
 
reco::PFCandidateRef pfCandidateRef () const
 
float pfEcalEnergy () const
 
reco::TrackRef pickyMuon () const
 Deprecated accessors to call the corresponding above two functions; no dytMuon since this naming is deprecated. More...
 
reco::TrackRef pickyTrack () const override
 reference to Track reconstructed using hits in the tracker + "good" muon hits (reimplemented from reco::Muon) More...
 
float puppiChargedHadronIso () const
 returns PUPPI isolations More...
 
float puppiNeutralHadronIso () const
 
float puppiNoLeptonsChargedHadronIso () const
 returns PUPPINoLeptons isolations More...
 
float puppiNoLeptonsNeutralHadronIso () const
 
float puppiNoLeptonsPhotonIso () const
 
float puppiPhotonIso () const
 
void readTimeExtra (const reco::MuonTimeExtra &t)
 
void rekeyEmbeddedTracks (std::vector< edm::Handle< edm::Association< reco::TrackExtraCollection >>> const &assocs)
 
double segmentCompatibility (reco::Muon::ArbitrationType arbitrationType=reco::Muon::SegmentAndTrackArbitration) const
 Returns the segment compatibility, using muon::segmentCompatibility (DataFormats/MuonReco/interface/MuonSelectors.h) More...
 
void setDB (double dB, double edB, IPTYPE type=PV2D)
 
void setExtSimType (reco::ExtendedMuonSimType type)
 
void setIsolationPUPPI (float chargedhadrons, float neutralhadrons, float photons)
 sets PUPPI isolations More...
 
void setIsolationPUPPINoLeptons (float chargedhadrons, float neutralhadrons, float photons)
 sets PUPPINoLeptons isolations More...
 
void setJetPtRatio (float jetPtRatio)
 
void setJetPtRel (float jetPtRel)
 
void setMvaIDValue (float mvaID)
 
void setNormChi2 (double normChi2)
 
void setNumberOfValidHits (unsigned int numberOfValidHits)
 
void setPFCandidateRef (const reco::PFCandidateRef &ref)
 add a reference to the source IsolatedPFCandidate More...
 
void setPfEcalEnergy (float pfEcalEnergy)
 
void setSimBX (int bx)
 
void setSimEta (float eta)
 
void setSimFlavour (int f)
 
void setSimHeaviestMotherFlavour (int id)
 
void setSimMatchQuality (float quality)
 
void setSimMotherPdgId (int id)
 
void setSimPdgId (int id)
 
void setSimPhi (float phi)
 
void setSimProdRho (float rho)
 
void setSimProdZ (float z)
 
void setSimPt (float pt)
 
void setSimTpEvent (int tpEvent)
 
void setSimType (reco::MuonSimType type)
 
void setSoftMvaRun3Value (float softmva)
 
void setSoftMvaValue (float softmva)
 
int simBX () const
 
float simEta () const
 
reco::ExtendedMuonSimType simExtType () const
 
int simFlavour () const
 
int simHeaviestMotherFlavour () const
 
float simMatchQuality () const
 
int simMotherPdgId () const
 
int simPdgId () const
 
float simPhi () const
 
float simProdRho () const
 
float simProdZ () const
 
float simPt () const
 
int simTpEvent () const
 
reco::MuonSimType simType () const
 MC matching information. More...
 
float softMvaRun3Value () const
 
float softMvaValue () const
 Soft Muon MVA. More...
 
reco::CandidatePtr sourceCandidatePtr (size_type i) const override
 get the candidate pointer with index i More...
 
reco::TrackRef standAloneMuon () const override
 reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon) More...
 
reco::MuonMETCorrectionData tcMETMuonCorrs () const
 muon MET corrections for tcMET; returns the muon correction struct if embedded during pat tuple production or an empty element More...
 
reco::TrackRef tpfmsMuon () const
 
reco::TrackRef tpfmsTrack () const override
 reference to Track reconstructed using hits in the tracker + info from the first muon station that has hits (reimplemented from reco::Muon) More...
 
reco::TrackRef track () const override
 reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) More...
 
float trackIso () const
 
bool triggered (const char *pathName) const
 
reco::TrackRef tunePMuonBestTrack () const override
 Track selected to be the best measurement of the muon parameters (from muon information alone) More...
 
 ~Muon () override
 destructor More...
 
- Public Member Functions inherited from pat::Lepton< reco::Muon >
float caloIso () const
 
float chargedHadronIso () const
 
Lepton< reco::Muon > * clone () const override
 
float ecalIso () const
 
const IsoDepositecalIsoDeposit () const
 
void ecalIsoDeposit (const IsoDeposit &dep)
 
const reco::GenParticlegenLepton () const
 
float hcalIso () const
 
const IsoDeposithcalIsoDeposit () const
 
void hcalIsoDeposit (const IsoDeposit &dep)
 
const IsoDepositisoDeposit (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 reco::Muon &aLepton)
 constructor from LeptonType More...
 
 Lepton (const edm::RefToBase< reco::Muon > &aLeptonRef)
 constructor from ref to LeptonType More...
 
 Lepton (const edm::Ptr< reco::Muon > &aLeptonRef)
 constructor from ref to LeptonType More...
 
const PFIsolationminiPFIsolation () 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 IsoDeposittrackIsoDeposit () const
 
void trackIsoDeposit (const IsoDeposit &dep)
 
float userIso (uint8_t index=0) const
 
const IsoDeposituserIsoDeposit (uint8_t index=0) const
 
void userIsoDeposit (const IsoDeposit &dep, uint8_t index=0)
 
float userIsolation (IsolationKeys key) const
 
float userIsolation (const std::string &key) const
 
 ~Lepton () override
 destructor More...
 
- Public Member Functions inherited from pat::PATObject< reco::Muon >
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::LookupTableRecordefficiency (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::GenParticlegenParticle (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::GenParticleRefgenParticleRefs () const
 
size_t genParticlesSize () const
 Number of generator level particles stored as ref or embedded. More...
 
const pat::CandKinResolutiongetKinResolution (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 std::string &key) const
 Return true if there is a user-defined float with a given name. More...
 
bool hasUserFloat (const char *key) const
 a CINT-friendly interface More...
 
bool hasUserInt (const std::string &key) const
 Return true if there is a user-defined int with a given name. More...
 
const reco::CandidateoriginalObject () 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::CandidatePtrVectoroverlaps (const std::string &label) const
 
 PATObject ()
 default constructor More...
 
 PATObject (const reco::Muon &obj)
 constructor from a base object (leaves invalid reference to original object!) More...
 
 PATObject (const edm::RefToBase< reco::Muon > &ref)
 constructor from reference More...
 
 PATObject (const edm::Ptr< reco::Muon > &ref)
 constructor from reference 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 TriggerObjectStandAlonetriggerObjectMatch (const size_t idx=0) const
 get one matched trigger object by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByCollection (const std::string &coll, const size_t idx=0) const
 get one matched trigger object from a certain collection by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByCollection (const char *coll, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByCondition (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 TriggerObjectStandAlonetriggerObjectMatchByCondition (const char *nameCondition, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByFilter (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 TriggerObjectStandAlonetriggerObjectMatchByFilter (const char *labelFilter, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByFilterID (const unsigned triggerObjectType, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const char *namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const std::string &namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByPath (const char *namePath, const unsigned pathLastFilterAccepted, const unsigned pathL3FilterAccepted=1, const size_t idx=0) const
 
const TriggerObjectStandAlonetriggerObjectMatchByType (const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
 get one matched trigger object of a certain type by index More...
 
const TriggerObjectStandAlonetriggerObjectMatchByType (const unsigned triggerObjectType, const size_t idx=0) const
 
const TriggerObjectStandAloneCollectiontriggerObjectMatches () const
 get all matched trigger objects More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const bool algoCondAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const bool algoCondAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const std::string &nameAlgorithm, const unsigned algoCondAccepted) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByAlgorithm (const char *nameAlgorithm, const unsigned algoCondAccepted) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCollection (const std::string &coll) const
 get all matched trigger objects from a certain collection More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByCollection (const char *coll) 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 triggerObjectMatchesByCondition (const char *nameCondition) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilter (const std::string &labelFilter) const
 get all matched HLT objects used in a certain HLT filter More...
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilter (const char *labelFilter) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByFilterID (const unsigned triggerObjectType) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true) const
 
const TriggerObjectStandAloneCollection triggerObjectMatchesByPath (const char *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 triggerObjectMatchesByPath (const char *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 TuserData (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 std::string &key) const
 
float userFloat (const char *key) const
 a CINT-friendly interface More...
 
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::Muon
TrackBaseRef bestTrackRef () const override
 best track RefToBase More...
 
MuonEnergy calEnergy () const
 get energy deposition information More...
 
float caloCompatibility () const
 
MuonQuality combinedQuality () const
 get energy deposition information More...
 
float dDxDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float dDyDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float dX (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float dY (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
unsigned int expectedNnumberOfMatchedStations (float minDistanceFromEdge=10.0) const
 
bool hasShowerInStation (int station, int muonSubdetId, int nDtDigisCut=20, int nCscDigisCut=36) const
 tag a shower in a given station layer More...
 
bool isAValidMuonTrack (const MuonTrackType &type) const
 
bool isCaloCompatibilityValid () const
 
bool isCaloMuon () const override
 
bool isEnergyValid () const
 
bool isGEMMuon () const
 
bool isGlobalMuon () const override
 
bool isIsolationValid () const
 
bool isMatchesValid () const
 
bool isME0Muon () const
 
bool isMuon () const override
 
const MuonIsolationisolationR03 () const
 
const MuonIsolationisolationR05 () const
 
bool isPFIsolationValid () const
 
bool isPFMuon () const
 
bool isQualityValid () const
 
bool isRPCMuon () const
 
bool isStandAloneMuon () const override
 
bool isTimeValid () const
 
bool isTrackerMuon () const override
 
std::vector< MuonChamberMatch > & matches ()
 get muon matching information More...
 
const std::vector< MuonChamberMatch > & matches () const
 
 Muon ()
 
 Muon (Charge, const LorentzVector &, const Point &=Point(0, 0, 0))
 constructor from values More...
 
virtual MuonTrackType muonBestTrackType () const
 
TrackRef muonTrack (const MuonTrackType &) const
 
TrackRef muonTrackFromMap (const MuonTrackType &type) const
 
int nDigisInStation (int station, int muonSubdetId) const
 

of digis in a given station layer

More...
 
int numberOfChambers () const
 
int numberOfChambersCSCorDT () const
 number of chambers CSC or DT matches only (MuonChamberMatches include RPC rolls) More...
 
int numberOfMatchedRPCLayers (ArbitrationType type=RPCHitAndTrackArbitration) const
 
int numberOfMatchedStations (ArbitrationType type=SegmentAndTrackArbitration) const
 
int numberOfMatches (ArbitrationType type=SegmentAndTrackArbitration) const
 get number of chambers with matched segments More...
 
int numberOfSegments (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 get number of segments More...
 
int numberOfShowers (int nDtDigisCut=20, int nCscDigisCut=36) const
 count the number of showers along a muon track More...
 
bool passed (uint64_t selection) const
 
bool passed (Selector selection) const
 
const MuonPFIsolationpfIsolationR03 () const
 
const MuonPFIsolationpfIsolationR04 () const
 
const MuonPFIsolationpfMeanDRIsoProfileR03 () const
 
const MuonPFIsolationpfMeanDRIsoProfileR04 () const
 
reco::Candidate::LorentzVector pfP4 () const
 
const MuonPFIsolationpfSumDRIsoProfileR03 () const
 
const MuonPFIsolationpfSumDRIsoProfileR04 () const
 
float pullDxDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration, bool includeSegmentError=true) const
 
float pullDyDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration, bool includeSegmentError=true) const
 
float pullX (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration, bool includeSegmentError=true) const
 
float pullY (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration, bool includeSegmentError=true) const
 
unsigned int RPClayerMask (ArbitrationType type=RPCHitAndTrackArbitration) const
 
MuonTime rpcTime () const
 get RPC timing information More...
 
float segmentDxDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentDxDzErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentDyDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentDyDzErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentX (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentXErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentY (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float segmentYErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
uint64_t selectors () const
 
virtual void setBestTrack (MuonTrackType muonType)
 
void setCalEnergy (const MuonEnergy &calEnergy)
 set energy deposition information More...
 
void setCaloCompatibility (float input)
 
virtual void setCombined (const TrackRef &t)
 
void setCombinedQuality (const MuonQuality &combinedQuality)
 set energy deposition information More...
 
virtual void setGlobalTrack (const TrackRef &t)
 set reference to Track More...
 
virtual void setInnerTrack (const TrackRef &t)
 set reference to Track More...
 
void setIsolation (const MuonIsolation &isoR03, const MuonIsolation &isoR05)
 
void setMatches (const std::vector< MuonChamberMatch > &matches)
 set muon matching information More...
 
void setMuonTrack (const MuonTrackType &, const TrackRef &)
 
virtual void setOuterTrack (const TrackRef &t)
 set reference to Track More...
 
void setPFIsolation (const std::string &label, const reco::MuonPFIsolation &deposit)
 
virtual void setPFP4 (const reco::Candidate::LorentzVector &p4_)
 
void setRPCTime (const MuonTime &time)
 set RPC timing information More...
 
void setSelector (Selector selector, bool passed)
 
void setSelectors (uint64_t selectors)
 
virtual void setStandAlone (const TrackRef &t)
 
void setTime (const MuonTime &time)
 set DT/CSC combined timing information More...
 
virtual void setTrack (const TrackRef &t)
 
virtual void setTunePBestTrack (MuonTrackType muonType)
 
void setType (unsigned int type)
 
unsigned int stationGapMaskDistance (float distanceCut=10.) const
 
unsigned int stationGapMaskPull (float sigmaCut=3.) const
 same as above for given number of sigmas More...
 
unsigned int stationMask (ArbitrationType type=SegmentAndTrackArbitration) const
 
float t0 (int n=0)
 
MuonTime time () const
 get DT/CSC combined timing information More...
 
float trackDist (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackDistErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackDxDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackDxDzErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackDyDz (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackDyDzErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackEdgeX (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackEdgeY (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackX (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackXErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackY (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
float trackYErr (int station, int muonSubdetId, ArbitrationType type=SegmentAndTrackArbitration) const
 
virtual MuonTrackType tunePMuonBestTrackType () const
 
unsigned int type () const
 
- Public Member Functions inherited from reco::RecoCandidate
const TrackbestTrack () const override
 best track pointer More...
 
virtual TrackType bestTrackType () const
 track type More...
 
virtual CaloTowerRef caloTower () const
 reference to a CaloTower More...
 
float dxyError () const override
 uncertainty on dxy More...
 
float dzError () const override
 uncertainty on dz More...
 
virtual reco::GsfTrackRef gsfTrack () const
 reference to a GsfTrack More...
 
virtual size_t numberOfTracks () const
 number of multiple Tracks 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...
 
virtual reco::SuperClusterRef superCluster () const
 reference to a SuperCluster More...
 
virtual reco::TrackRef track (size_t) const
 reference to one of multiple Tracks 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 Candidatedaughter (size_type) const override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (size_type) override
 return daughter at a given position (throws an exception) More...
 
Candidatedaughter (const std::string &s) override
 return daughter with a specified role name More...
 
const Candidatedaughter (const std::string &s) const override
 return daughter with a specified role name More...
 
double energy () const final
 energy More...
 
double et () const final
 transverse energy More...
 
double et2 () const final
 transverse energy squared (use this for cut!) More...
 
double eta () const final
 momentum pseudorapidity More...
 
void fillVertexCovariance (CovarianceMatrix &v) const override
 fill SMatrix More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
bool hasMasterClone () const override
 
bool hasMasterClonePtr () const override
 
bool isConvertedPhoton () const override
 
bool isElectron () const override
 
bool isJet () const override
 
bool isPhoton () const override
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&... args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
bool longLived () const final
 is long lived? More...
 
double mass () const final
 mass More...
 
bool massConstraint () const final
 do mass constraint? More...
 
double massSqr () const final
 mass squared More...
 
const CandidateBaseRefmasterClone () const override
 
const CandidatePtrmasterClonePtr () 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 Candidatemother (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...
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
double p () const final
 magnitude of momentum vector More...
 
const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
int pdgId () const final
 PDG identifier. More...
 
double phi () const final
 momentum azimuthal angle More...
 
const PolarLorentzVectorpolarP4 () 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...
 
int status () const final
 status word More...
 
double theta () const final
 momentum polar angle More...
 
int threeCharge () const final
 electric charge More...
 
const Pointvertex () const override
 vertex position (overwritten by PF...) More...
 
double vertexChi2 () const override
 chi-squares More...
 
double vertexCovariance (int i, int j) const override
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
double vertexNdof () const override
 
double vertexNormalizedChi2 () const override
 chi-squared divided by n.d.o.f. More...
 
double 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
const_iterator begin () const
 first daughter const_iterator More...
 
iterator begin ()
 first daughter iterator More...
 
 Candidate ()
 default constructor More...
 
const_iterator end () const
 last daughter const_iterator More...
 
iterator end ()
 last daughter iterator More...
 
template<typename T >
T get () const
 get a component More...
 
template<typename T , typename Tag >
T get () const
 get a component More...
 
template<typename T >
T get (size_type i) const
 get a component More...
 
template<typename T , typename Tag >
T get (size_type i) const
 get a component More...
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
template<typename T >
size_type numberOf () const
 number of components More...
 
template<typename T , typename Tag >
size_type numberOf () const
 number of components More...
 
virtual void setSourceCandidatePtr (const CandidatePtr &ptr)
 Set the ptr to the source Candidate. More...
 
virtual ~Candidate ()
 destructor More...
 

Protected Attributes

uint8_t cachedIP_
 globalTrack->numberOfValidHits() More...
 
bool cachedNormChi2_
 
bool cachedNumberOfValidHits_
 globalTrack->chi2() / globalTrack->ndof() More...
 
std::vector< reco::MuonMETCorrectionDatacaloMETMuonCorrs_
 
std::vector< reco::TrackcombinedMuon_
 
std::vector< reco::TrackdytMuon_
 
float eip_ [IpTypeSize]
 
bool embeddedCaloMETMuonCorrs_
 muon MET corrections for caloMET More...
 
bool embeddedCombinedMuon_
 track of combined fit More...
 
bool embeddedDytMuon_
 
bool embeddedMuonBestTrack_
 best muon track (global pflow) More...
 
bool embeddedPFCandidate_
 true if the IsolatedPFCandidate is embedded More...
 
bool embeddedPickyMuon_
 
bool embeddedStandAloneMuon_
 track of muon system More...
 
bool embeddedTCMETMuonCorrs_
 muon MET corrections for tcMET More...
 
bool embeddedTpfmsMuon_
 
bool embeddedTrack_
 track of inner track detector More...
 
bool embeddedTunePMuonBestTrack_
 best muon track (muon only) More...
 
float inverseBeta_
 Inverse beta. More...
 
float inverseBetaErr_
 
float ip_ [IpTypeSize]
 
float jetPtRatio_
 near-by jet information More...
 
float jetPtRel_
 
std::vector< reco::TrackmuonBestTrack_
 
float mvaIDValue_
 Muon MVA. More...
 
double normChi2_
 has the normalized chi2 been cached? More...
 
unsigned int numberOfValidHits_
 has the numberOfValidHits been cached? More...
 
reco::PFCandidateCollection pfCandidate_
 
reco::PFCandidateRef pfCandidateRef_
 
float pfEcalEnergy_
 
std::vector< reco::TrackpickyMuon_
 
float puppiChargedHadronIso_
 PUPPI isolations. More...
 
float puppiNeutralHadronIso_
 
float puppiNoLeptonsChargedHadronIso_
 PUPPINoLeptons isolations. More...
 
float puppiNoLeptonsNeutralHadronIso_
 
float puppiNoLeptonsPhotonIso_
 
float puppiPhotonIso_
 
int simBX_
 
float simEta_
 
reco::ExtendedMuonSimType simExtType_
 
int simFlavour_
 
int simHeaviestMotherFlavour_
 
float simMatchQuality_
 
int simMotherPdgId_
 
int simPdgId_
 
float simPhi_
 
float simProdRho_
 
float simProdZ_
 
float simPt_
 
int simTpEvent_
 
reco::MuonSimType simType_
 MC matching information. More...
 
float softMvaRun3Value_ = 0
 
float softMvaValue_
 
std::vector< reco::TrackstandAloneMuon_
 
std::vector< reco::MuonMETCorrectionDatatcMETMuonCorrs_
 
std::vector< reco::TracktpfmsMuon_
 
std::vector< reco::Tracktrack_
 
std::vector< reco::TracktunePMuonBestTrack_
 
- Protected Attributes inherited from pat::Lepton< reco::Muon >
IsoDepositPairs isoDeposits_
 
std::vector< float > isolations_
 
PFIsolation miniPFIsolation_
 
- Protected Attributes inherited from pat::PATObject< reco::Muon >
std::vector< std::string > efficiencyNames_
 vector of the efficiencies (names) More...
 
std::vector< pat::LookupTableRecordefficiencyValues_
 vector of the efficiencies (values) More...
 
std::vector< reco::GenParticlegenParticleEmbedded_
 vector to hold an embedded generator level particle More...
 
std::vector< reco::GenParticleRefgenParticleRef_
 Reference to a generator level particle. More...
 
std::vector< std::string > kinResolutionLabels_
 
std::vector< pat::CandKinResolutionkinResolutions_
 Kinematic resolutions. More...
 
std::vector< reco::CandidatePtrVectoroverlapItems_
 Overlapping items (sorted by distance) More...
 
std::vector< std::string > overlapLabels_
 Overlapping test labels (only if there are any overlaps) More...
 
edm::Ptr< reco::CandidaterefToOrig_
 
TriggerObjectStandAloneCollection triggerObjectMatchesEmbedded_
 vector of trigger matches More...
 
std::vector< std::string > userCandLabels_
 
std::vector< reco::CandidatePtruserCands_
 
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_
 

Friends

class PATMuonSlimmer
 
std::ostream & reco::operator<< (std::ostream &out, const pat::Muon &obj)
 pipe operator (introduced to use pat::Muon with PFTopProjectors) More...
 

Additional Inherited Members

- Static Public Attributes inherited from reco::Muon
static const unsigned int CaloMuon = 1 << 4
 
static const unsigned int GEMMuon = 1 << 7
 
static const unsigned int GlobalMuon = 1 << 1
 
static const unsigned int ME0Muon = 1 << 8
 
static const unsigned int PFMuon = 1 << 5
 
static const unsigned int RPCMuon = 1 << 6
 
static const unsigned int StandAloneMuon = 1 << 3
 
static const unsigned int TrackerMuon = 1 << 2
 
- Protected Types inherited from pat::Lepton< reco::Muon >
typedef std::vector< std::pair< IsolationKeys, pat::IsoDeposit > > IsoDepositPairs
 
- Protected Member Functions inherited from pat::PATObject< reco::Muon >
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...
 

Detailed Description

Analysis-level muon class.

pat::Muon implements the analysis-level muon class within the 'pat' namespace.

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, Colin Bernet

Definition at line 51 of file Muon.h.

Member Typedef Documentation

◆ IpType

Muon High Level Selection The user can choose to cache this info so they can drop the global tracks. If the global track is present these should not be set, but the "getters" will return the appropriate value. The exception is dB which requires the beamline

Member Enumeration Documentation

◆ IPTYPE

Muon High Level Selection The user can choose to cache this info so they can drop the global tracks. If the global track is present these should not be set, but the "getters" will return the appropriate value. The exception is dB which requires the beamline

Enumerator
PV2D 
PV3D 
BS2D 
BS3D 
PVDZ 
IpTypeSize 

Definition at line 237 of file Muon.h.

237 { PV2D = 0, PV3D = 1, BS2D = 2, BS3D = 3, PVDZ = 4, IpTypeSize = 5 } IpType;
enum pat::Muon::IPTYPE IpType

Constructor & Destructor Documentation

◆ Muon() [1/4]

pat::Muon::Muon ( )

default constructor

Referenced by clone().

◆ Muon() [2/4]

pat::Muon::Muon ( const reco::Muon aMuon)

constructor from a reco muon

◆ Muon() [3/4]

pat::Muon::Muon ( const edm::RefToBase< reco::Muon > &  aMuonRef)

constructor from a RefToBase to a reco muon (to be superseded by Ptr counterpart)

◆ Muon() [4/4]

pat::Muon::Muon ( const edm::Ptr< reco::Muon > &  aMuonRef)

constructor from a Ptr to a reco muon

◆ ~Muon()

pat::Muon::~Muon ( )
override

destructor

Member Function Documentation

◆ bestTrack()

const reco::Track* pat::Muon::bestTrack ( ) const
inlineoverridevirtual

Track selected to be the best measurement of the muon parameters (including PFlow global information)

Reimplemented from reco::Muon.

Definition at line 82 of file Muon.h.

References edm::Ref< C, T, F >::get(), and muonBestTrack().

Referenced by Muon.Muon::ptErr().

82 { return muonBestTrack().get(); }
T const * get() const
Returns C++ pointer to the item.
Definition: Ref.h:226
reco::TrackRef muonBestTrack() const override
Track selected to be the best measurement of the muon parameters (including PFlow global information)...

◆ caloIso()

float pat::Muon::caloIso ( ) const
inline

Overload of pat::Lepton::trackIso(); returns the sum of ecalIso() and hcalIso

Definition at line 190 of file Muon.h.

References ecalIso(), and hcalIso().

190 { return ecalIso() + hcalIso(); }
float hcalIso() const
Definition: Muon.h:187
float ecalIso() const
Definition: Muon.h:183

◆ caloMETMuonCorrs()

reco::MuonMETCorrectionData pat::Muon::caloMETMuonCorrs ( ) const
inline

muon MET corrections for caloMET; returns the muon correction struct if embedded during pat tuple production or an empty element

Definition at line 105 of file Muon.h.

References caloMETMuonCorrs_, and embeddedCaloMETMuonCorrs_.

105  {
107  };
std::vector< reco::MuonMETCorrectionData > caloMETMuonCorrs_
Definition: Muon.h:369
bool embeddedCaloMETMuonCorrs_
muon MET corrections for caloMET
Definition: Muon.h:368

◆ clone()

Muon* pat::Muon::clone ( void  ) const
inlineoverridevirtual

required reimplementation of the Candidate's clone method

Reimplemented from reco::Muon.

Definition at line 65 of file Muon.h.

References Muon().

65 { return new Muon(*this); }
Muon()
default constructor

◆ combinedMuon()

reco::TrackRef pat::Muon::combinedMuon ( ) const
overridevirtual

reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Referenced by globalTrack().

◆ dB() [1/2]

double pat::Muon::dB ( IPTYPE  type) const

◆ dB() [2/2]

double pat::Muon::dB ( ) const
inline

the version without arguments returns PD2D, but with an absolute value (for backwards compatibility)

Definition at line 243 of file Muon.h.

References funct::abs(), dB(), and PV2D.

Referenced by dB(), Lepton.Lepton::ip3D(), setDB(), and Lepton.Lepton::sip3D().

243 { return std::abs(dB(PV2D)); }
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
double dB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:243

◆ dytTrack()

reco::TrackRef pat::Muon::dytTrack ( ) const
overridevirtual

reference to Track reconstructed using DYT algorithm

Reimplemented from reco::Muon.

◆ ecalIso()

float pat::Muon::ecalIso ( ) const
inline

Overload of pat::Lepton::trackIso(); returns the value of the summed Et of all recHits in the ecal in a cone of deltaR<0.3

Definition at line 183 of file Muon.h.

References reco::MuonIsolation::emEt, and reco::Muon::isolationR03().

Referenced by caloIso().

183 { return isolationR03().emEt; }
const MuonIsolation & isolationR03() const
Definition: Muon.h:166
float emEt
ecal sum-Et
Definition: MuonIsolation.h:7

◆ edB() [1/2]

double pat::Muon::edB ( IPTYPE  type) const

Referenced by Lepton.Lepton::sip3D().

◆ edB() [2/2]

double pat::Muon::edB ( ) const
inline

the version without arguments returns PD2D, but with an absolute value (for backwards compatibility)

Definition at line 245 of file Muon.h.

References funct::abs(), edB(), and PV2D.

Referenced by edB(), setDB(), and Lepton.Lepton::sip3D().

245 { return std::abs(edB(PV2D)); }
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
double edB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:245

◆ embedCaloMETMuonCorrs()

void pat::Muon::embedCaloMETMuonCorrs ( const reco::MuonMETCorrectionData t)

◆ embedCombinedMuon()

void pat::Muon::embedCombinedMuon ( )

set reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedDytMuon()

void pat::Muon::embedDytMuon ( )

embed reference to the above dyt Track

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedMuonBestTrack()

void pat::Muon::embedMuonBestTrack ( bool  force = false)

set reference to Track selected to be the best measurement of the muon parameters (reimplemented from reco::Muon) if force == false, do not embed this track if it's embedded already (e.g. ig it's a tracker track, and that's already embedded)

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedPFCandidate()

void pat::Muon::embedPFCandidate ( )

embed the IsolatedPFCandidate pointed to by pfCandidateRef_

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

◆ embedPickyMuon()

void pat::Muon::embedPickyMuon ( )

embed reference to the above picky Track

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedStandAloneMuon()

void pat::Muon::embedStandAloneMuon ( )

set reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedTcMETMuonCorrs()

void pat::Muon::embedTcMETMuonCorrs ( const reco::MuonMETCorrectionData t)

◆ embedTpfmsMuon()

void pat::Muon::embedTpfmsMuon ( )

embed reference to the above tpfms Track

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedTrack()

void pat::Muon::embedTrack ( )

set reference to Track reconstructed in the tracker only (reimplemented from reco::Muon)

Referenced by pat::PATMuonProducer::fillMuon().

◆ embedTunePMuonBestTrack()

void pat::Muon::embedTunePMuonBestTrack ( bool  force = false)

set reference to Track selected to be the best measurement of the muon parameters (reimplemented from reco::Muon) if force == false, do not embed this track if it's embedded already (e.g. ig it's a tracker track, and that's already embedded)

Referenced by pat::PATMuonProducer::fillMuon().

◆ globalTrack()

reco::TrackRef pat::Muon::globalTrack ( ) const
inlineoverridevirtual

reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Definition at line 80 of file Muon.h.

References combinedMuon().

Referenced by Muon.Muon::muonID(), MuScleFitMuonSelector::selGlobalMuon(), and MuScleFit::selGlobalMuon().

80 { return combinedMuon(); }
reco::TrackRef combinedMuon() const override
reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) ...

◆ hcalIso()

float pat::Muon::hcalIso ( ) const
inline

Overload of pat::Lepton::trackIso(); returns the value of the summed Et of all caloTowers in the hcal in a cone of deltaR<0.4

Definition at line 187 of file Muon.h.

References reco::MuonIsolation::hadEt, and reco::Muon::isolationR03().

Referenced by caloIso().

187 { return isolationR03().hadEt; }
float hadEt
hcal sum-Et
Definition: MuonIsolation.h:8
const MuonIsolation & isolationR03() const
Definition: Muon.h:166

◆ hltObject()

const pat::TriggerObjectStandAlone* pat::Muon::hltObject ( const size_t  idx = 0) const
inline

Definition at line 340 of file Muon.h.

References heavyIonCSV_trainingSettings::idx, trigger::TriggerMuon, and pat::PATObject< reco::Muon >::triggerObjectMatchByType().

340  {
342  }
const TriggerObjectStandAlone * triggerObjectMatchByType(const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
get one matched trigger object of a certain type by index
Definition: PATObject.h:561

◆ initImpactParameters()

void pat::Muon::initImpactParameters ( void  )

◆ initSimInfo()

void pat::Muon::initSimInfo ( void  )

◆ innerTrack()

reco::TrackRef pat::Muon::innerTrack ( ) const
inlineoverridevirtual

reference to Track reconstructed in the tracker only (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Definition at line 72 of file Muon.h.

References track().

Referenced by Lepton.Lepton::lostInner(), Muon.Muon::muonID(), MuScleFitMuonSelector::selectMuons(), MuScleFitMuonSelector::selGlobalMuon(), MuScleFit::selGlobalMuon(), MuScleFitMuonSelector::selTrackerMuon(), and MuScleFit::selTrackerMuon().

72 { return track(); }
reco::TrackRef track() const override
reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) ...

◆ inverseBeta()

float pat::Muon::inverseBeta ( ) const
inline

(time is constraint to the bunch crossing time)

Definition at line 297 of file Muon.h.

References inverseBeta_.

297 { return inverseBeta_; }
float inverseBeta_
Inverse beta.
Definition: Muon.h:422

◆ inverseBetaErr()

float pat::Muon::inverseBetaErr ( ) const
inline

Definition at line 298 of file Muon.h.

References inverseBetaErr_.

298 { return inverseBetaErr_; }
float inverseBetaErr_
Definition: Muon.h:423

◆ isGood()

bool pat::Muon::isGood ( const std::string &  name) const
inline

wrapper for the muonID method to maintain backwards compatibility with when the reco::Muon::isGood method existed

Definition at line 163 of file Muon.h.

References muonID(), and mergeVDriftHistosByStation::name.

163 { return muonID(name); }
bool muonID(const std::string &name) const

◆ isHighPtMuon()

bool pat::Muon::isHighPtMuon ( const reco::Vertex ) const

◆ isLooseMuon()

bool pat::Muon::isLooseMuon ( ) const

◆ isMediumMuon()

bool pat::Muon::isMediumMuon ( ) const

◆ isSoftMuon()

bool pat::Muon::isSoftMuon ( const reco::Vertex ) const

◆ isTightMuon()

bool pat::Muon::isTightMuon ( const reco::Vertex ) const

if muon id results are ever extracted from muon id value maps then the isMuonIDAvailable method will be defined Muon Selectors as specified in https://twiki.cern.ch/twiki/bin/view/CMSPublic/SWGuideMuonId

◆ jetPtRatio()

float pat::Muon::jetPtRatio ( ) const
inline

near-by jet information

Definition at line 280 of file Muon.h.

References jetPtRatio_.

Referenced by setJetPtRatio().

280 { return jetPtRatio_; }
float jetPtRatio_
near-by jet information
Definition: Muon.h:413

◆ jetPtRel()

float pat::Muon::jetPtRel ( ) const
inline

Definition at line 281 of file Muon.h.

References jetPtRel_.

Referenced by setJetPtRel().

281 { return jetPtRel_; }
float jetPtRel_
Definition: Muon.h:414

◆ l1Object()

const pat::TriggerObjectStandAlone* pat::Muon::l1Object ( const size_t  idx = 0) const
inline

Trigger information.

Definition at line 337 of file Muon.h.

References heavyIonCSV_trainingSettings::idx, trigger::TriggerL1Mu, and pat::PATObject< reco::Muon >::triggerObjectMatchByType().

337  {
339  }
const TriggerObjectStandAlone * triggerObjectMatchByType(const trigger::TriggerObjectType triggerObjectType, const size_t idx=0) const
get one matched trigger object of a certain type by index
Definition: PATObject.h:561
enum start value shifted to 81 so as to avoid clashes with PDG codes

◆ muonBestTrack()

reco::TrackRef pat::Muon::muonBestTrack ( ) const
overridevirtual

Track selected to be the best measurement of the muon parameters (including PFlow global information)

Reimplemented from reco::Muon.

Referenced by bestTrack(), and pat::LeptonUpdater< T >::setDZ().

◆ muonID()

bool pat::Muon::muonID ( const std::string &  name) const

accessor for the various muon id algorithms currently defined in DataFormats/MuonReco/interface/MuonSelectors.h e.g. bool result = patmuon.muonID("TMLastStationLoose")

Referenced by isGood(), MuScleFitMuonSelector::selGlobalMuon(), MuScleFit::selGlobalMuon(), MuScleFitMuonSelector::selTrackerMuon(), MuScleFit::selTrackerMuon(), and Muon.Muon::tightId().

◆ mvaIDValue()

float pat::Muon::mvaIDValue ( ) const
inline

Muon MVA ID.

Definition at line 292 of file Muon.h.

References mvaIDValue_.

292 { return mvaIDValue_; }
float mvaIDValue_
Muon MVA.
Definition: Muon.h:417

◆ normChi2()

double pat::Muon::normChi2 ( ) const

Norm chi2 gives the normalized chi2 of the global track.

Referenced by setNormChi2().

◆ numberOfSourceCandidatePtrs()

size_t pat::Muon::numberOfSourceCandidatePtrs ( ) const
inlineoverridevirtual

get the number of non-null PF candidates

Reimplemented from reco::LeafCandidate.

Definition at line 145 of file Muon.h.

References edm::Ptr< T >::isNonnull(), edm::Ref< C, T, F >::isNonnull(), pfCandidateRef_, and pat::PATObject< reco::Muon >::refToOrig_.

145  {
146  size_t res = 0;
148  res++;
149  if (refToOrig_.isNonnull())
150  res++;
151  return res;
152  }
reco::PFCandidateRef pfCandidateRef_
Definition: Muon.h:387
bool isNonnull() const
Checks for non-null.
Definition: Ref.h:232
Definition: Electron.h:6
bool isNonnull() const
Checks for non-null.
Definition: Ptr.h:148
edm::Ptr< reco::Candidate > refToOrig_
Definition: PATObject.h:458

◆ numberOfValidHits()

unsigned int pat::Muon::numberOfValidHits ( ) const

numberOfValidHits returns the number of valid hits on the global track.

Referenced by setNumberOfValidHits().

◆ outerTrack()

reco::TrackRef pat::Muon::outerTrack ( ) const
inlineoverridevirtual

reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Definition at line 76 of file Muon.h.

References standAloneMuon().

76 { return standAloneMuon(); }
reco::TrackRef standAloneMuon() const override
reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon) ...

◆ pfCandidateRef()

reco::PFCandidateRef pat::Muon::pfCandidateRef ( ) const

reference to the source IsolatedPFCandidates null if this has been built from a standard muon

Referenced by pat::PATMuonProducer::fillMuon().

◆ pfEcalEnergy()

float pat::Muon::pfEcalEnergy ( ) const
inline

Definition at line 276 of file Muon.h.

References pfEcalEnergy_.

Referenced by setPfEcalEnergy().

276 { return pfEcalEnergy_; }
float pfEcalEnergy_
Definition: Muon.h:410

◆ pickyMuon()

reco::TrackRef pat::Muon::pickyMuon ( ) const
inline

Deprecated accessors to call the corresponding above two functions; no dytMuon since this naming is deprecated.

Definition at line 124 of file Muon.h.

References pickyTrack().

124 { return pickyTrack(); } // JMTBAD gcc deprecated attribute?
reco::TrackRef pickyTrack() const override
reference to Track reconstructed using hits in the tracker + "good" muon hits (reimplemented from rec...

◆ pickyTrack()

reco::TrackRef pat::Muon::pickyTrack ( ) const
overridevirtual

reference to Track reconstructed using hits in the tracker + "good" muon hits (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Referenced by pickyMuon().

◆ puppiChargedHadronIso()

float pat::Muon::puppiChargedHadronIso ( ) const
inline

returns PUPPI isolations

Definition at line 193 of file Muon.h.

References puppiChargedHadronIso_.

193 { return puppiChargedHadronIso_; }
float puppiChargedHadronIso_
PUPPI isolations.
Definition: Muon.h:402

◆ puppiNeutralHadronIso()

float pat::Muon::puppiNeutralHadronIso ( ) const
inline

Definition at line 194 of file Muon.h.

References puppiNeutralHadronIso_.

194 { return puppiNeutralHadronIso_; }
float puppiNeutralHadronIso_
Definition: Muon.h:403

◆ puppiNoLeptonsChargedHadronIso()

float pat::Muon::puppiNoLeptonsChargedHadronIso ( ) const
inline

returns PUPPINoLeptons isolations

Definition at line 197 of file Muon.h.

References puppiNoLeptonsChargedHadronIso_.

float puppiNoLeptonsChargedHadronIso_
PUPPINoLeptons isolations.
Definition: Muon.h:406

◆ puppiNoLeptonsNeutralHadronIso()

float pat::Muon::puppiNoLeptonsNeutralHadronIso ( ) const
inline

Definition at line 198 of file Muon.h.

References puppiNoLeptonsNeutralHadronIso_.

float puppiNoLeptonsNeutralHadronIso_
Definition: Muon.h:407

◆ puppiNoLeptonsPhotonIso()

float pat::Muon::puppiNoLeptonsPhotonIso ( ) const
inline

Definition at line 199 of file Muon.h.

References puppiNoLeptonsPhotonIso_.

199 { return puppiNoLeptonsPhotonIso_; }
float puppiNoLeptonsPhotonIso_
Definition: Muon.h:408

◆ puppiPhotonIso()

float pat::Muon::puppiPhotonIso ( ) const
inline

Definition at line 195 of file Muon.h.

References puppiPhotonIso_.

195 { return puppiPhotonIso_; }
float puppiPhotonIso_
Definition: Muon.h:404

◆ readTimeExtra()

void pat::Muon::readTimeExtra ( const reco::MuonTimeExtra t)

◆ rekeyEmbeddedTracks()

void pat::Muon::rekeyEmbeddedTracks ( std::vector< edm::Handle< edm::Association< reco::TrackExtraCollection >>> const &  assocs)

◆ segmentCompatibility()

double pat::Muon::segmentCompatibility ( reco::Muon::ArbitrationType  arbitrationType = reco::Muon::SegmentAndTrackArbitration) const

Returns the segment compatibility, using muon::segmentCompatibility (DataFormats/MuonReco/interface/MuonSelectors.h)

◆ setDB()

void pat::Muon::setDB ( double  dB,
double  edB,
IPTYPE  type = PV2D 
)
inline

Definition at line 247 of file Muon.h.

References cachedIP_, dB(), edB(), eip_, createfilelist::int, ip_, and reco::Muon::type().

Referenced by pat::PATMuonProducer::embedHighLevel(), and pat::LeptonUpdater< T >::setDZ().

247  {
248  ip_[type] = dB;
249  eip_[type] = edB;
250  cachedIP_ |= (1 << int(type));
251  }
uint8_t cachedIP_
globalTrack->numberOfValidHits()
Definition: Muon.h:397
float ip_[IpTypeSize]
Definition: Muon.h:398
unsigned int type() const
Definition: Muon.h:299
float eip_[IpTypeSize]
Definition: Muon.h:399
double edB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:245
double dB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:243

◆ setExtSimType()

void pat::Muon::setExtSimType ( reco::ExtendedMuonSimType  type)
inline

Definition at line 322 of file Muon.h.

References simExtType_, and reco::Muon::type().

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

322 { simExtType_ = type; }
unsigned int type() const
Definition: Muon.h:299
reco::ExtendedMuonSimType simExtType_
Definition: Muon.h:427

◆ setIsolationPUPPI()

void pat::Muon::setIsolationPUPPI ( float  chargedhadrons,
float  neutralhadrons,
float  photons 
)
inline

sets PUPPI isolations

Definition at line 201 of file Muon.h.

References BPHMonitor_cfi::photons, puppiChargedHadronIso_, puppiNeutralHadronIso_, and puppiPhotonIso_.

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

201  {
202  puppiChargedHadronIso_ = chargedhadrons;
203  puppiNeutralHadronIso_ = neutralhadrons;
205  }
float puppiPhotonIso_
Definition: Muon.h:404
float puppiNeutralHadronIso_
Definition: Muon.h:403
float puppiChargedHadronIso_
PUPPI isolations.
Definition: Muon.h:402

◆ setIsolationPUPPINoLeptons()

void pat::Muon::setIsolationPUPPINoLeptons ( float  chargedhadrons,
float  neutralhadrons,
float  photons 
)
inline

sets PUPPINoLeptons isolations

Definition at line 207 of file Muon.h.

References BPHMonitor_cfi::photons, puppiNoLeptonsChargedHadronIso_, puppiNoLeptonsNeutralHadronIso_, and puppiNoLeptonsPhotonIso_.

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

207  {
208  puppiNoLeptonsChargedHadronIso_ = chargedhadrons;
209  puppiNoLeptonsNeutralHadronIso_ = neutralhadrons;
211  }
float puppiNoLeptonsChargedHadronIso_
PUPPINoLeptons isolations.
Definition: Muon.h:406
float puppiNoLeptonsPhotonIso_
Definition: Muon.h:408
float puppiNoLeptonsNeutralHadronIso_
Definition: Muon.h:407

◆ setJetPtRatio()

void pat::Muon::setJetPtRatio ( float  jetPtRatio)
inline

Definition at line 282 of file Muon.h.

References jetPtRatio(), and jetPtRatio_.

282 { jetPtRatio_ = jetPtRatio; }
float jetPtRatio() const
near-by jet information
Definition: Muon.h:280
float jetPtRatio_
near-by jet information
Definition: Muon.h:413

◆ setJetPtRel()

void pat::Muon::setJetPtRel ( float  jetPtRel)
inline

Definition at line 283 of file Muon.h.

References jetPtRel(), and jetPtRel_.

283 { jetPtRel_ = jetPtRel; }
float jetPtRel() const
Definition: Muon.h:281
float jetPtRel_
Definition: Muon.h:414

◆ setMvaIDValue()

void pat::Muon::setMvaIDValue ( float  mvaID)
inline

Definition at line 293 of file Muon.h.

References photons_cff::mvaID, and mvaIDValue_.

293 { mvaIDValue_ = mvaID; }
float mvaIDValue_
Muon MVA.
Definition: Muon.h:417

◆ setNormChi2()

void pat::Muon::setNormChi2 ( double  normChi2)
inline

Definition at line 262 of file Muon.h.

References cachedNormChi2_, normChi2(), and normChi2_.

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

262  {
264  cachedNormChi2_ = true;
265  }
double normChi2() const
Norm chi2 gives the normalized chi2 of the global track.
bool cachedNormChi2_
Definition: Muon.h:390
double normChi2_
has the normalized chi2 been cached?
Definition: Muon.h:391

◆ setNumberOfValidHits()

void pat::Muon::setNumberOfValidHits ( unsigned int  numberOfValidHits)
inline

Definition at line 255 of file Muon.h.

References cachedNumberOfValidHits_, numberOfValidHits(), and numberOfValidHits_.

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

255  {
258  }
unsigned int numberOfValidHits_
has the numberOfValidHits been cached?
Definition: Muon.h:394
bool cachedNumberOfValidHits_
globalTrack->chi2() / globalTrack->ndof()
Definition: Muon.h:393
unsigned int numberOfValidHits() const
numberOfValidHits returns the number of valid hits on the global track.

◆ setPFCandidateRef()

void pat::Muon::setPFCandidateRef ( const reco::PFCandidateRef ref)
inline

add a reference to the source IsolatedPFCandidate

Definition at line 141 of file Muon.h.

References pfCandidateRef_.

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

141 { pfCandidateRef_ = ref; }
reco::PFCandidateRef pfCandidateRef_
Definition: Muon.h:387

◆ setPfEcalEnergy()

void pat::Muon::setPfEcalEnergy ( float  pfEcalEnergy)
inline

Definition at line 277 of file Muon.h.

References pfEcalEnergy(), and pfEcalEnergy_.

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

float pfEcalEnergy_
Definition: Muon.h:410
float pfEcalEnergy() const
Definition: Muon.h:276

◆ setSimBX()

void pat::Muon::setSimBX ( int  bx)
inline

Definition at line 327 of file Muon.h.

References nano_mu_digi_cff::bx, and simBX_.

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

327 { simBX_ = bx; }
int simBX_
Definition: Muon.h:432

◆ setSimEta()

void pat::Muon::setSimEta ( float  eta)
inline

Definition at line 332 of file Muon.h.

References reco::LeafCandidate::eta(), and simEta_.

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

332 { simEta_ = eta; }
float simEta_
Definition: Muon.h:437
double eta() const final
momentum pseudorapidity

◆ setSimFlavour()

void pat::Muon::setSimFlavour ( int  f)
inline

Definition at line 323 of file Muon.h.

References f, and simFlavour_.

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

323 { simFlavour_ = f; }
double f[11][100]
int simFlavour_
Definition: Muon.h:428

◆ setSimHeaviestMotherFlavour()

void pat::Muon::setSimHeaviestMotherFlavour ( int  id)
inline

◆ setSimMatchQuality()

void pat::Muon::setSimMatchQuality ( float  quality)
inline

Definition at line 334 of file Muon.h.

References quality, and simMatchQuality_.

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

float simMatchQuality_
Definition: Muon.h:439
string quality

◆ setSimMotherPdgId()

void pat::Muon::setSimMotherPdgId ( int  id)
inline

◆ setSimPdgId()

void pat::Muon::setSimPdgId ( int  id)
inline

◆ setSimPhi()

void pat::Muon::setSimPhi ( float  phi)
inline

Definition at line 333 of file Muon.h.

References reco::LeafCandidate::phi(), and simPhi_.

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

333 { simPhi_ = phi; }
double phi() const final
momentum azimuthal angle
float simPhi_
Definition: Muon.h:438

◆ setSimProdRho()

void pat::Muon::setSimProdRho ( float  rho)
inline

Definition at line 329 of file Muon.h.

References rho, and simProdRho_.

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

◆ setSimProdZ()

void pat::Muon::setSimProdZ ( float  z)
inline

Definition at line 330 of file Muon.h.

References simProdZ_, and z.

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

◆ setSimPt()

void pat::Muon::setSimPt ( float  pt)
inline

Definition at line 331 of file Muon.h.

References reco::LeafCandidate::pt(), and simPt_.

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

331 { simPt_ = pt; }
double pt() const final
transverse momentum
float simPt_
Definition: Muon.h:436

◆ setSimTpEvent()

void pat::Muon::setSimTpEvent ( int  tpEvent)
inline

Definition at line 328 of file Muon.h.

References simTpEvent_.

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

328 { simTpEvent_ = tpEvent; }
int simTpEvent_
Definition: Muon.h:433

◆ setSimType()

void pat::Muon::setSimType ( reco::MuonSimType  type)
inline

Definition at line 321 of file Muon.h.

References simType_, and reco::Muon::type().

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

321 { simType_ = type; }
reco::MuonSimType simType_
MC matching information.
Definition: Muon.h:426
unsigned int type() const
Definition: Muon.h:299

◆ setSoftMvaRun3Value()

void pat::Muon::setSoftMvaRun3Value ( float  softmva)
inline

Definition at line 289 of file Muon.h.

References softMvaRun3Value_.

289 { softMvaRun3Value_ = softmva; }
float softMvaRun3Value_
Definition: Muon.h:419

◆ setSoftMvaValue()

void pat::Muon::setSoftMvaValue ( float  softmva)
inline

Definition at line 287 of file Muon.h.

References softMvaValue_.

287 { softMvaValue_ = softmva; }
float softMvaValue_
Definition: Muon.h:418

◆ simBX()

int pat::Muon::simBX ( ) const
inline

Definition at line 311 of file Muon.h.

References simBX_.

311 { return simBX_; }
int simBX_
Definition: Muon.h:432

◆ simEta()

float pat::Muon::simEta ( ) const
inline

Definition at line 316 of file Muon.h.

References simEta_.

316 { return simEta_; }
float simEta_
Definition: Muon.h:437

◆ simExtType()

reco::ExtendedMuonSimType pat::Muon::simExtType ( ) const
inline

Definition at line 302 of file Muon.h.

References simExtType_.

302 { return simExtType_; }
reco::ExtendedMuonSimType simExtType_
Definition: Muon.h:427

◆ simFlavour()

int pat::Muon::simFlavour ( ) const
inline

Definition at line 307 of file Muon.h.

References simFlavour_.

307 { return simFlavour_; }
int simFlavour_
Definition: Muon.h:428

◆ simHeaviestMotherFlavour()

int pat::Muon::simHeaviestMotherFlavour ( ) const
inline

Definition at line 308 of file Muon.h.

References simHeaviestMotherFlavour_.

308 { return simHeaviestMotherFlavour_; }
int simHeaviestMotherFlavour_
Definition: Muon.h:429

◆ simMatchQuality()

float pat::Muon::simMatchQuality ( ) const
inline

Definition at line 318 of file Muon.h.

References simMatchQuality_.

318 { return simMatchQuality_; }
float simMatchQuality_
Definition: Muon.h:439

◆ simMotherPdgId()

int pat::Muon::simMotherPdgId ( ) const
inline

Definition at line 310 of file Muon.h.

References simMotherPdgId_.

310 { return simMotherPdgId_; }
int simMotherPdgId_
Definition: Muon.h:431

◆ simPdgId()

int pat::Muon::simPdgId ( ) const
inline

Definition at line 309 of file Muon.h.

References simPdgId_.

309 { return simPdgId_; }
int simPdgId_
Definition: Muon.h:430

◆ simPhi()

float pat::Muon::simPhi ( ) const
inline

Definition at line 317 of file Muon.h.

References simPhi_.

317 { return simPhi_; }
float simPhi_
Definition: Muon.h:438

◆ simProdRho()

float pat::Muon::simProdRho ( ) const
inline

Definition at line 313 of file Muon.h.

References simProdRho_.

313 { return simProdRho_; }
float simProdRho_
Definition: Muon.h:434

◆ simProdZ()

float pat::Muon::simProdZ ( ) const
inline

Definition at line 314 of file Muon.h.

References simProdZ_.

314 { return simProdZ_; }
float simProdZ_
Definition: Muon.h:435

◆ simPt()

float pat::Muon::simPt ( ) const
inline

Definition at line 315 of file Muon.h.

References simPt_.

315 { return simPt_; }
float simPt_
Definition: Muon.h:436

◆ simTpEvent()

int pat::Muon::simTpEvent ( ) const
inline

Definition at line 312 of file Muon.h.

References simTpEvent_.

312 { return simTpEvent_; }
int simTpEvent_
Definition: Muon.h:433

◆ simType()

reco::MuonSimType pat::Muon::simType ( ) const
inline

MC matching information.

Definition at line 301 of file Muon.h.

References simType_.

301 { return simType_; }
reco::MuonSimType simType_
MC matching information.
Definition: Muon.h:426

◆ softMvaRun3Value()

float pat::Muon::softMvaRun3Value ( ) const
inline

Definition at line 288 of file Muon.h.

References softMvaRun3Value_.

288 { return softMvaRun3Value_; }
float softMvaRun3Value_
Definition: Muon.h:419

◆ softMvaValue()

float pat::Muon::softMvaValue ( ) const
inline

Soft Muon MVA.

Definition at line 286 of file Muon.h.

References softMvaValue_.

286 { return softMvaValue_; }
float softMvaValue_
Definition: Muon.h:418

◆ sourceCandidatePtr()

reco::CandidatePtr pat::Muon::sourceCandidatePtr ( size_type  i) const
overridevirtual

get the candidate pointer with index i

Reimplemented from reco::LeafCandidate.

◆ standAloneMuon()

reco::TrackRef pat::Muon::standAloneMuon ( ) const
overridevirtual

reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Referenced by outerTrack().

◆ tcMETMuonCorrs()

reco::MuonMETCorrectionData pat::Muon::tcMETMuonCorrs ( ) const
inline

muon MET corrections for tcMET; returns the muon correction struct if embedded during pat tuple production or an empty element

Definition at line 110 of file Muon.h.

References embeddedTCMETMuonCorrs_, and tcMETMuonCorrs_.

110  {
112  };
bool embeddedTCMETMuonCorrs_
muon MET corrections for tcMET
Definition: Muon.h:365
std::vector< reco::MuonMETCorrectionData > tcMETMuonCorrs_
Definition: Muon.h:366

◆ tpfmsMuon()

reco::TrackRef pat::Muon::tpfmsMuon ( ) const
inline

Definition at line 125 of file Muon.h.

References tpfmsTrack().

125 { return tpfmsTrack(); } // JMTBAD gcc deprecated attribute?
reco::TrackRef tpfmsTrack() const override
reference to Track reconstructed using hits in the tracker + info from the first muon station that ha...

◆ tpfmsTrack()

reco::TrackRef pat::Muon::tpfmsTrack ( ) const
overridevirtual

reference to Track reconstructed using hits in the tracker + info from the first muon station that has hits (reimplemented from reco::Muon)

Reimplemented from reco::Muon.

Referenced by tpfmsMuon().

◆ track()

reco::TrackRef pat::Muon::track ( ) const
overridevirtual

◆ trackIso()

float pat::Muon::trackIso ( ) const
inline

Overload of pat::Lepton::trackIso(); returns the value of the summed track pt in a cone of deltaR<0.3

Definition at line 179 of file Muon.h.

References reco::Muon::isolationR03(), and reco::MuonIsolation::sumPt.

179 { return isolationR03().sumPt; }
const MuonIsolation & isolationR03() const
Definition: Muon.h:166
float sumPt
sum-pt of tracks
Definition: MuonIsolation.h:6

◆ triggered()

bool pat::Muon::triggered ( const char *  pathName) const
inline

Definition at line 343 of file Muon.h.

References hltMonBTagIPClient_cfi::pathName, and pat::PATObject< reco::Muon >::triggerObjectMatchByPath().

343 { return triggerObjectMatchByPath(pathName, true, true) != nullptr; }
const TriggerObjectStandAlone * triggerObjectMatchByPath(const std::string &namePath, const bool pathLastFilterAccepted=false, const bool pathL3FilterAccepted=true, const size_t idx=0) const
Definition: PATObject.h:689

◆ tunePMuonBestTrack()

reco::TrackRef pat::Muon::tunePMuonBestTrack ( ) const
overridevirtual

Track selected to be the best measurement of the muon parameters (from muon information alone)

Reimplemented from reco::Muon.

Friends And Related Function Documentation

◆ PATMuonSlimmer

friend class PATMuonSlimmer
friend

Definition at line 274 of file Muon.h.

◆ reco::operator<<

std::ostream& reco::operator<< ( std::ostream &  out,
const pat::Muon obj 
)
friend

pipe operator (introduced to use pat::Muon with PFTopProjectors)

Member Data Documentation

◆ cachedIP_

uint8_t pat::Muon::cachedIP_
protected

globalTrack->numberOfValidHits()

Definition at line 397 of file Muon.h.

Referenced by setDB().

◆ cachedNormChi2_

bool pat::Muon::cachedNormChi2_
protected

Definition at line 390 of file Muon.h.

Referenced by setNormChi2().

◆ cachedNumberOfValidHits_

bool pat::Muon::cachedNumberOfValidHits_
protected

globalTrack->chi2() / globalTrack->ndof()

Definition at line 393 of file Muon.h.

Referenced by setNumberOfValidHits().

◆ caloMETMuonCorrs_

std::vector<reco::MuonMETCorrectionData> pat::Muon::caloMETMuonCorrs_
protected

Definition at line 369 of file Muon.h.

Referenced by caloMETMuonCorrs().

◆ combinedMuon_

std::vector<reco::Track> pat::Muon::combinedMuon_
protected

Definition at line 362 of file Muon.h.

◆ dytMuon_

std::vector<reco::Track> pat::Muon::dytMuon_
protected

Definition at line 377 of file Muon.h.

◆ eip_

float pat::Muon::eip_[IpTypeSize]
protected

Definition at line 399 of file Muon.h.

Referenced by setDB().

◆ embeddedCaloMETMuonCorrs_

bool pat::Muon::embeddedCaloMETMuonCorrs_
protected

muon MET corrections for caloMET

Definition at line 368 of file Muon.h.

Referenced by caloMETMuonCorrs().

◆ embeddedCombinedMuon_

bool pat::Muon::embeddedCombinedMuon_
protected

track of combined fit

Definition at line 361 of file Muon.h.

◆ embeddedDytMuon_

bool pat::Muon::embeddedDytMuon_
protected

Definition at line 374 of file Muon.h.

◆ embeddedMuonBestTrack_

bool pat::Muon::embeddedMuonBestTrack_
protected

best muon track (global pflow)

Definition at line 349 of file Muon.h.

◆ embeddedPFCandidate_

bool pat::Muon::embeddedPFCandidate_
protected

true if the IsolatedPFCandidate is embedded

Definition at line 381 of file Muon.h.

◆ embeddedPickyMuon_

bool pat::Muon::embeddedPickyMuon_
protected

Definition at line 372 of file Muon.h.

◆ embeddedStandAloneMuon_

bool pat::Muon::embeddedStandAloneMuon_
protected

track of muon system

Definition at line 358 of file Muon.h.

◆ embeddedTCMETMuonCorrs_

bool pat::Muon::embeddedTCMETMuonCorrs_
protected

muon MET corrections for tcMET

Definition at line 365 of file Muon.h.

Referenced by tcMETMuonCorrs().

◆ embeddedTpfmsMuon_

bool pat::Muon::embeddedTpfmsMuon_
protected

Definition at line 373 of file Muon.h.

◆ embeddedTrack_

bool pat::Muon::embeddedTrack_
protected

track of inner track detector

Definition at line 355 of file Muon.h.

◆ embeddedTunePMuonBestTrack_

bool pat::Muon::embeddedTunePMuonBestTrack_
protected

best muon track (muon only)

Definition at line 352 of file Muon.h.

◆ inverseBeta_

float pat::Muon::inverseBeta_
protected

Inverse beta.

Definition at line 422 of file Muon.h.

Referenced by inverseBeta().

◆ inverseBetaErr_

float pat::Muon::inverseBetaErr_
protected

Definition at line 423 of file Muon.h.

Referenced by inverseBetaErr().

◆ ip_

float pat::Muon::ip_[IpTypeSize]
protected

Definition at line 398 of file Muon.h.

Referenced by setDB().

◆ jetPtRatio_

float pat::Muon::jetPtRatio_
protected

near-by jet information

Definition at line 413 of file Muon.h.

Referenced by jetPtRatio(), and setJetPtRatio().

◆ jetPtRel_

float pat::Muon::jetPtRel_
protected

Definition at line 414 of file Muon.h.

Referenced by jetPtRel(), and setJetPtRel().

◆ muonBestTrack_

std::vector<reco::Track> pat::Muon::muonBestTrack_
protected

Definition at line 350 of file Muon.h.

◆ mvaIDValue_

float pat::Muon::mvaIDValue_
protected

Muon MVA.

Definition at line 417 of file Muon.h.

Referenced by mvaIDValue(), and setMvaIDValue().

◆ normChi2_

double pat::Muon::normChi2_
protected

has the normalized chi2 been cached?

Definition at line 391 of file Muon.h.

Referenced by setNormChi2().

◆ numberOfValidHits_

unsigned int pat::Muon::numberOfValidHits_
protected

has the numberOfValidHits been cached?

Definition at line 394 of file Muon.h.

Referenced by setNumberOfValidHits().

◆ pfCandidate_

reco::PFCandidateCollection pat::Muon::pfCandidate_
protected

if embeddedPFCandidate_, a copy of the source IsolatedPFCandidate is stored in this vector

Definition at line 384 of file Muon.h.

◆ pfCandidateRef_

reco::PFCandidateRef pat::Muon::pfCandidateRef_
protected

reference to the IsolatedPFCandidate this has been built from null if this has been built from a standard muon

Definition at line 387 of file Muon.h.

Referenced by numberOfSourceCandidatePtrs(), and setPFCandidateRef().

◆ pfEcalEnergy_

float pat::Muon::pfEcalEnergy_
protected

Definition at line 410 of file Muon.h.

Referenced by pfEcalEnergy(), and setPfEcalEnergy().

◆ pickyMuon_

std::vector<reco::Track> pat::Muon::pickyMuon_
protected

Definition at line 375 of file Muon.h.

◆ puppiChargedHadronIso_

float pat::Muon::puppiChargedHadronIso_
protected

PUPPI isolations.

Definition at line 402 of file Muon.h.

Referenced by puppiChargedHadronIso(), and setIsolationPUPPI().

◆ puppiNeutralHadronIso_

float pat::Muon::puppiNeutralHadronIso_
protected

Definition at line 403 of file Muon.h.

Referenced by puppiNeutralHadronIso(), and setIsolationPUPPI().

◆ puppiNoLeptonsChargedHadronIso_

float pat::Muon::puppiNoLeptonsChargedHadronIso_
protected

PUPPINoLeptons isolations.

Definition at line 406 of file Muon.h.

Referenced by puppiNoLeptonsChargedHadronIso(), and setIsolationPUPPINoLeptons().

◆ puppiNoLeptonsNeutralHadronIso_

float pat::Muon::puppiNoLeptonsNeutralHadronIso_
protected

Definition at line 407 of file Muon.h.

Referenced by puppiNoLeptonsNeutralHadronIso(), and setIsolationPUPPINoLeptons().

◆ puppiNoLeptonsPhotonIso_

float pat::Muon::puppiNoLeptonsPhotonIso_
protected

Definition at line 408 of file Muon.h.

Referenced by puppiNoLeptonsPhotonIso(), and setIsolationPUPPINoLeptons().

◆ puppiPhotonIso_

float pat::Muon::puppiPhotonIso_
protected

Definition at line 404 of file Muon.h.

Referenced by puppiPhotonIso(), and setIsolationPUPPI().

◆ simBX_

int pat::Muon::simBX_
protected

Definition at line 432 of file Muon.h.

Referenced by setSimBX(), and simBX().

◆ simEta_

float pat::Muon::simEta_
protected

Definition at line 437 of file Muon.h.

Referenced by setSimEta(), and simEta().

◆ simExtType_

reco::ExtendedMuonSimType pat::Muon::simExtType_
protected

Definition at line 427 of file Muon.h.

Referenced by setExtSimType(), and simExtType().

◆ simFlavour_

int pat::Muon::simFlavour_
protected

Definition at line 428 of file Muon.h.

Referenced by setSimFlavour(), and simFlavour().

◆ simHeaviestMotherFlavour_

int pat::Muon::simHeaviestMotherFlavour_
protected

Definition at line 429 of file Muon.h.

Referenced by setSimHeaviestMotherFlavour(), and simHeaviestMotherFlavour().

◆ simMatchQuality_

float pat::Muon::simMatchQuality_
protected

Definition at line 439 of file Muon.h.

Referenced by setSimMatchQuality(), and simMatchQuality().

◆ simMotherPdgId_

int pat::Muon::simMotherPdgId_
protected

Definition at line 431 of file Muon.h.

Referenced by setSimMotherPdgId(), and simMotherPdgId().

◆ simPdgId_

int pat::Muon::simPdgId_
protected

Definition at line 430 of file Muon.h.

Referenced by setSimPdgId(), and simPdgId().

◆ simPhi_

float pat::Muon::simPhi_
protected

Definition at line 438 of file Muon.h.

Referenced by setSimPhi(), and simPhi().

◆ simProdRho_

float pat::Muon::simProdRho_
protected

Definition at line 434 of file Muon.h.

Referenced by setSimProdRho(), and simProdRho().

◆ simProdZ_

float pat::Muon::simProdZ_
protected

Definition at line 435 of file Muon.h.

Referenced by setSimProdZ(), and simProdZ().

◆ simPt_

float pat::Muon::simPt_
protected

Definition at line 436 of file Muon.h.

Referenced by setSimPt(), and simPt().

◆ simTpEvent_

int pat::Muon::simTpEvent_
protected

Definition at line 433 of file Muon.h.

Referenced by setSimTpEvent(), and simTpEvent().

◆ simType_

reco::MuonSimType pat::Muon::simType_
protected

MC matching information.

Definition at line 426 of file Muon.h.

Referenced by setSimType(), and simType().

◆ softMvaRun3Value_

float pat::Muon::softMvaRun3Value_ = 0
protected

Definition at line 419 of file Muon.h.

Referenced by setSoftMvaRun3Value(), and softMvaRun3Value().

◆ softMvaValue_

float pat::Muon::softMvaValue_
protected

Definition at line 418 of file Muon.h.

Referenced by setSoftMvaValue(), and softMvaValue().

◆ standAloneMuon_

std::vector<reco::Track> pat::Muon::standAloneMuon_
protected

Definition at line 359 of file Muon.h.

◆ tcMETMuonCorrs_

std::vector<reco::MuonMETCorrectionData> pat::Muon::tcMETMuonCorrs_
protected

Definition at line 366 of file Muon.h.

Referenced by tcMETMuonCorrs().

◆ tpfmsMuon_

std::vector<reco::Track> pat::Muon::tpfmsMuon_
protected

Definition at line 376 of file Muon.h.

◆ track_

std::vector<reco::Track> pat::Muon::track_
protected

Definition at line 356 of file Muon.h.

◆ tunePMuonBestTrack_

std::vector<reco::Track> pat::Muon::tunePMuonBestTrack_
protected

Definition at line 353 of file Muon.h.