DQMHistAnalysisECLSummary.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
#include <dqm/core/DQMHistAnalysis.h>
 
//ROOT
#include <TCanvas.h>
#include <TH2F.h>
#include <TText.h>
#include <TExec.h>
 
//std
#include <set>
 
//ECL
#include <ecl/mapper/ECLChannelMapper.h>
#include <ecl/geometry/ECLNeighbours.h>
 
namespace Belle2 {

 
  class DQMHistAnalysisECLSummaryModule final : public DQMHistAnalysisModule { 
 
  public:

    DQMHistAnalysisECLSummaryModule();

    void initialize() override final;
    void beginRun() override final;
    void event() override final;
    void endRun() override final;
    void terminate() override final;

    std::map<int, int> getSuspiciousChannels(TH1* hist, double total_events,
                                             const std::vector< std::vector<short> >& neighbours,
                                             double max_deviation, bool occupancy_histogram);
 
  private:
    struct ECLAlarmType {
      std::string name; 
      std::string title; 
      int warning_limit; 
      int alarm_limit; 
      double required_statistics; 
    };

    static const int c_max_masked_channels = 200;
    struct dbr_sts_long_array {
      dbr_short_t     status;                       
      dbr_short_t     severity;                     
      dbr_long_t      value[c_max_masked_channels]; 
    };

    std::pair<int, ECLAlarmType> getAlarmByName(std::string name);

    void updateAlarmConfig();

    bool getMaskedChannels(std::map<std::string, dbr_sts_long_array>& mask_info);
 

    std::vector< std::vector<int> > updateAlarmCounts(bool update_mirabelle = false);

    std::map<int, int> getChannelsWithOccupancyProblems();

    std::map<int, int> getChannelsWithChi2Problems();

    void drawGrid(TH2* hist);
 
  private:
    std::string m_pvPrefix;
    bool m_useChannelMask;
    double m_maxDeviationForOccupancy;
    double m_maxDeviationForChi2;
    bool m_onlyIfUpdated;

    std::vector<ECLAlarmType> m_ecl_alarms;

    std::map<std::string, std::set<int> > m_mask;

    double m_total_events = 0;

    TH2F* h_channels_summary = nullptr;
    TCanvas* c_channels_summary = nullptr;
    std::vector<TText*> m_labels;
    TExec* m_ecl_style = nullptr;
    TExec* m_default_style = nullptr;
    ECL::ECLChannelMapper m_mapper;
    ECL::ECLNeighbours m_neighbours_obj;

    TCanvas* c_occupancy = nullptr;
    TCanvas* c_bad_chi2 = nullptr;
    TH1F* h_bad_occ_overlay = nullptr;  
    TH1F* h_bad_chi2_overlay = nullptr; 
    TH1F* h_bad_occ_overlay_green = nullptr;  
    TH1F* h_bad_chi2_overlay_green = nullptr; 
 
    MonitoringObject* m_monObj = nullptr; 
  };

} // end namespace Belle2