DQMHistAnalysisKLM.h

/**************************************************************************
 * 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.                  *
 **************************************************************************/
 
#pragma once
 
/* DQM headers. */
#include <dqm/core/DQMHistAnalysis.h>
 
/* Basf2 headers. */
#include <framework/database/DBObjPtr.h>
#include <klm/dataobjects/bklm/BKLMElementNumbers.h>
#include <klm/dataobjects/KLMChannelArrayIndex.h>
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dataobjects/KLMSectorArrayIndex.h>
#include <klm/dbobjects/KLMElectronicsMap.h>
 
/* ROOT headers. */
#include <TCanvas.h>
#include <TFile.h>
#include <TH1.h>
#include <TH2F.h>
#include <TLatex.h>
#include <TLine.h>
#include <TText.h>
 
/* C++ headers. */
#include <vector>
 
namespace Belle2 {

  class DQMHistAnalysisKLMModule final : public DQMHistAnalysisModule {
 
  public:

    DQMHistAnalysisKLMModule();
 

    void initialize() override final;

    void beginRun() override final;

    void event() override final;

    void endRun() override final;

    void terminate() override final;
 
  private:

    double getProcessedEvents();

    void analyseChannelHitHistogram(
      int subdetector, int section, int sector, int index,
      TH1* histogram, TH1* delta, TCanvas* canvas, TLatex& latex);

    void processSpatial2DHitEndcapHistogram(
      uint16_t section, TH2F* histogram, TCanvas* canvas);

    void processTimeHistogram(const std::string& histName);

    void processPlaneHistogram(const std::string& histName, TLatex* latex, TH1* histogram);

    // Overloaded function for backward compatibility (TLatex reference)
    // so that the above function can be used with or without TLatex for FE histograms.
    void processPlaneHistogram(const std::string& histName, TLatex& latex);

    void updateCanvasStatus(
      TCanvas* canvas, const std::vector<KLMModuleNumber>& deadModules,
      TLatex* latex, int& message_counter, double xAlarm, double yAlarm);

    void processFEHistogram(TH1* feHist,  TH1* denominator, TH1* numerator, TCanvas* canvas);

    void fillMaskedChannelsHistogram(const std::string& histName);

    void deltaDrawer(TH1* delta, TH1* histogram, TCanvas* canvas);

    double m_ProcessedEvents;

    int m_ThresholdForMasked;

    int m_ThresholdForHot;

    int m_ThresholdForLog;

    int m_MinHitsForFlagging;

    int m_MessageThreshold;

    double m_MinProcessedEventsForMessagesInput;

    double m_MinProcessedEventsForMessages;

    double m_minEntries;

    std::string m_histogramDirectoryName;

    std::vector<uint16_t> m_DeadBarrelModules;

    std::vector<uint16_t> m_DeadEndcapModules;

    std::vector<uint16_t> m_MaskedChannels;

    TLine m_2DHitsLine;

    TLine m_PlaneLine;

    TText m_PlaneText;

    TH1* m_fe_bklm_ratio = nullptr;

    TCanvas* m_c_fe_bklm_ratio = nullptr;

    TH1* m_fe_eklm_ratio = nullptr;

    TCanvas* m_c_fe_eklm_ratio = nullptr;

    bool m_IsNullRun;

    const KLMChannelArrayIndex* m_ChannelArrayIndex;

    const KLMSectorArrayIndex* m_SectorArrayIndex;

    const KLMElementNumbers* m_ElementNumbers;

    const EKLMElementNumbers* m_EklmElementNumbers;

    DBObjPtr<KLMElectronicsMap> m_ElectronicsMap;

    MonitoringObject* m_monObj {};
 
  };

}