Reference Manual

const IsoDeposit * isoDeposit(IsolationKeys key) const

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition: Photon.h:153

void pat::Photon::ecalIsoDeposit ( const IsoDeposit & dep )

inline

Sets ecal IsoDeposit.

Definition at line 180 of file Photon.h.

References pat::EcalIso, and setIsoDeposit().

180 { setIsoDeposit(pat::EcalIso, dep); }

pat::PATObject< reco::Photon >::genParticle

void setIsoDeposit(IsolationKeys key, const IsoDeposit &dep)

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition: Photon.h:170

pat::EcalIso

Definition: Isolation.h:9

void Photon::embedSuperCluster ( )

method to store the photon's supercluster internally

Definition at line 71 of file Photon.cc.

References embeddedSuperCluster_, reco::Photon::superCluster(), and superCluster_.

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

                                {
   superCluster_.clear();
   if (reco::Photon::superCluster().isNonnull()) {
       superCluster_.push_back(*reco::Photon::superCluster());
       embeddedSuperCluster_ = true;
   }
 }

const reco::Candidate* pat::Photon::genPhoton ( ) const

inline

return the match to the generated photon

Definition at line 74 of file Photon.h.

References pat::PATObject< reco::Photon >::genParticle().

74 { return genParticle(); }

const reco::GenParticle * genParticle(size_t idx=0) const

Definition: PATObject.h:234

float pat::Photon::hcalIso ( ) const

inline

Returns summed Et in a cone of deltaR<0.4 calculated from caloTowers

Definition at line 101 of file Photon.h.

References reco::Photon::hcalTowerSumEtConeDR04().

Referenced by PatPhotonSimpleAnalyzer::analyze(), and caloIso().

101 { return hcalTowerSumEtConeDR04(); }

reco::Photon::hcalTowerSumEtConeDR04

float hcalTowerSumEtConeDR04() const

Hcal isolation sum.

Definition: Photon.h:340

const IsoDeposit* pat::Photon::hcalIsoDeposit ( ) const

inline

Return the hcal IsoDeposit.

Definition at line 166 of file Photon.h.

References pat::HcalIso, and isoDeposit().

166 { return isoDeposit(pat::HcalIso ); }

pat::HcalIso

Definition: Isolation.h:9

const IsoDeposit * isoDeposit(IsolationKeys key) const

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition: Photon.h:153

void pat::Photon::hcalIsoDeposit ( const IsoDeposit & dep )

inline

Sets hcal IsoDeposit.

Definition at line 182 of file Photon.h.

References pat::HcalIso, and setIsoDeposit().

182 { setIsoDeposit(pat::HcalIso, dep); }

pat::HcalIso

Definition: Isolation.h:9

void setIsoDeposit(IsolationKeys key, const IsoDeposit &dep)

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition: Photon.h:170

const IsoDeposit* pat::Photon::isoDeposit ( IsolationKeys key ) const

inline

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition at line 153 of file Photon.h.

References isoDeposits_.

Referenced by ecalIsoDeposit(), hcalIsoDeposit(), trackIsoDeposit(), and userIsoDeposit().

                                                              {
           for (IsoDepositPairs::const_iterator it = isoDeposits_.begin(), ed = isoDeposits_.end(); 
                   it != ed; ++it) 
           {
               if (it->first == key) return & it->second;
           }
           return 0;
       } 

bool Photon::isPhotonIDAvailable ( const std::string & name ) const

Returns true if a specific ID is available in this pat::Photon.

Definition at line 94 of file Photon.cc.

References photonIDs_.

                                                              {
   for (std::vector<IdPair>::const_iterator it = photonIDs_.begin(), ed = photonIDs_.end(); it != ed; ++it) {
     if (it->first == name) return true;
   }
   return false;
 }

Bool_t Photon::photonID ( const std::string & name ) const

Returns a specific photon ID associated to the pat::Photon given its name. Note: an exception is thrown if the specified ID is not available

Definition at line 80 of file Photon.cc.

References photonIDs_.

                                                     {
   for (std::vector<IdPair>::const_iterator it = photonIDs_.begin(), ed = photonIDs_.end(); it != ed; ++it) {
     if (it->first == name) return it->second;
   }
   cms::Exception ex("Key not found");
   ex << "pat::Photon: the ID " << name << " can't be found in this pat::Photon.\n";
   ex << "The available IDs are: ";
   for (std::vector<IdPair>::const_iterator it = photonIDs_.begin(), ed = photonIDs_.end(); it != ed; ++it) {
     ex << "'" << it->first << "' ";
   }
   ex << ".\n";
   throw ex;
 }

const std::vector<IdPair>& pat::Photon::photonIDs ( ) const

inline

Returns all the Photon IDs in the form of <name,value> pairs The 'default' ID is the first in the list

Definition at line 86 of file Photon.h.

References photonIDs_.

86 { return photonIDs_; }

pat::Photon::photonIDs_

std::vector< IdPair > photonIDs_

Definition: Photon.h:195

void pat::Photon::setEcalIso ( float caloIso )

inline

Sets ecal isolation variable.

Definition at line 145 of file Photon.h.

References pat::EcalIso, and setIsolation().

145 { setIsolation(EcalIso, caloIso); }

pat::PATObject< reco::Photon >::setGenParticleRef

void setIsolation(IsolationKeys key, float value)

Definition: Photon.h:130

pat::EcalIso

Definition: Isolation.h:9

pat::Photon::caloIso

float caloIso() const

Definition: Photon.h:104

void pat::Photon::setGenPhoton	(	const reco::GenParticleRef &	gp,
		bool	embed = `false`
	)

inline

method to set the generated photon

Definition at line 76 of file Photon.h.

References embed, and pat::PATObject< reco::Photon >::setGenParticleRef().

76 { setGenParticleRef(gp, embed); }

void setGenParticleRef(const reco::GenParticleRef &ref, bool embed=false)

Set the generator level particle reference.

embed

#define embed

Definition: AMPTWrapper.h:178

void pat::Photon::setHcalIso ( float caloIso )

inline

Sets hcal isolation variable.

Definition at line 147 of file Photon.h.

References pat::HcalIso, and setIsolation().

147 { setIsolation(HcalIso, caloIso); }

pat::HcalIso

Definition: Isolation.h:9

void setIsolation(IsolationKeys key, float value)

Definition: Photon.h:130

pat::Photon::caloIso

float caloIso() const

Definition: Photon.h:104

void pat::Photon::setIsoDeposit	(	IsolationKeys	key,
		const IsoDeposit &	dep
	)

inline

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition at line 170 of file Photon.h.

References isoDeposits_.

Referenced by ecalIsoDeposit(), hcalIsoDeposit(), pat::PATPhotonProducer::produce(), trackIsoDeposit(), and userIsoDeposit().

                                                                    {
           IsoDepositPairs::iterator it = isoDeposits_.begin(), ed = isoDeposits_.end();
           for (; it != ed; ++it) {
               if (it->first == key) { it->second = dep; return; }
           }
           isoDeposits_.push_back(std::make_pair(key,dep));
       } 

void pat::Photon::setIsolation	(	IsolationKeys	key,
		float	value
	)

inline

Sets the isolation variable for a specifc key. Note that you can't set isolation for a pseudo-key like CaloIso

Definition at line 130 of file Photon.h.

References edm::hlt::Exception, isolations_, combine::key, and relativeConstraints::value.

Referenced by pat::PATPhotonProducer::produce(), setEcalIso(), setHcalIso(), setTrackIso(), and setUserIso().

                                                         {
           if (key >= 0) {
               if (size_t(key) >= isolations_.size()) isolations_.resize(key+1, -1.0);
               isolations_[key] = value;
           } else {
               throw cms::Exception("Illegal Argument") << 
                   "The key for which you're setting isolation does not correspond " <<
                   "to an individual isolation but to the sum of more independent isolations " <<
                   "(e.g. Calo = Ecal + Hcal), so you can't SET the value, just GET it.\n" <<
                   "Please set up each component independly.\n";
           }
       }

void pat::Photon::setPhotonIDs ( const std::vector< IdPair > & ids )

inline

Store multiple photon ID values, discarding existing ones The first one in the list becomes the 'default' photon id

Definition at line 89 of file Photon.h.

References photonIDs_.

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

89 { photonIDs_ = ids; }

pat::Photon::photonIDs_

std::vector< IdPair > photonIDs_

Definition: Photon.h:195

void pat::Photon::setTrackIso ( float trackIso )

inline

Sets tracker isolation variable.

Definition at line 143 of file Photon.h.

References setIsolation(), and pat::TrackIso.

143 { setIsolation(TrackIso, trackIso); }

pat::TrackIso

Definition: Isolation.h:9

pat::Photon::trackIso

float trackIso() const

Definition: Photon.h:95

void setIsolation(IsolationKeys key, float value)

Definition: Photon.h:130

void pat::Photon::setUserIso	(	float	value,
		uint8_t	index = `0`
	)

inline

Sets user isolation variable index.

Definition at line 149 of file Photon.h.

References setIsolation(), and pat::UserBaseIso.

149 { setIsolation(IsolationKeys(UserBaseIso + index), value); }

relativeConstraints.value

Definition: Isolation.h:12

tuple value

Definition: relativeConstraints.py:54

IsolationKeys

Enum defining isolation keys.

Definition: Isolation.h:9

void setIsolation(IsolationKeys key, float value)

Definition: Photon.h:130

reco::Photon::trkSumPtSolidConeDR04

unsigned int index

Definition: LeafCandidate.h:34

reco::SuperClusterRef Photon::superCluster ( ) const

virtual

override the superCluster method from CaloJet, to access the internal storage of the supercluster

override the superCluster method from CaloJet, to access the internal storage of the supercluster this returns a transient Ref which should never be persisted!

Reimplemented from reco::Photon.

Definition at line 62 of file Photon.cc.

References embeddedSuperCluster_, reco::Photon::superCluster(), and superCluster_.

Referenced by PatPhotonSimpleAnalyzer::analyze().

                                                {
   if (embeddedSuperCluster_) {
     return reco::SuperClusterRef(&superCluster_, 0);
   } else {
     return reco::Photon::superCluster();
   }
 }

float pat::Photon::trackIso ( ) const

inline

Returns the summed track pt in a cone of deltaR<0.4 including the region of the reconstructed photon

Definition at line 95 of file Photon.h.

References reco::Photon::trkSumPtSolidConeDR04().

Referenced by PatPhotonSimpleAnalyzer::analyze().

95 { return trkSumPtSolidConeDR04(); }

float trkSumPtSolidConeDR04() const

Definition: Photon.h:352

const IsoDeposit* pat::Photon::trackIsoDeposit ( ) const

inline

Return the tracker IsoDeposit.

Definition at line 162 of file Photon.h.

References isoDeposit(), and pat::TrackIso.

162 { return isoDeposit(pat::TrackIso); }

pat::TrackIso

Definition: Isolation.h:9

const IsoDeposit * isoDeposit(IsolationKeys key) const

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition: Photon.h:153

void pat::Photon::trackIsoDeposit ( const IsoDeposit & dep )

inline

Sets tracker IsoDeposit.

Definition at line 178 of file Photon.h.

References setIsoDeposit(), and pat::TrackIso.

178 { setIsoDeposit(pat::TrackIso, dep); }

pat::TrackIso

Definition: Isolation.h:9

void setIsoDeposit(IsolationKeys key, const IsoDeposit &dep)

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition: Photon.h:170

float pat::Photon::userIso ( uint8_t index = 0 ) const

inline

Returns a user defined isolation value.

Definition at line 106 of file Photon.h.

References pat::UserBaseIso, and userIsolation().

106 { return userIsolation(IsolationKeys(UserBaseIso + index)); }

Definition: Isolation.h:12

IsolationKeys

Enum defining isolation keys.

Definition: Isolation.h:9

pat::Photon::userIsolation

unsigned int index

Definition: LeafCandidate.h:34

float userIsolation(IsolationKeys key) const

Definition: Photon.h:109

const IsoDeposit* pat::Photon::userIsoDeposit ( uint8_t index = 0 ) const

inline

Return a specified user-level IsoDeposit.

Definition at line 168 of file Photon.h.

References isoDeposit(), and pat::UserBaseIso.

168 { return isoDeposit(IsolationKeys(UserBaseIso + index)); }

Definition: Isolation.h:12

IsolationKeys

Enum defining isolation keys.

Definition: Isolation.h:9

unsigned int index

Definition: LeafCandidate.h:34

const IsoDeposit * isoDeposit(IsolationKeys key) const

Returns the IsoDeposit associated with some key, or a null pointer if it is not available.

Definition: Photon.h:153

void pat::Photon::userIsoDeposit	(	const IsoDeposit &	dep,
		uint8_t	index = `0`
	)

inline

Sets user-level IsoDeposit.

Definition at line 184 of file Photon.h.

References setIsoDeposit(), and pat::UserBaseIso.

184 { setIsoDeposit(IsolationKeys(UserBaseIso + index), dep); }

Definition: Isolation.h:12

IsolationKeys

Enum defining isolation keys.

Definition: Isolation.h:9

void setIsoDeposit(IsolationKeys key, const IsoDeposit &dep)

Sets the IsoDeposit associated with some key; if it is already existent, it is overwritten.

Definition: Photon.h:170