ATLAS Offline Software
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Monitored::HistogramFiller2DProfile Class Reference

Filler for profile 2D histogram. More...

#include <HistogramFiller2DProfile.h>

Inheritance diagram for Monitored::HistogramFiller2DProfile:
Collaboration diagram for Monitored::HistogramFiller2DProfile:

Public Member Functions

 HistogramFiller2DProfile (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

Filler for profile 2D histogram.

Definition at line 17 of file HistogramFiller2DProfile.h.

Constructor & Destructor Documentation

◆ HistogramFiller2DProfile()

Monitored::HistogramFiller2DProfile::HistogramFiller2DProfile ( const HistogramDef &  definition,
std::shared_ptr< IHistogramProvider >  provider 
)
inline

Definition at line 19 of file HistogramFiller2DProfile.h.

20  : HistogramFiller(definition, std::move(provider)) {}

Member Function Documentation

◆ fill() [1/2]

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

Method that actually fills the ROOT object.

Returns
number of fills performed

Implements Monitored::HistogramFiller.

Definition at line 23 of file HistogramFiller2DProfile.h.

23  {
24  if ( vars.size() != 3) {
25  return 0;
26  }
27 
28  // handling of the cutmask
29  auto cutMaskValuePair = getCutMaskFunc(vars.cut);
30  if (cutMaskValuePair.first == 0) { return 0; }
31  const auto & cutMaskAccessor = cutMaskValuePair.second;
32 
33  if (vars.weight) {
34  // Weighted fill
35  auto weightAccessor = [&](size_t i){ return vars.weight->get(i); };
36  const size_t size0 = vars.var[0]->size();
37  const size_t size1 = vars.var[1]->size();
38  const size_t size2 = vars.var[2]->size();
39  const size_t sizeWeight = vars.weight->size();
40  if (ATH_UNLIKELY(size0 > 1 && size1 > 1 && size2 > 1 &&
41  sizeWeight > 1 && size0 != sizeWeight)) {
42  MsgStream log(Athena::getMessageSvc(), "HistogramFiller2DProfile");
43  log << MSG::ERROR << "Weight does not match the size of plotted variable: "
44  << vars.weight->size() << " " << size0 << endmsg;
45  return 0;
46  }
47  // Need to fill here while weightVector is still in scope
48  if (not vars.cut) return HistogramFiller::fill<TProfile2D>(weightAccessor, detail::noCut, *vars.var[0], *vars.var[1], *vars.var[2]);
49  else return HistogramFiller::fill<TProfile2D>(weightAccessor, cutMaskAccessor, *vars.var[0], *vars.var[1], *vars.var[2]);
50  }
51  // Unweighted fill
52  if (not vars.cut) return HistogramFiller::fill<TProfile2D>(detail::noWeight, detail::noCut, *vars.var[0], *vars.var[1], *vars.var[2]);
53  else return HistogramFiller::fill<TProfile2D>(detail::noWeight, cutMaskAccessor, *vars.var[0], *vars.var[1], *vars.var[2]);
54  }

◆ 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
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 185 of file HistogramFiller.h.

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

◆ getCutMaskFunc()

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

Definition at line 156 of file HistogramFiller.h.

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

◆ getLock()

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

Definition at line 145 of file HistogramFiller.h.

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

◆ histogram()

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

Definition at line 151 of file HistogramFiller.h.

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

◆ histogramCutMaskName()

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

Definition at line 141 of file HistogramFiller.h.

141  {
142  return m_histDef->cutMask;
143  }

◆ histogramVariablesNames()

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

Definition at line 133 of file HistogramFiller.h.

133  {
134  return m_histDef->name;
135  }

◆ histogramWeightName()

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

Definition at line 137 of file HistogramFiller.h.

137  {
138  return m_histDef->weight;
139  }

◆ touch()

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

Ensure histogram exists.

Definition at line 128 of file HistogramFiller.h.

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

Member Data Documentation

◆ m_histDef

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

Definition at line 197 of file HistogramFiller.h.

◆ m_histogramProvider

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

Definition at line 198 of file HistogramFiller.h.

◆ m_lock

std::mutex Monitored::HistogramFiller::m_lock
mutableprotectedinherited

Definition at line 199 of file HistogramFiller.h.

The documentation for this class was generated from the following file:
Monitored::HistogramFiller::m_histDef
std::shared_ptr< HistogramDef > m_histDef
Definition: HistogramFiller.h:197
Monitored::HistogramFiller::m_histogramProvider
std::shared_ptr< IHistogramProvider > m_histogramProvider
Definition: HistogramFiller.h:198
max
constexpr double max()
Definition: ap_fixedTest.cxx:33
plotmaker.hist
hist
Definition: plotmaker.py:148
ATH_UNLIKELY
#define ATH_UNLIKELY(x)
Definition: AthUnlikelyMacros.h:17
Athena::getMessageSvc
IMessageSvc * getMessageSvc(bool quiet=false)
Definition: getMessageSvc.cxx:20
python.utils.AtlRunQueryLookup.mask
string mask
Definition: AtlRunQueryLookup.py:459
dqt_zlumi_pandas.weight
int weight
Definition: dqt_zlumi_pandas.py:190
Monitored::detail::noCut
auto noCut
no cut for filling
Definition: HistogramFillerUtils.h:29
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
endmsg
#define endmsg
Definition: AnalysisConfig_Ntuple.cxx:63
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:199
Monitored::detail::noWeight
auto noWeight
no weight for filling
Definition: HistogramFillerUtils.h:28
python.CaloCondTools.log
log
Definition: CaloCondTools.py:20
Monitored::HistogramFiller::getCutMaskFunc
std::pair< size_t, std::function< bool(size_t)> > getCutMaskFunc(const Monitored::IMonitoredVariable *mask) const
Definition: HistogramFiller.h:156
xAOD::bool
setBGCode setTAP setLVL2ErrorBits bool
Definition: TrigDecision_v1.cxx:60
Monitored::HistogramFiller::HistogramFiller
HistogramFiller(const HistogramDef &histDef, std::shared_ptr< IHistogramProvider > histogramProvider)
Default constructor.
Definition: HistogramFiller.h:51
python.SystemOfUnits.m
float m
Definition: SystemOfUnits.py:106
Generated on Mon Sep 1 2025 22:03:26 for ATLAS Offline Software by   doxygen 1.8.18