HistogramFillerRebinable.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef AthenaMonitoringKernel_HistogramFiller_HistogramFillerRebinable1D_h
#define AthenaMonitoringKernel_HistogramFiller_HistogramFillerRebinable1D_h
 
#include "AthenaMonitoringKernel/OHLockedHist.h"
#include "HistogramFiller1D.h"
#include "HistogramFiller2D.h"
#include "HistogramFillerUtils.h"
 
#include <cmath>
 
namespace Monitored {

  template<typename BASE, Monitored::Axis AXIS>
  class HistogramFillerRebinableAxis : public BASE {
  public:
 
    HistogramFillerRebinableAxis(const HistogramDef& definition, std::shared_ptr<IHistogramProvider> provider)
      : BASE(definition, std::move(provider)) {
      if (definition.kAddBinsDynamically) {
        m_rebinMode = RebinMode::AddBins;
      } else {
        m_rebinMode = RebinMode::ExtendAxes;
      }
    }
 
    virtual unsigned fill( const HistogramFiller::VariablesPack& vars ) const override {
      if (AXIS >= vars.size() ) { return 0; }
      if (vars[AXIS]->size()==0) { return 0; }
 
      // check if any of the cutmasks are non-zero before attempting any rebinning
      if (vars.cut) {
        bool anyTrue = false;
        for(size_t i=0; i<vars.cut->size(); i++) {
          anyTrue |= static_cast<bool>(vars.cut->get(i));
        }
        if(!anyTrue) { return 0; }
      }
 
      double min = std::numeric_limits<double>::max();
      double max = std::numeric_limits<double>::min();
      const IMonitoredVariable& var = *vars[AXIS];
      for (size_t i = 0; i < var.size(); i++) {
        const double v = var.get(i);
        if (v < min) min = v;
        if (v > max) max = v;
      }
 
      TH1* hist = this->template histogram<TH1>();
      TAxis* axis = detail::getAxis<AXIS>(hist);
      if (m_rebinMode == RebinMode::AddBins) {
        if (Monitored::detail::shouldRebinHistogram(axis, max)) {
          Monitored::detail::rebinHistogram<AXIS>(hist, max);
        }
      } else {
        hist->SetCanExtend(detail::axis_bit[AXIS]);
        // ExtendAxis is an extremely expensive operation; only call if necessary
        // Rebinning requires a lock on the global ROOT directory state
        std::scoped_lock<std::mutex> dirLock(HistogramFactory::globalROOTMutex());
        if (max >= axis->GetXmax()) hist->ExtendAxis(max, axis);
        if (min < axis->GetXmin()) hist->ExtendAxis(min, axis);
      }
      return BASE::fill( vars );
    }
 
  private:
    enum class RebinMode { AddBins, ExtendAxes };
    RebinMode m_rebinMode;
  };

  typedef HistogramFillerRebinableAxis<HistogramFiller1D, Axis::X> HistogramFillerRebinable1D;
  typedef HistogramFillerRebinableAxis<HistogramFiller2D, Axis::X> HistogramFillerRebinable2DX;
  typedef HistogramFillerRebinableAxis<HistogramFiller2D, Axis::Y> HistogramFillerRebinable2DY;
  typedef HistogramFillerRebinableAxis<HistogramFillerRebinable2DX, Axis::Y> HistogramFillerRebinable2D;
}
 
#endif /* AthenaMonitoringKernel_HistogramFiller_HistogramFillerRebinable1D_h */