ATLAS Offline Software
Loading...
Searching...
No Matches
CounterThread Class Reference

Concrete implimentation of Counter to monitor all algorithms executing on a single thread. More...

#include <CounterThread.h>

Inheritance diagram for CounterThread:
Collaboration diagram for CounterThread:

Public Member Functions

 CounterThread ()=delete
 Forbid default constructor.
 CounterThread (const std::string &name, const MonitorBase *parent)
 Construct counter.
virtual ~CounterThread ()=default
 Default destructor.
CounterThreadoperator= (const CounterThread &)=delete
 Forbid assignment.
 CounterThread (const CounterThread &)=delete
 Forbid copy.
virtual StatusCode newEvent (const CostData &data, size_t index, const float weight=1.0) override
 Concrete implementation.
StatusCode postProcess (float weight=1.0)
 Apply post-processing to the Counter, before endEvent is called.
uint64_t getLowTimestamp () const
 Get the lowest timestamp of this single thread.
uint64_t getHighTimestamp () const
 Get the highest timestamp of this single thread.
void setAllThreadsTimestamps (uint64_t low, uint64_t high)
 Set the low and high timestamps over all threads.
const std::string & getName () const
 Getter for Counter's name.
const MonitorBasegetParent () const
 Return cached non-owning const ptr to this Counter's parent Monitor.
bool variableExists (const std::string &name) const
 Check if a variable of a given name exists.
VariablegetVariable (const std::string &name)
 Returns a mutable reference to a named Variable.
StatusCode fill (const std::string &name, float value, float weight=1.0)
 Fill (for per-Call) or accumulate in a buffer (for per-Event) a quantity histogrammed by a named Variable.
StatusCode fill (const std::string &name, float xvalue, float yvalue, float weight)
 Fill (for per-Call) or accumulate in a buffer (for per-Event) a quantity histogrammed by a named Variable.
StatusCode increment (const std::string &name, float weight=1.0)
 Convenience function.
StatusCode setDenominator (const std::string &name, float value)
 Optional for per-Event Variables.
virtual StatusCode endEvent (float weight=1.0)
 Called by the framework.

Public Attributes

uint64_t m_lowTimestamp
 Records the lowest timestamp seen on this single thread in an event.
uint64_t m_highTimestamp
 Records the highest timestamp seen on this single thread in an event.
uint64_t m_globalLowTimestamp
 Records the lowest timestamp seen over all threads in an event.
uint64_t m_globalHighTimestamp
 Records the highest timestamp seen over all threads in an event.

Protected Member Functions

void regHistogram (const std::string &name, const std::string &title, const VariableType type=VariableType::kPerCall, const LogType xaxis=kLog, const float min=0.1, const float max=1000000., const size_t bins=70)
 Book a histogram for this Counter, to be filled in per-event monitoring.
void regHistogram (const std::string &name, const std::string &title, const VariableType type, const LogType xaxis, const float xmin, const float xmax, const size_t xbins, const LogType yaxis, const float ymin, const float ymax, const size_t ybins)
 Book a 2D histogram for this Counter, to be filled in per-event monitoring.
void regTProfile (const std::string &name, const std::string &title, const VariableType type=VariableType::kPerCall, const LogType xaxis=kLog, const float min=0.1, const float max=1000000., const size_t bins=70)
 Book a TProfile for this Counter, to be filled in per-event monitoring.
TH1 * bookGetPointer (TH1 *hist, const std::string &tDir="") const
 Appends Counter name (to histogram path) and forwards histogram book request to parent Monitor.
float timeToMilliSec (const uint64_t start, const uint64_t stop) const
 Helper function.

Private Attributes

const std::string m_name
 Counter's name.
const MonitorBasem_parent
 Counter's parent Monitor.
std::unordered_map< std::string, Variablem_variables
 Store of Counter's Variables.

Detailed Description

Concrete implimentation of Counter to monitor all algorithms executing on a single thread.

Definition at line 14 of file CounterThread.h.

Constructor & Destructor Documentation

◆ CounterThread() [1/3]

CounterThread::CounterThread ( )
delete

Forbid default constructor.

◆ CounterThread() [2/3]

CounterThread::CounterThread ( const std::string & name,
const MonitorBase * parent )

Construct counter.

Parameters
[in]nameCounter's name
[in]parentCounter's parent monitor, cached non-owning pointer.

Definition at line 9 of file CounterThread.cxx.

10 : CounterBase(name, parent), m_lowTimestamp(std::numeric_limits<uint64_t>::max()), m_highTimestamp(0),
11 m_globalLowTimestamp(std::numeric_limits<uint64_t>::max()), m_globalHighTimestamp(0)
12{
13 regHistogram("AlgTime_perEvent", "Algorithm CPU Time/Event;Time [ms];Events", VariableType::kPerEvent);
14 regHistogram("FrameworkTime_perEvent", "Framework CPU Time/Event;Time [ms];Events", VariableType::kPerEvent);
15 regHistogram("UnmonitoredTime_perEvent", "Unmonitored CPU Time/Event;Time [ms];Events", VariableType::kPerEvent);
16 regHistogram("WallTime_perEvent", "Total walltime from HLT start to stop/Event;Time [ms];Events", VariableType::kPerEvent);
17
18 regHistogram("AlgTime_perEventFractional", "Algorithm CPU Time Fractional;Fractional Time;Events", VariableType::kPerEvent, kLinear, 0., 1.);
19 regHistogram("FrameworkTime_perEventFractional", "Framework Time/Event CPU Time Fractional;Fractional Time;Events", VariableType::kPerEvent, kLinear, 0., 1.);
20 regHistogram("FrameworkTime_perEventFractional_vs_TotalTime_perEvent", "Framework Fractional Time vs Total Time/Event;Framework Time/Event CPU Time Fractional;Total Time/Event CPU Time Fractional;Events", VariableType::kPerEvent, kLinear, 0., 1., 70, kLog, 0.1, 1000000., 70);
21 regHistogram("AlgTime_perEventFractional_vs_TotalTime_perEvent", "Algorithm Fractional Time vs Total Time/Event;Algorithm Time/Event CPU Time Fractional;Total Time/Event CPU Time Fractional;Events", VariableType::kPerEvent, kLinear, 0., 1., 70, kLog, 0.1, 1000000., 70);
22 regHistogram("UnmonitoredTime_perEventFractional", "Unmonitored CPU Time Fractional;Fractional Time;Events", VariableType::kPerEvent, kLinear, 0., 1.);
23
24 regHistogram("AlgCalls_perEvent", "Algorithm Calls/Event;Calls;Events", VariableType::kPerEvent, kLog, 0.5, 10000.5, 500);
25 regHistogram("ThisAlgCalls_perEvent", "This Event Algorithm Calls/Event;Calls;Events", VariableType::kPerEvent, kLog, 0.5, 10000.5, 500);
26 regHistogram("OtherAlgCalls_perEvent", "Other Event Algorithm Calls/Event;Calls;Events", VariableType::kPerEvent, kLog, 0.5, 10000.5, 500);
27 regHistogram("AlgSlot_perCall", "Algorithm Slot/Call;Slot;Calls", VariableType::kPerCall, kLinear, -0.5, 20.5, 21);
28
29}
@ kPerEvent
Variable should buffer fill calls in an accumulator and fill the underlying histogram once at the end...
@ kPerCall
Variable should fill underlying histogram on each fill.
@ kLog
Logarithmic x-binning.
CounterBase()=delete
Forbid default constructor.
void regHistogram(const std::string &name, const std::string &title, const VariableType type=VariableType::kPerCall, const LogType xaxis=kLog, const float min=0.1, const float max=1000000., const size_t bins=70)
Book a histogram for this Counter, to be filled in per-event monitoring.
uint64_t m_globalLowTimestamp
Records the lowest timestamp seen over all threads in an event.
uint64_t m_highTimestamp
Records the highest timestamp seen on this single thread in an event.
uint64_t m_lowTimestamp
Records the lowest timestamp seen on this single thread in an event.
uint64_t m_globalHighTimestamp
Records the highest timestamp seen over all threads in an event.

◆ ~CounterThread()

virtual CounterThread::~CounterThread ( )
virtualdefault

Default destructor.

◆ CounterThread() [3/3]

CounterThread::CounterThread ( const CounterThread & )
delete

Forbid copy.

Member Function Documentation

◆ bookGetPointer()

TH1 * CounterBase::bookGetPointer ( TH1 * hist,
const std::string & tDir = "" ) const
protectedinherited

Appends Counter name (to histogram path) and forwards histogram book request to parent Monitor.

Parameters
[in]histBare pointer to histogram. Ownership transferred to THistSvc.
[in]tDirHistogram name & directory.
Returns
Cached pointer to histogram. Used to fill histogram without having to perform THishSvc lookup.

Definition at line 233 of file CounterBase.cxx.

233 {
234 std::string dir = getName();
235 if (tDir != "") {
236 dir += "/";
237 dir += tDir;
238 }
239 return getParent()->bookGetPointer(hist, dir);
240}
const MonitorBase * getParent() const
Return cached non-owning const ptr to this Counter's parent Monitor.
const std::string & getName() const
Getter for Counter's name.
TH1 * bookGetPointer(TH1 *hist, const std::string &tDir="") const
Appends Monitor name (to histogram path) and forwards histogram book request to parent Range.

◆ endEvent()

StatusCode CounterBase::endEvent ( float weight = 1.0)
virtualinherited

Called by the framework.

Causes per-Event Variables to fill their histograms with their accumulated data.

Definition at line 225 of file CounterBase.cxx.

225 {
226 for (auto& nameVariablePair : m_variables) {
227 ATH_CHECK( nameVariablePair.second.endEvent() );
228 }
229 return StatusCode::SUCCESS;
230}
#define ATH_CHECK
Evaluate an expression and check for errors.
std::unordered_map< std::string, Variable > m_variables
Store of Counter's Variables.

◆ fill() [1/2]

StatusCode CounterBase::fill ( const std::string & name,
float value,
float weight = 1.0 )
inherited

Fill (for per-Call) or accumulate in a buffer (for per-Event) a quantity histogrammed by a named Variable.

Parameters
[in]nameVariable to increment
[in]valueThe payload value
[in]weightGlobal event weight

Definition at line 191 of file CounterBase.cxx.

191 {
192 auto it = m_variables.find(name);
193 if (it == m_variables.end()) {
194 return StatusCode::FAILURE;
195 }
196 ATH_CHECK( it->second.fill(value, weight) );
197 return StatusCode::SUCCESS;
198}

◆ fill() [2/2]

StatusCode CounterBase::fill ( const std::string & name,
float xvalue,
float yvalue,
float weight )
inherited

Fill (for per-Call) or accumulate in a buffer (for per-Event) a quantity histogrammed by a named Variable.

Parameters
[in]nameVariable to increment
[in]xvalueThe payload x-axis value
[in]yvalueThe payload y-axis value
[in]weightGlobal event weight

Definition at line 200 of file CounterBase.cxx.

200 {
201 auto it = m_variables.find(name);
202 if (it == m_variables.end()) {
203 return StatusCode::FAILURE;
204 }
205 ATH_CHECK( it->second.fill(xvalue, yvalue, weight) );
206 return StatusCode::SUCCESS;
207}

◆ getHighTimestamp()

uint64_t CounterThread::getHighTimestamp ( ) const

Get the highest timestamp of this single thread.

Definition at line 102 of file CounterThread.cxx.

102 {
103 return m_highTimestamp;
104}

◆ getLowTimestamp()

uint64_t CounterThread::getLowTimestamp ( ) const

Get the lowest timestamp of this single thread.

Definition at line 97 of file CounterThread.cxx.

97 {
98 return m_lowTimestamp;
99}

◆ getName()

const std::string & CounterBase::getName ( ) const
inherited

Getter for Counter's name.

Returns
Counter's name const string reference.

Definition at line 17 of file CounterBase.cxx.

17 {
18 return m_name;
19}
const std::string m_name
Counter's name.

◆ getParent()

const MonitorBase * CounterBase::getParent ( ) const
inherited

Return cached non-owning const ptr to this Counter's parent Monitor.

Returns
Cached pointer parent Monitor.

Definition at line 22 of file CounterBase.cxx.

22 {
23 return m_parent;
24}
const MonitorBase * m_parent
Counter's parent Monitor.

◆ getVariable()

Variable & CounterBase::getVariable ( const std::string & name)
inherited

Returns a mutable reference to a named Variable.

Throws if no such Variable exists. Used when more complicated logic is needed on a Variable than simply using the fill() method.

Parameters
[in]nameVariable to return
Returns
Mutable reference to Variable

Definition at line 182 of file CounterBase.cxx.

182 {
183 auto it = m_variables.find(name);
184 if (it == m_variables.end()) {
185 throw std::runtime_error( "CounterBase::getVariable: No varialbe with name " + name );
186 }
187 return (it->second);
188}

◆ increment()

StatusCode CounterBase::increment ( const std::string & name,
float weight = 1.0 )
inherited

Convenience function.

Equivalent to fill(name, 1.0, weight);

Parameters
[in]nameVariable to increment
[in]weightGlobal event weight

Definition at line 220 of file CounterBase.cxx.

220 {
221 return fill(name, 1.0, weight);
222}
StatusCode fill(const std::string &name, float value, float weight=1.0)
Fill (for per-Call) or accumulate in a buffer (for per-Event) a quantity histogrammed by a named Vari...

◆ newEvent()

StatusCode CounterThread::newEvent ( const CostData & data,
size_t index,
const float weight = 1.0 )
overridevirtual

Concrete implementation.

Monitores algorithm at specified index for this counter's thread.

Parameters
[in]dataAccess to event data
[in]indexIndex within appropriate event data container which is to be analysed by this Counter
[in]weightGlobal event weight

Implements CounterBase.

Definition at line 32 of file CounterThread.cxx.

32 {
33 const xAOD::TrigComposite* alg = data.costCollection().at(index);
34
35 const uint64_t start = alg->getDetail<uint64_t>("start"); // in mus
36 const uint64_t stop = alg->getDetail<uint64_t>("stop"); // in mus
37 const uint32_t slot = alg->getDetail<uint32_t>("slot");
38 const float cpuTime = timeToMilliSec(start, stop);
39 ATH_CHECK( fill("AlgTime_perEvent", cpuTime, weight) );
40 ATH_CHECK( fill("AlgTime_perEventFractional", cpuTime, weight) );
41 ATH_CHECK( increment("AlgCalls_perEvent", weight) );
42 if (slot == 0) {
43 ATH_CHECK( increment("ThisAlgCalls_perEvent", weight) );
44 } else {
45 ATH_CHECK( increment("OtherAlgCalls_perEvent", weight) );
46 }
47 ATH_CHECK( fill("AlgSlot_perCall", slot, weight) );
48 m_lowTimestamp = std::min(m_lowTimestamp, start);
49 m_highTimestamp = std::max(m_highTimestamp, stop);
50
51 return StatusCode::SUCCESS;
52}
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
float timeToMilliSec(const uint64_t start, const uint64_t stop) const
Helper function.
StatusCode increment(const std::string &name, float weight=1.0)
Convenience function.
TrigComposite_v1 TrigComposite
Declare the latest version of the class.
setEventNumber uint32_t

◆ operator=()

CounterThread & CounterThread::operator= ( const CounterThread & )
delete

Forbid assignment.

◆ postProcess()

StatusCode CounterThread::postProcess ( float weight = 1.0)

Apply post-processing to the Counter, before endEvent is called.

Parameters
[in]weightGlobal event weight

Definition at line 54 of file CounterThread.cxx.

54 {
55 // Total time from start of HLTSeeding to "stop" of SummaryMaker.
57
58 // We know that we may loose data on algs which started executing before the HLTSeeding triggered the data collection.
59 // But we truncate the data for algs which are running still when we stop collecting data.
60 float unmonitoredTime = 0;
61 if (m_highTimestamp > 0) {
62 const float unmonitoredStart = timeToMilliSec(m_globalLowTimestamp, m_lowTimestamp);
63 const float unmonitoredEnd = timeToMilliSec(m_highTimestamp, m_globalHighTimestamp);
64 unmonitoredTime = unmonitoredStart + unmonitoredEnd;
65 // As of T12, unmonitoredEnd should be zero due to truncating this record online.
66 }
67
68 // Time spent outside of any algorithm. E.g. in Gaudi
69 const float frameworkTime = eventTime - unmonitoredTime - getVariable("AlgTime_perEvent").getAccumulator();
70
71 ATH_CHECK( fill("UnmonitoredTime_perEvent", unmonitoredTime, weight) );
72 ATH_CHECK( fill("UnmonitoredTime_perEventFractional", unmonitoredTime, weight) );
73
74 ATH_CHECK( fill("FrameworkTime_perEvent", frameworkTime, weight) );
75 ATH_CHECK( fill("FrameworkTime_perEventFractional", frameworkTime, weight) );
76
77 ATH_CHECK( fill("WallTime_perEvent", eventTime, weight) );
78
79 ATH_CHECK( setDenominator("AlgTime_perEventFractional", eventTime) );
80 ATH_CHECK( setDenominator("FrameworkTime_perEventFractional", eventTime) );
81 ATH_CHECK( setDenominator("UnmonitoredTime_perEventFractional", eventTime) );
82
83 ATH_CHECK( fill("FrameworkTime_perEventFractional_vs_TotalTime_perEvent", frameworkTime, eventTime, weight) );
84 ATH_CHECK( fill("AlgTime_perEventFractional_vs_TotalTime_perEvent", getVariable("AlgTime_perEvent").getAccumulator(), eventTime, weight) );
85 ATH_CHECK( setDenominator("FrameworkTime_perEventFractional_vs_TotalTime_perEvent", eventTime) );
86 ATH_CHECK( setDenominator("AlgTime_perEventFractional_vs_TotalTime_perEvent", eventTime) );
87
88 m_lowTimestamp = std::numeric_limits<uint64_t>::max();
90 m_globalLowTimestamp = std::numeric_limits<uint64_t>::max();
92
93 return StatusCode::SUCCESS;
94}
Variable & getVariable(const std::string &name)
Returns a mutable reference to a named Variable.
StatusCode setDenominator(const std::string &name, float value)
Optional for per-Event Variables.
float getAccumulator() const
Getter for accumulated value of a kPerEvent Variable.
Definition Variable.cxx:34

◆ regHistogram() [1/2]

void CounterBase::regHistogram ( const std::string & name,
const std::string & title,
const VariableType type,
const LogType xaxis,
const float xmin,
const float xmax,
const size_t xbins,
const LogType yaxis,
const float ymin,
const float ymax,
const size_t ybins )
protectedinherited

Book a 2D histogram for this Counter, to be filled in per-event monitoring.

Parameters
[in]nameThe name of the histogram (and corresponding Variable)
[in]titleROOT histogram title string in format "title;xaxis;yaxis"
[in]xaxisControls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]xminX-axis minimum bound.
[in]xmaxX-axis maximum bound.
[in]xbinsNumber of histogram bins.
[in]yaxisControls if the y-axis should use fixed-width or logarithmic bin boundaries.
[in]yminY-axis minimum bound.
[in]ymaxY-axis maximum bound.
[in]ybinsNumber of histogram bins.

Definition at line 109 of file CounterBase.cxx.

120{
121 std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
122 std::unique_ptr<TH2F> hist;
123
124 if (xmax <= xmin || ymax <= ymin || xbins == 0 || ybins == 0) {
125 throw std::runtime_error("CounterBase::regHistogram: Cannot have max <= min or bins == 0");
126 }
127
128 if (xaxis == kLinear && yaxis == kLinear) {
129 hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xmin, xmax, ybins, ymin, ymax);
130 } else if (xaxis == kLog || yaxis == kLog) {
131 if ( (xaxis == kLog && xmin <= 0) || (yaxis == kLog && ymin <= 0) ) {
132 throw std::runtime_error("CounterBase::regHistogram: Cannot have min <= 0 with log binning");
133 }
134 std::unique_ptr<double[]> xlogbins = std::make_unique<double[]>(xbins+1);
135 std::unique_ptr<double[]> ylogbins = std::make_unique<double[]>(ybins+1);
136 if (xaxis == kLog){
137 const double xlogmin = log10(xmin);
138 const double xlogmax = log10(xmax);
139 const double dlogx = (xlogmax-xlogmin)/((double)xbins);
140 for (size_t i = 0; i <= xbins; ++i) {
141 const double xlog = xlogmin + i*dlogx;
142 xlogbins[i] = exp( log(10) * xlog );
143 }
144 } else {
145 const double dx = (xmax-xmin)/((double)xbins);
146 for (size_t i = 0; i <= xbins; ++i) {
147 xlogbins[i] = xmin + i*dx;
148 }
149 }
150
151 if (yaxis == kLog){
152 const double ylogmin = log10(ymin);
153 const double ylogmax = log10(ymax);
154 const double dlogy = (ylogmax-ylogmin)/((double)ybins);
155 for (size_t i = 0; i <= ybins; ++i) {
156 const double ylog = ylogmin + i*dlogy;
157 ylogbins[i] = exp( log(10) * ylog );
158 }
159 } else {
160 const double dy = (ymax-ymin)/((double)ybins);
161 for (size_t i = 0; i <= ybins; ++i) {
162 ylogbins[i] = ymin + i*dy;
163 }
164 }
165
166 hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xlogbins.get(), ybins, ylogbins.get());
167 } else {
168 throw std::runtime_error("CounterBase::regHistogram: Unknown logarithm flag");
169 }
170
171 m_variables.emplace(std::piecewise_construct,
172 std::forward_as_tuple(name),
173 std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
174 );
175 // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
176}
TH1 * bookGetPointer(TH1 *hist, const std::string &tDir="") const
Appends Counter name (to histogram path) and forwards histogram book request to parent Monitor.
const MonitoredRange * getParent() const
Return cached non-owning const ptr to this Monitor's parent Range.
const std::string & getName() const
Getter for Monitor's name.
const std::string & getName() const
Getter for Range's name.
double xmax
Definition listroot.cxx:61
double ymin
Definition listroot.cxx:63
double xmin
Definition listroot.cxx:60
double ymax
Definition listroot.cxx:64

◆ regHistogram() [2/2]

void CounterBase::regHistogram ( const std::string & name,
const std::string & title,
const VariableType type = VariableType::kPerCall,
const LogType xaxis = kLog,
const float min = 0.1,
const float max = 1000000.,
const size_t bins = 70 )
protectedinherited

Book a histogram for this Counter, to be filled in per-event monitoring.

Parameters
[in]nameThe name of the histogram (and corresponding Variable)
[in]titleROOT histogram title string in format "title;xaxis;yaxis"
[in]xaxisControls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]minX-axis minimum bound.
[in]maxX-axis maximum bound.
[in]binsNumber of histogram bins.

Definition at line 27 of file CounterBase.cxx.

34{
35 std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
36 std::unique_ptr<TH1F> hist;
37
38 if (max <= min || bins == 0) {
39 throw std::runtime_error("CounterBase::regHistogram: Cannot have max <= min or bins == 0");
40 }
41
42 if (xaxis == kLinear) {
43 hist = std::make_unique<TH1F>(hisSvcName.c_str(), title.c_str(), bins, min, max);
44 } else if (xaxis == kLog) {
45 if (min <= 0) {
46 throw std::runtime_error("CounterBase::regHistogram: Cannot have min <= 0 with log binning");
47 }
48 std::unique_ptr<double[]> xbins = std::make_unique<double[]>(bins+1);
49 const double xlogmin = log10(min);
50 const double xlogmax = log10(max);
51 const double dlogx = (xlogmax-xlogmin)/((double)bins);
52 for (size_t i = 0; i <= bins; ++i) {
53 const double xlog = xlogmin + i*dlogx;
54 xbins[i] = exp( log(10) * xlog );
55 }
56 hist = std::make_unique<TH1F>(hisSvcName.c_str(), title.c_str(), bins, xbins.get());
57 } else {
58 throw std::runtime_error("CounterBase::regHistogram: Unknown logarithm flag");
59 }
60
61 m_variables.emplace(std::piecewise_construct,
62 std::forward_as_tuple(name),
63 std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
64 );
65 // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
66}
static const std::vector< std::string > bins
#define min(a, b)
Definition cfImp.cxx:40
#define max(a, b)
Definition cfImp.cxx:41

◆ regTProfile()

void CounterBase::regTProfile ( const std::string & name,
const std::string & title,
const VariableType type = VariableType::kPerCall,
const LogType xaxis = kLog,
const float min = 0.1,
const float max = 1000000.,
const size_t bins = 70 )
protectedinherited

Book a TProfile for this Counter, to be filled in per-event monitoring.

Parameters
[in]nameThe name of the histogram (and corresponding Variable)
[in]titleROOT histogram title string in format "title;xaxis;yaxis"
[in]xaxisControls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]minX-axis minimum bound.
[in]maxX-axis maximum bound.
[in]binsNumber of histogram bins.

Definition at line 68 of file CounterBase.cxx.

75{
76 std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
77 std::unique_ptr<TProfile> hist;
78
79 if (max <= min || bins == 0) {
80 throw std::runtime_error("CounterBase::regTProfile: Cannot have max <= min or bins == 0");
81 }
82
83 if (xaxis == kLinear) {
84 hist = std::make_unique<TProfile>(hisSvcName.c_str(), title.c_str(), bins, min, max);
85 } else if (xaxis == kLog) {
86 if (min <= 0) {
87 throw std::runtime_error("CounterBase::regTProfile: Cannot have min <= 0 with log binning");
88 }
89 std::unique_ptr<double[]> xbins = std::make_unique<double[]>(bins+1);
90 const double xlogmin = log10(min);
91 const double xlogmax = log10(max);
92 const double dlogx = (xlogmax-xlogmin)/((double)bins);
93 for (size_t i = 0; i <= bins; ++i) {
94 const double xlog = xlogmin + i*dlogx;
95 xbins[i] = exp( log(10) * xlog );
96 }
97 hist = std::make_unique<TProfile>(hisSvcName.c_str(), title.c_str(), bins, xbins.get());
98 } else {
99 throw std::runtime_error("CounterBase::regTProfile: Unknown logarithm flag");
100 }
101
102 m_variables.emplace(std::piecewise_construct,
103 std::forward_as_tuple(name),
104 std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
105 );
106 // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
107}

◆ setAllThreadsTimestamps()

void CounterThread::setAllThreadsTimestamps ( uint64_t low,
uint64_t high )

Set the low and high timestamps over all threads.

Definition at line 107 of file CounterThread.cxx.

107 {
110}

◆ setDenominator()

StatusCode CounterBase::setDenominator ( const std::string & name,
float value )
inherited

Optional for per-Event Variables.

Sets a denominator to divide the value through by before filling.

Parameters
[in]nameVariable to set the denominator for.
[in]valueThe denominator

Definition at line 210 of file CounterBase.cxx.

210 {
211 auto it = m_variables.find(name);
212 if (it == m_variables.end()) {
213 return StatusCode::FAILURE;
214 }
215 it->second.setDenominator(value);
216 return StatusCode::SUCCESS;
217}

◆ timeToMilliSec()

float CounterBase::timeToMilliSec ( const uint64_t start,
const uint64_t stop ) const
protectedinherited

Helper function.

Compute the time difference in discreet microseconds and covert to fractional milliseconds.

Returns
Time difference in milliseconds, floating point.

Definition at line 243 of file CounterBase.cxx.

243 {
244 if (stop < start) {
245 throw std::runtime_error("Asked for a stop time " + std::to_string(stop) + " which is before the start time " + std::to_string(start));
246 }
247 const uint64_t difference = stop - start;
248 return (difference * 1e-3); // micro to ms
249}
difference(file_1="Geometry_1.json", file_2="Geometry_2.json", output_file="Geometry_diff.json")

◆ variableExists()

bool CounterBase::variableExists ( const std::string & name) const
inherited

Check if a variable of a given name exists.

Parameters
[in]nameName of Variable.
Returns
True if variable already exists.

Definition at line 178 of file CounterBase.cxx.

178 {
179 return (m_variables.count(name) == 1);
180}

Member Data Documentation

◆ m_globalHighTimestamp

uint64_t CounterThread::m_globalHighTimestamp

Records the highest timestamp seen over all threads in an event.

Definition at line 76 of file CounterThread.h.

◆ m_globalLowTimestamp

uint64_t CounterThread::m_globalLowTimestamp

Records the lowest timestamp seen over all threads in an event.

Definition at line 75 of file CounterThread.h.

◆ m_highTimestamp

uint64_t CounterThread::m_highTimestamp

Records the highest timestamp seen on this single thread in an event.

Definition at line 73 of file CounterThread.h.

◆ m_lowTimestamp

uint64_t CounterThread::m_lowTimestamp

Records the lowest timestamp seen on this single thread in an event.

Definition at line 72 of file CounterThread.h.

◆ m_name

const std::string CounterBase::m_name
privateinherited

Counter's name.

Definition at line 203 of file CounterBase.h.

◆ m_parent

const MonitorBase* CounterBase::m_parent
privateinherited

Counter's parent Monitor.

Cached non-owning const pointer.

Definition at line 204 of file CounterBase.h.

◆ m_variables

std::unordered_map< std::string, Variable > CounterBase::m_variables
privateinherited

Store of Counter's Variables.

These wrap a histogram pointer. Keyed by name.

Definition at line 205 of file CounterBase.h.


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