ATLAS Offline Software
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Monitored::HistogramFiller Class Referenceabstract

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. More...
 
 HistogramFiller (const HistogramFiller &hf)
 Copy constructor. More...
 
virtual ~HistogramFiller ()
 Virtual destructor. More...
 
virtual unsigned fill (const VariablesPack &) const =0
 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 >
H * histogram () const
 
std::pair< size_t, std::function< bool(size_t)> > getCutMaskFunc (const Monitored::IMonitoredVariable *mask) const
 
template<class H , typename W , typename C , typename ... Ms>
unsigned fill (W weight, C cut, const Ms &... m) const
 Fill histogram from IMonitoredVariable. More...
 

Protected Attributes

std::shared_ptr< HistogramDefm_histDef
 
std::shared_ptr< IHistogramProviderm_histogramProvider
 
std::mutex m_lock
 

Private Member Functions

HistogramFilleroperator= (HistogramFiller const &)=delete
 

Detailed Description

Base class for all histogram fillers.

Definition at line 43 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
histDefHistogram definition of ROOT object

Definition at line 50 of file HistogramFiller.h.

51  : m_histDef(new HistogramDef(histDef)),
52  m_histogramProvider(histogramProvider) {}

◆ HistogramFiller() [2/2]

Monitored::HistogramFiller::HistogramFiller ( const HistogramFiller hf)
inline

Copy constructor.

Parameters
hfOther HistogramFiller

Definition at line 58 of file HistogramFiller.h.

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

◆ ~HistogramFiller()

virtual Monitored::HistogramFiller::~HistogramFiller ( )
inlinevirtual

Virtual destructor.

Definition at line 65 of file HistogramFiller.h.

65 {}

Member Function Documentation

◆ fill() [1/2]

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

◆ fill() [2/2]

template<class H , typename W , typename C , typename ... Ms>
unsigned Monitored::HistogramFiller::fill ( weight,
cut,
const Ms &...  m 
) const
inlineprotected

Fill histogram from IMonitoredVariable.

Supports arbitrary dimensions and double/string representation.

Template Parameters
Hhistogram type (TH1, TH2, ...)
Parameters
weightweight accessor (use detail::noWeight if not needed)
cutcut mask accessor (use detail::noCut if not needed)
m...IMonitoredVariable list to fill from

Definition at line 184 of file HistogramFiller.h.

184  {
185  auto hist = this->histogram<H>();
186 
187  size_t i = 0;
188  for (; i < std::max({m.size()...}); ++i ) {
189  if ( cut(i) ) {
190  detail::doFill(hist, weight, i, m...);
191  }
192  }
193  return i;
194  }

◆ getCutMaskFunc()

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

Definition at line 155 of file HistogramFiller.h.

155  {
156  std::function<bool(size_t)> cutMaskValue = [] (size_t){ return true; }; // default is true
157  size_t maskSize = 1;
158  if ( mask != nullptr ) {
159  maskSize = mask->size();
160  if (maskSize == 1) {
161  if (!mask->get(0)) {
162  // globally fails cut; zero first argument is a signal that one can abort
163  return std::make_pair(0, [](size_t){ return false; });
164  // otherwise, default cutMaskValue is sufficient
165  }
166  } else {
167  return std::make_pair(maskSize, [mask](size_t i){ return static_cast<bool>(mask->get(i)); });
168  }
169  }
170  return std::make_pair(maskSize, cutMaskValue);
171  }

◆ getLock()

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

Definition at line 144 of file HistogramFiller.h.

144  {
145  return std::unique_lock(m_lock);
146  }

◆ histogram()

template<class H >
H* Monitored::HistogramFiller::histogram ( ) const
inlineprotected

Definition at line 150 of file HistogramFiller.h.

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

◆ histogramCutMaskName()

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

Definition at line 140 of file HistogramFiller.h.

140  {
141  return m_histDef->cutMask;
142  }

◆ histogramVariablesNames()

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

Definition at line 132 of file HistogramFiller.h.

132  {
133  return m_histDef->name;
134  }

◆ histogramWeightName()

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

Definition at line 136 of file HistogramFiller.h.

136  {
137  return m_histDef->weight;
138  }

◆ operator=()

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

◆ touch()

void Monitored::HistogramFiller::touch ( ) const
inline

Ensure histogram exists.

Definition at line 127 of file HistogramFiller.h.

127  {
128  histogram<void>();
129  }

Member Data Documentation

◆ m_histDef

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

Definition at line 196 of file HistogramFiller.h.

◆ m_histogramProvider

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

Definition at line 197 of file HistogramFiller.h.

◆ m_lock

std::mutex Monitored::HistogramFiller::m_lock
mutableprotected

Definition at line 198 of file HistogramFiller.h.


The documentation for this class was generated from the following file:
python.SystemOfUnits.m
int m
Definition: SystemOfUnits.py:91
Monitored::HistogramFiller::m_histDef
std::shared_ptr< HistogramDef > m_histDef
Definition: HistogramFiller.h:196
Monitored::HistogramFiller::m_histogramProvider
std::shared_ptr< IHistogramProvider > m_histogramProvider
Definition: HistogramFiller.h:197
max
constexpr double max()
Definition: ap_fixedTest.cxx:33
plotmaker.hist
hist
Definition: plotmaker.py:148
python.utils.AtlRunQueryLookup.mask
string mask
Definition: AtlRunQueryLookup.py:460
dqt_zlumi_pandas.weight
int weight
Definition: dqt_zlumi_pandas.py:189
Monitored::detail::doFill
void doFill(H *hist, W weight, size_t i, const M &m1, const Ms &... m)
Perform (arbitrary dimension) histogram fill with weight.
Definition: HistogramFillerUtils.h:164
H
#define H(x, y, z)
Definition: MD5.cxx:114
ROBbits::maskSize
const uint32_t maskSize
Definition: TrigMonROBData.cxx:17
lumiFormat.i
int i
Definition: lumiFormat.py:85
BindingsTest.cut
cut
This script demonstrates how to call a C++ class from Python Also how to use PyROOT is shown.
Definition: BindingsTest.py:13
Monitored::HistogramFiller::m_lock
std::mutex m_lock
Definition: HistogramFiller.h:198
xAOD::bool
setBGCode setTAP setLVL2ErrorBits bool
Definition: TrigDecision_v1.cxx:60