SVDDQMHitTimeModule.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 <svd/modules/svdDQM/SVDDQMHitTimeModule.h>
#include <framework/core/HistoModule.h>
#include <mdst/dataobjects/TRGSummary.h>
#include <TDirectory.h>
 
using namespace Belle2;
 
REG_MODULE(SVDDQMHitTime);
 
//---------------------------------
SVDDQMHitTimeModule::SVDDQMHitTimeModule(): HistoModule()
{
  setPropertyFlags(c_ParallelProcessingCertified); // parallel processing
  setDescription("Make data quality monitoring plots for SVD Hit Time for bhabha, mu mu, and hadron samples seeded by different trigger times (ECL, CDC).");
  addParam("histogramDirectoryName", m_histogramDirectoryName, "Name of the directory where histograms will be placed.",
           std::string("SVDHitTime"));
  addParam("Clusters", m_storeSVDClustersName, "SVDCluster StoreArray name.",
           std::string(""));
  addParam("EventInfo", m_storeSVDEventInfoName, "SVDEventInfo StoreObjPtr name.",
           std::string(""));
  addParam("desynchronizeSVDTime", m_desynchSVDTime,
           "if True, svd time back in SVD time reference", bool(false));
 
}
 
//---------------------------------
SVDDQMHitTimeModule::~SVDDQMHitTimeModule() { }
 
 
//---------------------------------
void SVDDQMHitTimeModule::defineHisto()
{
 
  TDirectory* oldDir = gDirectory;
  oldDir->mkdir(m_histogramDirectoryName.c_str())->cd();
 
  int nBins = 300 ;
  double minT0 = -150 ;
  double maxT0 =  150 ;
 
  TString refFrame = "in FTSW reference";
  if (m_desynchSVDTime)
    refFrame = "in SVD reference";
 
  m_l3v_bhabha_L1_ECLTRG = new TH1F("SVDTime_L3V_bhabha_ECLTRG",
                                    Form("SVD L3 V-Side Cluster Time %s: bhabhas, ECLTRG time", refFrame.Data()),
                                    nBins, minT0, maxT0);
  m_l3v_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_bhabha_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_bhabha_ECLTRG",
                                         "SVD L3 V-Side Cluster Time - EventT0 : bhabhas, ECLTRG time",
                                         nBins, minT0, maxT0);
  m_l3vEvtT0_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_l3v_hadron_L1_ECLTRG = new TH1F("SVDTime_L3V_hadron_ECLTRG",
                                    Form("SVD L3 V-Side Cluster Time %s: hadrons, ECLTRG time", refFrame.Data()),
                                    nBins, minT0, maxT0);
  m_l3v_hadron_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_hadron_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_hadron_ECLTRG",
                                         "SVD L3 V-Side Cluster Time - EventT0 : hadrons, ECLTRG time",
                                         nBins, minT0, maxT0);
  m_l3vEvtT0_hadron_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_l3v_mumu_L1_ECLTRG = new TH1F("SVDTime_L3V_mumu_ECLTRG",
                                  Form("SVD L3 V-Side Cluster Time %s: mumus, ECLTRG time", refFrame.Data()),
                                  nBins, minT0, maxT0);
  m_l3v_mumu_L1_ECLTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_mumu_L1_ECLTRG = new TH1F("SVDTimeEvtT0_L3V_mumu_ECLTRG",
                                       "SVD L3 V-Side Cluster Time - EventT0 : mumus, ECLTRG time",
                                       nBins, minT0, maxT0);
  m_l3vEvtT0_mumu_L1_ECLTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_l3v_bhabha_L1_CDCTRG = new TH1F("SVDTime_L3V_bhabha_CDCTRG",
                                    Form("SVD L3 V-Side Cluster Time %s: bhabhas, CDCTRG time", refFrame.Data()),
                                    nBins, minT0, maxT0);
  m_l3v_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_bhabha_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_bhabha_CDCTRG",
                                         "SVD L3 V-Side Cluster Time - EventT0 : bhabhas, CDCTRG time",
                                         nBins, minT0, maxT0);
  m_l3vEvtT0_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_l3v_hadron_L1_CDCTRG = new TH1F("SVDTime_L3V_hadron_CDCTRG",
                                    Form("SVD L3 V-Side Cluster Time %s: hadrons, CDCTRG time", refFrame.Data()),
                                    nBins, minT0, maxT0);
  m_l3v_hadron_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_hadron_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_hadron_CDCTRG",
                                         "SVD L3 V-Side Cluster Time - EventT0 : hadrons, CDCTRG time",
                                         nBins, minT0, maxT0);
  m_l3vEvtT0_hadron_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_l3v_mumu_L1_CDCTRG = new TH1F("SVDTime_L3V_mumu_CDCTRG",
                                  Form("SVD L3 V-Side Cluster Time %s: mumus, CDCTRG time", refFrame.Data()),
                                  nBins, minT0, maxT0);
  m_l3v_mumu_L1_CDCTRG->GetXaxis()->SetTitle("cluster time (ns)");
  m_l3vEvtT0_mumu_L1_CDCTRG = new TH1F("SVDTimeEvtT0_L3V_mumu_CDCTRG",
                                       "SVD L3 V-Side Cluster Time - EventT0 : mumus, CDCTRG time",
                                       nBins, minT0, maxT0);
  m_l3vEvtT0_mumu_L1_CDCTRG->GetXaxis()->SetTitle("cluster time - EventT0 (ns)");
 
  m_SVD3EventT0 = new TH1F("SVD3EventT0", "SVD EventT0 for 3 samples", nBins, minT0, maxT0);
  m_SVD3EventT0->GetXaxis()->SetTitle("SVD EventT0 time (ns)");
  m_SVD3EventT0->GetYaxis()->SetTitle("count");
 
  m_SVD6EventT0 = new TH1F("SVD6EventT0", "SVD EventT0 for 6 samples", nBins, minT0, maxT0);
  m_SVD6EventT0->GetXaxis()->SetTitle("SVD EventT0 time (ns)");
  m_SVD6EventT0->GetYaxis()->SetTitle("count");
 
  m_SVD3EventT0_bhabha_L1_ECLTRG = new TH1F("SVD3EventT0_bhabha_L1_ECLTRG",
                                            "SVD EventT0 3 samples : bhabhas, ECLTRG time",
                                            nBins, minT0, maxT0);
  m_SVD3EventT0_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD3EventT0_hadron_L1_ECLTRG = new TH1F("SVD3EventT0_hadron_L1_ECLTRG",
                                            "SVD EventT0 3 samples : hadrons, ECLTRG time",
                                            nBins, minT0, maxT0);
  m_SVD3EventT0_hadron_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD3EventT0_mumu_L1_ECLTRG = new TH1F("SVD3EventT0_mumu_L1_ECLTRG",
                                          "SVD EventT0 3 samples : mumus, ECLTRG time",
                                          nBins, minT0, maxT0);
  m_SVD3EventT0_mumu_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD3EventT0_bhabha_L1_CDCTRG = new TH1F("SVD3EventT0_bhabha_L1_CDCTRG",
                                            "SVD EventT0 3 samples : bhabhas, CDCTRG time",
                                            nBins, minT0, maxT0);
  m_SVD3EventT0_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD3EventT0_hadron_L1_CDCTRG = new TH1F("SVD3EventT0_hadron_L1_CDCTRG",
                                            "SVD EventT0 3 samples : hadrons, CDCTRG time",
                                            nBins, minT0, maxT0);
  m_SVD3EventT0_hadron_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD3EventT0_mumu_L1_CDCTRG = new TH1F("SVD3EventT0_mumu_L1_CDCTRG",
                                          "SVD EventT0 3 samples : mumus, CDCTRG time",
                                          nBins, minT0, maxT0);
  m_SVD3EventT0_mumu_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
 
 
  m_SVD6EventT0_bhabha_L1_ECLTRG = new TH1F("SVD6EventT0_bhabha_L1_ECLTRG",
                                            "SVD EventT0 6 samples : bhabhas, ECLTRG time",
                                            nBins, minT0, maxT0);
  m_SVD6EventT0_bhabha_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD6EventT0_hadron_L1_ECLTRG = new TH1F("SVD6EventT0_hadron_L1_ECLTRG",
                                            "SVD EventT0 6 samples : hadrons, ECLTRG time",
                                            nBins, minT0, maxT0);
  m_SVD6EventT0_hadron_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD6EventT0_mumu_L1_ECLTRG = new TH1F("SVD6EventT0_mumu_L1_ECLTRG",
                                          "SVD EventT0 6 samples : mumus, ECLTRG time",
                                          nBins, minT0, maxT0);
  m_SVD6EventT0_mumu_L1_ECLTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD6EventT0_bhabha_L1_CDCTRG = new TH1F("SVD6EventT0_bhabha_L1_CDCTRG",
                                            "SVD EventT0 6 samples : bhabhas, CDCTRG time",
                                            nBins, minT0, maxT0);
  m_SVD6EventT0_bhabha_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD6EventT0_hadron_L1_CDCTRG = new TH1F("SVD6EventT0_hadron_L1_CDCTRG",
                                            "SVD EventT0 6 samples : hadrons, CDCTRG time",
                                            nBins, minT0, maxT0);
  m_SVD6EventT0_hadron_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  m_SVD6EventT0_mumu_L1_CDCTRG = new TH1F("SVD6EventT0_mumu_L1_CDCTRG",
                                          "SVD EventT0 6 samples : mumus, CDCTRG time",
                                          nBins, minT0, maxT0);
  m_SVD6EventT0_mumu_L1_CDCTRG->GetXaxis()->SetTitle("SVD EventT0 (ns)");
 
  oldDir->cd();
 
}
 
 
//---------------------------------
void SVDDQMHitTimeModule::initialize()
{
 
  m_TrgResult.isOptional();
  m_eventT0.isOptional();
  m_svdEventInfo.isOptional(m_storeSVDEventInfoName);
  m_clusters.isOptional(m_storeSVDClustersName);
 
  REG_HISTOGRAM
 
}
 
 
 
//---------------------------------
void SVDDQMHitTimeModule::beginRun()
{
 
  m_l3v_bhabha_L1_ECLTRG->Reset();
  m_l3vEvtT0_bhabha_L1_ECLTRG->Reset();
  m_l3v_hadron_L1_ECLTRG->Reset();
  m_l3vEvtT0_hadron_L1_ECLTRG->Reset();
  m_l3v_mumu_L1_ECLTRG->Reset();
  m_l3vEvtT0_mumu_L1_ECLTRG->Reset();
 
  m_l3v_bhabha_L1_CDCTRG->Reset();
  m_l3vEvtT0_bhabha_L1_CDCTRG->Reset();
  m_l3v_hadron_L1_CDCTRG->Reset();
  m_l3vEvtT0_hadron_L1_CDCTRG->Reset();
  m_l3v_mumu_L1_CDCTRG->Reset();
  m_l3vEvtT0_mumu_L1_CDCTRG->Reset();
 
  m_SVD3EventT0->Reset();
  m_SVD6EventT0->Reset();
 
  m_SVD3EventT0_bhabha_L1_ECLTRG->Reset();
  m_SVD3EventT0_hadron_L1_ECLTRG->Reset();
  m_SVD3EventT0_mumu_L1_ECLTRG->Reset();
  m_SVD3EventT0_bhabha_L1_CDCTRG->Reset();
  m_SVD3EventT0_hadron_L1_CDCTRG->Reset();
  m_SVD3EventT0_mumu_L1_CDCTRG->Reset();
 
  m_SVD6EventT0_bhabha_L1_ECLTRG->Reset();
  m_SVD6EventT0_hadron_L1_ECLTRG->Reset();
  m_SVD6EventT0_mumu_L1_ECLTRG->Reset();
  m_SVD6EventT0_bhabha_L1_CDCTRG->Reset();
  m_SVD3EventT0_hadron_L1_CDCTRG->Reset();
  m_SVD6EventT0_mumu_L1_CDCTRG->Reset();
}
 
 
//---------------------------------
void SVDDQMHitTimeModule::event()
{
 
  if (!m_TrgResult.isValid()) {
    B2WARNING("Missing TRGSummary, SVDDQMHitTime is skipped.");
    return;
  }
  if (!m_svdEventInfo.isValid()) {
    B2WARNING("Missing SVDEventInfo, SVDDQMHitTime is skipped.");
    return;
  }
 
 
 
  if (!m_clusters.isValid()) {
    B2WARNING("Missing SVDClusters, SVDDQMHitTime is skipped.");
    return;
  }
 
 
  if (!m_objTrgSummary.isValid()) {
    B2WARNING("TRGSummary object not available but required to indicate which detector provided the L1 trigger time");
    return;
  } else {
    m_L1TimingSrc = m_objTrgSummary->getTimType();
  }
 
  bool Is_ECL_L1TriggerSource = false ;
  bool Is_CDC_L1TriggerSource = false ;
  if (m_L1TimingSrc == TRGSummary::ETimingType::TTYP_ECL) {            // for L1 timing source is "ecl trigger"
    Is_ECL_L1TriggerSource = true ;
  } else if (m_L1TimingSrc == TRGSummary::ETimingType::TTYP_CDC) {     // for L1 timing source is "cdc trigger"
    Is_CDC_L1TriggerSource = true ;
  }
  // else if(m_L1TimingSrc==ETimingType::TTYP_DPHY){  // for L1 timing source is "delayed Bhabha" }
  B2DEBUG(20, "Is_ECL_L1TriggerSource = " << Is_ECL_L1TriggerSource) ;
  B2DEBUG(20, "Is_CDC_L1TriggerSource= " << Is_CDC_L1TriggerSource) ;
 
 
  if (!m_TrgResult.isValid()) {
    B2WARNING("SoftwareTriggerResult object not available but require to select bhabha/mumu/hadron events for this module");
    return;
  }
 
  const std::map<std::string, int>& fresults = m_TrgResult->getResults();
  if ((fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end())   ||
      (fresults.find("software_trigger_cut&skim&accept_mumu_2trk") == fresults.end())   ||
      (fresults.find("software_trigger_cut&skim&accept_hadron") == fresults.end())) {
    B2WARNING("SVDDQMHitTimeModule: Can't find required bhabha or mumu or hadron trigger identifier");
    return;
  }
 
 
 
  // determine if the event was part of the hadron skim or bhabha skim or mumu skim
  const bool IsEvtAcceptedBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
                                    SoftwareTriggerCutResult::c_accept);
  const bool IsEvtAcceptedHadron = (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron") ==
                                    SoftwareTriggerCutResult::c_accept);
  const bool IsEvtAcceptedMumu = (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk") ==
                                  SoftwareTriggerCutResult::c_accept);
 
 
  B2DEBUG(20, "bhabha trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha"))) ;
  B2DEBUG(20, "hadron trigger result = " << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_hadron"))) ;
  B2DEBUG(20, "mu mu trigger result = "  << static_cast<std::underlying_type<SoftwareTriggerCutResult>::type>
          (m_TrgResult->getResult("software_trigger_cut&skim&accept_mumu_2trk"))) ;
  B2DEBUG(20, "bhabha trigger comparison bool = " << IsEvtAcceptedBhabha) ;
  B2DEBUG(20, "hadron trigger comparison bool = " << IsEvtAcceptedHadron) ;
  B2DEBUG(20, "mumu trigger comparison bool = "   << IsEvtAcceptedMumu) ;
 
 
  // get EventT0 if present and valid
  double eventT0 = -1000;
  if (m_eventT0.isValid())
    if (m_eventT0->hasEventT0())
      eventT0 = m_eventT0->getEventT0();
 
  // if svd time in SVD time reference is shown, eventT0 is also synchronized with SVD reference frame, firstFrame = 0
  if (m_desynchSVDTime && m_svdEventInfo.isValid())
    eventT0 = eventT0 - m_svdEventInfo->getSVD2FTSWTimeShift(0);
 
  int nSamples = m_svdEventInfo->getNSamples();
 
  if (m_eventT0->hasTemporaryEventT0(Const::EDetector::SVD)) {
    const auto bestSVDEvtT0 = m_eventT0->getBestSVDTemporaryEventT0() ;
    //    There is only one estimate of SVD EVentT0 for the moment
    float svdEventT0 = bestSVDEvtT0->eventT0 ;
 
    if (nSamples == 3) {
      m_SVD3EventT0->Fill(svdEventT0);
    } else  {
      m_SVD6EventT0->Fill(svdEventT0);
    }
 
    if (Is_ECL_L1TriggerSource) {
      if (IsEvtAcceptedBhabha) {
        if (nSamples == 3) {
          m_SVD3EventT0_bhabha_L1_ECLTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_bhabha_L1_ECLTRG->Fill(svdEventT0);
        }
      }
      if (IsEvtAcceptedHadron) {
        if (nSamples == 3) {
          m_SVD3EventT0_hadron_L1_ECLTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_hadron_L1_ECLTRG->Fill(svdEventT0);
        }
      }
      if (IsEvtAcceptedMumu) {
        if (nSamples == 3) {
          m_SVD3EventT0_mumu_L1_ECLTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_mumu_L1_ECLTRG->Fill(svdEventT0);
        }
      }
    }
 
    // Fill the plots that used the CDC trigger as the L1 timing source
    else if (Is_CDC_L1TriggerSource) {
      if (IsEvtAcceptedBhabha) {
        if (nSamples == 3) {
          m_SVD3EventT0_bhabha_L1_CDCTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_bhabha_L1_CDCTRG->Fill(svdEventT0);
        }
      }
      if (IsEvtAcceptedHadron) {
        if (nSamples == 3) {
          m_SVD3EventT0_hadron_L1_CDCTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_hadron_L1_CDCTRG->Fill(svdEventT0);
        }
      }
      if (IsEvtAcceptedMumu) {
        if (nSamples == 3) {
          m_SVD3EventT0_mumu_L1_CDCTRG->Fill(svdEventT0);
        } else {
          m_SVD6EventT0_mumu_L1_CDCTRG->Fill(svdEventT0);
        }
      }
    }
  }
 
  //loop on clusters
  for (const SVDCluster& cluster : m_clusters) {
 
    //skip all non-L3 clusters
    if (cluster.getSensorID().getLayerNumber() != 3) continue;
    //skip all U-side clusters
    if (cluster.isUCluster()) continue;
 
    double time = cluster.getClsTime();
 
    //if svd time is shown in SVD time reference we need to desynchronize (eventT0 is, instead, synchronized, see a few lines above
    if (m_desynchSVDTime && m_svdEventInfo.isValid())
      time = time - m_svdEventInfo->getSVD2FTSWTimeShift(cluster.getFirstFrame());
 
    // Fill the plots that used the ECL trigger as the L1 timing source
    if (Is_ECL_L1TriggerSource) {
      if (IsEvtAcceptedBhabha) {
        m_l3v_bhabha_L1_ECLTRG->Fill(time);
        m_l3vEvtT0_bhabha_L1_ECLTRG->Fill(time - eventT0);
      }
      if (IsEvtAcceptedHadron) {
        m_l3v_hadron_L1_ECLTRG->Fill(time);
        m_l3vEvtT0_hadron_L1_ECLTRG->Fill(time - eventT0);
      }
      if (IsEvtAcceptedMumu) {
        m_l3v_mumu_L1_ECLTRG->Fill(time);
        m_l3vEvtT0_mumu_L1_ECLTRG->Fill(time - eventT0);
      }
    }
 
    // Fill the plots that used the CDC trigger as the L1 timing source
    else if (Is_CDC_L1TriggerSource) {
      if (IsEvtAcceptedBhabha) {
        m_l3v_bhabha_L1_CDCTRG->Fill(time);
        m_l3vEvtT0_bhabha_L1_CDCTRG->Fill(time - eventT0);
      }
      if (IsEvtAcceptedHadron) {
        m_l3v_hadron_L1_CDCTRG->Fill(time);
        m_l3vEvtT0_hadron_L1_CDCTRG->Fill(time - eventT0);
      }
      if (IsEvtAcceptedMumu) {
        m_l3v_mumu_L1_CDCTRG->Fill(time);
        m_l3vEvtT0_mumu_L1_CDCTRG->Fill(time - eventT0);
      }
    }
 
    B2DEBUG(20, "eventT0 = " << eventT0 << " ns" << ", SVD HitTime = " << time << " ns") ;
 
  } //close loop on clusters
}