Monitored::HistogramFiller2DGeneric< H > Class Template Reference

Generic filler for 2D histogram. More...

#include <HistogramFiller2D.h>

Inheritance diagram for Monitored::HistogramFiller2DGeneric< H >:

Collaboration diagram for Monitored::HistogramFiller2DGeneric< H >:

Public Member Functions
	HistogramFiller2DGeneric (const HistogramDef &definition, std::shared_ptr< IHistogramProvider > provider)
virtual unsigned	fill (const HistogramFiller::VariablesPack &vars) const override
	Method that actually fills the ROOT object. More...
void	touch () const
	Ensure histogram exists. More...
const std::vector< std::string > &	histogramVariablesNames () const
const std::string &	histogramWeightName () const
const std::string &	histogramCutMaskName () const
const std::unique_lock< std::mutex >	getLock () const

Protected Member Functions
template<class H , typename W , typename C , typename ... Ms>
unsigned	fill (W weight, C cut, const Ms &... m) const
	Fill histogram from IMonitoredVariable. More...
template<class H >
H *	histogram () const
std::pair< size_t, std::function< bool(size_t)> >	getCutMaskFunc (const Monitored::IMonitoredVariable *mask) const

Protected Attributes
std::shared_ptr< HistogramDef >	m_histDef
std::shared_ptr< IHistogramProvider >	m_histogramProvider
std::mutex	m_lock

Detailed Description

template<typename H>
class Monitored::HistogramFiller2DGeneric< H >

Generic filler for 2D histogram.

Template Parameters

H	Type of 2D histogram (TH2, TProfile)

Definition at line 23 of file HistogramFiller2D.h.

Constructor & Destructor Documentation

HistogramFiller2DGeneric()

template<typename H >

Monitored::HistogramFiller2DGeneric< H >::HistogramFiller2DGeneric ( const HistogramDef &  definition, std::shared_ptr< IHistogramProvider >  provider  )

inline

Definition at line 25 of file HistogramFiller2D.h.

      : HistogramFiller(definition, provider) {}

Member Function Documentation

fill() [1/2]

template<typename H >

virtual unsigned Monitored::HistogramFiller2DGeneric< H >::fill ( const HistogramFiller::VariablesPack &  ) const

inlineoverridevirtual

Method that actually fills the ROOT object.

Returns

number of fills performed

Implements Monitored::HistogramFiller.

Definition at line 28 of file HistogramFiller2D.h.

                                                                                    {
      if (ATH_UNLIKELY(vars.var[0] == nullptr or vars.var[1] == nullptr )) return 0;
 
      const size_t size0 = vars.var[0]->size();
      const size_t size1 = vars.var[1]->size();
 
      if (ATH_UNLIKELY(size0 == 0 || size1 == 0)) {
        // nothing to do
        return 0;
      }
 
      if (ATH_UNLIKELY(size0 > 1 && size1 > 1 && size0 != size1)) {
        MsgStream log(Athena::getMessageSvc(), "HistogramFiller2D");
        log << MSG::ERROR << "Mismatch of provided vector sizes "
            << size0 << "," << size1 << " for " << m_histDef->alias << endmsg;
        return 0;
      }
 
      std::function<bool(size_t)> cutMaskAccessor;
      if (vars.cut) {
        // handling of the cutmask
        auto cutMaskValuePair = getCutMaskFunc(vars.cut);
        if (cutMaskValuePair.first == 0) { return 0; }
        if (ATH_UNLIKELY(size0 > 1 && size1 > 1 &&
                         cutMaskValuePair.first > 1 && size0 != cutMaskValuePair.first)) {
          MsgStream log(Athena::getMessageSvc(), "HistogramFiller2D");
          log << MSG::ERROR << "CutMask does not match the size of plotted variable: "
              << cutMaskValuePair.first << " " << size0 << endmsg;
          return 0;
        }
        cutMaskAccessor = cutMaskValuePair.second;
      }
 
      if (vars.weight) {
        auto weightAccessor = [&](size_t i){ return vars.weight->get(i); };
        if (ATH_UNLIKELY(size0 > 1 && size1 > 1 &&
                         vars.weight->size() > 1 && size0 != vars.weight->size())) {
          MsgStream log(Athena::getMessageSvc(), "HistogramFiller2D");
          log << MSG::ERROR << "Weight does not match the size of plotted variable: "
              << vars.weight->size() << " " << size0 << endmsg;
          return 0;
        }
        // Need to fill here while weightVector is still in scope
        if (not vars.cut) return HistogramFiller::fill<H>(weightAccessor, detail::noCut, *vars.var[0], *vars.var[1]);
        else                  return HistogramFiller::fill<H>(weightAccessor, cutMaskAccessor, *vars.var[0], *vars.var[1]);
      }
 
      if (not vars.cut) return HistogramFiller::fill<H>(detail::noWeight, detail::noCut, *vars.var[0], *vars.var[1]);
      else                  return HistogramFiller::fill<H>(detail::noWeight, cutMaskAccessor, *vars.var[0], *vars.var[1]);
    }

fill() [2/2]

template<class H , typename W , typename C , typename ... Ms>

unsigned Monitored::HistogramFiller::fill ( W  weight, C  cut, const Ms &...  m  ) const

inlineprotectedinherited

Fill histogram from IMonitoredVariable.

Supports arbitrary dimensions and double/string representation.

Template Parameters

H	histogram type (TH1, TH2, ...)

Parameters

weight	weight accessor (use detail::noWeight if not needed)
cut	cut mask accessor (use detail::noCut if not needed)
m...	IMonitoredVariable list to fill from

Definition at line 184 of file HistogramFiller.h.

                                                         {
      auto hist = this->histogram<H>();
 
      size_t i = 0;
      for (; i < std::max({m.size()...}); ++i ) {
        if ( cut(i) ) {
          detail::doFill(hist, weight, i, m...);
        }
      }
      return i;
    }

getCutMaskFunc()

std::pair<size_t, std::function<bool(size_t)> > Monitored::HistogramFiller::getCutMaskFunc ( const Monitored::IMonitoredVariable *  mask ) const

inlineprotectedinherited

Definition at line 155 of file HistogramFiller.h.

                                                                                                              {
      std::function<bool(size_t)> cutMaskValue = [] (size_t){ return true; }; // default is true
      size_t maskSize = 1;
      if ( mask != nullptr ) {
        maskSize = mask->size();
        if (maskSize == 1) {
          if (!mask->get(0)) {
            // globally fails cut; zero first argument is a signal that one can abort
            return std::make_pair(0, [](size_t){ return false; });
            // otherwise, default cutMaskValue is sufficient
          }
        } else {
          return std::make_pair(maskSize, [mask](size_t i){ return static_cast<bool>(mask->get(i)); });
        }
      }
      return std::make_pair(maskSize, cutMaskValue);
    }

getLock()

const std::unique_lock<std::mutex> Monitored::HistogramFiller::getLock ( ) const

inlineinherited

Definition at line 144 of file HistogramFiller.h.

                                                   {
      return std::unique_lock(m_lock);
    }

histogram()

template<class H >

H* Monitored::HistogramFiller::histogram ( ) const

inlineprotectedinherited

Definition at line 150 of file HistogramFiller.h.

                         {
      return static_cast<H*>(m_histogramProvider->histogram());
    }

histogramCutMaskName()

const std::string& Monitored::HistogramFiller::histogramCutMaskName ( ) const

inlineinherited

Definition at line 140 of file HistogramFiller.h.

                                                  {
      return m_histDef->cutMask;
    }

histogramVariablesNames()

const std::vector<std::string>& Monitored::HistogramFiller::histogramVariablesNames ( ) const

inlineinherited

Definition at line 132 of file HistogramFiller.h.

                                                                {
      return m_histDef->name;
    }

histogramWeightName()

const std::string& Monitored::HistogramFiller::histogramWeightName ( ) const

inlineinherited

Definition at line 136 of file HistogramFiller.h.

                                                 {
      return m_histDef->weight;
    }

touch()

void Monitored::HistogramFiller::touch ( ) const

inlineinherited

Ensure histogram exists.

Definition at line 127 of file HistogramFiller.h.

                       {
      histogram<void>();
    }

Member Data Documentation

m_histDef

std::shared_ptr<HistogramDef> Monitored::HistogramFiller::m_histDef

protectedinherited

Definition at line 196 of file HistogramFiller.h.

m_histogramProvider

std::shared_ptr<IHistogramProvider> Monitored::HistogramFiller::m_histogramProvider

protectedinherited

Definition at line 197 of file HistogramFiller.h.

m_lock

std::mutex Monitored::HistogramFiller::m_lock

mutableprotectedinherited

Definition at line 198 of file HistogramFiller.h.

---

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

• HistogramFiller2D.h