Photon.h

Go to the documentation of this file.

//
// $Id: Photon.h,v 1.24 2011/06/08 20:40:18 rwolf Exp $
//

#ifndef DataFormats_PatCandidates_Photon_h
#define DataFormats_PatCandidates_Photon_h

#include "DataFormats/PatCandidates/interface/PATObject.h"
#include "DataFormats/EgammaCandidates/interface/Photon.h"
#include "DataFormats/EgammaReco/interface/SuperClusterFwd.h"
#include "DataFormats/EgammaReco/interface/SuperCluster.h"
#include "DataFormats/PatCandidates/interface/Isolation.h"


// Define typedefs for convenience
namespace pat {
  class Photon;
  typedef std::vector<Photon>              PhotonCollection; 
  typedef edm::Ref<PhotonCollection>       PhotonRef; 
  typedef edm::RefVector<PhotonCollection> PhotonRefVector; 
}

namespace reco {
  std::ostream& operator<<(std::ostream& out, const pat::Photon& obj);
}

// Class definition
namespace pat {


  class Photon : public PATObject<reco::Photon> {

    public:

      typedef std::pair<std::string,Bool_t> IdPair;

      Photon();
      Photon(const reco::Photon & aPhoton);
      Photon(const edm::RefToBase<reco::Photon> & aPhotonRef);
      Photon(const edm::Ptr<reco::Photon> & aPhotonRef);
      virtual ~Photon();

      virtual Photon * clone() const { return new Photon(*this); }

      // ---- methods for content embedding ----
      reco::SuperClusterRef superCluster() const;
      void embedSuperCluster();

      // ---- methods for access the generated photon ----
      const reco::Candidate * genPhoton() const { return genParticle(); }
      void setGenPhoton(const reco::GenParticleRef & gp, bool embed=false) { setGenParticleRef(gp, embed); }

      // ---- methods for photon ID ----
      Bool_t photonID(const std::string & name) const;
      bool isPhotonIDAvailable(const std::string & name) const;
      const std::vector<IdPair> &  photonIDs() const { return photonIDs_; }
      void setPhotonIDs(const std::vector<IdPair> & ids) { photonIDs_ = ids; }


      // ---- methods for photon isolation ----
      float trackIso() const { return trkSumPtSolidConeDR04(); }
      float ecalIso()  const { return ecalRecHitSumEtConeDR04(); }
      float hcalIso()  const { return hcalTowerSumEtConeDR04(); }
      float caloIso()  const { return ecalIso()+hcalIso(); }
      float userIso(uint8_t index=0)  const { return userIsolation(IsolationKeys(UserBaseIso + index)); }
      float userIsolation(IsolationKeys key) const { 
          if (key >= 0) {
        //if (key >= isolations_.size()) throw cms::Excepton("Missing Data") 
        //<< "Isolation corresponding to key " << key 
        //<< " was not stored for this particle.";
              if (size_t(key) >= isolations_.size()) return -1.0;
              return isolations_[key];
          } else switch (key) {
      case pat::CaloIso:  
        //if (isolations_.size() <= pat::HcalIso) throw cms::Excepton("Missing Data") 
        //<< "CalIsoo Isolation was not stored for this particle.";
        if (isolations_.size() <= pat::HcalIso) return -1.0; 
        return isolations_[pat::EcalIso] + isolations_[pat::HcalIso];
      default:
        return -1.0;
        //throw cms::Excepton("Missing Data") << "Isolation corresponding to key " 
        //<< key << " was not stored for this particle.";
          }
      }
      void setIsolation(IsolationKeys key, float value) {
          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 setTrackIso(float trackIso) { setIsolation(TrackIso, trackIso); }
      void setEcalIso(float caloIso)   { setIsolation(EcalIso,  caloIso);  } 
      void setHcalIso(float caloIso)   { setIsolation(HcalIso,  caloIso);  }
      void setUserIso(float value, uint8_t index=0)  { setIsolation(IsolationKeys(UserBaseIso + index), value); }

      // ---- methods for photon isolation deposits ----
      const IsoDeposit * isoDeposit(IsolationKeys key) const {
          for (IsoDepositPairs::const_iterator it = isoDeposits_.begin(), ed = isoDeposits_.end(); 
                  it != ed; ++it) 
          {
              if (it->first == key) return & it->second;
          }
          return 0;
      } 
      const IsoDeposit * trackIsoDeposit() const { return isoDeposit(pat::TrackIso); }
      const IsoDeposit * ecalIsoDeposit()  const { return isoDeposit(pat::EcalIso ); }
      const IsoDeposit * hcalIsoDeposit()  const { return isoDeposit(pat::HcalIso ); }
      const IsoDeposit * userIsoDeposit(uint8_t index=0) const { return isoDeposit(IsolationKeys(UserBaseIso + index)); }
      void setIsoDeposit(IsolationKeys key, const IsoDeposit &dep) {
          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 trackIsoDeposit(const IsoDeposit &dep) { setIsoDeposit(pat::TrackIso, dep); }
      void ecalIsoDeposit(const IsoDeposit &dep)  { setIsoDeposit(pat::EcalIso,  dep); }
      void hcalIsoDeposit(const IsoDeposit &dep)  { setIsoDeposit(pat::HcalIso,  dep); }
      void userIsoDeposit(const IsoDeposit &dep, uint8_t index=0) { setIsoDeposit(IsolationKeys(UserBaseIso + index), dep); }

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

    protected:

      // ---- for content embedding ----
      bool embeddedSuperCluster_;
      std::vector<reco::SuperCluster> superCluster_;
      // ---- photon ID's holder ----
      std::vector<IdPair> photonIDs_;
      // ---- Isolation and IsoDeposit related datamebers ----
      typedef std::vector<std::pair<IsolationKeys, pat::IsoDeposit> > IsoDepositPairs;
      IsoDepositPairs    isoDeposits_;
      std::vector<float> isolations_;

  };


}

#endif