Monitored::HistogramFiller Class Reference

Base class for all histogram fillers. More...

#include <HistogramFiller.h>

Inheritance diagram for Monitored::HistogramFiller:

Collaboration diagram for Monitored::HistogramFiller:

Classes
struct	VariablesPack
	helper class to pass variables to fillers More...

Public Member Functions
	HistogramFiller (const HistogramDef &histDef, std::shared_ptr< IHistogramProvider > histogramProvider)
	Default constructor.
	HistogramFiller (const HistogramFiller &hf)
	Copy constructor.
virtual	~HistogramFiller ()
	Virtual destructor.
virtual unsigned	fill (const VariablesPack &) const =0
	Method that actually fills the ROOT object.
void	touch () const
	Ensure histogram exists.
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>
H *	histogram () const
template<class H, typename W, typename C, typename ... Ms>
unsigned	fill (W weight, C cut, const Ms &... m) const
	Fill histogram from IMonitoredVariable.

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

Private Member Functions
HistogramFiller &	operator= (HistogramFiller const &)=delete

Detailed Description

Base class for all histogram fillers.

Definition at line 44 of file HistogramFiller.h.

Constructor & Destructor Documentation

HistogramFiller() [1/2]

Monitored::HistogramFiller::HistogramFiller ( const HistogramDef & histDef, std::shared_ptr< IHistogramProvider > histogramProvider )

inline

Default constructor.

Parameters

histDef

Histogram definition of ROOT object

Definition at line 51 of file HistogramFiller.h.

      : m_histDef(new HistogramDef(histDef)),
        m_histogramProvider(std::move(histogramProvider)) {}

HistogramFiller() [2/2]

Monitored::HistogramFiller::HistogramFiller ( const HistogramFiller & hf )

inline

Copy constructor.

Parameters

hf	Other HistogramFiller

Definition at line 59 of file HistogramFiller.h.

      : m_histDef(hf.m_histDef),
        m_histogramProvider(hf.m_histogramProvider) {}

~HistogramFiller()

virtual Monitored::HistogramFiller::~HistogramFiller ( )

inlinevirtual

Virtual destructor.

Definition at line 66 of file HistogramFiller.h.

{}

Member Function Documentation

fill() [1/2]

virtual unsigned Monitored::HistogramFiller::fill ( const VariablesPack & ) const

pure virtual

Method that actually fills the ROOT object.

Returns

number of fills performed

Implemented in Monitored::CumulativeHistogramFiller1D, Monitored::HistogramFiller1D, Monitored::HistogramFiller2DGeneric< H >, Monitored::HistogramFiller2DGeneric< TH2 >, Monitored::HistogramFiller2DGeneric< TProfile >, Monitored::HistogramFiller2DProfile, Monitored::HistogramFillerEfficiency, Monitored::HistogramFillerRebinableAxis< HistogramFiller1D, Axis::X >, Monitored::HistogramFillerRebinableAxis< HistogramFiller2D, Axis::X >, Monitored::HistogramFillerRebinableAxis< HistogramFiller2D, Axis::Y >, Monitored::HistogramFillerRebinableAxis< HistogramFiller2DProfile, Axis::X >, Monitored::HistogramFillerRebinableAxis< HistogramFillerProfile, Axis::X >, Monitored::HistogramFillerRebinableAxis< HistogramFillerRebinable2DX, Axis::Y >, Monitored::HistogramFillerTree, and Monitored::VecHistogramFiller1D.

fill() [2/2]

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

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

inlineprotected

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 168 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;
    }

getLock()

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

inline

Definition at line 147 of file HistogramFiller.h.

                                                   {
      return std::unique_lock(m_lock);
    }

histogram()

template<class H>

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

inlineprotected

Definition at line 153 of file HistogramFiller.h.

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

histogramCutMaskName()

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

inline

Definition at line 143 of file HistogramFiller.h.

                                                  {
      return m_histDef->cutMask;
    }

histogramVariablesNames()

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

inline

Definition at line 135 of file HistogramFiller.h.

                                                                {
      return m_histDef->name;
    }

histogramWeightName()

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

inline

Definition at line 139 of file HistogramFiller.h.

                                                 {
      return m_histDef->weight;
    }

operator=()

HistogramFiller & Monitored::HistogramFiller::operator= ( HistogramFiller const & )

privatedelete

touch()

void Monitored::HistogramFiller::touch ( ) const

inline

Ensure histogram exists.

Definition at line 130 of file HistogramFiller.h.

                       {
      histogram<void>();
    }

Member Data Documentation

m_histDef

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

protected

Definition at line 180 of file HistogramFiller.h.

m_histogramProvider

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

protected

Definition at line 181 of file HistogramFiller.h.

m_lock

std::mutex Monitored::HistogramFiller::m_lock

mutableprotected

Definition at line 182 of file HistogramFiller.h.

---

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

• HistogramFiller.h