pat::DiObjectProxy Class Reference

#include <PATDiObjectProxy.h>

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

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_
bool	totalP4ok_
const std::type_info *	type1_
const std::type_info *	type2_

Detailed Description

Definition at line 19 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 23 of file PATDiObjectProxy.h.

: cand1_(nullptr), cand2_(nullptr), type1_(nullptr), type2_(nullptr), totalP4ok_(false), totalP4_()  {}

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 26 of file PATDiObjectProxy.h.

                                                                        :
            cand1_(&c1), cand2_(&c2), type1_(&typeid(c1)), type2_(&typeid(c2)), totalP4ok_(false), totalP4_() {}

Member Function Documentation

const reco::Candidate& pat::DiObjectProxy::cand1 ( ) const

inline

Gets the first Candidate.

Definition at line 30 of file PATDiObjectProxy.h.

References cand1_.

{ return *cand1_; }

const reco::Candidate& pat::DiObjectProxy::cand2 ( ) const

inline

Gets the second Candidate.

Definition at line 32 of file PATDiObjectProxy.h.

References cand2_.

{ return *cand2_; }

double pat::DiObjectProxy::deltaPhi ( void  ) const

inline

Get the phi separation.

Definition at line 37 of file PATDiObjectProxy.h.

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

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

double pat::DiObjectProxy::deltaR ( ) const

inline

Get the angular separation.

Definition at line 35 of file PATDiObjectProxy.h.

References cand1_, cand2_, and boostedElectronIsolation_cff::deltaR.

{ 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 51 of file PATDiObjectProxy.h.

{ 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 68 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 85 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 57 of file PATDiObjectProxy.h.

{ 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 74 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 91 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 59 of file PATDiObjectProxy.h.

{ 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 76 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 93 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 61 of file PATDiObjectProxy.h.

{ 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 78 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 95 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 53 of file PATDiObjectProxy.h.

{ 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 70 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 87 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 63 of file PATDiObjectProxy.h.

{ 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 80 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 97 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 65 of file PATDiObjectProxy.h.

{ 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 82 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 99 of file PATDiObjectProxy.h.

References cand2_, and type2_.

{ 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 55 of file PATDiObjectProxy.h.

{ 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 72 of file PATDiObjectProxy.h.

References cand1_, and type1_.

{ 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 89 of file PATDiObjectProxy.h.

References cand2_, and type2_.

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

const reco::Candidate::LorentzVector& pat::DiObjectProxy::totalP4 ( ) const

inline

Get the total four momentum.

Definition at line 42 of file PATDiObjectProxy.h.

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

                                                           { 
            if (!totalP4ok_) { 
                totalP4_ = cand1_->p4() + cand2_->p4(); 
                totalP4ok_ = true; 
            }
            return totalP4_;
        }

template<typename T >

const T& pat::DiObjectProxy::tryGet_ ( const reco::Candidate *  ptr, const std::type_info *  type  ) const

inlineprivate

Definition at line 104 of file PATDiObjectProxy.h.

References cand1_, className(), and Exception.

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

template<typename T >

const T& pat::DiObjectProxy::tryGetOne_ ( ) const

inlineprivate

Definition at line 115 of file PATDiObjectProxy.h.

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

                                     {
            if (typeid(T) == *type1_) {
                if (typeid(T) == *type2_) {
                    throw cms::Exception("Type Error") << "pat::DiObjectProxy: " << 
                        "you can't get use methods that get a particle by type if the two are of the same type!\n" <<
                        " Requested Type:" << ClassName<T>::name() << "\n";
                }
                return static_cast<const T &>(*cand1_);
            } else {
                if (typeid(T) != *type2_) {
                    throw cms::Exception("Type Error") << "pat::DiObjectProxy: " << 
                        "you can't get use methods that get a particle by type if neither of the two is of that type!\n" <<
                        " Requested Type:" << ClassName<T>::name() << "\n" <<
                        " Type of first :" << className(*cand1_) << "\n" <<
                        " Type of second:" << className(*cand2_) << "\n";
                }
                return static_cast<const T &>(*cand2_);
            }
        }

Member Data Documentation

const reco::Candidate* pat::DiObjectProxy::cand1_

private

Definition at line 135 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 135 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_

mutableprivate

Definition at line 139 of file PATDiObjectProxy.h.

Referenced by totalP4().

bool pat::DiObjectProxy::totalP4ok_

mutableprivate

Definition at line 138 of file PATDiObjectProxy.h.

Referenced by totalP4().

const std::type_info* pat::DiObjectProxy::type1_

private

Definition at line 136 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 136 of file PATDiObjectProxy.h.

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