CMS 3D CMS Logo
pat::DiObjectProxy

pat::DiObjectProxy Class Reference

#include <PhysicsTools/PatUtils/interface/PATDiObjectProxy.h>

List of all members.

Public Member Functions

const reco::Candidate & cand1 () const
 Gets the first Candidate.
const reco::Candidate & cand2 () const
 Gets the second Candidate.
double deltaPhi () const
 Get the phi separation.
double deltaR () const
 Get the angular separation.
 DiObjectProxy (const reco::Candidate &c1, const reco::Candidate &c2)
 Constructor of the pair from two Candidates Note: the Proxy MUST NOT outlive the Candidates, otherwise you get dangling pointers.
 DiObjectProxy ()
 Default constructor, requested by ROOT. NEVER use a default constructed item!
const Electron & ele () const
 Get the PAT Electron, if the pair contains one and only one PAT Electron (throw exception otherwise).
const Electron & ele1 () const
 Get the first item, if it's a PAT Electron (throw exception otherwise).
const Electron & ele2 () const
 Get the second item, if it's a PAT Electron (throw exception otherwise).
const Photon & gam () const
 Get the PAT Photon, if the pair contains one and only one PAT Photon (throw exception otherwise).
const Photon & gam1 () const
 Get the first item, if it's a PAT Photon (throw exception otherwise).
const Photon & gam2 () const
 Get the second item, if it's a PAT Photon (throw exception otherwise).
const Jet & jet () const
 Get the PAT Jet, if the pair contains one and only one PAT Jet (throw exception otherwise).
const Jet & jet1 () const
 Get the first item, if it's a PAT Jet (throw exception otherwise).
const Jet & jet2 () const
 Get the second item, if it's a PAT Jet (throw exception otherwise).
const MET & met () const
 Get the PAT MET, if the pair contains one and only one PAT MET (throw exception otherwise).
const MET & met1 () const
 Get the first item, if it's a PAT MET (throw exception otherwise).
const MET & met2 () const
 Get the second item, if it's a PAT MET (throw exception otherwise).
const Muon & mu () const
 Get the PAT Muon, if the pair contains one and only one PAT Muon (throw exception otherwise).
const Muon & mu1 () const
 Get the first item, if it's a PAT Muon (throw exception otherwise).
const Muon & mu2 () const
 Get the second item, if it's a PAT Muon (throw exception otherwise).
const GenericParticle & part () const
 Get the PAT GenericParticle, if the pair contains one and only one PAT GenericParticle (throw exception otherwise).
const GenericParticle & part1 () const
 Get the first item, if it's a PAT GenericParticle (throw exception otherwise).
const GenericParticle & part2 () const
 Get the second item, if it's a PAT GenericParticle (throw exception otherwise).
const PFParticle & pf () const
 Get the PAT PFParticle, if the pair contains one and only one PAT PFParticle (throw exception otherwise).
const PFParticle & pf1 () const
 Get the first item, if it's a PAT PFParticle (throw exception otherwise).
const PFParticle & pf2 () const
 Get the second item, if it's a PAT PFParticle (throw exception otherwise).
const Tau & tau () const
 Get the PAT Tau, if the pair contains one and only one PAT Tau (throw exception otherwise).
const Tau & tau1 () const
 Get the first item, if it's a PAT Tau (throw exception otherwise).
const Tau & tau2 () const
 Get the second item, if it's a PAT Tau (throw exception otherwise).
const
reco::Candidate::LorentzVector & 		totalP4 () const
 Get the total four momentum.

Private Member Functions

template<typename T>
const T & tryGet_ (const reco::Candidate *ptr, const std::type_info *type) const
template<typename T>
const T & tryGetOne_ () const

Private Attributes

const reco::Candidate * cand1_
const reco::Candidate * cand2_
reco::Candidate::LorentzVector totalP4_
edm::BoolCache totalP4ok_
const std::type_info * type1_
const std::type_info * type2_

Detailed Description

Definition at line 20 of file PATDiObjectProxy.h.

Constructor & Destructor Documentation

pat::DiObjectProxy::DiObjectProxy (  )  [inline]

Default constructor, requested by ROOT. NEVER use a default constructed item!

Definition at line 24 of file PATDiObjectProxy.h.

00024 : cand1_(0), cand2_(0), type1_(0), type2_(0) {}

pat::DiObjectProxy::DiObjectProxy ( const reco::Candidate &  c1,
const reco::Candidate &  c2 
) [inline]

Constructor of the pair from two Candidates Note: the Proxy MUST NOT outlive the Candidates, otherwise you get dangling pointers.

Definition at line 27 of file PATDiObjectProxy.h.

00027                                                                         :
00028             cand1_(&c1), cand2_(&c2), type1_(&typeid(c1)), type2_(&typeid(c2)) {}

Member Function Documentation

const reco::Candidate& pat::DiObjectProxy::cand1 (  )  const [inline]

Gets the first Candidate.

Definition at line 31 of file PATDiObjectProxy.h.

References cand1_.

00031 { return *cand1_; }

const reco::Candidate& pat::DiObjectProxy::cand2 (  )  const [inline]

Gets the second Candidate.

Definition at line 33 of file PATDiObjectProxy.h.

References cand2_.

00033 { return *cand2_; }

double pat::DiObjectProxy::deltaPhi (  )  const [inline]

Get the phi separation.

Definition at line 38 of file PATDiObjectProxy.h.

References cand1_, cand2_, deltaPhi(), and reco::Particle::phi().

00038 { return ::deltaPhi(cand1_->phi(), cand2_->phi()); }

double pat::DiObjectProxy::deltaR (  )  const [inline]

Get the angular separation.

Definition at line 36 of file PATDiObjectProxy.h.

References cand1_, cand2_, and deltaR().

00036 { return ::deltaR(*cand1_, *cand2_); }

const Electron& pat::DiObjectProxy::ele (  )  const [inline]

Get the PAT Electron, if the pair contains one and only one PAT Electron (throw exception otherwise).

Definition at line 52 of file PATDiObjectProxy.h.

00052 { return tryGetOne_<Electron>(); }

const Electron& pat::DiObjectProxy::ele1 (  )  const [inline]

Get the first item, if it's a PAT Electron (throw exception otherwise).

Definition at line 69 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00069 { return tryGet_<Electron>(cand1_, type1_); }

const Electron& pat::DiObjectProxy::ele2 (  )  const [inline]

Get the second item, if it's a PAT Electron (throw exception otherwise).

Definition at line 86 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00086 { return tryGet_<Electron>(cand2_, type2_); }

const Photon& pat::DiObjectProxy::gam (  )  const [inline]

Get the PAT Photon, if the pair contains one and only one PAT Photon (throw exception otherwise).

Definition at line 58 of file PATDiObjectProxy.h.

00058 { return tryGetOne_<Photon>(); }

const Photon& pat::DiObjectProxy::gam1 (  )  const [inline]

Get the first item, if it's a PAT Photon (throw exception otherwise).

Definition at line 75 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00075 { return tryGet_<Photon>(cand1_, type1_); }

const Photon& pat::DiObjectProxy::gam2 (  )  const [inline]

Get the second item, if it's a PAT Photon (throw exception otherwise).

Definition at line 92 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00092 { return tryGet_<Photon>(cand2_, type2_); }

const Jet& pat::DiObjectProxy::jet ( void   )  const [inline]

Get the PAT Jet, if the pair contains one and only one PAT Jet (throw exception otherwise).

Definition at line 60 of file PATDiObjectProxy.h.

00060 { return tryGetOne_<Jet>(); }

const Jet& pat::DiObjectProxy::jet1 (  )  const [inline]

Get the first item, if it's a PAT Jet (throw exception otherwise).

Definition at line 77 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00077 { return tryGet_<Jet>(cand1_, type1_); }

const Jet& pat::DiObjectProxy::jet2 (  )  const [inline]

Get the second item, if it's a PAT Jet (throw exception otherwise).

Definition at line 94 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00094 { return tryGet_<Jet>(cand2_, type2_); }

const MET& pat::DiObjectProxy::met (  )  const [inline]

Get the PAT MET, if the pair contains one and only one PAT MET (throw exception otherwise).

Definition at line 62 of file PATDiObjectProxy.h.

00062 { return tryGetOne_<MET>(); }

const MET& pat::DiObjectProxy::met1 (  )  const [inline]

Get the first item, if it's a PAT MET (throw exception otherwise).

Definition at line 79 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00079 { return tryGet_<MET>(cand1_, type1_); }

const MET& pat::DiObjectProxy::met2 (  )  const [inline]

Get the second item, if it's a PAT MET (throw exception otherwise).

Definition at line 96 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00096 { return tryGet_<MET>(cand2_, type2_); }

const Muon& pat::DiObjectProxy::mu (  )  const [inline]

Get the PAT Muon, if the pair contains one and only one PAT Muon (throw exception otherwise).

Definition at line 54 of file PATDiObjectProxy.h.

00054 { return tryGetOne_<Muon>(); }

const Muon& pat::DiObjectProxy::mu1 (  )  const [inline]

Get the first item, if it's a PAT Muon (throw exception otherwise).

Definition at line 71 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00071 { return tryGet_<Muon>(cand1_, type1_); }

const Muon& pat::DiObjectProxy::mu2 (  )  const [inline]

Get the second item, if it's a PAT Muon (throw exception otherwise).

Definition at line 88 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00088 { return tryGet_<Muon>(cand2_, type2_); }

const GenericParticle& pat::DiObjectProxy::part (  )  const [inline]

Get the PAT GenericParticle, if the pair contains one and only one PAT GenericParticle (throw exception otherwise).

Definition at line 64 of file PATDiObjectProxy.h.

00064 { return tryGetOne_<GenericParticle>(); }

const GenericParticle& pat::DiObjectProxy::part1 (  )  const [inline]

Get the first item, if it's a PAT GenericParticle (throw exception otherwise).

Definition at line 81 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00081 { return tryGet_<GenericParticle>(cand1_, type1_); }

const GenericParticle& pat::DiObjectProxy::part2 (  )  const [inline]

Get the second item, if it's a PAT GenericParticle (throw exception otherwise).

Definition at line 98 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00098 { return tryGet_<GenericParticle>(cand2_, type2_); }

const PFParticle& pat::DiObjectProxy::pf (  )  const [inline]

Get the PAT PFParticle, if the pair contains one and only one PAT PFParticle (throw exception otherwise).

Definition at line 66 of file PATDiObjectProxy.h.

00066 { return tryGetOne_<PFParticle>(); }

const PFParticle& pat::DiObjectProxy::pf1 (  )  const [inline]

Get the first item, if it's a PAT PFParticle (throw exception otherwise).

Definition at line 83 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00083 { return tryGet_<PFParticle>(cand1_, type1_); }

const PFParticle& pat::DiObjectProxy::pf2 (  )  const [inline]

Get the second item, if it's a PAT PFParticle (throw exception otherwise).

Definition at line 100 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00100 { return tryGet_<PFParticle>(cand2_, type2_); }

const Tau& pat::DiObjectProxy::tau (  )  const [inline]

Get the PAT Tau, if the pair contains one and only one PAT Tau (throw exception otherwise).

Definition at line 56 of file PATDiObjectProxy.h.

00056 { return tryGetOne_<Tau>(); }

const Tau& pat::DiObjectProxy::tau1 (  )  const [inline]

Get the first item, if it's a PAT Tau (throw exception otherwise).

Definition at line 73 of file PATDiObjectProxy.h.

References cand1_, and type1_.

00073 { return tryGet_<Tau>(cand1_, type1_); }

const Tau& pat::DiObjectProxy::tau2 (  )  const [inline]

Get the second item, if it's a PAT Tau (throw exception otherwise).

Definition at line 90 of file PATDiObjectProxy.h.

References cand2_, and type2_.

00090 { return tryGet_<Tau>(cand2_, type2_); }

const reco::Candidate::LorentzVector& pat::DiObjectProxy::totalP4 (  )  const [inline]

Get the total four momentum.

Definition at line 43 of file PATDiObjectProxy.h.

References cand1_, cand2_, reco::Particle::p4(), totalP4_, and totalP4ok_.

00043                                                            { 
00044             if (!totalP4ok_) { 
00045                 totalP4_ = cand1_->p4() + cand2_->p4(); 
00046                 totalP4ok_ = true; 
00047             }
00048             return totalP4_;
00049         }

template<typename T>
const T& pat::DiObjectProxy::tryGet_ ( const reco::Candidate *  ptr,
const std::type_info *  type 
) const [inline, private]

Definition at line 105 of file PATDiObjectProxy.h.

References cand1_, className(), and Exception.

00105                                                                                     {
00106             if (typeid(T) != *type) {
00107                 throw cms::Exception("Type Error") << "pat::DiObjectProxy: the object of the pair is not of the type you request.\n" 
00108                                                    << " Item Index in pair: " << (ptr == cand1_ ? "first" : "second") << "\n"
00109                                                    << " Requested TypeID  : " << ClassName<T>::name() << "\n"
00110                                                    << " Found TypeID      : " << className(*ptr) << "\n";
00111             }
00112             return static_cast<const T &>(*ptr);
00113         }

template<typename T>
const T& pat::DiObjectProxy::tryGetOne_ (  )  const [inline, private]

Definition at line 116 of file PATDiObjectProxy.h.

References cand1_, cand2_, className(), Exception, ClassName< T >::name(), type1_, and type2_.

00116                                      {
00117             if (typeid(T) == *type1_) {
00118                 if (typeid(T) == *type2_) {
00119                     throw cms::Exception("Type Error") << "pat::DiObjectProxy: " << 
00120                         "you can't get use methods that get a particle by type if the two are of the same type!\n" <<
00121                         " Requested Type:" << ClassName<T>::name() << "\n";
00122                 }
00123                 return static_cast<const T &>(*cand1_);
00124             } else {
00125                 if (typeid(T) != *type2_) {
00126                     throw cms::Exception("Type Error") << "pat::DiObjectProxy: " << 
00127                         "you can't get use methods that get a particle by type if neither of the two is of that type!\n" <<
00128                         " Requested Type:" << ClassName<T>::name() << "\n" <<
00129                         " Type of first :" << className(*cand1_) << "\n" <<
00130                         " Type of second:" << className(*cand2_) << "\n";
00131                 }
00132                 return static_cast<const T &>(*cand2_);
00133             }
00134         }

Member Data Documentation

const reco::Candidate* pat::DiObjectProxy::cand1_ [private]

Definition at line 136 of file PATDiObjectProxy.h.

Referenced by cand1(), deltaPhi(), deltaR(), ele1(), gam1(), jet1(), met1(), mu1(), part1(), pf1(), tau1(), totalP4(), tryGet_(), and tryGetOne_().

const reco::Candidate * pat::DiObjectProxy::cand2_ [private]

Definition at line 136 of file PATDiObjectProxy.h.

Referenced by cand2(), deltaPhi(), deltaR(), ele2(), gam2(), jet2(), met2(), mu2(), part2(), pf2(), tau2(), totalP4(), and tryGetOne_().

reco::Candidate::LorentzVector pat::DiObjectProxy::totalP4_ [mutable, private]

Definition at line 140 of file PATDiObjectProxy.h.

Referenced by totalP4().

edm::BoolCache pat::DiObjectProxy::totalP4ok_ [mutable, private]

Definition at line 139 of file PATDiObjectProxy.h.

Referenced by totalP4().

const std::type_info* pat::DiObjectProxy::type1_ [private]

Definition at line 137 of file PATDiObjectProxy.h.

Referenced by ele1(), gam1(), jet1(), met1(), mu1(), part1(), pf1(), tau1(), and tryGetOne_().

const std::type_info * pat::DiObjectProxy::type2_ [private]

Definition at line 137 of file PATDiObjectProxy.h.

Referenced by ele2(), gam2(), jet2(), met2(), mu2(), part2(), pf2(), tau2(), and tryGetOne_().

The documentation for this class was generated from the following file:
Generated on Tue Jun 9 18:49:31 2009 for CMSSW by  doxygen 1.5.4