HitParentTest.cc

Go to the documentation of this file.

#include <algorithm>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <map>
#include <memory>
#include <string>
#include <vector>

#include <TH1F.h>

#include "CommonTools/UtilAlgos/interface/TFileService.h"
#include "DataFormats/HcalDetId/interface/HcalDetId.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/one/EDAnalyzer.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "SimDataFormats/CaloHit/interface/PCaloHit.h"
#include "SimDataFormats/CaloHit/interface/PCaloHitContainer.h"
#include "SimDataFormats/GeneratorProducts/interface/HepMCProduct.h"
#include "SimDataFormats/Track/interface/SimTrackContainer.h"
#include "SimDataFormats/Vertex/interface/SimVertexContainer.h"
#include "SimG4CMS/Calo/interface/CaloHitID.h"

class HitParentTest : public edm::one::EDAnalyzer<edm::one::WatchRuns, edm::one::SharedResources> {
public:
  HitParentTest(const edm::ParameterSet& ps);
  ~HitParentTest() override {}
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

protected:
  void beginJob() override;
  void beginRun(edm::Run const&, edm::EventSetup const&) override {}
  void analyze(const edm::Event& e, const edm::EventSetup& c) override;
  void endRun(edm::Run const&, edm::EventSetup const&) override {}
  void endJob() override;

private:
  void analyzeHits(const std::vector<PCaloHit>&,
                   const edm::Handle<edm::SimTrackContainer>&,
                   const edm::Handle<edm::SimVertexContainer>&,
                   int type);
  void analyzeAPDHits(const std::vector<PCaloHit>&,
                      const edm::Handle<edm::SimTrackContainer>&,
                      const edm::Handle<edm::SimVertexContainer>&,
                      int depth);

  bool simTrackPresent(const edm::Handle<edm::SimTrackContainer>&, int id);
  math::XYZTLorentzVectorD getOldestParentVertex(const edm::Handle<edm::SimTrackContainer>&,
                                                 const edm::Handle<edm::SimVertexContainer>&,
                                                 edm::SimTrackContainer::const_iterator track);
  edm::SimTrackContainer::const_iterator parentSimTrack(const edm::Handle<edm::SimTrackContainer>&,
                                                        const edm::Handle<edm::SimVertexContainer>&,
                                                        edm::SimTrackContainer::const_iterator thisTrkItr);
  bool validSimTrack(const edm::Handle<edm::SimTrackContainer>&,
                     const edm::Handle<edm::SimVertexContainer>&,
                     unsigned int simTkId,
                     edm::SimTrackContainer::const_iterator thisTrkItr);

private:
  const std::string sourceLabel, g4Label_, hitLabEB_, hitLabEE_, hitLabES_, hitLabHC_;
  const edm::EDGetTokenT<edm::PCaloHitContainer> tok_eb_;
  const edm::EDGetTokenT<edm::PCaloHitContainer> tok_ee_;
  const edm::EDGetTokenT<edm::PCaloHitContainer> tok_es_;
  const edm::EDGetTokenT<edm::PCaloHitContainer> tok_hc_;
  const edm::EDGetTokenT<edm::SimTrackContainer> tok_tk_;
  const edm::EDGetTokenT<edm::SimVertexContainer> tok_vtx_;

  unsigned int total_num_apd_hits_seen[2];
  unsigned int num_apd_hits_no_parent[2];

  unsigned int num_apd_hits_no_simtrack[2];

  unsigned int num_apd_hits_no_gen_particle[2];

  std::map<int, unsigned> particle_type_count;

  std::string detector[7];
  bool histos;
  unsigned int totalHits[7], noParent[7];
  unsigned int noSimTrack[7], noGenParticle[7];
  TH1F *hitType[7], *hitRho[7], *hitZ[7];
};

HitParentTest::HitParentTest(const edm::ParameterSet& ps)
    : sourceLabel(ps.getUntrackedParameter<std::string>("SourceLabel", "VtxSmeared")),
      g4Label_(ps.getUntrackedParameter<std::string>("ModuleLabel", "g4SimHits")),
      hitLabEB_(ps.getUntrackedParameter<std::string>("EBCollection", "EcalHitsEB")),
      hitLabEE_(ps.getUntrackedParameter<std::string>("EECollection", "EcalHitsEE")),
      hitLabES_(ps.getUntrackedParameter<std::string>("ESCollection", "EcalHitsES")),
      hitLabHC_(ps.getUntrackedParameter<std::string>("HCCollection", "HcalHits")),
      tok_eb_(consumes<edm::PCaloHitContainer>(edm::InputTag(g4Label_, hitLabEB_))),
      tok_ee_(consumes<edm::PCaloHitContainer>(edm::InputTag(g4Label_, hitLabEE_))),
      tok_es_(consumes<edm::PCaloHitContainer>(edm::InputTag(g4Label_, hitLabES_))),
      tok_hc_(consumes<edm::PCaloHitContainer>(edm::InputTag(g4Label_, hitLabHC_))),
      tok_tk_(consumes<edm::SimTrackContainer>(edm::InputTag(g4Label_))),
      tok_vtx_(consumes<edm::SimVertexContainer>(edm::InputTag(g4Label_))) {
  usesResource(TFileService::kSharedResource);

  edm::LogVerbatim("HitParentTest") << "Module Label: " << g4Label_ << "   Hits: " << hitLabEB_ << ", " << hitLabEE_
                                    << ", " << hitLabES_ << ", " << hitLabHC_;

  for (unsigned int i = 0; i < 2; ++i) {
    total_num_apd_hits_seen[i] = 0;
    num_apd_hits_no_parent[i] = 0;
    num_apd_hits_no_simtrack[i] = 0;
    num_apd_hits_no_gen_particle[i] = 0;
  }
  std::string dets[7] = {"EB", "EE", "ES", "HB", "HE", "HO", "HF"};
  for (unsigned int i = 0; i < 7; ++i) {
    detector[i] = dets[i];
    totalHits[i] = 0;
    noParent[i] = 0;
    noSimTrack[i] = 0;
    noGenParticle[i] = 0;
  }
}

void HitParentTest::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.addUntracked<std::string>("SourceLabel", "generatorSmeared");
  desc.addUntracked<std::string>("ModuleLabel", "g4SimHits");
  desc.addUntracked<std::string>("EBCollection", "EcalHitsEB");
  desc.addUntracked<std::string>("EECollection", "EcalHitsEE");
  desc.addUntracked<std::string>("ESCollection", "EcalHitsES");
  desc.addUntracked<std::string>("HCCollection", "HcalHits");
  descriptions.add("HitParentTest", desc);
}

void HitParentTest::beginJob() {
  edm::Service<TFileService> tfile;
  if (!tfile.isAvailable()) {
    edm::LogVerbatim("HitParentTest") << "TFileService unavailable: no histograms";
    histos = false;
  } else {
    char name[20], title[100];
    histos = true;
    for (unsigned int i = 0; i < 7; ++i) {
      sprintf(name, "HitType%d", i);
      sprintf(title, "Hit types for %s", detector[i].c_str());
      hitType[i] = tfile->make<TH1F>(name, title, 10, 0., 10.);
      hitType[i]->GetXaxis()->SetTitle(title);
      hitType[i]->GetYaxis()->SetTitle("Hits");
      sprintf(name, "RhoVertex%d", i);
      sprintf(title, "#rho of the vertex for %s Hits", detector[i].c_str());
      hitRho[i] = tfile->make<TH1F>(name, title, 10000, 0., 100.);
      hitRho[i]->GetXaxis()->SetTitle(title);
      hitRho[i]->GetYaxis()->SetTitle("Hits");
      sprintf(name, "ZVertex%d", i);
      sprintf(title, "z of the vertex for %s Hits", detector[i].c_str());
      hitZ[i] = tfile->make<TH1F>(name, title, 2000, -100., 100.);
      hitZ[i]->GetXaxis()->SetTitle(title);
      hitZ[i]->GetYaxis()->SetTitle("Hits");
    }
  }
}

void HitParentTest::analyze(const edm::Event& e, const edm::EventSetup&) {
  edm::LogVerbatim("HitParentTest") << "HitParentTes::Run = " << e.id().run() << " Event = " << e.id().event();

  // get PCaloHits for ecal barrel
  const edm::Handle<edm::PCaloHitContainer>& caloHitEB = e.getHandle(tok_eb_);

  // get PCaloHits for ecal endcap
  const edm::Handle<edm::PCaloHitContainer>& caloHitEE = e.getHandle(tok_ee_);

  // get PCaloHits for preshower
  const edm::Handle<edm::PCaloHitContainer>& caloHitES = e.getHandle(tok_es_);

  // get PCaloHits for hcal
  const edm::Handle<edm::PCaloHitContainer>& caloHitHC = e.getHandle(tok_hc_);

  // get sim tracks
  const edm::Handle<edm::SimTrackContainer>& simTk = e.getHandle(tok_tk_);

  // get sim vertices
  const edm::Handle<edm::SimVertexContainer>& simVtx = e.getHandle(tok_vtx_);

  edm::LogVerbatim("HitParentTest") << "HitParentTest: hits valid[EB]: " << caloHitEB.isValid()
                                    << " valid[EE]: " << caloHitEE.isValid() << " valid[ES]: " << caloHitES.isValid()
                                    << " valid[HC]: " << caloHitHC.isValid();

  if (caloHitEB.isValid()) {
    for (int depth = 1; depth <= 2; ++depth)
      analyzeAPDHits(*caloHitEB, simTk, simVtx, depth);
    analyzeHits(*caloHitEB, simTk, simVtx, 0);
  }
  if (caloHitEE.isValid())
    analyzeHits(*caloHitEE, simTk, simVtx, 1);
  if (caloHitES.isValid())
    analyzeHits(*caloHitES, simTk, simVtx, 2);
  if (caloHitHC.isValid())
    analyzeHits(*caloHitHC, simTk, simVtx, 3);
}

class HitParentTestComparison {
protected:
  const std::map<int, unsigned>& particle_type_count;

public:
  HitParentTestComparison(const std::map<int, unsigned>& _particle_type_count)
      : particle_type_count(_particle_type_count) {}

  bool operator()(int pid1, int pid2) const { return particle_type_count.at(pid1) > particle_type_count.at(pid2); }
};

void HitParentTest::endJob() {
  edm::LogVerbatim("HitParentTest") << "HitParentTest::Total number of APD hits seen: "
                                    << total_num_apd_hits_seen[0] + total_num_apd_hits_seen[1];
  for (unsigned int depth = 0; depth < 2; ++depth) {
    edm::LogVerbatim("HitParentTest") << "APD Hits in depth = " << depth + 1
                                      << " Total = " << total_num_apd_hits_seen[depth];
    edm::LogVerbatim("HitParentTest") << "summary of errors:\n"
                                      << " number of APD hits with zero geant track id: "
                                      << num_apd_hits_no_parent[depth] << "\n"
                                      << "number of APD hits for which the parent simtrack was not found "
                                      << "in the simtrack collection: " << num_apd_hits_no_simtrack[depth] << "\n"
                                      << "number of APD hits for which no generator particle was "
                                      << "found: " << num_apd_hits_no_gen_particle[depth] << "\n";
  }

  for (unsigned int det = 0; det < 7; ++det) {
    edm::LogVerbatim("HitParentTest") << "Total number of hits seen in " << detector[det] << ": " << totalHits[det];
    edm::LogVerbatim("HitParentTest") << "summary of errors:\n"
                                      << "number of hits with zero geant track id: " << noParent[det] << "\n"
                                      << "number of hits for which the parent simtrack was not found in "
                                      << "the simtrack collection: " << noSimTrack[det] << "\n"
                                      << "number of hits for which no generator particle was found: "
                                      << noGenParticle[det] << "\n";
  }

  // sort in decreasing order of occurence
  std::vector<int> sorted_pids;
  for (std::map<int, unsigned>::const_iterator it = particle_type_count.begin(); it != particle_type_count.end(); ++it)
    sorted_pids.push_back(it->first);

  // now sort the pids

  std::sort(sorted_pids.begin(), sorted_pids.end(), HitParentTestComparison(particle_type_count));

  edm::LogVerbatim("HitParentTest") << "HitParentTest::Frequency particle types through the APD "
                                    << "(pid/frequency):";
  for (unsigned i = 0; i < sorted_pids.size(); ++i) {
    int pid = sorted_pids[i];
    edm::LogVerbatim("HitParentTest") << "  pid " << std::setw(6) << pid << ": count " << std::setw(6)
                                      << particle_type_count[pid];
  }
}

void HitParentTest::analyzeHits(const std::vector<PCaloHit>& hits,
                                const edm::Handle<edm::SimTrackContainer>& simTk,
                                const edm::Handle<edm::SimVertexContainer>& simVtx,
                                int type) {
  for (std::vector<PCaloHit>::const_iterator hit_it = hits.begin(); hit_it != hits.end(); ++hit_it) {
    int id(type), flag(0);
    if (type == 3) {
      HcalDetId id_ = HcalDetId(hit_it->id());
      int subdet = id_.subdet();
      if (subdet == static_cast<int>(HcalEndcap))
        id = type + 1;
      else if (subdet == static_cast<int>(HcalOuter))
        id = type + 2;
      else if (subdet == static_cast<int>(HcalForward))
        id = type + 3;
    }
    ++totalHits[id];

    // get the geant track id
    int hit_geant_track_id = hit_it->geantTrackId();

    if (hit_geant_track_id <= 0) {
      ++noParent[id];
      flag = 1;
    } else {
      bool found = false;
      flag = 2;
      // check whether this id is actually there in the list of simtracks
      for (edm::SimTrackContainer::const_iterator simTrkItr = simTk->begin(); simTrkItr != simTk->end() && !found;
           ++simTrkItr) {
        if (hit_geant_track_id == (int)(simTrkItr->trackId())) {
          found = true;
          flag = 3;
          bool match = validSimTrack(simTk, simVtx, hit_geant_track_id, simTrkItr);

          edm::LogVerbatim("HitParentTest")
              << "[" << detector[type] << "] Match = " << match << " hit_geant_track_id=" << hit_geant_track_id
              << " particle id=" << simTrkItr->type();

          if (!match) {
            edm::LogVerbatim("HitParentTest") << "NO MATCH FOUND !";
            ++noGenParticle[id];
          }

          // beam pipe...
          int pid = simTrkItr->type();
          math::XYZTLorentzVectorD oldest_parent_vertex = getOldestParentVertex(simTk, simVtx, simTrkItr);

          edm::SimTrackContainer::const_iterator oldest_parent_track = parentSimTrack(simTk, simVtx, simTrkItr);

          edm::LogVerbatim("HitParentTest")
              << "[" << detector[type] << "] Hit pid = " << pid << "  hit track id = " << hit_geant_track_id
              << " Oldest Parent's Vertex: " << oldest_parent_vertex << " rho = " << oldest_parent_vertex.Rho()
              << " Oldest Parent's pid: " << oldest_parent_track->type()
              << " Oldest Parent's track id: " << oldest_parent_track->trackId()
              << "\nHit vertex index: " << simTrkItr->vertIndex() << " (tot #vertices: " << simVtx->size() << ")"
              << "\nHit vertex parent track: " << (*simVtx)[simTrkItr->vertIndex()].parentIndex()
              << " present=" << simTrackPresent(simTk, (*simVtx)[simTrkItr->vertIndex()].parentIndex());
          if (histos) {
            hitRho[id]->Fill(oldest_parent_vertex.Rho());
            hitZ[id]->Fill(oldest_parent_vertex.Z());
          }
        }  // a match was found
      }    // geant track id found in simtracks

      if (!found)
        ++noSimTrack[id];
    }  // hits with a valid SimTrack Id
    if (histos)
      hitType[id]->Fill((double)(flag));
  }  // loop over all calohits (of the given depth)
}

void HitParentTest::analyzeAPDHits(const std::vector<PCaloHit>& hits,
                                   const edm::Handle<edm::SimTrackContainer>& simTk,
                                   const edm::Handle<edm::SimVertexContainer>& simVtx,
                                   int depth) {
  for (std::vector<PCaloHit>::const_iterator hit_it = hits.begin(); hit_it != hits.end(); ++hit_it) {
    if (hit_it->depth() == depth) {
      ++total_num_apd_hits_seen[depth - 1];

      // get the geant track id
      int hit_geant_track_id = hit_it->geantTrackId();

      if (hit_geant_track_id <= 0) {
        ++num_apd_hits_no_parent[depth - 1];
      } else {
        bool found = false;
        // check whether this id is actually there in the list of simtracks
        for (edm::SimTrackContainer::const_iterator simTrkItr = simTk->begin(); simTrkItr != simTk->end() && !found;
             ++simTrkItr) {
          if (hit_geant_track_id == (int)(simTrkItr->trackId())) {
            found = true;
            bool match = validSimTrack(simTk, simVtx, hit_geant_track_id, simTrkItr);

            edm::LogVerbatim("HitParentTest")
                << "APDHIT Match = " << match << " hit_geant_track_id = " << hit_geant_track_id
                << " particle id=" << simTrkItr->type();

            if (!match) {
              edm::LogVerbatim("HitParentTest") << "NO MATCH FOUND !";
              ++num_apd_hits_no_gen_particle[depth - 1];
            }

            int apd_pid = simTrkItr->type();
            std::map<int, unsigned>::iterator count_it = particle_type_count.find(apd_pid);
            if (count_it == particle_type_count.end())
              // first occurence of this particle pid
              particle_type_count[apd_pid] = 1;
            else
              ++count_it->second;

            //--------------------
            // check where the oldest parent has its vertex. Should be close to the
            // beam pipe...
            math::XYZTLorentzVectorD oldest_parent_vertex = getOldestParentVertex(simTk, simVtx, simTrkItr);

            edm::SimTrackContainer::const_iterator oldest_parent_track = parentSimTrack(simTk, simVtx, simTrkItr);

            edm::LogVerbatim("HitParentTest")
                << "APD hit pid = " << apd_pid << " APD hit track id = " << hit_geant_track_id
                << " depth = " << hit_it->depth() << " OLDEST PARENT'S VERTEX: " << oldest_parent_vertex
                << " rho = " << oldest_parent_vertex.Rho() << " OLDEST PARENT'S PID: " << oldest_parent_track->type()
                << " OLDEST PARENT'S track id: " << oldest_parent_track->trackId() << "\n"
                << "APD hit vertex index: " << simTrkItr->vertIndex() << " (tot #vertices: " << simVtx->size() << ")"
                << "\n"
                << "APD hit vertex parent track: " << (*simVtx)[simTrkItr->vertIndex()].parentIndex()
                << " present=" << simTrackPresent(simTk, (*simVtx)[simTrkItr->vertIndex()].parentIndex());

          }  // a match was found
        }    // geant track id found in simtracks

        if (!found)
          ++num_apd_hits_no_simtrack[depth - 1];
      }  // hits with a valid SimTrack Id
    }    // right depth index
  }      // loop over all calohits (of the given depth)
}

bool HitParentTest::simTrackPresent(const edm::Handle<edm::SimTrackContainer>& simTk, int id) {
  for (edm::SimTrackContainer::const_iterator simTrkItr = simTk->begin(); simTrkItr != simTk->end(); ++simTrkItr) {
    if ((int)(simTrkItr->trackId()) == id)
      return true;
  }
  return false;
}

math::XYZTLorentzVectorD HitParentTest::getOldestParentVertex(const edm::Handle<edm::SimTrackContainer>& simTk,
                                                              const edm::Handle<edm::SimVertexContainer>& simVtx,
                                                              edm::SimTrackContainer::const_iterator track) {
  static const math::XYZTLorentzVectorD invalid_vertex(
      10000, 10000, 10000, 10000);  // default value if no valid vertex found

  edm::SimTrackContainer::const_iterator oldest_parent_track = parentSimTrack(simTk, simVtx, track);

  int vertex_index = oldest_parent_track->vertIndex();

  // sanity checks
  if (vertex_index < 0 || vertex_index >= (int)(simVtx->size()))
    return invalid_vertex;

  return (*simVtx)[vertex_index].position();
}

edm::SimTrackContainer::const_iterator HitParentTest::parentSimTrack(const edm::Handle<edm::SimTrackContainer>& simTk,
                                                                     const edm::Handle<edm::SimVertexContainer>& simVtx,
                                                                     edm::SimTrackContainer::const_iterator thisTrkItr) {
  edm::SimTrackContainer::const_iterator itr = simTk->end();

  int vertIndex = thisTrkItr->vertIndex();
  int type = thisTrkItr->type();
  int charge = (int)thisTrkItr->charge();
  edm::LogVerbatim("HitParentTest") << "SimTrackParent:: " << thisTrkItr->trackId() << " Vertex " << vertIndex
                                    << " Type " << type << " Charge " << charge;

  if (vertIndex == -1)
    return thisTrkItr;
  else if (vertIndex >= (int)simVtx->size())
    return itr;

  edm::SimVertexContainer::const_iterator simVtxItr = simVtx->begin();
  for (int iv = 0; iv < vertIndex; iv++)
    simVtxItr++;
  int parent = simVtxItr->parentIndex();

  if (parent < 0 && simVtxItr != simVtx->begin()) {
    const math::XYZTLorentzVectorD pos1 = simVtxItr->position();
    for (simVtxItr = simVtx->begin(); simVtxItr != simVtx->end(); ++simVtxItr) {
      if (simVtxItr->parentIndex() > 0) {
        const math::XYZTLorentzVectorD pos2 = pos1 - simVtxItr->position();
        double dist = pos2.P();
        if (dist < 0.001) {
          parent = simVtxItr->parentIndex();
          break;
        }
      }
    }
  }
  for (edm::SimTrackContainer::const_iterator simTrkItr = simTk->begin(); simTrkItr != simTk->end(); simTrkItr++) {
    if ((int)simTrkItr->trackId() == parent && simTrkItr != thisTrkItr)
      return parentSimTrack(simTk, simVtx, simTrkItr);
  }

  return thisTrkItr;
}

bool HitParentTest::validSimTrack(const edm::Handle<edm::SimTrackContainer>& simTk,
                                  const edm::Handle<edm::SimVertexContainer>& simVtx,
                                  unsigned int simTkId,
                                  edm::SimTrackContainer::const_iterator thisTrkItr) {
  edm::LogVerbatim("HitParentTest") << "Inside validSimTrack: trackId " << thisTrkItr->trackId() << " vtxIndex "
                                    << thisTrkItr->vertIndex() << " to be matched to " << simTkId;

  //This track originates from simTkId
  if (thisTrkItr->trackId() == simTkId)
    return true;

  //Otherwise trace back the history using SimTracks and SimVertices
  int vertIndex = thisTrkItr->vertIndex();
  if (vertIndex == -1 || vertIndex >= (int)simVtx->size())
    return false;
  edm::SimVertexContainer::const_iterator simVtxItr = simVtx->begin();
  for (int iv = 0; iv < vertIndex; iv++)
    simVtxItr++;
  int parent = simVtxItr->parentIndex();
  edm::LogVerbatim("HitParentTest") << "validSimTrack:: parent index " << parent << " ";
  if (parent < 0 && simVtxItr != simVtx->begin()) {
    const math::XYZTLorentzVectorD pos1 = simVtxItr->position();
    for (simVtxItr = simVtx->begin(); simVtxItr != simVtx->end(); ++simVtxItr) {
      if (simVtxItr->parentIndex() > 0) {
        const math::XYZTLorentzVectorD pos2 = pos1 - simVtxItr->position();
        double dist = pos2.P();
        if (dist < 0.001) {
          parent = simVtxItr->parentIndex();
          break;
        }
      }
    }
  }
  edm::LogVerbatim("HitParentTest") << "HitParentTes::final index " << parent;
  for (edm::SimTrackContainer::const_iterator simTrkItr = simTk->begin(); simTrkItr != simTk->end(); simTrkItr++) {
    if ((int)simTrkItr->trackId() == parent && simTrkItr != thisTrkItr)
      return validSimTrack(simTk, simVtx, simTkId, simTrkItr);
  }

  return false;
}

//define this as a plug-in
DEFINE_FWK_MODULE(HitParentTest);