DQMHistAnalysisDeltaTest.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 : DQMHistAnalysisDeltaTest.cc
// Description : Test Module for Delta Histogram Access
//-
 
 
#include <dqm/analysis/modules/DQMHistAnalysisDeltaTest.h>
#include <TROOT.h>
 
using namespace std;
using namespace Belle2;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(DQMHistAnalysisDeltaTest);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
DQMHistAnalysisDeltaTestModule::DQMHistAnalysisDeltaTestModule()
  : DQMHistAnalysisModule()
{
  // This module CAN NOT be run in parallel!
  setDescription("Testing module for using delta histogramming functionality.");
 
  //Parameter definition
  addParam("histogramDirectoryName", m_histogramDirectoryName, "Name of Histogram dir", std::string("test"));
  addParam("histogramName", m_histogramName, "Name of Histogram", std::string("testHist"));
  addParam("PVPrefix", m_pvPrefix, "PV Prefix", std::string("TEST:"));
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: Constructor done.");
}
 
DQMHistAnalysisDeltaTestModule::~DQMHistAnalysisDeltaTestModule()
{
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: Destructor done.");
}
 
void DQMHistAnalysisDeltaTestModule::initialize()
{
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: initialized.");
 
  m_monObj = getMonitoringObject("test");
 
  gROOT->cd(); // this seems to be important, or strange things happen
 
  m_cTest = new TCanvas((m_histogramDirectoryName + "/c_Test").data());
 
  m_monObj->addCanvas(m_cTest);
 
  registerEpicsPV(m_pvPrefix + "TEST1", "TEST1");
  registerEpicsPV(m_pvPrefix + "TEST2", "TEST2");
}
 
void DQMHistAnalysisDeltaTestModule::beginRun()
{
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: beginRun called.");
}
 
void DQMHistAnalysisDeltaTestModule::endRun()
{
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: endRun called.");
}
 
void DQMHistAnalysisDeltaTestModule::event()
{
  double data_Test1 = 0.0;
  double data_Test2 = 0.0;
 
  m_cTest->Clear();
  m_cTest->Divide(3, 2);
 
  // more handy to have it as a full name, but find/get functions
  // can work with one or two parameters
  std::string fullname = m_histogramDirectoryName + "/" + m_histogramName;
 
  // get basic histogram (run integrated up)
  auto hh1 = findHist(m_histogramDirectoryName, m_histogramName, false);// even if no update
  if (hh1) {
    m_cTest->cd(1);
    auto a = (TH1*)hh1->DrawClone("hist");
    a->SetTitle("Hist always");
    data_Test2 = hh1->GetMean();
  }
 
  auto hh2 = findHist(m_histogramDirectoryName, m_histogramName, true);// only if updated
  if (hh2) {
    m_cTest->cd(2);
    auto a = (TH1*)hh2->DrawClone("hist");
    a->SetTitle("Hist only if updated");
  }
 
  // get most recent delta
  auto hd2 = getDelta(m_histogramDirectoryName, m_histogramName, 0, false);// even if no update
  if (hd2) {
    m_cTest->cd(4);
    auto a = (TH1*)hd2->DrawClone("hist");
    a->SetTitle("Delta always");
  }
 
  // get most recent delta
  auto hd1 = getDelta(m_histogramDirectoryName, m_histogramName, 0, true);// only if updated
  if (hd1) {
    m_cTest->cd(5);
    auto a = (TH1*)hd1->DrawClone("hist");
    a->SetTitle("Delta only if updated");
    data_Test1 = hd1->GetMean();
  }
 
  UpdateCanvas(m_cTest->GetName(), hd1 != nullptr);
 
  if (!hd2) {
    // Depending on you analysis, you want to see/plot
    // the histogram even before the first condition for update is met
    // thus, no delta histogram is available
    if (hh1) {
      m_cTest->cd(3);
      auto a = (TH1*)hh1->DrawClone("hist");
      a->SetLineColor(2);
      a->SetTitle("initial sampling");
    }
    // but, as the statistics is low, we dont want to have it updated yet (e.g. in EPICS)
    // data_Test1=hd1->GetMean(); //< thus, do not uncomment
  }
 
  // plot all delta histograms, thus make recent shifts more visible
  // it would be nicer to plot oldest first, left as exercise for reader
  m_cTest->cd(6);
  for (int i = 0; i < 99; i++) {
    auto h = getDelta(fullname, i, false);
    if (h == nullptr) break;
    if (i == 0) {
      h->Draw("hist");
    } else {
      h->SetLineColor(kBlue + 4 - i * 3); // a bit of shading
      h->Draw("same");
    }
  }
 
  // I see no reason to access that histogram, but just as low-level example.
  m_cTest->cd(7);
  auto it = getDeltaList().find(m_histogramName);
  if (it != getDeltaList().end()) {
    auto h = it->second.m_lastHist.get();
    if (h) {
      auto a = (TH1*)h->DrawClone("hist");
      a->SetTitle("last update histogram");
    }
  }
 
  m_cTest->cd(0);
  m_cTest->Update();
 
  TString fn;
  static int plot_count = 0;
  fn.Form("ana_%s_Delta_%d.png", m_histogramName.data(), plot_count++);
  m_cTest->Print(fn);
 
  // actually, we would prefer to only update the epics variable
  // if the main histogram or delta~ has changed. but there is until now no easy
  // way to check that
  if (true) {
    // currently, monObj are only used at end of run, thus this is not necessary
    // but, in the future we may want to use finer granularity.
    m_monObj->setVariable("data_Test1", data_Test1);
    m_monObj->setVariable("data_Test2", data_Test2);
 
    setEpicsPV("TEST1", data_Test1);
    setEpicsPV("TEST2", data_Test2);
  }
}
 
void DQMHistAnalysisDeltaTestModule::terminate()
{
  B2DEBUG(1, "DQMHistAnalysisDeltaTest: terminate called");
}