CsIStudyModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <framework/core/HistoModule.h>
#include <framework/datastore/StoreArray.h>
#include <framework/datastore/StoreObjPtr.h>
#include <framework/dataobjects/EventMetaData.h>
#include <framework/gearbox/Const.h>
#include <beast/csi/modules/CsiModule.h>
#include <beast/csi/dataobjects/CsiSimHit.h>
#include <beast/csi/dataobjects/CsiHit.h>
#include <beast/csi/dataobjects/CsiDigiHit.h>
#include <beast/csi/modules/CsIStudyModule.h>
 
// ROOT
#include <TH1.h>
#include <TFile.h>
 
using namespace std;
using namespace Belle2;
using namespace csi;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(CsIStudy);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
CsIStudyModule::CsIStudyModule() : HistoModule(),
  fWF(NULL),
  h_CrystalEdep(NULL),
  h_CrystalSpectrum(NULL),
  h_CrystalRadDose(NULL),
  h_CrystalRadDoseSH(NULL),
  h_NhitCrystal(NULL),
  h_LightYieldCrystal(NULL),
  h_Waveform(NULL),
  h_Gate(NULL),
  h_Charge(NULL),
  h_TrueEdep(NULL),
  h_Height(NULL),
  h_Weight(NULL)
 
{
  // Set module properties
  setDescription("Analyze simulations of CsI readings in BEAST. Requires HistoManager module.");
 
  // Parameter definitions
  addParam("nWFSamples", m_nWFSamples, "Number of samples in the saved waveforms", 8000);
  addParam("paramTemplate", m_paramTemplate, "Template of an input parameter. Noop for now.", 0.0);
 
  string rootfilepath = "output/waveforms.root";
  addParam("waveformFilename", m_waveformFilename, "Path to the root file to save waveforms", rootfilepath);
 
}
 
CsIStudyModule::~CsIStudyModule()
{
}
 
void CsIStudyModule::defineHisto()
{
  h_CrystalEdep         = new TH1F("Crystal_Edep",  "Energy distribution in each crystal;CellID", 16, -0.5, 15.5);
  h_CrystalSpectrum     = new TH1F("Crystal_Edist",  "Photon energy distribution in all crystals;", 100, 0, 0.1);
  h_NhitCrystal         = new TH1F("Crystal_HitRate", "Number of hit per crystal;CellID; hit/s", 16, -0.5, 15.5);
  h_CrystalRadDose      = new TH1F("Crystal_RadDose", "Crystal Radiation Dose;CellID;Gy/yr", 16, -0.5, 15.5);
  h_CrystalRadDoseSH    = new TH1F("Crystal_RadDose_SH", "Crystal Radiation Dose from SimHits;CellID;Gy/yr", 16, -0.5, 15.5);
  h_LightYieldCrystal   = new TH1F("Crystal_g_yield", "Light yield each crystal;CellID;gamma/sample", 16, -0.5, 15.5);
  h_Waveform            = new TH1S("Waveform", "Recorded waveform;Time index;ADC bits", m_nWFSamples, 0, m_nWFSamples - 1);
  h_Gate                = new TH1C("Gate", "Recorded gate;Time index;ADC bits", m_nWFSamples, 0, m_nWFSamples - 1);
  h_Charge              = new TH1F("Charge", "log_{10} of integrated Charge", 200, 0, 10);
  h_TrueEdep            = new TH1F("TrueEdep", "log_{10} of true deposited energy/GeV", 200, -6, 0);
  h_Height              = new TH1F("Height", "log10 of pulse height", 200, 0, 6);
  h_Weight              = new TH1F("Weight", "Distribution of the event weights form the generator", 1000, 0, 10);
}
 
void CsIStudyModule::initialize()
{
  REG_HISTOGRAM   // required to register histograms to HistoManager
 
  m_hits.isOptional();
  m_simhits.isRequired();
  m_digihits.isOptional();
 
  fWF = new TFile(m_waveformFilename.c_str(), "recreate");
}
 
void CsIStudyModule::beginRun()
{
}
 
void CsIStudyModule::endRun()
{
  //  h_LightYieldCrystal->Divide( h_CrystalEdep );
  //  h_LightYieldCrystal->Scale( 1e-6 );
}
 
 
void CsIStudyModule::event()
{
 
  StoreObjPtr<EventMetaData> eventMetaDataPtr;
  double eventWeight = eventMetaDataPtr->getGeneratedWeight();
 
  h_Weight->Fill(eventWeight);
 
  //Loop over CsiHits
  if (m_hits.getEntries() > 0) {
    int hitNum = m_hits.getEntries(); 
    double Mass = 5;             
    double edeptodose = GeVtoJ / Mass * usInYr / Sampletime; 
    for (int i = 0; i < hitNum; i++) {
      CsiHit* aCsIHit = m_hits[i];
      int m_cellID = aCsIHit->getCellId();       
      double edep = aCsIHit->getEnergyDep();     
      //double hitTime = aCsIHit->getTimeAve();    /**< Time of the hit*/
 
      // Fill histograms
      h_CrystalSpectrum->Fill(edep, eventWeight);
      h_CrystalEdep->Fill(m_cellID, edep * eventWeight);
      h_CrystalRadDose->Fill(m_cellID, edep * edeptodose * eventWeight);
 
      //Number of hits per second
      h_NhitCrystal->Fill(m_cellID, eventWeight * 1.0e9 / Sampletime);
    }
  }
 
  //Loop over CsiSimHits
  if (m_simhits.getEntries() > 0) {
    int hitNum = m_simhits.getEntries(); 
    double Mass = 5;  
    double edeptodose = GeVtoJ / Mass * usInYr / Sampletime;
    for (int i = 0; i < hitNum; i++) {
      CsiSimHit* aCsIHit = m_simhits[i];
      int m_cellID = aCsIHit->getCellId();       
      double edep = aCsIHit->getEnergyDep();     
      // Fill histograms
      h_CrystalRadDoseSH->Fill(m_cellID, eventWeight * edep * edeptodose);
 
      // To get the Number of photons per GeV (divide by total edep before plotting)
      if (Const::photon.getPDGCode() == aCsIHit->getPDGCode()) {
        h_LightYieldCrystal->Fill(m_cellID, eventWeight);
      }
    }
  }
 
  //Loop over Digihits
  if (m_digihits.getEntries() > 0) {
    int hitNum = m_digihits.getEntries(); 
    for (int i = 0; i < hitNum; i++) {
      CsiDigiHit* aCsIDigiHit = m_digihits[i];
 
      int cellID = aCsIDigiHit->getCellId();
      // cast to double before taking the log
      double charge = (double) aCsIDigiHit->getCharge();
      double height = (double) aCsIDigiHit->getMaxVal();
      double baseline = (double) aCsIDigiHit->getBaseline();
      double trueEdep = aCsIDigiHit->getTrueEdep();
      vector<uint16_t>* waveform = aCsIDigiHit->getWaveform();
      vector<uint8_t>* status = aCsIDigiHit->getStatusBits();
 
      h_TrueEdep->Fill(log10(trueEdep), eventWeight);
      h_Charge->Fill(log10(charge - baseline), eventWeight);
      h_Height->Fill(log10(height), eventWeight);
 
      // Write the wavforms. All have the same number in the TFile, but
      // we can access them by their cycle number:
      // root[] TFile *f1 = new TFile("filename.root")
      // root[] TH1F *Waveform4; f1->GetObject("h_Waveform;4",Waveform4);
 
      if (waveform->size()) {
        h_Gate->Reset();
        h_Waveform->Reset();
 
        char histoTitle[80];
        sprintf(histoTitle, "Waveform Hit No. %i, Cell No %i", i, cellID);
        h_Waveform->SetTitle(histoTitle);
 
 
        for (uint iBin = 0; iBin < waveform->size(); iBin++) {
          bool* statusBits = readDPPStatusBits(status->at(iBin));
          h_Gate->Fill(iBin + 1, (int) statusBits[1]);
          h_Waveform->Fill(iBin + 1, waveform->at(iBin));
        }
 
        fWF->cd();
        h_Gate->Write();
        h_Waveform->Write();
      }
    }
  }
}
 
 
void CsIStudyModule::terminate()
{
  fWF->Close();
}
 
 
bool*  CsIStudyModule::readDPPStatusBits(char data)
{
 
  bool* bit  = new bool[8];
 
  // fill data
  for (int i = 0; i < 8; i++) {
    bit[i] = ((data >> i) & 0x01);
  }
 
  return bit;
}