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

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, Variablem_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...
@ kPerCall
Variable should fill underlying histogram on each fill.
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 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}

◆ 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.

◆ 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 ( 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 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}
char data[hepevt_bytes_allocation_ATLAS]
Definition HepEvt.cxx:11
static Double_t tc
float timeToMilliSec(const uint64_t start, const uint64_t stop) const
Helper function.
bool variableExists(const std::string &name) const
Check if a variable of a given name exists.
Variable & getVariable(const std::string &name)
Returns a mutable reference to a named Variable.
StatusCode increment(const std::string &name, float weight=1.0)
Convenience function.
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
bool getDetail(const std::string &name, TYPE &value) const
Get an TYPE detail from the object.
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 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}
@ kLog
Logarithmic x-binning.
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}

◆ 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_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_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 > 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: