Monitored::LumiblockHistogramProvider Class Reference

Implementation of IHistogramProvider for lumi block based histograms. More...

#include <LumiblockHistogramProvider.h>

Inheritance diagram for Monitored::LumiblockHistogramProvider:

Collaboration diagram for Monitored::LumiblockHistogramProvider:

Public Member Functions
	LumiblockHistogramProvider (GenericMonitoringTool *const gmTool, std::shared_ptr< HistogramFactory > factory, const HistogramDef &histDef)
	Constructor.
TNamed *	histogram () override
	Getter of ROOT object.

Private Attributes
GenericMonitoringTool *const	m_gmTool
std::shared_ptr< HistogramFactory >	m_factory
const HistogramDef	m_histDef
std::map< unsigned, std::pair< HistogramDef, TNamed * > >	m_hists
	Map storing upper end of lumi page (or lumiblock if depth==1) with the corresponding histogram definition and pointer of currently active histograms.
std::mutex	m_mutex
	! mutex for the map

Static Private Attributes
static const unsigned	s_deregDelay {5}
	Number of lumiblocks before histogram gets deregistered/deleted.

Detailed Description

Implementation of IHistogramProvider for lumi block based histograms.

This provider produces histograms that groups data based on current lumi block and defined history depth. Note: kLBNHistoryDepth must be defined in histogram definition options

Definition at line 25 of file LumiblockHistogramProvider.h.

Constructor & Destructor Documentation

LumiblockHistogramProvider()

Monitored::LumiblockHistogramProvider::LumiblockHistogramProvider ( GenericMonitoringTool *const gmTool, std::shared_ptr< HistogramFactory > factory, const HistogramDef & histDef )

inline

Constructor.

Parameters

gmTool	Source of the lumi block info
factory	ROOT object factory
def	General definition of a histogram

Definition at line 34 of file LumiblockHistogramProvider.h.

      : IHistogramProvider()
      , m_gmTool(gmTool)
      , m_factory(std::move(factory))
      , m_histDef(histDef)
      {}

Member Function Documentation

histogram()

TNamed * Monitored::LumiblockHistogramProvider::histogram ( )

inlineoverridevirtual

Getter of ROOT object.

Return the histogram for the current lumiblock. Create a new one if needed. A configurable number of histograms is kept active at a given time.

Returns

ROOT object

Implements Monitored::IHistogramProvider.

Definition at line 51 of file LumiblockHistogramProvider.h.

                                 {
 
      const unsigned lumiBlock = m_gmTool->lumiBlock();
      std::scoped_lock lock(m_mutex);  // access to m_hists
 
      /* Find existing histogram. In the unlikely case of a very old lumiblock
         being processed, it would be filled into the oldest histogram. */
      const auto it = m_hists.lower_bound(lumiBlock);
      if (it!=m_hists.end() && it->second.second!=nullptr) {
        return it->second.second;
      }
 
      if (m_histDef.kLBNHistoryDepth <= 0) {
        throw HistogramException("Histogram >"+ m_histDef.path + "< has invalid kLBNHistoryDepth.");
      }
 
      const int historyDepth = m_histDef.kLBNHistoryDepth;
      const unsigned lumiPage = lumiBlock/historyDepth;
 
      // Helpers to calculate min/max lumiblock for a given "page" (histogram)
      auto minLumiBlock = [=](unsigned lumiPage) { return lumiPage * historyDepth; };
      auto maxLumiBlock = [=](unsigned lumiPage) { return (lumiPage+1) * historyDepth - 1; };
 
      // create new histogram definition with updated alias
      HistogramDef def = m_histDef;
      def.alias += "_LB" + std::to_string(minLumiBlock(lumiPage));
      if (historyDepth > 1) {
        def.alias += "_" + std::to_string(maxLumiBlock(lumiPage));
      }
 
      TNamed* hist = m_factory->create(def);
      m_hists.emplace(maxLumiBlock(lumiPage), std::make_pair(std::move(def), hist));
 
      // deregister old histograms
      for (auto it = m_hists.begin(); it!=m_hists.end();) {
        const unsigned maxLB = it->first;
        if (maxLB + s_deregDelay <= lumiBlock) {
          m_factory->remove(it->second.first);
          it = m_hists.erase(it);  // this advances iterator by one
        }
        else break;  // don't need to search further as std::map is sorted
      }
 
      return hist;
    }

Member Data Documentation

m_factory

std::shared_ptr<HistogramFactory> Monitored::LumiblockHistogramProvider::m_factory

private

Definition at line 99 of file LumiblockHistogramProvider.h.

m_gmTool

GenericMonitoringTool* const Monitored::LumiblockHistogramProvider::m_gmTool

private

Definition at line 98 of file LumiblockHistogramProvider.h.

m_histDef

const HistogramDef Monitored::LumiblockHistogramProvider::m_histDef

private

Definition at line 100 of file LumiblockHistogramProvider.h.

m_hists

std::map<unsigned, std::pair<HistogramDef, TNamed*> > Monitored::LumiblockHistogramProvider::m_hists

private

Map storing upper end of lumi page (or lumiblock if depth==1) with the corresponding histogram definition and pointer of currently active histograms.

Note: map is sorted by key (lumiblock)

Definition at line 117 of file LumiblockHistogramProvider.h.

m_mutex

std::mutex Monitored::LumiblockHistogramProvider::m_mutex

private

! mutex for the map

Definition at line 118 of file LumiblockHistogramProvider.h.

s_deregDelay

const unsigned Monitored::LumiblockHistogramProvider::s_deregDelay {5}

staticprivate

Number of lumiblocks before histogram gets deregistered/deleted.

This number needs to be set large enough for each histogram to be at least published once in the online. E.g. with a publication interval of 80 seconds, it needs to be at least 2 (see ADHI-4905).

Definition at line 108 of file LumiblockHistogramProvider.h.

{5};

---

The documentation for this class was generated from the following file:

• LumiblockHistogramProvider.h