---

pat::Muon Class Reference

Analysis-level muon class. More...

#include <DataFormats/PatCandidates/interface/Muon.h>

Inheritance diagram for pat::Muon:

List of all members.

Public Member Functions
virtual Muon *	clone () const
	required reimplementation of the Candidate's clone method
reco::TrackRef	combinedMuon () const
	reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)
void	embedCombinedMuon ()
	set reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)
void	embedPFCandidate ()
	embed the IsolatedPFCandidate pointed to by pfCandidateRef_
void	embedPickyMuon ()
	embed reference to the above picky Track
void	embedStandAloneMuon ()
	set reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)
void	embedTpfmsMuon ()
	embed reference to the above tpfms Track
void	embedTrack ()
	set reference to Track reconstructed in the tracker only (reimplemented from reco::Muon)
reco::TrackRef	globalTrack () const
	reference to Track reconstructed in both tracked and muon detector (reimplemented from reco::Muon)
reco::TrackRef	innerTrack () const
	reference to Track reconstructed in the tracker only (reimplemented from reco::Muon)
	Muon (const edm::Ptr< MuonType > &aMuonRef)
	constructor from a Ptr to a reco muon
	Muon (const edm::RefToBase< MuonType > &aMuonRef)
	constructor from a RefToBase to a reco muon (to be superseded by Ptr counterpart)
	Muon (const MuonType &aMuon)
	constructor from a reco muon
	Muon ()
	default constructor
reco::TrackRef	outerTrack () const
	reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)
reco::PFCandidateRef	pfCandidateRef () const
	reference to the source IsolatedPFCandidates null if this has been built from a standard muon
reco::TrackRef	pickyMuon () const
	reference to Track reconstructed using hits in the tracker + "good" muon hits
void	setPFCandidateRef (const reco::PFCandidateRef &ref)
	add a reference to the source IsolatedPFCandidate
void	setPickyMuon (const reco::TrackRef &t)
void	setTpfmsMuon (const reco::TrackRef &t)
reco::TrackRef	standAloneMuon () const
	reference to Track reconstructed in the muon detector only (reimplemented from reco::Muon)
reco::TrackRef	tpfmsMuon () const
	reference to Track reconstructed using hits in the tracker + info from the first muon station that has hits
reco::TrackRef	track () const
	reference to Track reconstructed in the tracker only (reimplemented from reco::Muon)
virtual	~Muon ()
	destructor
Protected Attributes
std::vector< reco::Track >	combinedMuon_
bool	embeddedCombinedMuon_
bool	embeddedPFCandidate_
	true if the IsolatedPFCandidate is embedded
bool	embeddedPickyMuon_
bool	embeddedStandAloneMuon_
bool	embeddedTpfmsMuon_
bool	embeddedTrack_
reco::PFCandidateCollection	pfCandidate_
	if embeddedPFCandidate_, a copy of the source IsolatedPFCandidate is stored in this vector
reco::PFCandidateRef	pfCandidateRef_
	reference to the IsolatedPFCandidate this has been built from null if this has been built from a standard muon
std::vector< reco::Track >	pickyMuon_
reco::TrackRef	pickyMuonRef_
std::vector< reco::Track >	standAloneMuon_
std::vector< reco::Track >	tpfmsMuon_
reco::TrackRef	tpfmsMuonRef_
std::vector< reco::Track >	track_

---

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: httpss://hypernews.cern.ch/HyperNews/CMS/get/physTools.html

Author:

Steven Lowette, Giovanni Petrucciani, Frederic Ronga, Colin Bernet

Version:

Id

Muon.h,v 1.20.2.3 2009/03/25 12:59:26 lusito Exp

Definition at line 49 of file Muon.h.

---

Constructor & Destructor Documentation

Muon::Muon

(

)

default constructor

Definition at line 12 of file Muon.cc.

Referenced by clone().

           :
    Lepton<MuonType>(),
    embeddedTrack_(false),
    embeddedStandAloneMuon_(false),
    embeddedCombinedMuon_(false),
    embeddedPickyMuon_(false),
    embeddedTpfmsMuon_(false),
    pickyMuonRef_(),
    tpfmsMuonRef_(),
    embeddedPFCandidate_(false)
    //pfCandidateRef_()
{
}

Muon::Muon

(

const MuonType &

aMuon

)

constructor from a reco muon

constructor from MuonType

Definition at line 28 of file Muon.cc.

                                 :
    Lepton<MuonType>(aMuon),
    embeddedTrack_(false),
    embeddedStandAloneMuon_(false),
    embeddedCombinedMuon_(false),
    embeddedPickyMuon_(false),
    embeddedTpfmsMuon_(false),
    pickyMuonRef_(),
    tpfmsMuonRef_(),
    embeddedPFCandidate_(false)
    //pfCandidateRef_()
{
}

Muon::Muon

(

const edm::RefToBase< MuonType > &

aMuonRef

)

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

constructor from ref to MuonType

Definition at line 44 of file Muon.cc.

                                                  :
    Lepton<MuonType>(aMuonRef),
    embeddedTrack_(false),
    embeddedStandAloneMuon_(false),
    embeddedCombinedMuon_(false),
    embeddedPickyMuon_(false),
    embeddedTpfmsMuon_(false),
    pickyMuonRef_(),
    tpfmsMuonRef_(),
    embeddedPFCandidate_(false)
    //pfCandidateRef_()
{
}

Muon::Muon

(

const edm::Ptr< MuonType > &

aMuonRef

)

constructor from a Ptr to a reco muon

constructor from ref to MuonType

Definition at line 60 of file Muon.cc.

                                            :
    Lepton<MuonType>(aMuonRef),
    embeddedTrack_(false),
    embeddedStandAloneMuon_(false),
    embeddedCombinedMuon_(false),
    embeddedPickyMuon_(false),
    embeddedTpfmsMuon_(false),
    pickyMuonRef_(),
    tpfmsMuonRef_(),
    embeddedPFCandidate_(false)
    //pfCandidateRef_()
{
}

Muon::~Muon

(

)

[virtual]

destructor

Definition at line 76 of file Muon.cc.

            {
}

---

Member Function Documentation

virtual Muon* pat::Muon::clone

(

void

)

const [inline, virtual]

required reimplementation of the Candidate's clone method

Reimplemented from pat::Lepton< LeptonType >.

Definition at line 65 of file Muon.h.

References Muon().

{ return new Muon(*this); }

reco::TrackRef Muon::combinedMuon

(

)

const

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

Definition at line 101 of file Muon.cc.

References combinedMuon_, embeddedCombinedMuon_, and reco::Muon::globalTrack().

Referenced by pat::HistoMuon::fill(), and globalTrack().

                                      {
  if (embeddedCombinedMuon_) {
    return reco::TrackRef(&combinedMuon_, 0);
  } else {
    return MuonType::globalTrack();
  }
}

void Muon::embedCombinedMuon

(

)

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

embed the Track reconstructed in both tracked and muon detector

Definition at line 160 of file Muon.cc.

References combinedMuon_, embeddedCombinedMuon_, and reco::Muon::globalTrack().

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

                             {
  combinedMuon_.clear();
  if (MuonType::globalTrack().isNonnull()) {
      combinedMuon_.push_back(*MuonType::globalTrack());
      embeddedCombinedMuon_ = true;
  }
}

void Muon::embedPFCandidate

(

)

embed the IsolatedPFCandidate pointed to by pfCandidateRef_

Definition at line 137 of file Muon.cc.

References embeddedPFCandidate_, edm::Ref< C, T, F >::isAvailable(), edm::Ref< C, T, F >::isNonnull(), pfCandidate_, and pfCandidateRef_.

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

                            {
  pfCandidate_.clear();
  if ( pfCandidateRef_.isAvailable() && pfCandidateRef_.isNonnull()) {
    pfCandidate_.push_back( *pfCandidateRef_ );
    embeddedPFCandidate_ = true;
  }
}

void Muon::embedPickyMuon

(

)

embed reference to the above picky Track

embed the picky Track

Definition at line 169 of file Muon.cc.

References embeddedPickyMuon_, edm::Ref< C, T, F >::isNonnull(), pickyMuon_, and pickyMuonRef_.

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

                          {
  pickyMuon_.clear();
  if (pickyMuonRef_.isNonnull()) {
      pickyMuon_.push_back(*pickyMuonRef_);
      embeddedPickyMuon_ = true;
  }
}

void Muon::embedStandAloneMuon

(

)

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

embed the Track reconstructed in the muon detector only

Definition at line 188 of file Muon.cc.

References embeddedStandAloneMuon_, reco::Muon::outerTrack(), and standAloneMuon_.

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

                               {         
  standAloneMuon_.clear();       
  if (MuonType::outerTrack().isNonnull()) {      
      standAloneMuon_.push_back(*MuonType::outerTrack());        
      embeddedStandAloneMuon_ = true;    
  }      
}

void Muon::embedTpfmsMuon

(

)

embed reference to the above tpfms Track

embed the tpfms Track

Definition at line 178 of file Muon.cc.

References embeddedTpfmsMuon_, edm::Ref< C, T, F >::isNonnull(), tpfmsMuon_, and tpfmsMuonRef_.

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

                          {
  tpfmsMuon_.clear();
  if (tpfmsMuonRef_.isNonnull()) {
      tpfmsMuon_.push_back(*tpfmsMuonRef_);
      embeddedTpfmsMuon_ = true;
  }
}

void Muon::embedTrack

(

)

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

embed the Track reconstructed in the tracker only

Definition at line 148 of file Muon.cc.

References embeddedTrack_, reco::Muon::innerTrack(), and track_.

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

                      {
  track_.clear();
  if (MuonType::innerTrack().isNonnull()) {
      track_.push_back(*MuonType::innerTrack());
      embeddedTrack_ = true;
  }
}

reco::TrackRef pat::Muon::globalTrack

(

)

const [inline]

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

Definition at line 79 of file Muon.h.

References combinedMuon().

Referenced by pat::HistoMuon::fill().

{ return combinedMuon(); }

reco::TrackRef pat::Muon::innerTrack

(

)

const [inline]

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

Definition at line 71 of file Muon.h.

References track().

{ return track(); }

reco::TrackRef pat::Muon::outerTrack

(

)

const [inline]

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

Definition at line 75 of file Muon.h.

References standAloneMuon().

{ return standAloneMuon(); }

reco::PFCandidateRef Muon::pfCandidateRef

(

)

const

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

reference to the source IsolatedPFCandidates

Definition at line 128 of file Muon.cc.

References embeddedPFCandidate_, pfCandidate_, and pfCandidateRef_.

                                              {
  if (embeddedPFCandidate_) {
    return reco::PFCandidateRef(&pfCandidate_, 0);
  } else {
    return pfCandidateRef_;
  }
}

reco::TrackRef Muon::pickyMuon

(

)

const

reference to Track reconstructed using hits in the tracker + "good" muon hits

Definition at line 110 of file Muon.cc.

References embeddedPickyMuon_, pickyMuon_, and pickyMuonRef_.

                                   {
  if (embeddedPickyMuon_) {
    return reco::TrackRef(&pickyMuon_, 0);
  } else {
    return pickyMuonRef_;
  }
}

void pat::Muon::setPFCandidateRef

(

const reco::PFCandidateRef &

ref

)

[inline]

add a reference to the source IsolatedPFCandidate

Definition at line 104 of file Muon.h.

References pfCandidateRef_.

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

                                                            {
        pfCandidateRef_ = ref;
      } 

void pat::Muon::setPickyMuon

(

const reco::TrackRef &

t

)

[inline]

Definition at line 90 of file Muon.h.

References pickyMuonRef_.

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

{ pickyMuonRef_ = t; }

void pat::Muon::setTpfmsMuon

(

const reco::TrackRef &

t

)

[inline]

Definition at line 93 of file Muon.h.

References tpfmsMuonRef_.

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

{ tpfmsMuonRef_ = t; }

reco::TrackRef Muon::standAloneMuon

(

)

const

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

Definition at line 91 of file Muon.cc.

References embeddedStandAloneMuon_, reco::Muon::outerTrack(), and standAloneMuon_.

Referenced by pat::HistoMuon::fill(), and outerTrack().

                                        {
  if (embeddedStandAloneMuon_) {
    return reco::TrackRef(&standAloneMuon_, 0);
  } else {
    return MuonType::outerTrack();
  }
}

reco::TrackRef Muon::tpfmsMuon

(

)

const

reference to Track reconstructed using hits in the tracker + info from the first muon station that has hits

Definition at line 119 of file Muon.cc.

References embeddedTpfmsMuon_, tpfmsMuon_, and tpfmsMuonRef_.

                                   {
  if (embeddedTpfmsMuon_) {
    return reco::TrackRef(&tpfmsMuon_, 0);
  } else {
    return tpfmsMuonRef_;
  }
}

reco::TrackRef Muon::track

(

void

)

const

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

Definition at line 81 of file Muon.cc.

References embeddedTrack_, reco::Muon::innerTrack(), and track_.

Referenced by pat::CaloIsolationEnergy::calculate(), pat::LeptonVertexSignificance::calculate(), pat::TrackerIsolationPt::calculate(), pat::HistoMuon::fill(), and innerTrack().

                               {
  if (embeddedTrack_) {
    return reco::TrackRef(&track_, 0);
  } else {
    return MuonType::innerTrack();
  }
}

---

Member Data Documentation

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

Definition at line 118 of file Muon.h.

Referenced by combinedMuon(), and embedCombinedMuon().

bool pat::Muon::embeddedCombinedMuon_ [protected]

Definition at line 117 of file Muon.h.

Referenced by combinedMuon(), and embedCombinedMuon().

bool pat::Muon::embeddedPFCandidate_ [protected]

true if the IsolatedPFCandidate is embedded

Definition at line 132 of file Muon.h.

Referenced by embedPFCandidate(), and pfCandidateRef().

bool pat::Muon::embeddedPickyMuon_ [protected]

Definition at line 123 of file Muon.h.

Referenced by embedPickyMuon(), and pickyMuon().

bool pat::Muon::embeddedStandAloneMuon_ [protected]

Definition at line 115 of file Muon.h.

Referenced by embedStandAloneMuon(), and standAloneMuon().

bool pat::Muon::embeddedTpfmsMuon_ [protected]

Definition at line 124 of file Muon.h.

Referenced by embedTpfmsMuon(), and tpfmsMuon().

bool pat::Muon::embeddedTrack_ [protected]

Definition at line 113 of file Muon.h.

Referenced by embedTrack(), and track().

reco::PFCandidateCollection pat::Muon::pfCandidate_ [protected]

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

Definition at line 135 of file Muon.h.

Referenced by embedPFCandidate(), and 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 138 of file Muon.h.

Referenced by embedPFCandidate(), pfCandidateRef(), and setPFCandidateRef().

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

Definition at line 127 of file Muon.h.

Referenced by embedPickyMuon(), and pickyMuon().

reco::TrackRef pat::Muon::pickyMuonRef_ [protected]

Definition at line 125 of file Muon.h.

Referenced by embedPickyMuon(), pickyMuon(), and setPickyMuon().

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

Definition at line 116 of file Muon.h.

Referenced by embedStandAloneMuon(), and standAloneMuon().

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

Definition at line 128 of file Muon.h.

Referenced by embedTpfmsMuon(), and tpfmsMuon().

reco::TrackRef pat::Muon::tpfmsMuonRef_ [protected]

Definition at line 126 of file Muon.h.

Referenced by embedTpfmsMuon(), setTpfmsMuon(), and tpfmsMuon().

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

Definition at line 114 of file Muon.h.

Referenced by embedTrack(), and track().

---

The documentation for this class was generated from the following files:

• DataFormats/PatCandidates/interface/Muon.h
• DataFormats/PatCandidates/src/Muon.cc

---