RealisticSimClusterMapper.cc

Go to the documentation of this file.

// Author: Felice Pantaleo
// Date:   30/06/2017
// Email: felice@cern.ch

#include "RealisticCluster.h"

#include "DataFormats/ForwardDetId/interface/HGCalDetId.h"
#include "DataFormats/ParticleFlowReco/interface/PFRecHitFraction.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "RecoLocalCalo/HGCalRecAlgos/interface/RecHitTools.h"
#include "RecoLocalCalo/HGCalRecProducers/interface/ComputeClusterTime.h"
#include "RecoParticleFlow/PFClusterProducer/interface/InitialClusteringStepBase.h"
#include "RecoParticleFlow/PFClusterProducer/plugins/SimMappers/RealisticHitToClusterAssociator.h"
#include "SimDataFormats/CaloAnalysis/interface/SimCluster.h"
#include "SimDataFormats/CaloAnalysis/interface/SimClusterFwd.h"

#include <unordered_map>

class RealisticSimClusterMapper : public InitialClusteringStepBase {
public:
  RealisticSimClusterMapper(const edm::ParameterSet& conf, edm::ConsumesCollector& cc)
      : InitialClusteringStepBase(conf, cc),
        invisibleFraction_(conf.getParameter<double>("invisibleFraction")),
        exclusiveFraction_(conf.getParameter<double>("exclusiveFraction")),
        maxDistanceFilter_(conf.getParameter<bool>("maxDistanceFilter")),
        maxDistance_(conf.getParameter<double>("maxDistance")),
        maxDforTimingSquared_(conf.getParameter<double>("maxDforTimingSquared")),
        timeOffset_(conf.getParameter<double>("timeOffset")),
        minNHitsforTiming_(conf.getParameter<unsigned int>("minNHitsforTiming")),
        useMCFractionsForExclEnergy_(conf.getParameter<bool>("useMCFractionsForExclEnergy")),
        calibMinEta_(conf.getParameter<double>("calibMinEta")),
        calibMaxEta_(conf.getParameter<double>("calibMaxEta")),
        hadronCalib_(conf.getParameter<std::vector<double> >("hadronCalib")),
        egammaCalib_(conf.getParameter<std::vector<double> >("egammaCalib")),
        simClusterToken_(cc.consumes<SimClusterCollection>(conf.getParameter<edm::InputTag>("simClusterSrc"))),
        geomToken_(cc.esConsumes<edm::Transition::BeginRun>()) {}

  ~RealisticSimClusterMapper() override {}
  RealisticSimClusterMapper(const RealisticSimClusterMapper&) = delete;
  RealisticSimClusterMapper& operator=(const RealisticSimClusterMapper&) = delete;

  void updateEvent(const edm::Event&) final;
  void update(const edm::EventSetup&) final;

  void buildClusters(const edm::Handle<reco::PFRecHitCollection>&,
                     const std::vector<bool>&,
                     const std::vector<bool>&,
                     reco::PFClusterCollection&) override;

private:
  hgcal::RecHitTools rhtools_;
  const float invisibleFraction_ = 0.3f;
  const float exclusiveFraction_ = 0.7f;
  const bool maxDistanceFilter_ = false;
  const float maxDistance_ = 10.f;
  const float maxDforTimingSquared_ = 4.0f;
  const float timeOffset_;
  const unsigned int minNHitsforTiming_ = 3;
  const bool useMCFractionsForExclEnergy_ = false;
  const float calibMinEta_ = 1.4;
  const float calibMaxEta_ = 3.0;
  std::vector<double> hadronCalib_;
  std::vector<double> egammaCalib_;

  edm::EDGetTokenT<SimClusterCollection> simClusterToken_;
  edm::Handle<SimClusterCollection> simClusterH_;

  edm::ESGetToken<CaloGeometry, CaloGeometryRecord> geomToken_;
};

DEFINE_EDM_PLUGIN(InitialClusteringStepFactory, RealisticSimClusterMapper, "RealisticSimClusterMapper");

#ifdef PFLOW_DEBUG
#define LOGVERB(x) edm::LogVerbatim(x)
#define LOGWARN(x) edm::LogWarning(x)
#define LOGERR(x) edm::LogError(x)
#define LOGDRESSED(x) edm::LogInfo(x)
#else
#define LOGVERB(x) LogTrace(x)
#define LOGWARN(x) edm::LogWarning(x)
#define LOGERR(x) edm::LogError(x)
#define LOGDRESSED(x) LogDebug(x)
#endif

namespace {

  inline bool isPi0(int pdgId) { return pdgId == 111; }

  inline bool isEGamma(int pdgId) {
    pdgId = std::abs(pdgId);
    return (pdgId == 11) or (pdgId == 22);
  }

  inline bool isHadron(int pdgId) {
    pdgId = std::abs(pdgId) % 10000;
    return ((pdgId > 100 and pdgId < 900) or (pdgId > 1000 and pdgId < 9000));
  }
}  // namespace

void RealisticSimClusterMapper::updateEvent(const edm::Event& ev) { ev.getByToken(simClusterToken_, simClusterH_); }

void RealisticSimClusterMapper::update(const edm::EventSetup& es) { rhtools_.setGeometry(es.getData(geomToken_)); }

void RealisticSimClusterMapper::buildClusters(const edm::Handle<reco::PFRecHitCollection>& input,
                                              const std::vector<bool>& rechitMask,
                                              const std::vector<bool>& seedable,
                                              reco::PFClusterCollection& output) {
  const SimClusterCollection& simClusters = *simClusterH_;
  auto const& hits = *input;
  RealisticHitToClusterAssociator realisticAssociator;
  const int numberOfLayers = rhtools_.getGeometryType() == 0 ? rhtools_.getLayer(ForwardSubdetector::ForwardEmpty)
                                                             : rhtools_.getLayer(DetId::Forward);
  realisticAssociator.init(hits.size(), simClusters.size(), numberOfLayers + 1);
  // for quick indexing back to hit energy
  std::unordered_map<uint32_t, size_t> detIdToIndex(hits.size());
  for (uint32_t i = 0; i < hits.size(); ++i) {
    detIdToIndex[hits[i].detId()] = i;
    auto ref = makeRefhit(input, i);
    const auto& hitPos = rhtools_.getPosition(ref->detId());

    realisticAssociator.insertHitPosition(hitPos.x(), hitPos.y(), hitPos.z(), i);
    realisticAssociator.insertHitEnergy(ref->energy(), i);
    realisticAssociator.insertLayerId(rhtools_.getLayerWithOffset(ref->detId()), i);
  }

  for (unsigned int ic = 0; ic < simClusters.size(); ++ic) {
    const auto& sc = simClusters[ic];
    const auto& hitsAndFractions = sc.hits_and_fractions();
    for (const auto& hAndF : hitsAndFractions) {
      auto itr = detIdToIndex.find(hAndF.first);
      if (itr == detIdToIndex.end()) {
        continue;  // hit wasn't saved in reco or did not pass the SNR threshold
      }
      auto hitId = itr->second;
      auto ref = makeRefhit(input, hitId);
      float fraction = hAndF.second;
      float associatedEnergy = fraction * ref->energy();
      realisticAssociator.insertSimClusterIdAndFraction(ic, fraction, hitId, associatedEnergy);
    }
  }
  realisticAssociator.computeAssociation(
      exclusiveFraction_, useMCFractionsForExclEnergy_, rhtools_.lastLayerEE(), rhtools_.lastLayerFH());
  realisticAssociator.findAndMergeInvisibleClusters(invisibleFraction_, exclusiveFraction_);
  realisticAssociator.findCentersOfGravity();
  if (maxDistanceFilter_)
    realisticAssociator.filterHitsByDistance(maxDistance_);

  const auto& realisticClusters = realisticAssociator.realisticClusters();
  unsigned int nClusters = realisticClusters.size();
  float bin_norm = 1. / (calibMaxEta_ - calibMinEta_);
  float egamma_bin_norm = egammaCalib_.size() * bin_norm;
  float hadron_bin_norm = hadronCalib_.size() * bin_norm;
  for (unsigned ic = 0; ic < nClusters; ++ic) {
    float highest_energy = 0.0f;
    output.emplace_back();
    reco::PFCluster& back = output.back();
    edm::Ref<std::vector<reco::PFRecHit> > seed;
    float energyCorrection = 1.f;
    float timeRealisticSC = -99.;
    if (realisticClusters[ic].isVisible()) {
      int pdgId = simClusters[ic].pdgId();
      auto abseta = std::abs(simClusters[ic].eta());
      if ((abseta >= calibMinEta_) and (abseta <= calibMaxEta_))  //protecting range
      {
        if ((isEGamma(pdgId) or isPi0(pdgId)) and !egammaCalib_.empty()) {
          unsigned int etabin = std::floor(((abseta - calibMinEta_) * egamma_bin_norm));
          energyCorrection = egammaCalib_[etabin];
        } else if (isHadron(pdgId) and !(isPi0(pdgId)) and
                   !hadronCalib_
                        .empty())  // this function is expensive.. should we treat as hadron everything which is not egamma?
        {
          unsigned int etabin = std::floor(((abseta - calibMinEta_) * hadron_bin_norm));
          energyCorrection = hadronCalib_[etabin];
        }
      }
      std::vector<float> timeHits;
      const auto& hitsIdsAndFractions = realisticClusters[ic].hitsIdsAndFractions();
      for (const auto& idAndF : hitsIdsAndFractions) {
        auto fraction = idAndF.second;
        if (fraction > 0.f) {
          auto ref = makeRefhit(input, idAndF.first);
          back.addRecHitFraction(reco::PFRecHitFraction(ref, fraction));
          const float hit_energy = fraction * ref->energy();
          if (hit_energy > highest_energy || highest_energy == 0.0) {
            highest_energy = hit_energy;
            seed = ref;
          }
          //select hits good for timing
          if (ref->time() > -1.) {
            int rhLayer = rhtools_.getLayerWithOffset(ref->detId());
            std::array<float, 3> scPosition = realisticClusters[ic].getCenterOfGravity(rhLayer);
            float distanceSquared =
                std::pow((ref->position().x() - scPosition[0]), 2) + std::pow((ref->position().y() - scPosition[1]), 2);
            if (distanceSquared < maxDforTimingSquared_) {
              timeHits.push_back(ref->time());
            }
          }
        }
      }
      //assign time if minimum number of hits
      hgcalsimclustertime::ComputeClusterTime timeEstimator;
      timeRealisticSC = (timeEstimator.fixSizeHighestDensity(timeHits)).first;
    }
    if (!back.hitsAndFractions().empty()) {
      back.setSeed(seed->detId());
      back.setEnergy(realisticClusters[ic].getEnergy());
      back.setCorrectedEnergy(energyCorrection * realisticClusters[ic].getEnergy());  //applying energy correction
      back.setTime(timeRealisticSC);
    } else {
      back.setSeed(-1);
      back.setEnergy(0.f);
    }
  }
}