CounterAlgorithm Class Reference

Concrete implimentation of Counter to monitor all properties of a given Algorithm instance. More...

#include <CounterAlgorithm.h>

Inheritance diagram for CounterAlgorithm:

Collaboration diagram for CounterAlgorithm:

Public Member Functions
	CounterAlgorithm ()=delete
	Forbid default constructor. More...
	CounterAlgorithm (const std::string &name, const MonitorBase *parent, const bool skipHistograms=false)
	Construct counter. More...
virtual	~CounterAlgorithm ()=default
	Default destructor. More...
CounterAlgorithm &	operator= (const CounterAlgorithm &)=delete
	Forbid assignment. More...
	CounterAlgorithm (const CounterAlgorithm &)=delete
	Forbid copy. More...
virtual StatusCode	newEvent (const CostData &data, size_t index, const float weight=1.) override
	Concrete implimentation. More...
const std::string &	getName () const
	Getter for Counter's name. More...
const MonitorBase *	getParent () const
	Return cached non-owning const ptr to this Counter's parent Monitor. More...
bool	variableExists (const std::string &name) const
	Check if a variable of a given name exists. More...
Variable &	getVariable (const std::string &name)
	Returns a mutable reference to a named Variable. More...
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. More...
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. More...
StatusCode	increment (const std::string &name, float weight=1.0)
	Convenience function. More...
StatusCode	setDenominator (const std::string &name, float value)
	Optional for per-Event Variables. More...
virtual StatusCode	endEvent (float weight=1.0)
	Called by the framework. More...

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. More...
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. More...
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. More...
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="") const
	Appends Counter name (to histogram path) and forwards histogram book request to parent Monitor. More...
float	timeToMilliSec (const uint64_t start, const uint64_t stop) const
	Helper function. More...

Private Attributes
const std::string	m_name
	Counter's name. More...
const MonitorBase *	m_parent
	Counter's parent Monitor. More...
std::unordered_map< std::string, Variable >	m_variables
	Store of Counter's Variables. More...

Detailed Description

Concrete implimentation of Counter to monitor all properties of a given Algorithm instance.

Definition at line 14 of file CounterAlgorithm.h.

Constructor & Destructor Documentation

CounterAlgorithm() [1/3]

CounterAlgorithm::CounterAlgorithm ( )

delete

Forbid default constructor.

CounterAlgorithm() [2/3]

CounterAlgorithm::CounterAlgorithm	(	const std::string &	name,
		const MonitorBase *	parent,
		const bool	skipHistograms = false
	)

Construct counter.

Parameters

[in]	name	Counter's name
[in]	parent	Counter's parent monitor, cached non-owning pointer.
[in]	skipHistograms	Skip histogram's decalration - for derived classes

Definition at line 10 of file CounterAlgorithm.cxx.

  : CounterBase(name, parent)
{
  if (!skipHistograms){
    regHistogram("Time_perCall", "CPU Time/Call;Time [ms];Calls", VariableType::kPerCall, kLog, 0.01, 100000);
    regHistogram("FirstTime_perEvent", "First Call CPU Time;Time [ms];Events", VariableType::kPerCall, kLog, 0.01, 100000);
    regHistogram("Time_perEvent", "CPU Time/Event;Time [ms];Events", VariableType::kPerEvent);
    regHistogram("Time_perEventFractional", "CPU Time/Event CPU Time;Fractional Time;Events", VariableType::kPerEvent, kLinear, 0., 1.);
    regHistogram("AlgCalls_perEvent", "Calls/Event;Calls;Events", VariableType::kPerEvent, kLinear, -0.5, 499.5, 500);
    regHistogram("InEventView_perCall", "In Event View;Yes or No;Calls", VariableType::kPerCall, kLinear, -0.5, 1.5, 2);
    regHistogram("RoIID_perCall", "RoI ID;RoI ID;Calls", VariableType::kPerCall, kLinear, -1.5, 20.5, 22);
    regHistogram("Request_perEvent", "Number of requests/Event;Number of requests;Events", VariableType::kPerEvent, LogType::kLinear, -0.5, 299.5, 300);
    regHistogram("NetworkRequest_perEvent", "Number of network requests/Event;Number of requests;Events", VariableType::kPerEvent, LogType::kLinear, -0.5, 299.5, 300);
    regHistogram("CachedROBSize_perEvent", "Total ROB Size/Event;ROB size;Events", VariableType::kPerEvent, LogType::kLinear, 0, 1024, 50);
    regHistogram("NetworkROBSize_perEvent", "Total ROB Size/Event;ROB size;Events", VariableType::kPerEvent, LogType::kLinear, 0, 1024, 50);
    regHistogram("RequestTime_perEvent", "ROB Elapsed Time/Event;Elapsed Time [ms];Events", VariableType::kPerEvent);
  }
}

~CounterAlgorithm()

virtual CounterAlgorithm::~CounterAlgorithm ( )

virtualdefault

Default destructor.

CounterAlgorithm() [3/3]

CounterAlgorithm::CounterAlgorithm ( const CounterAlgorithm &  )

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]	hist	Bare pointer to histogram. Ownership transferred to THistSvc.
[in]	tDir	Histogram 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.

                                                                       {
  std::string dir = getName();
  if (tDir != "") {
    dir += "/";
    dir += tDir;
  }
  return getParent()->bookGetPointer(hist, dir);
}

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.

                                      {
  for (auto& nameVariablePair : m_variables) {
    ATH_CHECK( nameVariablePair.second.endEvent() );
  }
  return StatusCode::SUCCESS;
}

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]	name	Variable to increment
[in]	value	The payload value
[in]	weight	Global event weight

Definition at line 191 of file CounterBase.cxx.

                                                                             {
  auto it = m_variables.find(name);
  if (it == m_variables.end()) {
    return StatusCode::FAILURE;
  }
  ATH_CHECK( it->second.fill(value, weight) );
  return StatusCode::SUCCESS;
}

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]	name	Variable to increment
[in]	xvalue	The payload x-axis value
[in]	yvalue	The payload y-axis value
[in]	weight	Global event weight

Definition at line 200 of file CounterBase.cxx.

                                                                                             {
  auto it = m_variables.find(name);
  if (it == m_variables.end()) {
    return StatusCode::FAILURE;
  }
  ATH_CHECK( it->second.fill(xvalue, yvalue, weight) );
  return StatusCode::SUCCESS;
}

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.

                                            {
  return m_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.

                                                {
  return m_parent;
}

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]

name

Variable to return

Returns

Mutable reference to Variable

Definition at line 182 of file CounterBase.cxx.

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

increment()

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

inherited

Convenience function.

Equivalent to fill(name, 1.0, weight);

Parameters

[in]	name	Variable to increment
[in]	weight	Global event weight

Definition at line 220 of file CounterBase.cxx.

                                                                     {
  return fill(name, 1.0, weight);
}

newEvent()

StatusCode CounterAlgorithm::newEvent ( const CostData &  data, size_t  index, const float  weight = 1.  )

overridevirtual

Concrete implimentation.

Monitores algorithm at specified index. Expected to match this instances name().

Parameters

[in]	data	Access to event data
[in]	index	Index within appropriate event data container which is to be analysed by this Counter
[in]	weight	Global event weight

Implements CounterBase.

Definition at line 30 of file CounterAlgorithm.cxx.

                                                                                            {
  const xAOD::TrigComposite* alg = data.costCollection().at(index);
 
  const uint64_t start = alg->getDetail<uint64_t>("start"); // in mus
  const uint64_t stop  = alg->getDetail<uint64_t>("stop"); // in mus
  const float cpuTime = timeToMilliSec(start, stop);
 
  ATH_CHECK( fill("Time_perCall", cpuTime, weight) );
 
  ATH_CHECK( fill("Time_perEvent", cpuTime, weight) );
 
  Variable& firstTime_perEvent = getVariable("FirstTime_perEvent");
  if (firstTime_perEvent.getCalls() == 0) {
    ATH_CHECK( firstTime_perEvent.fill(cpuTime, weight) );
  }
 
  ATH_CHECK( setDenominator("Time_perEventFractional", data.algTotalTimeMilliSec()) );
  ATH_CHECK( fill("Time_perEventFractional", cpuTime, weight) );
 
  ATH_CHECK( increment("AlgCalls_perEvent", weight) );
 
  const bool globalScope = (TrigConf::HLTUtils::hash2string( alg->getDetail<TrigConf::HLTHash>("store"), "STORE").find("StoreGateSvc") != std::string::npos);
  ATH_CHECK( fill("InEventView_perCall", (globalScope ? 0.0 : 1.0), weight) );
 
  ATH_CHECK( fill("RoIID_perCall", alg->getDetail<int32_t>("roi"), weight) );
 
  // Monitor data requests per algorithm
  if (data.algToRequestMap().count(index)) {
    for (size_t requestIdx : data.algToRequestMap().at(index)) {
      const xAOD::TrigComposite* request = data.rosCollection().at(requestIdx);
      const std::vector<unsigned> robs_history = request->getDetail<std::vector<unsigned>>("robs_history");
      const std::vector<uint32_t> robs_size = request->getDetail<std::vector<uint32_t>>("robs_size");
 
      bool networkRequestIncremented = false;
      for (size_t i = 0; i < robs_size.size(); ++i) {
        // ROB request was fetched over the network
        if (robs_history[i] == robmonitor::RETRIEVED) {
          // size is stored in words, should be in kilobytes
          ATH_CHECK( fill("NetworkROBSize_perEvent", robs_size[i] / 500., weight) );
          networkRequestIncremented = true;
        }
        // ROB request was cached
        else if (robs_history[i] == robmonitor::HLT_CACHED || robs_history[i] == robmonitor::DCM_CACHED) {
          ATH_CHECK( fill("CachedROBSize_perEvent", robs_size[i] / 500., weight) );
        }
      }
 
      ATH_CHECK( increment("Request_perEvent", weight) );
 
      if (networkRequestIncremented) {
        ATH_CHECK( increment("NetworkRequest_perEvent", weight) );
      }
 
      const float rosTime = timeToMilliSec(request->getDetail<uint64_t>("start"), request->getDetail<uint64_t>("stop"));
      ATH_CHECK( fill("RequestTime_perEvent", rosTime, weight) );
    }
  }
 
  return StatusCode::SUCCESS;
}

operator=()

CounterAlgorithm& CounterAlgorithm::operator= ( const CounterAlgorithm &  )

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]	name	The name of the histogram (and corresponding Variable)
[in]	title	ROOT histogram title string in format "title;xaxis;yaxis"
[in]	xaxis	Controls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]	xmin	X-axis minimum bound.
[in]	xmax	X-axis maximum bound.
[in]	xbins	Number of histogram bins.
[in]	yaxis	Controls if the y-axis should use fixed-width or logarithmic bin boundaries.
[in]	ymin	Y-axis minimum bound.
[in]	ymax	Y-axis maximum bound.
[in]	ybins	Number of histogram bins.

Definition at line 109 of file CounterBase.cxx.

{
  std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
  std::unique_ptr<TH2F> hist;
 
  if (xmax <= xmin || ymax <= ymin || xbins == 0 || ybins == 0) {
    throw std::runtime_error("CounterBase::regHistogram: Cannot have max <= min or bins == 0");
  }
 
  if (xaxis == kLinear && yaxis == kLinear) {
    hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xmin, xmax, ybins, ymin, ymax);
  } else if (xaxis == kLog || yaxis == kLog) {
    if ( (xaxis == kLog && xmin <= 0) || (yaxis == kLog && ymin <= 0) ) {
      throw std::runtime_error("CounterBase::regHistogram: Cannot have min <= 0 with log binning");
    }
    std::unique_ptr<double[]> xlogbins = std::make_unique<double[]>(xbins+1);
    std::unique_ptr<double[]> ylogbins = std::make_unique<double[]>(ybins+1);
    if (xaxis == kLog){
      const double xlogmin = log10(xmin);
      const double xlogmax = log10(xmax);
      const double dlogx   = (xlogmax-xlogmin)/((double)xbins);
      for (size_t i = 0; i <= xbins; ++i) { 
        const double xlog = xlogmin + i*dlogx;
        xlogbins[i] = exp( log(10) * xlog ); 
      }
    } else {
      const double dx = (xmax-xmin)/((double)xbins);
      for (size_t i = 0; i <= xbins; ++i) {
        xlogbins[i] = xmin + i*dx; 
      }
    }
 
    if (yaxis == kLog){
      const double ylogmin = log10(ymin);
      const double ylogmax = log10(ymax);
      const double dlogy   = (ylogmax-ylogmin)/((double)ybins);
      for (size_t i = 0; i <= ybins; ++i) { 
        const double ylog = ylogmin + i*dlogy;
        ylogbins[i] = exp( log(10) * ylog ); 
      }
    } else {
      const double dy = (ymax-ymin)/((double)ybins);
      for (size_t i = 0; i <= ybins; ++i) {
        ylogbins[i] = ymin + i*dy; 
      }
    }
 
    hist = std::make_unique<TH2F>(hisSvcName.c_str(), title.c_str(), xbins, xlogbins.get(), ybins, ylogbins.get());
  } else {
    throw std::runtime_error("CounterBase::regHistogram: Unknown logarithm flag");
  }
 
  m_variables.emplace(std::piecewise_construct,
    std::forward_as_tuple(name),
    std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
  );
  // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
}

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]	name	The name of the histogram (and corresponding Variable)
[in]	title	ROOT histogram title string in format "title;xaxis;yaxis"
[in]	xaxis	Controls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]	min	X-axis minimum bound.
[in]	max	X-axis maximum bound.
[in]	bins	Number of histogram bins.

Definition at line 27 of file CounterBase.cxx.

{
  std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
  std::unique_ptr<TH1F> hist;
 
  if (max <= min || bins == 0) {
    throw std::runtime_error("CounterBase::regHistogram: Cannot have max <= min or bins == 0");
  }
 
  if (xaxis == kLinear) {
    hist = std::make_unique<TH1F>(hisSvcName.c_str(), title.c_str(), bins, min, max);
  } else if (xaxis == kLog) {
    if (min <= 0) {
      throw std::runtime_error("CounterBase::regHistogram: Cannot have min <= 0 with log binning");
    }
    std::unique_ptr<double[]> xbins = std::make_unique<double[]>(bins+1);
    const double xlogmin = log10(min);
    const double xlogmax = log10(max);
    const double dlogx   = (xlogmax-xlogmin)/((double)bins);
    for (size_t i = 0; i <= bins; ++i) { 
      const double xlog = xlogmin + i*dlogx;
      xbins[i] = exp( log(10) * xlog ); 
    }
    hist = std::make_unique<TH1F>(hisSvcName.c_str(), title.c_str(), bins, xbins.get());
  } else {
    throw std::runtime_error("CounterBase::regHistogram: Unknown logarithm flag");
  }
 
  m_variables.emplace(std::piecewise_construct,
    std::forward_as_tuple(name),
    std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
  );
  // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
}

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]	name	The name of the histogram (and corresponding Variable)
[in]	title	ROOT histogram title string in format "title;xaxis;yaxis"
[in]	xaxis	Controls if the x-axis should use fixed-width or logarithmic bin boundaries.
[in]	min	X-axis minimum bound.
[in]	max	X-axis maximum bound.
[in]	bins	Number of histogram bins.

Definition at line 68 of file CounterBase.cxx.

{
  std::string hisSvcName = getParent()->getParent()->getName() + "_" + getParent()->getName() + "_" + getName() + "_" + name;
  std::unique_ptr<TProfile> hist;
 
  if (max <= min || bins == 0) {
    throw std::runtime_error("CounterBase::regTProfile: Cannot have max <= min or bins == 0");
  }
 
  if (xaxis == kLinear) {
    hist = std::make_unique<TProfile>(hisSvcName.c_str(), title.c_str(), bins, min, max);
  } else if (xaxis == kLog) {
    if (min <= 0) {
      throw std::runtime_error("CounterBase::regTProfile: Cannot have min <= 0 with log binning");
    }
    std::unique_ptr<double[]> xbins = std::make_unique<double[]>(bins+1);
    const double xlogmin = log10(min);
    const double xlogmax = log10(max);
    const double dlogx   = (xlogmax-xlogmin)/((double)bins);
    for (size_t i = 0; i <= bins; ++i) { 
      const double xlog = xlogmin + i*dlogx;
      xbins[i] = exp( log(10) * xlog ); 
    }
    hist = std::make_unique<TProfile>(hisSvcName.c_str(), title.c_str(), bins, xbins.get());
  } else {
    throw std::runtime_error("CounterBase::regTProfile: Unknown logarithm flag");
  }
 
  m_variables.emplace(std::piecewise_construct,
    std::forward_as_tuple(name),
    std::forward_as_tuple(name, bookGetPointer(hist.release()), type)
  );
  // Histogram is now owned by THistSvc. A cache of the ptr is kept in the Variable
}

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]	name	Variable to set the denominator for.
[in]	value	The denominator

Definition at line 210 of file CounterBase.cxx.

                                                                         {
  auto it = m_variables.find(name);
  if (it == m_variables.end()) {
    return StatusCode::FAILURE;
  }
  it->second.setDenominator(value);
  return StatusCode::SUCCESS;
}

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.

                                                                                 {
  if (stop < start) {
    throw std::runtime_error("Asked for a stop time " + std::to_string(stop) + " which is before the start time " + std::to_string(start));
  }
  const uint64_t difference = stop - start;
  return (difference * 1e-3); // micro to ms
}

variableExists()

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

inherited

Check if a variable of a given name exists.

Parameters

[in]

name

Name of Variable.

Returns

True if variable already exists.

Definition at line 178 of file CounterBase.cxx.

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

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

• CounterAlgorithm.h
• CounterAlgorithm.cxx