DQMHistAnalysisSVDClustersOnTrack.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.                  *
 **************************************************************************/
//+
// File : DQMHistAnalysisSVDClustersOnTrack.cc
// Description : module for DQM histogram analysis of SVD sensors occupancies
//-
 
 
#include <dqm/analysis/modules/DQMHistAnalysisSVDClustersOnTrack.h>
#include <vxd/geometry/GeoCache.h>
 
#include <TROOT.h>
#include <TStyle.h>
#include <TString.h>
#include <TAxis.h>
 
#include <TMath.h>
#include <iostream>
#include <cmath>
 
using namespace std;
using namespace Belle2;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(DQMHistAnalysisSVDClustersOnTrack);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
DQMHistAnalysisSVDClustersOnTrackModule::DQMHistAnalysisSVDClustersOnTrackModule()
  : DQMHistAnalysisSVDModule(true)
{
  //Parameter definition
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: Constructor done.");
 
  setDescription("DQM Analysis Module that produces colored canvas for a straightforward interpretation of the SVD Data Quality.");
 
  addParam("printCanvas", m_printCanvas, "if True prints pdf of the analysis canvas", bool(false));
  addParam("statThreshold", m_statThreshold, "Minimal number of events to compare histograms", double(10000.));
  addParam("timeThreshold", m_timeThreshold, "Acceptable difference between mean of central peak for present and reference run",
           double(8)); // 8 ns
  addParam("refMode", m_refMode, "Mode reference of the signal time peak", double(0.0));
  addParam("samples3", m_3Samples, "if True 3 samples histograms analysis is performed", bool(false));
  addParam("PVPrefix", m_pvPrefix, "PV Prefix", std::string("SVD:"));
}
 
DQMHistAnalysisSVDClustersOnTrackModule::~DQMHistAnalysisSVDClustersOnTrackModule() { }
 
void DQMHistAnalysisSVDClustersOnTrackModule::initialize()
{
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: initialized.");
 
  m_cClusterOnTrackTime_L456V = new TCanvas("SVDAnalysis/c_ClusterOnTrackTime_L456V");
 
  if (m_3Samples)
    m_cClusterOnTrackTimeL456V3Samples = new TCanvas("SVDAnalysis/c_ClusterOnTrackTime_L456V3Samples");
 
  //register limits for EPICS
  registerEpicsPV(m_pvPrefix + "clusterTimeOnTrackMode", "clusterTimeOnTrackMode");
  registerEpicsPV(m_pvPrefix + "ratio3_6", "ratio3_6");
  registerEpicsPV(m_pvPrefix + "clusterTimeOnTrackLimits", "clusTimeOnTrkLimits");
}
 
 
void DQMHistAnalysisSVDClustersOnTrackModule::beginRun()
{
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: beginRun called.");
 
  m_cClusterOnTrackTime_L456V->Clear();
 
  if (m_3Samples)
    m_cClusterOnTrackTimeL456V3Samples->Clear();
 
  //Retrieve limits from EPICS
  double timeWarnUp = 0.;
  double timeErrorLo = 0.;
  double timeWarnLo = 0.;
  requestLimitsFromEpicsPVs("clusTimeOnTrkLimits", timeErrorLo, timeWarnLo, timeWarnUp,  m_timeThreshold);
 
  //Retrieve mode value for cluster time on track
  double ref = getEpicsPV("clusterTimeOnTrackMode");
  if (!std::isnan(ref))
    m_refMode = ref;
 
  B2DEBUG(10, " SVD cluster time on track threshold taken from EPICS configuration file:");
  B2DEBUG(10, "  CLUSTER TIME ON TRACK: error > " << m_timeThreshold - m_refMode << " ns with minimum statistics of " <<
          m_statThreshold);
 
  // cluster time on tracks legend
  m_legProblem->Clear();
  m_legProblem->AddText("ERROR!");
  m_legProblem->AddText(Form("abs(Mode - Ref) > %3.1f ns", m_timeThreshold));
  m_legProblem->AddText("Mode: 0.0 ns");
 
 
  m_legWarning->Clear();
  m_legWarning->AddText("WARNING!");
 
  m_legNormal->Clear();
  m_legNormal->AddText("TIME SHIFT UNDER LIMIT");
  m_legNormal->AddText(Form("abs(Mode - Ref) < %3.1f ns", m_timeThreshold));
  m_legNormal->AddText("Mode: 0.0 ns");
 
  m_legLowStat->Clear();
  m_legLowStat->AddText("Not enough statistics");
 
  m_legEmpty->Clear();
  m_legEmpty->AddText("No data recieved");
}
 
void DQMHistAnalysisSVDClustersOnTrackModule::event()
{
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: event called.");
 
  //find nEvents
  TH1* hnEvnts = findHist("SVDExpReco/SVDDQM_nEvents", true);
  if (hnEvnts == NULL) {
    B2INFO("no events, nothing to do here");
    return;
  } else {
    B2DEBUG(10, "SVDExpReco/SVDDQM_nEvents found");
  }
 
  string rtype = getRunType();
  m_runtype = !rtype.empty() ? rtype.c_str() : "physics"; // per default
 
  if (rtype.empty())
    B2INFO("no run type found, put defaultwise physics");
 
  TString tmp = hnEvnts->GetTitle();
  Int_t pos = tmp.Last('~');
  if (pos == -1) pos = 0;
 
  TString runID = tmp(pos, tmp.Length() - pos);
  B2INFO("DQMHistAnalysisSVDClustersOnTrackModule::runID = " << runID);
  Float_t nEvents = hnEvnts->GetEntries();
 
  // cluster time for clusters of track
  double ratio3_6 = 0.;
  TH1* m_h = findHist("SVDClsTrk/SVDTRK_ClusterTimeV456");
 
  int status;
  if (m_h != NULL) {
 
    m_hClusterOnTrackTime_L456V.Clear();
    m_h->Copy(m_hClusterOnTrackTime_L456V);
    TString hName = getHistoNameFromCanvas(m_cClusterOnTrackTime_L456V->GetName());
    m_hClusterOnTrackTime_L456V.SetName(hName.Data());
    m_hClusterOnTrackTime_L456V.SetTitle(Form("ClusterOnTrack Time L456V %s", runID.Data()));
    m_hClusterOnTrackTime_L456V.SetStats(false);
 
    Int_t binMax = m_hClusterOnTrackTime_L456V.GetMaximumBin();
    double mode = m_hClusterOnTrackTime_L456V.GetXaxis()->GetBinCenter(binMax);
 
    if (nEvents > m_statThreshold)
      status = getCanvasStatus(mode);
    else
      status = lowStat;
 
    m_cClusterOnTrackTime_L456V->cd();
    m_hClusterOnTrackTime_L456V.Draw();
    setStatusOfCanvas(status, m_cClusterOnTrackTime_L456V);
 
  } else {
    B2INFO("Histogram SVDClsTrk/c_SVDTRK_ClusterTimeV456 from SVDDQMClustersOnTrack module not found!");
    m_cClusterOnTrackTime_L456V->cd();
    m_hClusterOnTrackTime_L456V.Draw();
    setStatusOfCanvas(noStat, m_cClusterOnTrackTime_L456V);
  }
 
  if (m_printCanvas)
    m_cClusterOnTrackTime_L456V->Print("c_SVDClusterOnTrackTime_L456V.pdf");
 
 
  // cluster time for clusters of track for 3 samples
  if (m_3Samples) {
    m_h = findHist("SVDClsTrk/SVDTRK_Cluster3TimeV456");
 
    if (m_h != NULL) {
      m_hClusterOnTrackTimeL456V3Samples.Clear();
      TString hName = getHistoNameFromCanvas(m_cClusterOnTrackTimeL456V3Samples->GetName());
      m_h->Copy(m_hClusterOnTrackTimeL456V3Samples);
      m_hClusterOnTrackTimeL456V3Samples.SetName(hName.Data());
      m_hClusterOnTrackTimeL456V3Samples.SetTitle(Form("ClusterOnTrack Time L456V 3 samples %s", runID.Data()));
 
      Int_t binMax = m_hClusterOnTrackTime_L456V.GetMaximumBin();
      double mode = m_hClusterOnTrackTime_L456V.GetXaxis()->GetBinCenter(binMax);
 
 
      if (nEvents > m_statThreshold)
        status = getCanvasStatus(mode);
      else
        status = lowStat;
 
      m_cClusterOnTrackTimeL456V3Samples->cd();
      m_hClusterOnTrackTimeL456V3Samples.Draw();
      setStatusOfCanvas(status, m_cClusterOnTrackTimeL456V3Samples);
 
    } else {
      B2INFO("Histogram SVDClsTrk/c_SVDTRK_Cluster3TimeV456 from SVDDQMClustersOnTrack module not found!");
      m_cClusterOnTrackTimeL456V3Samples->cd();
      m_hClusterOnTrackTimeL456V3Samples.Draw();
      setStatusOfCanvas(noStat, m_cClusterOnTrackTimeL456V3Samples);
    }
 
    if (m_printCanvas)
      m_cClusterOnTrackTimeL456V3Samples->Print("c_SVDClusterOnTrack3Time_L456V.pdf");
 
    ratio3_6 = m_hClusterOnTrackTimeL456V3Samples.GetEntries() / m_hClusterOnTrackTime_L456V.GetEntries();
  }
 
  setEpicsPV("ratio3_6", ratio3_6);
}
 
void DQMHistAnalysisSVDClustersOnTrackModule::endRun()
{
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: endRun called");
}
 
 
void DQMHistAnalysisSVDClustersOnTrackModule::terminate()
{
  B2DEBUG(10, "DQMHistAnalysisSVDClustersOnTrack: terminate called");
 
  delete m_cClusterOnTrackTime_L456V;
  delete m_cClusterOnTrackTimeL456V3Samples;
}
 
int DQMHistAnalysisSVDClustersOnTrackModule::getCanvasStatus(double mode)
{
  int status = good;
 
  if (fabs(mode - m_refMode) > m_timeThreshold) {
    status = error;
    TText* text = m_legProblem->GetLine(m_legProblem->GetSize() - 1);
    text->SetText(text->GetX(), text->GetY(), Form("Mode - Ref: %3.1f ns", mode - m_refMode));
  } else {
    status = good;
    TText* text = m_legNormal->GetLine(m_legNormal->GetSize() - 1);
    text->SetText(text->GetX(), text->GetY(), Form("Mode - Ref: %3.1f ns", mode - m_refMode));
  }
 
  return status;
}