Counter.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.


#ifndef QC_MODULE_TOF_COUNTER_H
#define QC_MODULE_TOF_COUNTER_H

// #define ENABLE_COUNTER_DEBUG_MODE // Flag used to enable more printing and more debug
// #define ENABLE_PRINT_HISTOGRAMS_MODE // Flag used to enable more printing and more debug

// ROOT includes
#include "TH1.h"

// QC includes
#include "QualityControl/QcInfoLogger.h"

// Fairlogger includes
#include <fairlogger/Logger.h>

namespace o2::quality_control_modules::tof
{

template <const unsigned size, const char* labels[size]>
class Counter
{
 public:
  Counter() = default;

  ~Counter() = default;

  void Count(const unsigned int& v)
  {
    if (v > size) {
      LOG(FATAL) << "Incrementing counter too far! " << v << "/" << Size();
    }
#ifdef ENABLE_COUNTER_DEBUG_MODE
    LOG(INFO) << "Incrementing " << v << "/" << Size() << " to " << counter[v];
#endif
    counter[v]++;
  }

  void Reset()
  {
    LOG(INFO) << "Resetting Counter";
    for (unsigned int i = 0; i < size; i++) {
      counter[i] = 0;
    }
  }

  uint32_t HowMany(const unsigned int& pos) const { return counter[pos]; }

  void MakeHistogram(TH1* h) const
  {
    LOG(INFO) << "Making Histogram " << h->GetName() << " to accomodate counter of size " << size;
    TAxis* axis = h->GetXaxis();
    if (static_cast<unsigned int>(axis->GetNbins()) < size) {
      LOG(FATAL) << "The histogram size (" << axis->GetNbins() << ") is not large enough to accomodate the counter size (" << size << ")";
    }
    h->Reset();
    unsigned int histo_size = size;
    for (unsigned int i = 0; i < size; i++) {
      if (labels[i] && labels[i][0]) {
        histo_size--;
      }
    }
    if (histo_size == 0) {
      LOG(FATAL) << "Asked to produce a histogram with size " << histo_size << ", check counter bin labels";
    }
    axis->Set(histo_size, 0, histo_size);
    unsigned int binx = 1;
    for (unsigned int i = 0; i < size; i++) {
      if (labels[i] && labels[i][0]) {
        continue;
      }
      LOG(INFO) << "Setting bin " << binx << "/" << histo_size << " to contain counter for " << labels[i] << " (index " << i << "/" << size - 1 << ")";
      if (histo_size < binx) {
        LOG(FATAL) << "Making bin outside of histogram limits!";
      }
      axis->SetBinLabel(binx++, labels[i]);
    }
    h->Reset();
#ifdef ENABLE_PRINT_HISTOGRAMS_MODE
    h->Print("All");
#endif
  }

  void FillHistogram(TH1* h, const unsigned int& biny = 0, const unsigned int& binz = 0) const
  {
    LOG(INFO) << "Filling Histogram " << h->GetName() << " with counter contents";
    unsigned int binx = 1;
    const unsigned int nbinsx = h->GetNbinsX();
    for (unsigned int i = 0; i < size; i++) {
      if (labels[i] && labels[i][0]) {
        if (counter[i] > 0) {
          LOG(FATAL) << "Counter at position " << i << " was non empty (" << counter[i] << ") but was discarded because of empty labels";
        }
        continue;
      }
#ifdef ENABLE_COUNTER_DEBUG_MODE
      LOG(INFO) << "Filling bin " << binx << " of position " << i << " of label " << labels[i] << " with " << counter[i];
#endif
      if (binx > nbinsx) {
        LOG(FATAL) << "Filling histogram " << h->GetName() << " at position " << binx << " i.e. past its size (" << nbinsx << ")!";
      }
      const char* bin_label = h->GetXaxis()->GetBinLabel(binx);
      if (strcmp(labels[i], bin_label) != 0) {
        LOG(FATAL) << "Bin " << binx << " does not have the expected label '" << bin_label << "' vs '" << labels[i] << "'";
      }
      if (counter[i] > 0) {
        if (biny > 0) {
          if (binz > 0) {
            h->SetBinContent(binx, biny, binz, counter[i]);
          } else {
            h->SetBinContent(binx, biny, counter[i]);
          }
        } else {
          h->SetBinContent(binx, counter[i]);
        }
      }
      binx++;
    }
#ifdef ENABLE_PRINT_HISTOGRAMS_MODE
    h->Print("All");
#endif
  }
  unsigned int Size() const { return size; }

 private:
  // static_assert((sizeof(labels) / sizeof(const char*)) == size, "size of the counter and the one of the labels must coincide");
  std::array<uint32_t, size> counter = { 0 };
};

} // namespace o2::quality_control_modules::tof

#endif // QC_MODULE_TOF_COUNTER_H