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,
  IpTypeSize = 4
}
 
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
}
 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
 
- 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
 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...
 
virtual Muonclone () const
 required reimplementation of the Candidate's clone method More...
 
reco::TrackRef combinedMuon () const
 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
 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
 reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) More...
 
float hcalIso () const
 
void initImpactParameters (void)
 
reco::TrackRef innerTrack () const
 reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) More...
 
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
 
 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
 Track selected to be the best measurement of the muon parameters (including PFlow global information) More...
 
bool muonID (const std::string &name) const
 
double normChi2 () const
 Norm chi2 gives the normalized chi2 of the global track. More...
 
size_t numberOfSourceCandidatePtrs () const
 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
 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
 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
 
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 setIsolationPUPPI (float chargedhadrons, float neutralhadrons, float photons)
 sets PUPPI isolations More...
 
void setIsolationPUPPINoLeptons (float chargedhadrons, float neutralhadrons, float photons)
 sets PUPPINoLeptons isolations More...
 
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)
 
reco::CandidatePtr sourceCandidatePtr (size_type i) const
 get the candidate pointer with index i More...
 
reco::TrackRef standAloneMuon () const
 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
 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
 reference to Track reconstructed in the tracker only (reimplemented from reco::Muon) More...
 
float trackIso () const
 
virtual reco::TrackRef tunePMuonBestTrack () const
 Track selected to be the best measurement of the muon parameters (from muon information alone) More...
 
virtual ~Muon ()
 destructor More...
 
- Public Member Functions inherited from pat::Lepton< reco::Muon >
float caloIso () const
 
float chargedHadronIso () const
 
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 ()
 
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
 
virtual ~Lepton ()
 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...
 
virtual ~PATObject ()
 destructor More...
 
- Public Member Functions inherited from reco::Muon
virtual TrackBaseRef bestTrackRef () const
 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
 
bool isAValidMuonTrack (const MuonTrackType &type) const
 
bool isCaloCompatibilityValid () const
 
bool isCaloMuon () const
 
bool isEnergyValid () const
 
bool isGEMMuon () const
 
bool isGlobalMuon () const
 
bool isIsolationValid () const
 
bool isMatchesValid () const
 
bool isME0Muon () const
 
bool isMuon () const
 
const MuonIsolationisolationR03 () const
 
const MuonIsolationisolationR05 () const
 
bool isPFIsolationValid () const
 
bool isPFMuon () const
 
bool isQualityValid () const
 
bool isRPCMuon () const
 
bool isStandAloneMuon () const
 
bool isTimeValid () const
 
bool isTrackerMuon () const
 
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 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...
 
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
 
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...
 
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
virtual TrackType bestTrackType () const
 track type More...
 
virtual CaloTowerRef caloTower () const
 reference to a CaloTower More...
 
virtual float dxyError () const
 uncertainty on dxy More...
 
virtual float dzError () const
 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...
 
virtual ~RecoCandidate ()
 destructor More...
 
- Public Member Functions inherited from reco::LeafCandidate
virtual Vector boostToCM () const final
 
virtual 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)
 
virtual const Candidatedaughter (size_type) const
 return daughter at a given position (throws an exception) More...
 
virtual Candidatedaughter (size_type)
 return daughter at a given position (throws an exception) More...
 
virtual Candidatedaughter (const std::string &s)
 return daughter with a specified role name More...
 
virtual const Candidatedaughter (const std::string &s) const
 return daughter with a specified role name More...
 
virtual double energy () const final
 energy More...
 
virtual double et () const final
 transverse energy More...
 
virtual double et2 () const final
 transverse energy squared (use this for cut!) More...
 
virtual double eta () const final
 momentum pseudorapidity More...
 
virtual void fillVertexCovariance (CovarianceMatrix &v) const
 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...
 
virtual bool hasMasterClone () const
 
virtual bool hasMasterClonePtr () const
 
virtual bool isConvertedPhoton () const
 
virtual bool isElectron () const
 
virtual bool isJet () const
 
virtual bool isPhoton () const
 
 LeafCandidate ()
 
 LeafCandidate (const Candidate &c)
 
template<typename... Args>
 LeafCandidate (Args &&...args)
 
 LeafCandidate (LeafCandidate &rh)
 
 LeafCandidate (LeafCandidate &&)=default
 
 LeafCandidate (LeafCandidate const &)=default
 
virtual bool longLived () const final
 is long lived? More...
 
virtual double mass () const final
 mass More...
 
virtual bool massConstraint () const final
 do mass constraint? More...
 
virtual double massSqr () const final
 mass squared More...
 
virtual const CandidateBaseRefmasterClone () const
 
virtual const CandidatePtrmasterClonePtr () const
 
template<typename Ref >
Ref masterRef () const
 cast master clone reference to a concrete type More...
 
virtual Vector momentum () const final
 spatial momentum vector More...
 
virtual const Candidatemother (size_type) const
 return mother at a given position (throws an exception) More...
 
virtual double mt () const final
 transverse mass More...
 
virtual 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...
 
virtual size_t numberOfDaughters () const
 number of daughters More...
 
virtual size_t numberOfMothers () const
 number of mothers More...
 
LeafCandidateoperator= (LeafCandidate &&)=default
 
LeafCandidateoperator= (LeafCandidate const &)=default
 
virtual double p () const final
 magnitude of momentum vector More...
 
virtual const LorentzVectorp4 () const final
 four-momentum Lorentz vector More...
 
virtual int pdgId () const final
 PDG identifier. More...
 
virtual double phi () const final
 momentum azimuthal angle More...
 
virtual const PolarLorentzVectorpolarP4 () const final
 four-momentum Lorentz vector More...
 
virtual double pt () const final
 transverse momentum More...
 
virtual double px () const final
 x coordinate of momentum vector More...
 
virtual double py () const final
 y coordinate of momentum vector More...
 
virtual double pz () const final
 z coordinate of momentum vector More...
 
virtual double rapidity () const final
 rapidity More...
 
virtual void setCharge (Charge q) final
 set electric charge More...
 
virtual void setLongLived () final
 
virtual void setMass (double m) final
 set particle mass More...
 
virtual void setMassConstraint () final
 
virtual void setP4 (const LorentzVector &p4) final
 set 4-momentum More...
 
virtual void setP4 (const PolarLorentzVector &p4) final
 set 4-momentum More...
 
virtual void setPdgId (int pdgId) final
 
virtual void setPz (double pz) final
 
virtual void setStatus (int status) final
 set status word More...
 
virtual void setThreeCharge (Charge qx3) final
 set electric charge More...
 
virtual void setVertex (const Point &vertex)
 set vertex More...
 
virtual int status () const final
 status word More...
 
virtual double theta () const final
 momentum polar angle More...
 
virtual int threeCharge () const final
 electric charge More...
 
virtual const Pointvertex () const
 vertex position (overwritten by PF...) More...
 
virtual double vertexChi2 () const
 chi-squares More...
 
virtual double vertexCovariance (int i, int j) const
 (i, j)-th element of error matrix, i, j = 0, ... 2 More...
 
CovarianceMatrix vertexCovariance () const final
 return SMatrix More...
 
virtual double vertexNdof () const
 
virtual double vertexNormalizedChi2 () const
 chi-squared divided by n.d.o.f. More...
 
virtual double vx () const
 x coordinate of vertex position More...
 
virtual double vy () const
 y coordinate of vertex position More...
 
virtual double vz () const
 z coordinate of vertex position More...
 
virtual double y () const final
 rapidity More...
 
virtual ~LeafCandidate ()
 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 ip_ [IpTypeSize]
 
std::vector< reco::TrackmuonBestTrack_
 
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_
 
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 49 of file Muon.h.

Member Typedef Documentation

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

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 
IpTypeSize 

Definition at line 230 of file Muon.h.

231  {
232  PV2D = 0, PV3D = 1, BS2D = 2, BS3D = 3, IpTypeSize = 4
233  } IpType;
enum pat::Muon::IPTYPE IpType

Constructor & Destructor Documentation

pat::Muon::Muon ( )

default constructor

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

constructor from a reco muon

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

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

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

constructor from a Ptr to a reco muon

virtual pat::Muon::~Muon ( )
virtual

destructor

Member Function Documentation

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

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 genericParticleProducer_cfi::embedCombinedMuon, muonProducer_cfi::embedMuonBestTrack, genericParticleProducer_cfi::embedStandAloneMuon, electronProducer_cfi::embedTrack, muonProducer_cfi::embedTunePMuonBestTrack, and cmsStageWithFailover::force.

Referenced by Muon.Muon::ptErr().

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

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

Definition at line 181 of file Muon.h.

181 { return ecalIso()+hcalIso(); }
float ecalIso() const
Definition: Muon.h:174
float hcalIso() const
Definition: Muon.h:178
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 103 of file Muon.h.

References boostedMuonIsolation_cff::embedCaloMETMuonCorrs, and lumiQTWidget::t.

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

std::vector< reco::MuonMETCorrectionData > caloMETMuonCorrs_
Definition: Muon.h:293
bool embeddedCaloMETMuonCorrs_
muon MET corrections for caloMET
Definition: Muon.h:292
virtual Muon* pat::Muon::clone ( void  ) const
inlinevirtual

required reimplementation of the Candidate's clone method

Reimplemented from pat::Lepton< reco::Muon >.

Definition at line 65 of file Muon.h.

References configurableAnalysis::Muon, HiIsolationCommonParameters_cff::track, and reco::RecoCandidate::track().

65 { return new Muon(*this); }
Muon()
default constructor
reco::TrackRef pat::Muon::combinedMuon ( ) const
virtual

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

Reimplemented from reco::Muon.

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

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

Definition at line 239 of file Muon.h.

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

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

239 { 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:239
reco::TrackRef pat::Muon::dytTrack ( ) const
virtual

reference to Track reconstructed using DYT algorithm

Reimplemented from reco::Muon.

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 174 of file Muon.h.

References muons2muons_cfi::isolationR03.

Referenced by MuonVPlusJetsIDSelectionFunctor::fall10Cuts(), MuonVPlusJetsIDSelectionFunctor::firstDataCuts(), MuonVPlusJetsIDSelectionFunctor::kitQCDCuts(), MuonVPlusJetsIDSelectionFunctor::spring10Cuts(), and MuonVPlusJetsIDSelectionFunctor::summer08Cuts().

174 { return isolationR03().emEt; }
float emEt
ecal sum-Et
Definition: MuonIsolation.h:8
const MuonIsolation & isolationR03() const
Definition: Muon.h:162
double pat::Muon::edB ( IPTYPE  type) const
double pat::Muon::edB ( ) const
inline

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

Definition at line 241 of file Muon.h.

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

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

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

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

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

void pat::Muon::embedDytMuon ( )

embed reference to the above dyt Track

Referenced by pat::PATMuonProducer::fillMuon(), and pat::PATMuonSlimmer::produce().

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

void pat::Muon::embedPFCandidate ( )

embed the IsolatedPFCandidate pointed to by pfCandidateRef_

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

void pat::Muon::embedPickyMuon ( )

embed reference to the above picky Track

Referenced by pat::PATMuonProducer::fillMuon(), and pat::PATMuonSlimmer::produce().

void pat::Muon::embedStandAloneMuon ( )

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

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

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

embed reference to the above tpfms Track

Referenced by pat::PATMuonProducer::fillMuon(), and pat::PATMuonSlimmer::produce().

void pat::Muon::embedTrack ( )

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

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

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

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

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.

Referenced by MuonVPlusJetsIDSelectionFunctor::fall10Cuts(), BPHTrackReference::getMuonGT(), MuonVPlusJetsIDSelectionFunctor::kitQCDCuts(), Muon.Muon::muonID(), ZMuMuMuonUserData::produce(), MuScleFitMuonSelector::selGlobalMuon(), MuScleFit::selGlobalMuon(), MuonVPlusJetsIDSelectionFunctor::spring10Cuts(), and PFMuonSelector::TopPag12LjetsCuts().

80 { return combinedMuon(); }
reco::TrackRef combinedMuon() const
reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon) ...
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 178 of file Muon.h.

References muons2muons_cfi::isolationR03.

Referenced by MuonVPlusJetsIDSelectionFunctor::fall10Cuts(), MuonVPlusJetsIDSelectionFunctor::firstDataCuts(), MuonVPlusJetsIDSelectionFunctor::kitQCDCuts(), MuonVPlusJetsIDSelectionFunctor::spring10Cuts(), and MuonVPlusJetsIDSelectionFunctor::summer08Cuts().

178 { return isolationR03().hadEt; }
float hadEt
hcal sum-Et
Definition: MuonIsolation.h:9
const MuonIsolation & isolationR03() const
Definition: Muon.h:162
void pat::Muon::initImpactParameters ( void  )
reco::TrackRef pat::Muon::innerTrack ( ) const
inlinevirtual
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 154 of file Muon.h.

References muon::isHighPtMuon(), muon::isLooseMuon(), muon::isMediumMuon(), muon::isSoftMuon(), muon::isTightMuon(), and TopDecayID::muonID.

154 { return muonID(name); }
bool muonID(const std::string &name) const
bool pat::Muon::isHighPtMuon ( const reco::Vertex ) const
bool pat::Muon::isLooseMuon ( ) const
bool pat::Muon::isMediumMuon ( ) const
bool pat::Muon::isSoftMuon ( const reco::Vertex ) const
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

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

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

Reimplemented from reco::Muon.

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 MuScleFitMuonSelector::selGlobalMuon(), MuScleFit::selGlobalMuon(), MuScleFitMuonSelector::selTrackerMuon(), MuScleFit::selTrackerMuon(), and Muon.Muon::tightId().

double pat::Muon::normChi2 ( ) const
size_t pat::Muon::numberOfSourceCandidatePtrs ( ) const
inlinevirtual

get the number of non-null PF candidates

Reimplemented from reco::LeafCandidate.

Definition at line 138 of file Muon.h.

References mps_fire::i, TopDecayID::muonID, dataset::name, and AlCaHLTBitMon_QueryRunRegistry::string.

138  {
139  size_t res=0;
140  if(pfCandidateRef_.isNonnull()) res++;
141  if(refToOrig_.isNonnull()) res++;
142  return res;
143  }
reco::PFCandidateRef pfCandidateRef_
Definition: Muon.h:311
bool isNonnull() const
Checks for non-null.
Definition: Ref.h:252
Definition: Electron.h:4
bool isNonnull() const
Checks for non-null.
Definition: Ptr.h:169
edm::Ptr< reco::Candidate > refToOrig_
Definition: PATObject.h:421
unsigned int pat::Muon::numberOfValidHits ( ) const
reco::TrackRef pat::Muon::outerTrack ( ) const
inlinevirtual

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 susybsm::HSCParticleType::standAloneMuon.

Referenced by GlbMuQualityCutsAnalysis::analyze(), ZMuMuMuonUserData::produce(), and ZToLLEdmNtupleDumper::produce().

76 { return standAloneMuon(); }
reco::TrackRef standAloneMuon() const
reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon) ...
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(), and BPHTrackReference::getMuonPF().

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

Definition at line 265 of file Muon.h.

265 { return pfEcalEnergy_; }
float pfEcalEnergy_
Definition: Muon.h:334
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 118 of file Muon.h.

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

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

Reimplemented from reco::Muon.

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

returns PUPPI isolations

Definition at line 184 of file Muon.h.

184 {return puppiChargedHadronIso_; }
float puppiChargedHadronIso_
PUPPI isolations.
Definition: Muon.h:326
float pat::Muon::puppiNeutralHadronIso ( ) const
inline

Definition at line 185 of file Muon.h.

185 {return puppiNeutralHadronIso_; }
float puppiNeutralHadronIso_
Definition: Muon.h:327
float pat::Muon::puppiNoLeptonsChargedHadronIso ( ) const
inline

returns PUPPINoLeptons isolations

Definition at line 188 of file Muon.h.

float puppiNoLeptonsChargedHadronIso_
PUPPINoLeptons isolations.
Definition: Muon.h:330
float pat::Muon::puppiNoLeptonsNeutralHadronIso ( ) const
inline

Definition at line 189 of file Muon.h.

float puppiNoLeptonsNeutralHadronIso_
Definition: Muon.h:331
float pat::Muon::puppiNoLeptonsPhotonIso ( ) const
inline

Definition at line 190 of file Muon.h.

190 {return puppiNoLeptonsPhotonIso_; }
float puppiNoLeptonsPhotonIso_
Definition: Muon.h:332
float pat::Muon::puppiPhotonIso ( ) const
inline

Definition at line 186 of file Muon.h.

186 {return puppiPhotonIso_; }
float puppiPhotonIso_
Definition: Muon.h:328
double pat::Muon::segmentCompatibility ( reco::Muon::ArbitrationType  arbitrationType = reco::Muon::SegmentAndTrackArbitration) const

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

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

Definition at line 243 of file Muon.h.

References createfilelist::int.

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

243  {
244  ip_[type] = dB; eip_[type] = edB; cachedIP_ |= (1 << int(type));
245  }
type
Definition: HCALResponse.h:21
uint8_t cachedIP_
globalTrack->numberOfValidHits()
Definition: Muon.h:321
double edB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:241
float ip_[IpTypeSize]
Definition: Muon.h:322
float eip_[IpTypeSize]
Definition: Muon.h:323
double dB() const
the version without arguments returns PD2D, but with an absolute value (for backwards compatibility) ...
Definition: Muon.h:239
unsigned int type() const
Definition: Muon.h:222
void pat::Muon::setIsolationPUPPI ( float  chargedhadrons,
float  neutralhadrons,
float  photons 
)
inline

sets PUPPI isolations

Definition at line 192 of file Muon.h.

References jetCleaner_cfi::photons.

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

193  {
194  puppiChargedHadronIso_ = chargedhadrons;
195  puppiNeutralHadronIso_ = neutralhadrons;
197  }
float puppiPhotonIso_
Definition: Muon.h:328
float puppiNeutralHadronIso_
Definition: Muon.h:327
float puppiChargedHadronIso_
PUPPI isolations.
Definition: Muon.h:326
void pat::Muon::setIsolationPUPPINoLeptons ( float  chargedhadrons,
float  neutralhadrons,
float  photons 
)
inline

sets PUPPINoLeptons isolations

Definition at line 199 of file Muon.h.

References jetCleaner_cfi::photons.

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

200  {
201  puppiNoLeptonsChargedHadronIso_ = chargedhadrons;
202  puppiNoLeptonsNeutralHadronIso_ = neutralhadrons;
204  }
float puppiNoLeptonsChargedHadronIso_
PUPPINoLeptons isolations.
Definition: Muon.h:330
float puppiNoLeptonsPhotonIso_
Definition: Muon.h:332
float puppiNoLeptonsNeutralHadronIso_
Definition: Muon.h:331
void pat::Muon::setNormChi2 ( double  normChi2)
inline

Definition at line 254 of file Muon.h.

References MuonAssociatorByHits_cfi::obj, reco::operator<<(), MillePedeFileConverter_cfg::out, reco::Muon::SegmentAndTrackArbitration, and BadChargedCandidateFilter_cfi::segmentCompatibility.

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

255  { normChi2_ = normChi2; cachedNormChi2_ = true; }
bool cachedNormChi2_
Definition: Muon.h:314
double normChi2_
has the normalized chi2 been cached?
Definition: Muon.h:315
double normChi2() const
Norm chi2 gives the normalized chi2 of the global track.
void pat::Muon::setNumberOfValidHits ( unsigned int  numberOfValidHits)
inline

Definition at line 249 of file Muon.h.

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

unsigned int numberOfValidHits_
has the numberOfValidHits been cached?
Definition: Muon.h:318
bool cachedNumberOfValidHits_
globalTrack->chi2() / globalTrack->ndof()
Definition: Muon.h:317
unsigned int numberOfValidHits() const
numberOfValidHits returns the number of valid hits on the global track.
void pat::Muon::setPFCandidateRef ( const reco::PFCandidateRef ref)
inline

add a reference to the source IsolatedPFCandidate

Definition at line 132 of file Muon.h.

References electronProducer_cfi::embedPFCandidate.

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

132  {
133  pfCandidateRef_ = ref;
134  }
reco::PFCandidateRef pfCandidateRef_
Definition: Muon.h:311
void pat::Muon::setPfEcalEnergy ( float  pfEcalEnergy)
inline

Definition at line 266 of file Muon.h.

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

float pfEcalEnergy() const
Definition: Muon.h:265
float pfEcalEnergy_
Definition: Muon.h:334
reco::CandidatePtr pat::Muon::sourceCandidatePtr ( size_type  i) const
virtual

get the candidate pointer with index i

Reimplemented from reco::LeafCandidate.

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

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

Reimplemented from reco::Muon.

Referenced by BPHTrackReference::getMuonSA().

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 106 of file Muon.h.

References boostedMuonIsolation_cff::embedTcMETMuonCorrs.

bool embeddedTCMETMuonCorrs_
muon MET corrections for tcMET
Definition: Muon.h:289
std::vector< reco::MuonMETCorrectionData > tcMETMuonCorrs_
Definition: Muon.h:290
reco::TrackRef pat::Muon::tpfmsMuon ( ) const
inline

Definition at line 119 of file Muon.h.

References muonProducer_cfi::embedDytMuon, muonProducer_cfi::embedPickyMuon, and muonProducer_cfi::embedTpfmsMuon.

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

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.

reco::TrackRef pat::Muon::track ( ) const
virtual
float pat::Muon::trackIso ( ) const
inline
virtual reco::TrackRef pat::Muon::tunePMuonBestTrack ( ) const
virtual

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

Reimplemented from reco::Muon.

Friends And Related Function Documentation

friend class PATMuonSlimmer
friend

Definition at line 263 of file Muon.h.

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

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

Member Data Documentation

uint8_t pat::Muon::cachedIP_
protected

globalTrack->numberOfValidHits()

Definition at line 321 of file Muon.h.

bool pat::Muon::cachedNormChi2_
protected

Definition at line 314 of file Muon.h.

bool pat::Muon::cachedNumberOfValidHits_
protected

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

Definition at line 317 of file Muon.h.

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

Definition at line 293 of file Muon.h.

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

Definition at line 286 of file Muon.h.

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

Definition at line 301 of file Muon.h.

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

Definition at line 323 of file Muon.h.

bool pat::Muon::embeddedCaloMETMuonCorrs_
protected

muon MET corrections for caloMET

Definition at line 292 of file Muon.h.

bool pat::Muon::embeddedCombinedMuon_
protected

track of combined fit

Definition at line 285 of file Muon.h.

bool pat::Muon::embeddedDytMuon_
protected

Definition at line 298 of file Muon.h.

bool pat::Muon::embeddedMuonBestTrack_
protected

best muon track (global pflow)

Definition at line 273 of file Muon.h.

bool pat::Muon::embeddedPFCandidate_
protected

true if the IsolatedPFCandidate is embedded

Definition at line 305 of file Muon.h.

bool pat::Muon::embeddedPickyMuon_
protected

Definition at line 296 of file Muon.h.

bool pat::Muon::embeddedStandAloneMuon_
protected

track of muon system

Definition at line 282 of file Muon.h.

bool pat::Muon::embeddedTCMETMuonCorrs_
protected

muon MET corrections for tcMET

Definition at line 289 of file Muon.h.

bool pat::Muon::embeddedTpfmsMuon_
protected

Definition at line 297 of file Muon.h.

bool pat::Muon::embeddedTrack_
protected

track of inner track detector

Definition at line 279 of file Muon.h.

bool pat::Muon::embeddedTunePMuonBestTrack_
protected

best muon track (muon only)

Definition at line 276 of file Muon.h.

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

Definition at line 322 of file Muon.h.

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

Definition at line 274 of file Muon.h.

double pat::Muon::normChi2_
protected

has the normalized chi2 been cached?

Definition at line 315 of file Muon.h.

unsigned int pat::Muon::numberOfValidHits_
protected

has the numberOfValidHits been cached?

Definition at line 318 of file Muon.h.

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

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

Definition at line 308 of file Muon.h.

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 311 of file Muon.h.

float pat::Muon::pfEcalEnergy_
protected

Definition at line 334 of file Muon.h.

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

Definition at line 299 of file Muon.h.

float pat::Muon::puppiChargedHadronIso_
protected

PUPPI isolations.

Definition at line 326 of file Muon.h.

float pat::Muon::puppiNeutralHadronIso_
protected

Definition at line 327 of file Muon.h.

float pat::Muon::puppiNoLeptonsChargedHadronIso_
protected

PUPPINoLeptons isolations.

Definition at line 330 of file Muon.h.

float pat::Muon::puppiNoLeptonsNeutralHadronIso_
protected

Definition at line 331 of file Muon.h.

float pat::Muon::puppiNoLeptonsPhotonIso_
protected

Definition at line 332 of file Muon.h.

float pat::Muon::puppiPhotonIso_
protected

Definition at line 328 of file Muon.h.

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

Definition at line 283 of file Muon.h.

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

Definition at line 290 of file Muon.h.

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

Definition at line 300 of file Muon.h.

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

Definition at line 280 of file Muon.h.

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

Definition at line 277 of file Muon.h.