HLTRechitInRegionsProducer.cc

Go to the documentation of this file.

// C/C++ headers
#include <vector>

// Framework
#include "DataFormats/Common/interface/Handle.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "CommonTools/Utils/interface/StringToEnumValue.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "HLTrigger/HLTcore/interface/defaultModuleLabel.h"

// Reconstruction Classes
#include "DataFormats/EcalRecHit/interface/EcalUncalibratedRecHit.h"
#include "DataFormats/EcalRecHit/interface/EcalRecHit.h"
#include "DataFormats/EcalRecHit/interface/EcalRecHitCollections.h"
#include "DataFormats/EcalDetId/interface/EBDetId.h"
#include "CondFormats/DataRecord/interface/EcalChannelStatusRcd.h"
#include "CondFormats/EcalObjects/interface/EcalChannelStatus.h"
#include "RecoLocalCalo/EcalRecAlgos/interface/EcalSeverityLevelAlgo.h"
#include "RecoLocalCalo/EcalRecAlgos/interface/EcalSeverityLevelAlgoRcd.h"

// Geometry
#include "Geometry/Records/interface/CaloGeometryRecord.h"
#include "Geometry/CaloGeometry/interface/CaloSubdetectorGeometry.h"
#include "Geometry/CaloGeometry/interface/CaloCellGeometry.h"
#include "Geometry/CaloGeometry/interface/CaloGeometry.h"
#include "Geometry/CaloTopology/interface/EcalBarrelTopology.h"
#include "Geometry/CaloTopology/interface/EcalEndcapTopology.h"
#include "Geometry/CaloTopology/interface/EcalPreshowerTopology.h"

// Level 1 Trigger
#include "DataFormats/L1Trigger/interface/L1EmParticle.h"
#include "DataFormats/L1Trigger/interface/L1EmParticleFwd.h"
#include "CondFormats/L1TObjects/interface/L1CaloGeometry.h"
#include "CondFormats/DataRecord/interface/L1CaloGeometryRecord.h"

#include <memory>

#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/MakerMacros.h"

#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/EDGetToken.h"

// Reco candidates
#include "DataFormats/RecoCandidate/interface/RecoCandidate.h"
#include "DataFormats/RecoCandidate/interface/RecoChargedCandidate.h"

#include "DataFormats/Math/interface/RectangularEtaPhiRegion.h"
#include "DataFormats/EcalRecHit/interface/EcalRecHitCollections.h"

// Geometry and topology
#include "Geometry/Records/interface/CaloGeometryRecord.h"
#include "Geometry/CaloGeometry/interface/CaloSubdetectorGeometry.h"
#include "Geometry/CaloGeometry/interface/CaloCellGeometry.h"
#include "Geometry/CaloGeometry/interface/CaloGeometry.h"
#include "Geometry/CaloTopology/interface/EcalBarrelTopology.h"
#include "Geometry/CaloTopology/interface/EcalEndcapTopology.h"
#include "Geometry/CaloTopology/interface/EcalPreshowerTopology.h"

// Level 1 Trigger
#include "DataFormats/L1Trigger/interface/L1EmParticle.h"
#include "DataFormats/L1Trigger/interface/L1EmParticleFwd.h"
#include "CondFormats/L1TObjects/interface/L1CaloGeometry.h"
#include "CondFormats/DataRecord/interface/L1CaloGeometryRecord.h"

template <typename T1>
class HLTRechitInRegionsProducer : public edm::stream::EDProducer<> {
  typedef std::vector<T1> T1Collection;
  typedef typename T1::const_iterator T1iterator;

public:
  HLTRechitInRegionsProducer(const edm::ParameterSet& ps);
  ~HLTRechitInRegionsProducer() override;

  void produce(edm::Event&, const edm::EventSetup&) override;
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

private:
  void getEtaPhiRegions(std::vector<RectangularEtaPhiRegion>*, T1Collection, const L1CaloGeometry&, bool);

  const bool useUncalib_;

  const bool doIsolated_;

  const edm::EDGetTokenT<T1Collection> l1TokenIsolated_;
  const edm::EDGetTokenT<T1Collection> l1TokenNonIsolated_;
  const double l1LowerThr_;
  const double l1UpperThr_;
  const double l1LowerThrIgnoreIsolation_;

  const double regionEtaMargin_;
  const double regionPhiMargin_;

  const std::vector<edm::InputTag> hitLabels;
  const std::vector<std::string> productLabels;

  std::vector<edm::EDGetTokenT<EcalRecHitCollection>> hitTokens;
  std::vector<edm::EDGetTokenT<EcalUncalibratedRecHitCollection>> uncalibHitTokens;

  const edm::ESGetToken<CaloGeometry, CaloGeometryRecord> caloGeometryToken_;
  const edm::ESGetToken<L1CaloGeometry, L1CaloGeometryRecord> l1CaloGeometryToken_;
};

template <typename T1>
HLTRechitInRegionsProducer<T1>::HLTRechitInRegionsProducer(const edm::ParameterSet& ps)
    : useUncalib_(ps.getParameter<bool>("useUncalib")),
      doIsolated_(ps.getParameter<bool>("doIsolated")),
      l1TokenIsolated_(doIsolated_ ? consumes<T1Collection>(ps.getParameter<edm::InputTag>("l1TagIsolated"))
                                   : edm::EDGetTokenT<T1Collection>()),
      l1TokenNonIsolated_(consumes<T1Collection>(ps.getParameter<edm::InputTag>("l1TagNonIsolated"))),
      l1LowerThr_(ps.getParameter<double>("l1LowerThr")),
      l1UpperThr_(ps.getParameter<double>("l1UpperThr")),
      l1LowerThrIgnoreIsolation_(ps.getParameter<double>("l1LowerThrIgnoreIsolation")),
      regionEtaMargin_(ps.getParameter<double>("regionEtaMargin")),
      regionPhiMargin_(ps.getParameter<double>("regionPhiMargin")),
      hitLabels(ps.getParameter<std::vector<edm::InputTag>>("ecalhitLabels")),
      productLabels(ps.getParameter<std::vector<std::string>>("productLabels")),
      caloGeometryToken_{esConsumes()},
      l1CaloGeometryToken_{esConsumes()} {
  if (useUncalib_) {
    for (unsigned int i = 0; i < hitLabels.size(); i++) {
      uncalibHitTokens.push_back(consumes<EcalUncalibratedRecHitCollection>(hitLabels[i]));
      produces<EcalUncalibratedRecHitCollection>(productLabels[i]);
    }
  } else {
    for (unsigned int i = 0; i < hitLabels.size(); i++) {
      hitTokens.push_back(consumes<EcalRecHitCollection>(hitLabels[i]));
      produces<EcalRecHitCollection>(productLabels[i]);
    }
  }
}

template <typename T1>
HLTRechitInRegionsProducer<T1>::~HLTRechitInRegionsProducer() {}

template <typename T1>
void HLTRechitInRegionsProducer<T1>::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  std::vector<std::string> productTags;
  productTags.push_back("EcalRegionalRecHitsEB");
  productTags.push_back("EcalRegionalRecHitsEE");
  desc.add<std::vector<std::string>>("productLabels", productTags);
  std::vector<edm::InputTag> inputTags;
  inputTags.push_back(edm::InputTag("hltEcalRegionalEgammaRecHit:EcalRecHitsEB"));
  inputTags.push_back(edm::InputTag("hltEcalRegionalEgammaRecHit:EcalRecHitsEE"));
  inputTags.push_back(edm::InputTag("hltESRegionalEgammaRecHit:EcalRecHitsES"));
  desc.add<std::vector<edm::InputTag>>("ecalhitLabels", inputTags);
  desc.add<edm::InputTag>("l1TagIsolated", edm::InputTag("l1extraParticles", "Isolated"));
  desc.add<edm::InputTag>("l1TagNonIsolated", edm::InputTag("l1extraParticles", "NonIsolated"));
  desc.add<bool>("useUncalib", true);
  desc.add<bool>("doIsolated", true);
  desc.add<double>("l1LowerThr", 5.0);
  desc.add<double>("l1UpperThr", 999.);
  desc.add<double>("l1LowerThrIgnoreIsolation", 0.0);
  desc.add<double>("regionEtaMargin", 0.14);
  desc.add<double>("regionPhiMargin", 0.4);
  descriptions.add(defaultModuleLabel<HLTRechitInRegionsProducer<T1>>(), desc);
}

template <typename T1>
void HLTRechitInRegionsProducer<T1>::produce(edm::Event& evt, const edm::EventSetup& eventSetup) {
  // get the collection geometry:
  auto const& geometry = eventSetup.getData(caloGeometryToken_);
  const CaloSubdetectorGeometry* geometry_p;
  std::unique_ptr<const CaloSubdetectorTopology> topology;

  //Get the L1 EM Particle Collection
  edm::Handle<T1Collection> emIsolColl;
  if (doIsolated_) {
    evt.getByToken(l1TokenIsolated_, emIsolColl);
  }

  // Get the CaloGeometry
  auto const& l1CaloGeom = eventSetup.getData(l1CaloGeometryToken_);

  std::vector<RectangularEtaPhiRegion> regions;
  if (doIsolated_)
    getEtaPhiRegions(&regions, *emIsolColl, l1CaloGeom, true);

  if (!doIsolated_ or (l1LowerThrIgnoreIsolation_ < 64))
    getEtaPhiRegions(&regions, evt.get(l1TokenNonIsolated_), l1CaloGeom, false);

  if (useUncalib_) {
    edm::Handle<EcalUncalibratedRecHitCollection> urhcH[3];
    for (unsigned int i = 0; i < hitLabels.size(); i++) {
      auto uhits = std::make_unique<EcalUncalibratedRecHitCollection>();

      evt.getByToken(uncalibHitTokens[i], urhcH[i]);
      if (!(urhcH[i].isValid())) {
        edm::LogError("ProductNotFound") << "could not get a handle on the EcalRecHitCollection! ("
                                         << hitLabels[i].encode() << ")" << std::endl;
        return;
      }
      const EcalUncalibratedRecHitCollection* uncalibRecHits = urhcH[i].product();

      if (!uncalibRecHits->empty()) {
        if ((*uncalibRecHits)[0].id().subdetId() == EcalBarrel) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalBarrel);
          topology = std::make_unique<EcalBarrelTopology>(geometry);
        } else if ((*uncalibRecHits)[0].id().subdetId() == EcalEndcap) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalEndcap);
          topology = std::make_unique<EcalEndcapTopology>(geometry);
        } else if ((*uncalibRecHits)[0].id().subdetId() == EcalPreshower) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalPreshower);
          topology = std::make_unique<EcalPreshowerTopology>();
        } else
          throw(std::runtime_error("\n\nProducer encountered invalied ecalhitcollection type.\n\n"));

        if (!regions.empty()) {
          EcalUncalibratedRecHitCollection::const_iterator it;

          for (it = uncalibRecHits->begin(); it != uncalibRecHits->end(); it++) {
            auto this_cell = geometry_p->getGeometry(it->id());

            std::vector<RectangularEtaPhiRegion>::const_iterator region;
            for (region = regions.begin(); region != regions.end(); region++) {
              if (region->inRegion(this_cell->etaPos(), this_cell->phiPos())) {
                uhits->push_back(*it);
                break;
              }
            }
          }
        }
      }
      evt.put(std::move(uhits), productLabels[i]);
    }

  } else {
    edm::Handle<EcalRecHitCollection> rhcH[3];
    for (unsigned int i = 0; i < hitLabels.size(); i++) {
      auto hits = std::make_unique<EcalRecHitCollection>();

      evt.getByToken(hitTokens[i], rhcH[i]);
      if (!(rhcH[i].isValid())) {
        edm::LogError("ProductNotFound") << "could not get a handle on the EcalRecHitCollection! ("
                                         << hitLabels[i].encode() << ")" << std::endl;
        return;
      }
      const EcalRecHitCollection* recHits = rhcH[i].product();

      if (!recHits->empty()) {
        if ((*recHits)[0].id().subdetId() == EcalBarrel) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalBarrel);
          topology = std::make_unique<EcalBarrelTopology>(geometry);
        } else if ((*recHits)[0].id().subdetId() == EcalEndcap) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalEndcap);
          topology = std::make_unique<EcalEndcapTopology>(geometry);
        } else if ((*recHits)[0].id().subdetId() == EcalPreshower) {
          geometry_p = geometry.getSubdetectorGeometry(DetId::Ecal, EcalPreshower);
          topology = std::make_unique<EcalPreshowerTopology>();
        } else
          throw(std::runtime_error("\n\nProducer encountered invalied ecalhitcollection type.\n\n"));

        if (!regions.empty()) {
          EcalRecHitCollection::const_iterator it;
          for (it = recHits->begin(); it != recHits->end(); it++) {
            auto this_cell = geometry_p->getGeometry(it->id());

            std::vector<RectangularEtaPhiRegion>::const_iterator region;
            for (region = regions.begin(); region != regions.end(); region++) {
              if (region->inRegion(this_cell->etaPos(), this_cell->phiPos())) {
                hits->push_back(*it);
                break;
              }
            }
          }
        }
      }
      evt.put(std::move(hits), productLabels[i]);
    }
  }
}

template <>
void HLTRechitInRegionsProducer<l1extra::L1EmParticle>::getEtaPhiRegions(
    std::vector<RectangularEtaPhiRegion>* theRegions,
    T1Collection theCandidateCollection,
    const L1CaloGeometry& l1CaloGeom,
    bool isolatedCase) {
  for (unsigned int candItr = 0; candItr < theCandidateCollection.size(); candItr++) {
    l1extra::L1EmParticle emItr = theCandidateCollection.at(candItr);

    if (!isolatedCase) {
      if (doIsolated_ and (emItr.et() < l1LowerThrIgnoreIsolation_))
        continue;
    }

    if ((emItr.et() > l1LowerThr_) and (emItr.et() < l1UpperThr_)) {
      // Access the GCT hardware object corresponding to the L1Extra EM object.
      int etaIndex = emItr.gctEmCand()->etaIndex();
      int phiIndex = emItr.gctEmCand()->phiIndex();

      // Use the L1CaloGeometry to find the eta, phi bin boundaries.
      double etaLow = l1CaloGeom.etaBinLowEdge(etaIndex);
      double etaHigh = l1CaloGeom.etaBinHighEdge(etaIndex);
      double phiLow = l1CaloGeom.emJetPhiBinLowEdge(phiIndex);
      double phiHigh = l1CaloGeom.emJetPhiBinHighEdge(phiIndex);

      etaLow -= regionEtaMargin_;
      etaHigh += regionEtaMargin_;
      phiLow -= regionPhiMargin_;
      phiHigh += regionPhiMargin_;

      theRegions->push_back(RectangularEtaPhiRegion(etaLow, etaHigh, phiLow, phiHigh));
    }
  }
}

template <typename T1>
void HLTRechitInRegionsProducer<T1>::getEtaPhiRegions(std::vector<RectangularEtaPhiRegion>* theRegions,
                                                      T1Collection theCandidateCollection,
                                                      const L1CaloGeometry& l1CaloGeom,
                                                      bool isolatedCase) {
  for (unsigned int candItr = 0; candItr < theCandidateCollection.size(); candItr++) {
    T1 emItr = theCandidateCollection.at(candItr);
    if ((emItr.et() > l1LowerThr_) and (emItr.et() < l1UpperThr_)) {
      double etaLow = emItr.eta() - regionEtaMargin_;
      double etaHigh = emItr.eta() + regionEtaMargin_;
      double phiLow = emItr.phi() - regionPhiMargin_;
      double phiHigh = emItr.phi() + regionPhiMargin_;

      theRegions->push_back(RectangularEtaPhiRegion(etaLow, etaHigh, phiLow, phiHigh));
    }
  }
}

typedef HLTRechitInRegionsProducer<l1extra::L1EmParticle> EgammaHLTRechitInRegionsProducer;
DEFINE_FWK_MODULE(EgammaHLTRechitInRegionsProducer);

typedef HLTRechitInRegionsProducer<reco::RecoChargedCandidate> MuonHLTRechitInRegionsProducer;
DEFINE_FWK_MODULE(MuonHLTRechitInRegionsProducer);