BlurredClustering_module.cc

Go to the documentation of this file.

// Class:       BlurredClustering
// Module Type: producer
// File:        BlurredClustering_module.cc
// Author:      Mike Wallbank (m.wallbank@sheffield.ac.uk), May 2015
//
// Reconstructs showers by blurring the hit map image to introduce fake
// hits before clustering to make fuller and more complete clusters.
//
// See DUNE-DocDB 54 (public) for details.

// Framework includes:
#include "art/Framework/Core/EDProducer.h"
#include "art/Framework/Core/ModuleMacros.h"
#include "art/Framework/Principal/Event.h"
#include "art/Framework/Principal/Handle.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "canvas/Persistency/Common/Ptr.h"
#include "canvas/Persistency/Common/PtrVector.h"
#include "fhiclcpp/ParameterSet.h"
#include "messagefacility/MessageLogger/MessageLogger.h"

// LArSoft includes
#include "larcore/Geometry/Geometry.h"
#include "lardata/DetectorInfoServices/DetectorClocksService.h"
#include "lardata/DetectorInfoServices/DetectorPropertiesService.h"
#include "lardata/Utilities/AssociationUtil.h"
#include "lardata/Utilities/GeometryUtilities.h"
#include "lardataobj/RecoBase/Cluster.h"
#include "lardataobj/RecoBase/Hit.h"
#include "lardataobj/RecoBase/PFParticle.h"
#include "lardataobj/RecoBase/SpacePoint.h"
#include "lardataobj/RecoBase/Track.h"
#include "lardataobj/RecoBase/Vertex.h"
#include "larreco/ClusterFinder/ClusterCreator.h"
#include "larreco/RecoAlg/BlurredClusteringAlg.h"
#include "larreco/RecoAlg/ClusterParamsImportWrapper.h"
#include "larreco/RecoAlg/ClusterRecoUtil/StandardClusterParamsAlg.h"
#include "larreco/RecoAlg/MergeClusterAlg.h"
#include "larreco/RecoAlg/TrackShowerSeparationAlg.h"

// ROOT & C++ includes
#include "TH2F.h"
#include <map>
#include <string>

namespace cluster {
  class BlurredClustering;
}

class cluster::BlurredClustering : public art::EDProducer {
public:
  explicit BlurredClustering(fhicl::ParameterSet const& pset);

private:
  void produce(art::Event& evt) override;

  std::string const fHitsModuleLabel, fTrackModuleLabel, fVertexModuleLabel, fPFParticleModuleLabel;
  bool const fCreateDebugPDF, fMergeClusters, fGlobalTPCRecon, fShowerReconOnly;

  // Create instances of algorithm classes to perform the clustering
  cluster::BlurredClusteringAlg fBlurredClusteringAlg;
  cluster::MergeClusterAlg fMergeClusterAlg;
  shower::TrackShowerSeparationAlg fTrackShowerSeparationAlg;
};

cluster::BlurredClustering::BlurredClustering(fhicl::ParameterSet const& pset)
  : EDProducer{pset}
  , fHitsModuleLabel{pset.get<std::string>("HitsModuleLabel")}
  , fTrackModuleLabel{pset.get<std::string>("TrackModuleLabel")}
  , fVertexModuleLabel{pset.get<std::string>("VertexModuleLabel")}
  , fPFParticleModuleLabel{pset.get<std::string>("PFParticleModuleLabel")}
  , fCreateDebugPDF{pset.get<bool>("CreateDebugPDF")}
  , fMergeClusters{pset.get<bool>("MergeClusters")}
  , fGlobalTPCRecon{pset.get<bool>("GlobalTPCRecon")}
  , fShowerReconOnly{pset.get<bool>("ShowerReconOnly")}
  , fBlurredClusteringAlg{pset.get<fhicl::ParameterSet>("BlurredClusterAlg")}
  , fMergeClusterAlg{pset.get<fhicl::ParameterSet>("MergeClusterAlg")}
  , fTrackShowerSeparationAlg{pset.get<fhicl::ParameterSet>("TrackShowerSeparationAlg")}
{
  produces<std::vector<recob::Cluster>>();
  produces<art::Assns<recob::Cluster, recob::Hit>>();
}

void cluster::BlurredClustering::produce(art::Event& evt)
{
  // Create debug pdf to illustrate the blurring process
  if (fCreateDebugPDF) fBlurredClusteringAlg.CreateDebugPDF(evt.run(), evt.subRun(), evt.event());

  // Output containers -- collection of clusters and associations
  auto clusters = std::make_unique<std::vector<recob::Cluster>>();
  auto associations = std::make_unique<art::Assns<recob::Cluster, recob::Hit>>();

  // Compute the cluster characteristics
  // Just use default for now, but configuration will go here
  ClusterParamsImportWrapper<StandardClusterParamsAlg> ClusterParamAlgo;

  // Services
  art::ServiceHandle<geo::Geometry const> geom;
  auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
  auto const detProp =
    art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clockData);
  util::GeometryUtilities const gser{*geom, clockData, detProp};
  int const readoutWindowSize = detProp.ReadOutWindowSize();

  // Get the hits from the event
  art::Handle<std::vector<recob::Hit>> hitCollection;
  std::vector<art::Ptr<recob::Hit>> hits;
  std::vector<art::Ptr<recob::Hit>> hitsToCluster;
  if (evt.getByLabel(fHitsModuleLabel, hitCollection)) art::fill_ptr_vector(hits, hitCollection);

  if (fShowerReconOnly) {

    // Get the tracks from the event
    art::Handle<std::vector<recob::Track>> trackCollection;
    std::vector<art::Ptr<recob::Track>> tracks;
    if (evt.getByLabel(fTrackModuleLabel, trackCollection))
      art::fill_ptr_vector(tracks, trackCollection);

    // Get the space points from the event
    art::Handle<std::vector<recob::SpacePoint>> spacePointCollection;
    std::vector<art::Ptr<recob::SpacePoint>> spacePoints;
    if (evt.getByLabel(fTrackModuleLabel, spacePointCollection))
      art::fill_ptr_vector(spacePoints, spacePointCollection);

    // Get vertices from the event
    art::Handle<std::vector<recob::Vertex>> vertexCollection;
    std::vector<art::Ptr<recob::Vertex>> vertices;
    if (evt.getByLabel(fVertexModuleLabel, vertexCollection))
      art::fill_ptr_vector(vertices, vertexCollection);

    // Get pandora pfparticles and clusters from the event
    art::Handle<std::vector<recob::PFParticle>> pfParticleCollection;
    std::vector<art::Ptr<recob::PFParticle>> pfParticles;
    if (evt.getByLabel(fPFParticleModuleLabel, pfParticleCollection))
      art::fill_ptr_vector(pfParticles, pfParticleCollection);
    art::Handle<std::vector<recob::Cluster>> clusterCollection;
    evt.getByLabel(fPFParticleModuleLabel, clusterCollection);

    if (trackCollection.isValid()) {
      art::FindManyP<recob::Hit> fmht(trackCollection, evt, fTrackModuleLabel);
      art::FindManyP<recob::Track> fmth(hitCollection, evt, fTrackModuleLabel);
      art::FindManyP<recob::SpacePoint> fmspt(trackCollection, evt, fTrackModuleLabel);
      art::FindManyP<recob::Track> fmtsp(spacePointCollection, evt, fTrackModuleLabel);
      hitsToCluster = fTrackShowerSeparationAlg.SelectShowerHits(
        evt.event(), hits, tracks, spacePoints, fmht, fmth, fmspt, fmtsp);
    }
  }
  else
    hitsToCluster = hits;

  // Make a map between the planes and the hits on each
  std::map<std::pair<int, int>, std::vector<art::Ptr<recob::Hit>>> planeToHits;
  for (auto const& hitToCluster : hitsToCluster) {
    auto const& wireID = hitToCluster->WireID();
    auto const planeNo = wireID.Plane;
    auto const tpc = fGlobalTPCRecon ? wireID.TPC % 2 : wireID.TPC;
    planeToHits[std::make_pair(planeNo, tpc)].push_back(hitToCluster);
  }

  // Loop over views
  for (auto const& [plane, hits] : planeToHits) {
    std::vector<art::PtrVector<recob::Hit>> finalClusters;

    // Implement the algorithm
    if (hits.size() >= fBlurredClusteringAlg.GetMinSize()) {

      // Convert hit map to TH2 histogram and blur it
      auto const image = fBlurredClusteringAlg.ConvertRecobHitsToVector(hits, readoutWindowSize);
      auto const blurred = fBlurredClusteringAlg.GaussianBlur(image);

      // Find clusters in histogram
      std::vector<std::vector<int>>
        allClusterBins; // Vector of clusters (clusters are vectors of hits)
      int numClusters = fBlurredClusteringAlg.FindClusters(blurred, allClusterBins);
      mf::LogVerbatim("Blurred Clustering") << "Found " << numClusters << " clusters" << std::endl;

      // Create output clusters from the vector of clusters made in FindClusters
      std::vector<art::PtrVector<recob::Hit>> planeClusters;
      fBlurredClusteringAlg.ConvertBinsToClusters(image, allClusterBins, planeClusters);

      // Use the cluster merging algorithm
      if (fMergeClusters) {
        int numMergedClusters = fMergeClusterAlg.MergeClusters(planeClusters, finalClusters);
        mf::LogVerbatim("Blurred Clustering")
          << "After merging, there are " << numMergedClusters << " clusters" << std::endl;
      }
      else
        finalClusters = planeClusters;

      // Make the debug PDF
      if (fCreateDebugPDF) {
        std::stringstream name;
        name << "blurred_image";
        TH2F* imageHist = fBlurredClusteringAlg.MakeHistogram(image, TString{name.str()});
        name << "_convolved";
        TH2F* blurredHist = fBlurredClusteringAlg.MakeHistogram(blurred, TString{name.str()});
        auto const [planeNo, tpc] = plane;
        fBlurredClusteringAlg.SaveImage(imageHist, 1, tpc, planeNo);
        fBlurredClusteringAlg.SaveImage(blurredHist, 2, tpc, planeNo);
        fBlurredClusteringAlg.SaveImage(blurredHist, allClusterBins, 3, tpc, planeNo);
        fBlurredClusteringAlg.SaveImage(imageHist, finalClusters, 4, tpc, planeNo);
        imageHist->Delete();
        blurredHist->Delete();
      }

    } // End min hits check

    // Make the output cluster objects
    for (auto const& clusterHits : finalClusters) {
      if (clusterHits.empty()) continue;

      // Get the start and end wires of the cluster
      unsigned int const startWire =
        fBlurredClusteringAlg.GlobalWire(clusterHits.front()->WireID());
      unsigned int const endWire = fBlurredClusteringAlg.GlobalWire(clusterHits.back()->WireID());

      // Put cluster hits in the algorithm
      ClusterParamAlgo.ImportHits(gser, clusterHits);

      // Create the recob::Cluster and place in the vector of clusters
      ClusterCreator cluster(gser,
                             ClusterParamAlgo,                        // algo
                             float(startWire),                        // start_wire
                             0.,                                      // sigma_start_wire
                             clusterHits.front()->PeakTime(),         // start_tick
                             clusterHits.front()->SigmaPeakTime(),    // sigma_start_tick
                             float(endWire),                          // end_wire
                             0.,                                      // sigma_end_wire,
                             clusterHits.back()->PeakTime(),          // end_tick
                             clusterHits.back()->SigmaPeakTime(),     // sigma_end_tick
                             clusters->size(),                        // ID
                             clusterHits.front()->View(),             // view
                             clusterHits.front()->WireID().planeID(), // plane
                             recob::Cluster::Sentry                   // sentry
      );
      clusters->emplace_back(cluster.move());

      // Associate the hits to this cluster
      util::CreateAssn(evt, *clusters, clusterHits, *associations);
    } // End loop over all clusters
  }

  evt.put(std::move(clusters));
  evt.put(std::move(associations));
}

DEFINE_ART_MODULE(cluster::BlurredClustering)