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

Concrete implimentation of Counter to monitor the data requests for a single Read Out System request and corresponding Read Out Buffer requests. More...

#include <CounterROS.h>

Inheritance diagram for CounterROS:
Collaboration diagram for CounterROS:

Public Member Functions

 CounterROS ()=delete
 Forbid default constructor.
 CounterROS (const std::string &name, const MonitorBase *parent)
 Construct counter.
 CounterROS (const std::string &name, unsigned nRobs, const MonitorBase *parent)
 Construct counter.
virtual ~CounterROS ()=default
 Default destructor.
CounterROSoperator= (const CounterROS &)=delete
 Forbid assignment.
 CounterROS (const CounterROS &)=delete
 Forbid copy.
virtual StatusCode newEvent (const CostData &data, size_t index, const float weight=1.) override
 Concrete implementation.
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 (std::string_view name)
 Returns a mutable reference to a named Variable.
StatusCode fill (std::string_view 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 (std::string_view 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 (std::string_view 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.

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 Member Functions

int getROBHistoryBin (const unsigned history)
 Get histogram bin for ROBHistory enum values.

Private Attributes

std::map< uint32_t, unsigned > m_robIdToBin
 Cached mapping of rob id to bin in ROBsPerRequest_perEvent histogram.
const std::string m_name
 Counter's name.
const MonitorBasem_parent {}
 Counter's parent Monitor.
std::unordered_map< std::string, Variable, CxxUtils::TransparentStringHash, std::equal_to<> > m_variables
 Store of Counter's Variables.

Detailed Description

Concrete implimentation of Counter to monitor the data requests for a single Read Out System request and corresponding Read Out Buffer requests.

Definition at line 15 of file CounterROS.h.

Constructor & Destructor Documentation

◆ CounterROS() [1/4]

CounterROS::CounterROS ( )
delete

Forbid default constructor.

◆ CounterROS() [2/4]

CounterROS::CounterROS ( 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 14 of file CounterROS.cxx.

15 : CounterBase(name, parent) {
16
17 regHistogram("Request_perEvent", "Number of requests/Event;Number of requests;Events", VariableType::kPerEvent, LogType::kLinear, -0.5, 49.5, 50);
18 regHistogram("NetworkRequest_perEvent", "Number of network requests/Event;Number of requests;Events", VariableType::kPerEvent, LogType::kLinear, -0.5, 20.5, 21);
19 regHistogram("CachedROBSize_perEvent", "Total Cached ROB Size/Event;ROB size;Events", VariableType::kPerEvent, LogType::kLinear, 0, 1024, 50);
20 regHistogram("NetworkROBSize_perEvent", "Total Network ROB Size/Event;ROB size;Events", VariableType::kPerEvent, LogType::kLinear, 0, 1024, 50);
21 regHistogram("Time_perEvent", "ROB Elapsed Time/Event;Elapsed Time [ms];Events", VariableType::kPerEvent);
22 regHistogram("ROBStatus_perCall", "ROB status/Call;Status;Calls", VariableType::kPerCall, LogType::kLinear, 0, robmonitor::NUM_ROBHIST_CODES+1, robmonitor::NUM_ROBHIST_CODES+1);
23 regHistogram("NROBsPerRequest_perCall", "Number of requested ROBs;Number of requestes ROBs;Number of requests", VariableType::kPerCall, LogType::kLinear, 0.5, 30.5, 30);
24}
@ kPerEvent
Variable should buffer fill calls in an accumulator and fill the underlying histogram once at the end...
Definition Variable.h:21
@ kPerCall
Variable should fill underlying histogram on each fill.
Definition Variable.h:20
@ kLinear
Linear x-binning.
Definition Variable.h:29
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.

◆ CounterROS() [3/4]

CounterROS::CounterROS ( const std::string & name,
unsigned nRobs,
const MonitorBase * parent )

Construct counter.

Parameters
[in]nameCounter's name
[in]nRobsNumber of ROBs possible for this ROB
[in]parentCounter's parent monitor, cached non-owning pointer.

Definition at line 26 of file CounterROS.cxx.

27 : CounterROS(name, parent) {
28
29 regHistogram("ROBsPerRequest_perCall", "Number of ROB requests;ROBs names;Number of requests", VariableType::kPerCall, LogType::kLinear, 0, nRobs, nRobs);
30}
CounterROS()=delete
Forbid default constructor.

◆ ~CounterROS()

virtual CounterROS::~CounterROS ( )
virtualdefault

Default destructor.

◆ CounterROS() [4/4]

CounterROS::CounterROS ( const CounterROS & )
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 235 of file CounterBase.cxx.

235 {
236 std::string dir = getName();
237 if (tDir != "") {
238 dir += "/";
239 dir += tDir;
240 }
241 return getParent()->bookGetPointer(hist, dir);
242}
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 227 of file CounterBase.cxx.

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

◆ fill() [1/2]

StatusCode CounterBase::fill ( std::string_view 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 193 of file CounterBase.cxx.

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

◆ fill() [2/2]

StatusCode CounterBase::fill ( std::string_view 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 202 of file CounterBase.cxx.

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

◆ getName()

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

Getter for Counter's name.

Returns
Counter's name const string reference.

Definition at line 19 of file CounterBase.cxx.

19 {
20 return m_name;
21}
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 24 of file CounterBase.cxx.

24 {
25 return m_parent;
26}
const MonitorBase * m_parent
Counter's parent Monitor.

◆ getROBHistoryBin()

int CounterROS::getROBHistoryBin ( const unsigned history)
private

Get histogram bin for ROBHistory enum values.

Parameters
[in]historyROBHistory value

Definition at line 114 of file CounterROS.cxx.

114 {
115 int history_bin;
116 switch (history) {
118 history_bin = 1;
119 break;
121 history_bin = 2;
122 break;
124 history_bin = 3;
125 break;
127 history_bin = 4;
128 break;
130 history_bin = 5;
131 break;
132 default: // UNCLASSIFIED
133 history_bin = 0;
134 break;
135 }
136
137 return history_bin;
138}

◆ getVariable()

Variable & CounterBase::getVariable ( std::string_view 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 184 of file CounterBase.cxx.

184 {
185 auto it = m_variables.find(name);
186 if (it == m_variables.end()) {
187 throw std::runtime_error( std::format("CounterBase::getVariable: No variable with name {}", name) );
188 }
189 return (it->second);
190}

◆ increment()

StatusCode CounterBase::increment ( std::string_view 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 222 of file CounterBase.cxx.

222 {
223 return fill(name, 1.0, weight);
224}
StatusCode fill(std::string_view 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 CounterROS::newEvent ( const CostData & data,
size_t index,
const float weight = 1. )
overridevirtual

Concrete implementation.

Monitors global properties in a single LB, or over all LB in a Range

Parameters
[in]dataAccess to event data
[in]indexIndex of data request to monitor
[in]weightGlobal event weight

Implements CounterBase.

Definition at line 32 of file CounterROS.cxx.

32 {
33
34 // Monitor only ROB data for corresponding ROS
35 const xAOD::TrigComposite* tc = data.rosCollection()[index];
36 const std::vector<uint32_t> robIdsPerRequest = tc->getDetail<std::vector<uint32_t>>("robs_id");
37 const std::vector<uint32_t> robs_size = tc->getDetail<std::vector<uint32_t>>("robs_size");
38 const std::vector<unsigned> robs_history = tc->getDetail<std::vector<unsigned>>("robs_history");
39 const std::vector<unsigned short> robs_status = tc->getDetail<std::vector<unsigned short>>("robs_status");
40
41
42 if (m_robIdToBin.empty()) {
43 // Set lables of status histogram
44 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(1, "Unclassified"));
45 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(2, "Retrieved"));
46 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(3, "HLT Cached"));
47 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(4, "DCM Cached"));
48 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(5, "Ignored"));
49 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(6, "Disabled"));
50 ATH_CHECK( getVariable("ROBStatus_perCall").setBinLabel(7, "IsNotOK"));
51
52 if (variableExists("ROBsPerRequest_perCall")) {
53 // This monitor has it's own binning for ROBs due to the fact that limited number of ROBs are associated with one ROS
54 unsigned robCounter = 0;
55 for (uint32_t robId : data.costROSData().getROBForROS(getName())) {
56 std::string robName = data.costROSData().getROBName(robId);
57 ATH_CHECK( getVariable("ROBsPerRequest_perCall").setBinLabel(robCounter+1, robName));
58
59 m_robIdToBin[robId] = robCounter;
60 ++robCounter;
61 }
62 }
63 }
64
65
66 // Find all ROB requests that are both in request and correspond to this ROS
67 bool networkRequestIncremented = false;
68 int nRequestedRobs = 0;
69 for (size_t i = 0; i < robIdsPerRequest.size(); ++i) {
70
71 // Check if the ROB was requested by ROS
72 if (data.costROSData().getROSForROB(robIdsPerRequest[i]) != getName() ) continue;
73
74 if (m_robIdToBin.find(robIdsPerRequest[i]) != m_robIdToBin.end()) {
75 ATH_CHECK( fill("ROBStatus_perCall", getROBHistoryBin(robs_history[i]), weight) );
76 // If status is okay robs_status[i] equals true
77 if (robs_status[i] == false ) {
78 // The last bin of ROBStatus_perCall histogram store isStatusNotOk bool value
79 ATH_CHECK( fill("ROBStatus_perCall", robmonitor::NUM_ROBHIST_CODES, weight) );
80 }
81
82 // ROB request was fetched over the network
83 if (robs_history[i] == robmonitor::RETRIEVED) {
84 // size is stored in words, should be in kilobytes
85 ATH_CHECK( fill("NetworkROBSize_perEvent", robs_size[i] / 500., weight) );
86 networkRequestIncremented = true;
87 }
88 else if (robs_history[i] == robmonitor::HLT_CACHED || robs_history[i] == robmonitor::DCM_CACHED) {
89 ATH_CHECK( fill("CachedROBSize_perEvent", robs_size[i] / 500., weight) );
90 }
91
92 if (variableExists("ROBsPerRequest_perCall")){
93 ATH_CHECK( fill("ROBsPerRequest_perCall", m_robIdToBin.at(robIdsPerRequest[i]), weight) );
94 }
95
96 ++nRequestedRobs;
97 }
98 }
99
100 ATH_CHECK( fill("NROBsPerRequest_perCall", nRequestedRobs, weight) );
101
102 ATH_CHECK( increment("Request_perEvent", weight) );
103
104 if (networkRequestIncremented) {
105 ATH_CHECK( increment("NetworkRequest_perEvent", weight) );
106 }
107
108 const float rosTime = timeToMilliSec(tc->getDetail<uint64_t>("start"), tc->getDetail<uint64_t>("stop"));
109 ATH_CHECK( fill("Time_perEvent", rosTime, weight) );
110
111 return StatusCode::SUCCESS;
112}
static Double_t tc
float timeToMilliSec(const uint64_t start, const uint64_t stop) const
Helper function.
StatusCode increment(std::string_view name, float weight=1.0)
Convenience function.
bool variableExists(const std::string &name) const
Check if a variable of a given name exists.
Variable & getVariable(std::string_view name)
Returns a mutable reference to a named Variable.
int getROBHistoryBin(const unsigned history)
Get histogram bin for ROBHistory enum values.
std::map< uint32_t, unsigned > m_robIdToBin
Cached mapping of rob id to bin in ROBsPerRequest_perEvent histogram.
Definition CounterROS.h:67
str index
Definition DeMoScan.py:362
TrigComposite_v1 TrigComposite
Declare the latest version of the class.

◆ operator=()

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

Forbid assignment.

◆ 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 111 of file CounterBase.cxx.

122{
123 std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
124 std::unique_ptr<TH2F> hist;
125
126 if (xmax <= xmin || ymax <= ymin || xbins == 0 || ybins == 0) {
127 throw std::runtime_error("CounterBase::regHistogram: Cannot have max <= min or bins == 0");
128 }
129
130 if (xaxis == kLinear && yaxis == kLinear) {
131 hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xmin, xmax, ybins, ymin, ymax);
132 } else if (xaxis == kLog || yaxis == kLog) {
133 if ( (xaxis == kLog && xmin <= 0) || (yaxis == kLog && ymin <= 0) ) {
134 throw std::runtime_error("CounterBase::regHistogram: Cannot have min <= 0 with log binning");
135 }
136 std::unique_ptr<double[]> xlogbins = std::make_unique<double[]>(xbins+1);
137 std::unique_ptr<double[]> ylogbins = std::make_unique<double[]>(ybins+1);
138 if (xaxis == kLog){
139 const double xlogmin = log10(xmin);
140 const double xlogmax = log10(xmax);
141 const double dlogx = (xlogmax-xlogmin)/((double)xbins);
142 for (size_t i = 0; i <= xbins; ++i) {
143 const double xlog = xlogmin + i*dlogx;
144 xlogbins[i] = exp( log(10) * xlog );
145 }
146 } else {
147 const double dx = (xmax-xmin)/((double)xbins);
148 for (size_t i = 0; i <= xbins; ++i) {
149 xlogbins[i] = xmin + i*dx;
150 }
151 }
152
153 if (yaxis == kLog){
154 const double ylogmin = log10(ymin);
155 const double ylogmax = log10(ymax);
156 const double dlogy = (ylogmax-ylogmin)/((double)ybins);
157 for (size_t i = 0; i <= ybins; ++i) {
158 const double ylog = ylogmin + i*dlogy;
159 ylogbins[i] = exp( log(10) * ylog );
160 }
161 } else {
162 const double dy = (ymax-ymin)/((double)ybins);
163 for (size_t i = 0; i <= ybins; ++i) {
164 ylogbins[i] = ymin + i*dy;
165 }
166 }
167
168 hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xlogbins.get(), ybins, ylogbins.get());
169 } else {
170 throw std::runtime_error("CounterBase::regHistogram: Unknown logarithm flag");
171 }
172
173 m_variables.emplace(std::piecewise_construct,
174 std::forward_as_tuple(name),
175 std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
176 );
177 // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
178}
@ kLog
Logarithmic x-binning.
Definition Variable.h:30
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 29 of file CounterBase.cxx.

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

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

◆ 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 212 of file CounterBase.cxx.

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

◆ 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 245 of file CounterBase.cxx.

245 {
246 if (stop < start) {
247 throw std::runtime_error("Asked for a stop time " + std::to_string(stop) + " which is before the start time " + std::to_string(start));
248 }
249 const uint64_t difference = stop - start;
250 return (difference * 1e-3); // micro to ms
251}
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 180 of file CounterBase.cxx.

180 {
181 return m_variables.contains(name);
182}

Member Data Documentation

◆ m_name

const std::string CounterBase::m_name
privateinherited

Counter's name.

Definition at line 210 of file CounterBase.h.

◆ m_parent

const MonitorBase* CounterBase::m_parent {}
privateinherited

Counter's parent Monitor.

Cached non-owning const pointer.

Definition at line 211 of file CounterBase.h.

211{};

◆ m_robIdToBin

std::map<uint32_t, unsigned> CounterROS::m_robIdToBin
private

Cached mapping of rob id to bin in ROBsPerRequest_perEvent histogram.

Definition at line 67 of file CounterROS.h.

◆ m_variables

std::unordered_map< std::string, Variable, CxxUtils::TransparentStringHash, std::equal_to<> > CounterBase::m_variables
privateinherited

Store of Counter's Variables.

These wrap a histogram pointer. Keyed by name.

Definition at line 212 of file CounterBase.h.


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