HGCalRecHitValidation.cc

Go to the documentation of this file.

// system include files
#include <cmath>
#include <fstream>
#include <iostream>
#include <map>
#include <string>
#include <vector>

#include "DataFormats/ForwardDetId/interface/ForwardSubdetector.h"
#include "DataFormats/HGCRecHit/interface/HGCRecHitCollections.h"
#include "DataFormats/HcalDetId/interface/HcalDetId.h"
#include "DataFormats/HcalDetId/interface/HcalSubdetector.h"
#include "DataFormats/HcalRecHit/interface/HcalRecHitCollections.h"
#include "DataFormats/DetId/interface/DetId.h"

#include "DetectorDescription/Core/interface/DDCompactView.h"

#include "DQMServices/Core/interface/DQMEDAnalyzer.h"
#include "DQMServices/Core/interface/MonitorElement.h"

#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/ESTransientHandle.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"

#include "Geometry/CaloGeometry/interface/CaloGeometry.h"
#include "Geometry/HGCalGeometry/interface/HGCalGeometry.h"
#include "Geometry/HcalCommonData/interface/HcalDDDRecConstants.h"
#include "Geometry/HGCalCommonData/interface/HGCalDDDConstants.h"
#include "Geometry/Records/interface/IdealGeometryRecord.h"
#include "Geometry/Records/interface/CaloGeometryRecord.h"
#include "Geometry/Records/interface/HcalRecNumberingRecord.h"

#include "CLHEP/Units/GlobalSystemOfUnits.h"
#include "TVector3.h"

class HGCalRecHitValidation : public DQMEDAnalyzer {

public:
  struct energysum{
    energysum() {e15=e25=e50=e100=e250=e1000=0.0;}
    double e15, e25, e50, e100, e250, e1000;
  };

  struct HitsInfo{
    HitsInfo() {
      x=y=z=time=energy=phi=eta=0.0;
      layer=0;
    }
    float x, y, z, time, energy, phi, eta ;
    float layer;
  };
  

  explicit HGCalRecHitValidation(const edm::ParameterSet&);
  ~HGCalRecHitValidation() override {}
  
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
  void dqmBeginRun(const edm::Run&, const edm::EventSetup&) override;
  void bookHistograms(DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &) override;
  void analyze(const edm::Event&, const edm::EventSetup&) override;
  
private:
  template<class T1, class T2>
    void recHitValidation(DetId & detId, int layer, const T1* geom, T2 it);
  void fillHitsInfo(); 
  void fillHitsInfo(HitsInfo& hits); 
  void fillOccupancyMap(std::map<int, int>& OccupancyMap, int layer);
  
  // ----------member data ---------------------------
  std::string           nameDetector_;
  edm::EDGetToken       recHitSource_;
  bool                  ifHCAL_;
  int                   verbosity_;
  unsigned int          layers_;
  int                   firstLayer_;
  std::map<int, int>    OccupancyMap_plus;
  std::map<int, int>    OccupancyMap_minus;

  std::vector<MonitorElement*> EtaPhi_Plus_;
  std::vector<MonitorElement*> EtaPhi_Minus_;
  std::vector<MonitorElement*> energy_;
  std::vector<MonitorElement*> HitOccupancy_Plus_;
  std::vector<MonitorElement*> HitOccupancy_Minus_;
  MonitorElement* MeanHitOccupancy_Plus_;
  MonitorElement* MeanHitOccupancy_Minus_;
};

HGCalRecHitValidation::HGCalRecHitValidation(const edm::ParameterSet& iConfig):
  nameDetector_(iConfig.getParameter<std::string>("DetectorName")),
  ifHCAL_(iConfig.getParameter<bool>("ifHCAL")),
  verbosity_(iConfig.getUntrackedParameter<int>("Verbosity",0)),
  firstLayer_(1) {

  auto temp = iConfig.getParameter<edm::InputTag>("RecHitSource");
  if (nameDetector_ == "HGCalEESensitive" || 
      nameDetector_ == "HGCalHESiliconSensitive" ||
      nameDetector_ == "HGCalHEScintillatorSensitive") {
    recHitSource_    = consumes<HGCRecHitCollection>(temp);
  } else if (nameDetector_ == "HCal") {
    if (ifHCAL_) recHitSource_ = consumes<HBHERecHitCollection>(temp);
    else         recHitSource_ = consumes<HGChebRecHitCollection>(temp);
  } else {
    throw cms::Exception("BadHGCRecHitSource")
      << "HGCal DetectorName given as " << nameDetector_ << " must be: "
      << "\"HGCalHESiliconSensitive\", \"HGCalHESiliconSensitive\", "
      << "\"HGCalHEScintillatorSensitive\", or \"HCal\"!"; 
  }
}


void HGCalRecHitValidation::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.add<std::string>("DetectorName","HGCalEESensitive");
  desc.add<edm::InputTag>("RecHitSource",edm::InputTag("HGCalRecHit","HGCEERecHits"));
  desc.add<bool>("ifHCAL",false);
  desc.addUntracked<int>("Verbosity",0);
  descriptions.add("hgcalRecHitValidationEE",desc);
}

void HGCalRecHitValidation::analyze(const edm::Event& iEvent, 
                    const edm::EventSetup& iSetup) {
  OccupancyMap_plus.clear();
  OccupancyMap_minus.clear();

  bool ok(true);
  unsigned int ntot(0), nused(0);
  if (nameDetector_ == "HCal") {
    edm::ESHandle<CaloGeometry> geom;
    iSetup.get<CaloGeometryRecord>().get(geom);
    if (!geom.isValid()) {
      edm::LogVerbatim("HGCalValidation") << "Cannot get valid HGCalGeometry "
                      << "Object for " << nameDetector_;
    } else {
      const CaloGeometry* geom0 = geom.product();
      if (ifHCAL_) {
    edm::Handle<HBHERecHitCollection> hbhecoll;
    iEvent.getByToken(recHitSource_, hbhecoll);
    if (hbhecoll.isValid()) {
      if (verbosity_>0) 
        edm::LogVerbatim("HGCalValidation") << nameDetector_ << " with " 
                        << hbhecoll->size() 
                        << " element(s)";
      for (const auto & it : *(hbhecoll.product())) {
        DetId detId = it.id();
        ntot++;
        if (detId.subdetId() == HcalEndcap) {
          nused++;
          int   layer = HcalDetId(detId).depth();
          recHitValidation(detId, layer, geom0, &it);
        }
      }
    } else {
      ok = false;
      edm::LogVerbatim("HGCalValidation") << "HBHERecHitCollection "
                          << "Handle does not exist !!!";
    }
      } else {
    edm::Handle<HGChebRecHitCollection> hbhecoll;
    iEvent.getByToken(recHitSource_, hbhecoll);
    if (hbhecoll.isValid()) {
      if (verbosity_>0) 
        edm::LogVerbatim("HGCalValidation") << nameDetector_ << " with "
                        << hbhecoll->size() 
                        << " element(s)";
      for (const auto & it : *(hbhecoll.product())) {
        DetId detId = it.id();
        ntot++; nused++;
        int   layer = HcalDetId(detId).depth();
        recHitValidation(detId, layer, geom0, &it);
      }
    } else {
      ok = false;
      edm::LogVerbatim("HGCalValidation") << "HGChebRecHitCollection "
                          << "Handle does not exist !!!";
    }
      }
    }
  } else {
    edm::ESHandle<HGCalGeometry> geom;
    iSetup.get<IdealGeometryRecord>().get(nameDetector_, geom);
    if (!geom.isValid()) {
      edm::LogVerbatim("HGCalValidation") << "Cannot get valid HGCalGeometry "
                      << "Object for " << nameDetector_;
    } else {
      const HGCalGeometry* geom0 = geom.product();
      HGCalGeometryMode::GeometryMode mode = geom0->topology().geomMode();
      int geomType = (((mode == HGCalGeometryMode::Hexagon8) ||
               (mode == HGCalGeometryMode::Hexagon8Full)) ? 1 :
              ((mode == HGCalGeometryMode::Trapezoid) ? 2 : 0));
      
      edm::Handle<HGCRecHitCollection> theRecHitContainers;
      iEvent.getByToken(recHitSource_, theRecHitContainers);
      if (theRecHitContainers.isValid()) {
    if (verbosity_>0) 
      edm::LogVerbatim("HGCalValidation") << nameDetector_ << " with " 
                          << theRecHitContainers->size()
                          << " element(s)";
    for (const auto &  it : *(theRecHitContainers.product())) {
      ntot++; nused++;
      DetId detId = it.id();
      int layer   = ((geomType == 0) ? HGCalDetId(detId).layer() :
             ((geomType == 1) ? HGCSiliconDetId(detId).layer() :
              HGCScintillatorDetId(detId).layer()));
      recHitValidation(detId, layer, geom0, &it);
    }
      } else {
    ok = false;
    edm::LogVerbatim("HGCalValidation") << "HGCRecHitCollection Handle "
                        << "does not exist !!!";
      }
    }
  }
  if (ok) fillHitsInfo();
  if (verbosity_>0) 
    edm::LogVerbatim("HGCalValidation") << "Event " << iEvent.id().event()
                    << " with " << ntot << " total and "
                    << nused << " used recHits";
}

template<class T1, class T2>
void HGCalRecHitValidation::recHitValidation(DetId & detId, int layer, 
                         const T1* geom, T2 it) {

  const GlobalPoint& global = geom->getPosition(detId);
  double      energy = it->energy();

  float globalx = global.x();
  float globaly = global.y();
  float globalz = global.z();
      
  HitsInfo   hinfo;
  hinfo.energy = energy;
  hinfo.x      = globalx;
  hinfo.y      = globaly;
  hinfo.z      = globalz;
  hinfo.layer  = layer-firstLayer_;
  hinfo.phi    = global.phi();
  hinfo.eta    = global.eta();
      
  if (verbosity_>1) 
    edm::LogVerbatim("HGCalValidation") << "--------------------------   gx = "
                    << globalx << " gy = "  << globaly   
                    << " gz = " << globalz << " phi = " 
                    << hinfo.phi << " eta = " << hinfo.eta
                    << " lay = " << hinfo.layer;
      
  fillHitsInfo(hinfo);
      
  if (hinfo.eta > 0)  fillOccupancyMap(OccupancyMap_plus,  hinfo.layer);
  else                fillOccupancyMap(OccupancyMap_minus, hinfo.layer);
      
}      

void HGCalRecHitValidation::fillOccupancyMap(std::map<int, int>& OccupancyMap,
                         int layer) {
  if (OccupancyMap.find(layer) != OccupancyMap.end()) OccupancyMap[layer]++;
  else                                                OccupancyMap[layer] = 1;
}

void HGCalRecHitValidation::fillHitsInfo() { 

  for (auto const& itr : OccupancyMap_plus) { 
    int layer      = itr.first;
    int occupancy  = itr.second;
    HitOccupancy_Plus_.at(layer)->Fill(occupancy);
  }

  for (auto const & itr : OccupancyMap_minus) {
    int layer      = itr.first;
    int occupancy  = itr.second;
    HitOccupancy_Minus_.at(layer)->Fill(occupancy);
  }
  
}

void HGCalRecHitValidation::fillHitsInfo(HitsInfo& hits) {

  unsigned int ilayer = hits.layer;
  energy_.at(ilayer)->Fill(hits.energy);

  EtaPhi_Plus_.at(ilayer)->Fill(hits.eta , hits.phi);
  EtaPhi_Minus_.at(ilayer)->Fill(hits.eta, hits.phi);

}

void HGCalRecHitValidation::dqmBeginRun(const edm::Run&, 
                    const edm::EventSetup& iSetup) {

  if (nameDetector_ == "HCal") {
    edm::ESHandle<HcalDDDRecConstants> pHRNDC;
    iSetup.get<HcalRecNumberingRecord>().get( pHRNDC );
    const HcalDDDRecConstants *hcons   = &(*pHRNDC);
    layers_ = hcons->getMaxDepth(1);
  } else {
    edm::ESHandle<HGCalDDDConstants>  pHGDC;
    iSetup.get<IdealGeometryRecord>().get(nameDetector_, pHGDC);
    const HGCalDDDConstants & hgcons_ = (*pHGDC);
    layers_     = hgcons_.layers(true);
    firstLayer_ = hgcons_.firstLayer();
  }
}

void HGCalRecHitValidation::bookHistograms(DQMStore::IBooker& iB, 
                       edm::Run const&, 
                       edm::EventSetup const&) {

  iB.setCurrentFolder("HGCAL/HGCalRecHitsV/"+nameDetector_);
  std::ostringstream histoname;
  for (unsigned int il=0; il<layers_; ++il) {
    int ilayer = firstLayer_ + (int)(il);
    histoname.str(""); histoname << "HitOccupancy_Plus_layer_" << ilayer;
    HitOccupancy_Plus_.push_back(iB.book1D( histoname.str().c_str(), "RecHitOccupancy_Plus", 100, 0, 10000));
    histoname.str(""); histoname << "HitOccupancy_Minus_layer_" << ilayer;
    HitOccupancy_Minus_.push_back(iB.book1D( histoname.str().c_str(), "RecHitOccupancy_Minus", 100, 0, 10000));

    histoname.str(""); histoname << "EtaPhi_Plus_" << "layer_" << ilayer;
    EtaPhi_Plus_.push_back(iB.book2D(histoname.str().c_str(), "Occupancy", 31, 1.45, 3.0, 72, -CLHEP::pi, CLHEP::pi));
    histoname.str(""); histoname << "EtaPhi_Minus_" << "layer_" << ilayer;
    EtaPhi_Minus_.push_back(iB.book2D(histoname.str().c_str(), "Occupancy", 31, -3.0, -1.45, 72, -CLHEP::pi, CLHEP::pi));
      
    histoname.str(""); histoname << "energy_layer_" << ilayer; 
    energy_.push_back(iB.book1D(histoname.str().c_str(),"energy_",500,0,1));
  }//loop over layers ends here 

  histoname.str(""); histoname << "SUMOfRecHitOccupancy_Plus";
  MeanHitOccupancy_Plus_= iB.book1D( histoname.str().c_str(), "SUMOfRecHitOccupancy_Plus", layers_, -0.5, layers_-0.5);
  histoname.str(""); histoname << "SUMOfRecHitOccupancy_Minus";
  MeanHitOccupancy_Minus_ = iB.book1D( histoname.str().c_str(), "SUMOfRecHitOccupancy_Minus", layers_, -0.5,layers_-0.5);
}


// ------------ method fills 'descriptions' with the allowed parameters for the module  ------------

#include "FWCore/Framework/interface/MakerMacros.h"

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