PFMultiDepthClusterizer.cc

Go to the documentation of this file.

#include "DataFormats/Math/interface/deltaPhi.h"
#include "DataFormats/Math/interface/deltaR.h"
#include "DataFormats/ParticleFlowReco/interface/PFRecHit.h"
#include "DataFormats/ParticleFlowReco/interface/PFRecHitFraction.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "Math/GenVector/VectorUtil.h"
#include "RecoParticleFlow/PFClusterProducer/interface/PFClusterBuilderBase.h"
#include "CondFormats/DataRecord/interface/HcalPFCutsRcd.h"
#include "CondTools/Hcal/interface/HcalPFCutsHandler.h"
#include "vdt/vdtMath.h"

#include <iterator>
#include <unordered_map>

class PFMultiDepthClusterizer final : public PFClusterBuilderBase {
  typedef PFMultiDepthClusterizer B2DGPF;

public:
  PFMultiDepthClusterizer(const edm::ParameterSet& conf, edm::ConsumesCollector& cc);

  ~PFMultiDepthClusterizer() override = default;
  PFMultiDepthClusterizer(const B2DGPF&) = delete;
  B2DGPF& operator=(const B2DGPF&) = delete;

  void update(const edm::EventSetup& es) override { _allCellsPosCalc->update(es); }

  void buildClusters(const reco::PFClusterCollection&,
                     const std::vector<bool>&,
                     reco::PFClusterCollection& outclus,
                     const HcalPFCuts*) override;

private:
  std::unique_ptr<PFCPositionCalculatorBase> _allCellsPosCalc;
  double nSigmaEta_;
  double nSigmaPhi_;

  class ClusterLink {
  public:
    ClusterLink(unsigned int i, unsigned int j, double DR, int DZ, double energy) {
      from_ = i;
      to_ = j;
      linkDR_ = DR;
      linkDZ_ = DZ;
      linkE_ = energy;
    }

    ~ClusterLink() = default;

    unsigned int from() const { return from_; }
    unsigned int to() const { return to_; }
    double dR() const { return linkDR_; }
    int dZ() const { return linkDZ_; }
    double energy() const { return linkE_; }

  private:
    unsigned int from_;
    unsigned int to_;
    double linkDR_;
    int linkDZ_;
    double linkE_;
  };

  void calculateShowerShapes(const reco::PFClusterCollection&, std::vector<double>&, std::vector<double>&);
  std::vector<ClusterLink> link(const reco::PFClusterCollection&,
                                const std::vector<double>&,
                                const std::vector<double>&);
  std::vector<ClusterLink> prune(std::vector<ClusterLink>&, std::vector<bool>& linkedClusters);

  void expandCluster(reco::PFCluster&,
                     unsigned int point,
                     std::vector<bool>& mask,
                     const reco::PFClusterCollection&,
                     const std::vector<ClusterLink>& links);

  void absorbCluster(reco::PFCluster&, const reco::PFCluster&);
};

DEFINE_EDM_PLUGIN(PFClusterBuilderFactory, PFMultiDepthClusterizer, "PFMultiDepthClusterizer");

PFMultiDepthClusterizer::PFMultiDepthClusterizer(const edm::ParameterSet& conf, edm::ConsumesCollector& cc)
    : PFClusterBuilderBase(conf, cc) {
  const auto& acConf = conf.getParameterSet("allCellsPositionCalc");
  if (!acConf.empty()) {
    const std::string& algoac = acConf.getParameter<std::string>("algoName");
    if (!algoac.empty())
      _allCellsPosCalc = PFCPositionCalculatorFactory::get()->create(algoac, acConf, cc);
  }

  nSigmaEta_ = pow(conf.getParameter<double>("nSigmaEta"), 2);
  nSigmaPhi_ = pow(conf.getParameter<double>("nSigmaPhi"), 2);
}

void PFMultiDepthClusterizer::buildClusters(const reco::PFClusterCollection& input,
                                            const std::vector<bool>& seedable,
                                            reco::PFClusterCollection& output,
                                            const HcalPFCuts* hcalCuts) {
  std::vector<double> etaRMS2(input.size(), 0.0);
  std::vector<double> phiRMS2(input.size(), 0.0);

  //We need to sort the clusters for smaller to larger depth
  //  for (unsigned int i=0;i<input.size();++i)
  //   printf(" cluster%f %f \n",input[i].depth(),input[i].energy());

  //calculate cluster shapes
  calculateShowerShapes(input, etaRMS2, phiRMS2);

  //link
  auto&& links = link(input, etaRMS2, phiRMS2);
  //  for (const auto& link: links)
  //    printf("link %d %d %f %f\n",link.from(),link.to(),link.dR(),link.dZ());

  std::vector<bool> mask(input.size(), false);
  std::vector<bool> linked(input.size(), false);

  //prune
  auto&& prunedLinks = prune(links, linked);

  //printf("Pruned links\n")
  //  for (const auto& link: prunedLinks)
  //  printf("link %d %d %f %f\n",link.from(),link.to(),link.dR(),link.dZ());

  //now we need to build clusters
  for (unsigned int i = 0; i < input.size(); ++i) {
    //if not masked
    if (mask[i])
      continue;
    //if not linked just spit it out
    if (!linked[i]) {
      output.push_back(input[i]);
      //      printf("Added single cluster with energy =%f \n",input[i].energy());
      mask[i] = true;
      continue;
    }

    //now business: if  linked and not  masked gather clusters
    reco::PFCluster cluster = input[i];
    mask[i] = true;
    expandCluster(cluster, i, mask, input, prunedLinks);
    _allCellsPosCalc->calculateAndSetPosition(cluster, hcalCuts);
    output.push_back(cluster);
    //    printf("Added linked cluster with energy =%f\n",cluster.energy());
  }
}

void PFMultiDepthClusterizer::calculateShowerShapes(const reco::PFClusterCollection& clusters,
                                                    std::vector<double>& etaRMS2,
                                                    std::vector<double>& phiRMS2) {
  //shower shapes. here do not use the fractions

  for (unsigned int i = 0; i < clusters.size(); ++i) {
    const reco::PFCluster& cluster = clusters[i];
    double etaSum = 0.0;
    double phiSum = 0.0;
    auto const& crep = cluster.positionREP();
    for (const auto& frac : cluster.recHitFractions()) {
      auto const& h = *frac.recHitRef();
      auto const& rep = h.positionREP();
      etaSum += (frac.fraction() * h.energy()) * std::abs(rep.eta() - crep.eta());
      phiSum += (frac.fraction() * h.energy()) * std::abs(deltaPhi(rep.phi(), crep.phi()));
    }
    //protection for single line : assign ~ tower
    etaRMS2[i] = std::max(etaSum / cluster.energy(), 0.1);
    etaRMS2[i] *= etaRMS2[i];
    phiRMS2[i] = std::max(phiSum / cluster.energy(), 0.1);
    phiRMS2[i] *= phiRMS2[i];
  }
}

std::vector<PFMultiDepthClusterizer::ClusterLink> PFMultiDepthClusterizer::link(
    const reco::PFClusterCollection& clusters, const std::vector<double>& etaRMS2, const std::vector<double>& phiRMS2) {
  std::vector<ClusterLink> links;
  //loop on all pairs
  for (unsigned int i = 0; i < clusters.size(); ++i)
    for (unsigned int j = 0; j < clusters.size(); ++j) {
      if (i == j)
        continue;

      const reco::PFCluster& cluster1 = clusters[i];
      const reco::PFCluster& cluster2 = clusters[j];

      // PFCluster depth stored as double but HCAL layer clusters have integral depths only
      auto dz = (static_cast<int>(cluster2.depth()) - static_cast<int>(cluster1.depth()));

      //Do not link at the same layer and only link inside out!
      if (dz <= 0)
        continue;

      auto const& crep1 = cluster1.positionREP();
      auto const& crep2 = cluster2.positionREP();

      auto deta = crep1.eta() - crep2.eta();
      deta = deta * deta / (etaRMS2[i] + etaRMS2[j]);
      auto dphi = deltaPhi(crep1.phi(), crep2.phi());
      dphi = dphi * dphi / (phiRMS2[i] + phiRMS2[j]);

      //      printf("Testing Link %d -> %d (%f %f %f %f ) \n",i,j,deta,dphi,cluster1.position().Eta()-cluster2.position().Eta(),deltaPhi(cluster1.position().Phi(),cluster2.position().Phi()));

      if ((deta < nSigmaEta_) & (dphi < nSigmaPhi_))
        links.push_back(ClusterLink(i, j, deta + dphi, std::abs(dz), cluster1.energy() + cluster2.energy()));
    }

  return links;
}

std::vector<PFMultiDepthClusterizer::ClusterLink> PFMultiDepthClusterizer::prune(std::vector<ClusterLink>& links,
                                                                                 std::vector<bool>& linkedClusters) {
  std::vector<ClusterLink> goodLinks;
  std::vector<bool> mask(links.size(), false);
  if (links.empty())
    return goodLinks;

  for (unsigned int i = 0; i < links.size() - 1; ++i) {
    if (mask[i])
      continue;
    for (unsigned int j = i + 1; j < links.size(); ++j) {
      if (mask[j])
        continue;

      const ClusterLink& link1 = links[i];
      const ClusterLink& link2 = links[j];

      if (link1.to() == link2.to()) {  //found two links going to the same spot,kill one
        //first prefer nearby layers
        if (link1.dZ() < link2.dZ()) {
          mask[j] = true;
        } else if (link1.dZ() > link2.dZ()) {
          mask[i] = true;
        } else {  //if same layer-pick based on transverse compatibility
          if (link1.dR() < link2.dR()) {
            mask[j] = true;
          } else if (link1.dR() > link2.dR()) {
            mask[i] = true;
          } else {
            //same distance as well -> can happen !!!!! Pick the highest SUME
            if (link1.energy() < link2.energy())
              mask[i] = true;
            else
              mask[j] = true;
          }
        }
      }
    }
  }

  for (unsigned int i = 0; i < links.size(); ++i) {
    if (mask[i])
      continue;
    goodLinks.push_back(links[i]);
    linkedClusters[links[i].from()] = true;
    linkedClusters[links[i].to()] = true;
  }

  return goodLinks;
}

void PFMultiDepthClusterizer::absorbCluster(reco::PFCluster& main, const reco::PFCluster& added) {
  double e1 = 0.0;
  double e2 = 0.0;

  //find seeds
  for (const auto& fraction : main.recHitFractions())
    if (fraction.recHitRef()->detId() == main.seed()) {
      e1 = fraction.recHitRef()->energy();
    }

  for (const auto& fraction : added.recHitFractions()) {
    main.addRecHitFraction(fraction);
    if (fraction.recHitRef()->detId() == added.seed()) {
      e2 = fraction.recHitRef()->energy();
    }
  }
  if (e2 > e1)
    main.setSeed(added.seed());
}

void PFMultiDepthClusterizer::expandCluster(reco::PFCluster& cluster,
                                            unsigned int point,
                                            std::vector<bool>& mask,
                                            const reco::PFClusterCollection& clusters,
                                            const std::vector<ClusterLink>& links) {
  for (const auto& link : links) {
    if (link.from() == point) {
      //found link that starts from this guy if not masked absorb
      if (!mask[link.from()]) {
        absorbCluster(cluster, clusters[link.from()]);
        mask[link.from()] = true;
      }

      if (!mask[link.to()]) {
        absorbCluster(cluster, clusters[link.to()]);
        mask[link.to()] = true;
        expandCluster(cluster, link.to(), mask, clusters, links);
      }
    }
    if (link.to() == point) {
      //found link that starts from this guy if not masked absorb
      if (!mask[link.to()]) {
        absorbCluster(cluster, clusters[link.to()]);
        mask[link.to()] = true;
      }

      if (!mask[link.from()]) {
        absorbCluster(cluster, clusters[link.from()]);
        mask[link.from()] = true;
        expandCluster(cluster, link.from(), mask, clusters, links);
      }
    }
  }
}