icarus::trigger::details::TriggerPassCounters Class Reference

Tracks pass rate by discrimination threshold and trigger pattern name. More...

#include <TriggerEfficiencyPlotsBase.h>

Public Types
using	Threshold_t = std::string
using	Counter_t = icarus::ns::util::PassCounter< unsigned int >
	Type used as counter for a specific trigger. More...
using	IndexPair_t = std::pair< std::size_t, std::size_t >

Public Member Functions
IndexPair_t	create (Threshold_t const &threshold, std::string const &patternName)
	Creates and returns a new counter. More...
std::size_t	thresholdIndex (Threshold_t const &threshold) const
	Returns the index of the specified threshold (max() if not registered). More...
std::size_t	patternIndex (std::string const &patternName) const
	Returns the index of the specified pattern (max() if not registered). More...
Threshold_t const &	threshold (std::size_t index) const
std::string const &	patternName (std::size_t index) const
std::size_t	nThresholds () const
	Returns the number of thresholds currently registered. More...
std::size_t	nPatterns () const
	Returns the number of patterns currently registered. More...
void	dump (std::ostream &out) const
	Dump all the counters on the specified stream. More...
Counter_t const &	counter (Threshold_t const &threshold, std::string const &patternName) const
Counter_t const &	counter (std::size_t threshold, std::string const &patternName) const
Counter_t const &	counter (Threshold_t const &threshold, std::size_t patternName) const
Counter_t const &	counter (std::size_t threshold, std::size_t patternName) const
Counter_t const &	counter (IndexPair_t indices) const
Counter_t const &	operator() (Threshold_t const &threshold, std::string const &patternName) const
Counter_t const &	operator() (std::size_t threshold, std::string const &patternName) const
Counter_t const &	operator() (Threshold_t const &threshold, std::size_t patternName) const
Counter_t const &	operator() (std::size_t threshold, std::size_t patternName) const
Counter_t const &	operator() (IndexPair_t indices) const
Counter_t &	counter (Threshold_t const &threshold, std::string const &patternName)
Counter_t &	counter (std::size_t threshold, std::string const &patternName)
Counter_t &	counter (Threshold_t const &threshold, std::size_t patternName)
Counter_t &	counter (std::size_t threshold, std::size_t patternName)
Counter_t &	counter (IndexPair_t indices)
Counter_t &	operator() (Threshold_t const &threshold, std::string const &patternName)
Counter_t &	operator() (std::size_t threshold, std::string const &patternName)
Counter_t &	operator() (Threshold_t const &threshold, std::size_t patternName)
Counter_t &	operator() (std::size_t threshold, std::size_t patternName)
Counter_t &	operator() (IndexPair_t indices)
bool	hasThreshold (Threshold_t const &threshold) const
	Returns whether the specified threshold is registered. More...
bool	hasThreshold (std::size_t index) const
bool	hasPattern (std::string const &patternName) const
	Returns whether the specified pattern is registered. More...
bool	hasPattern (std::size_t patternIndex) const

Static Public Attributes
static constexpr std::size_t	NoIndex = std::numeric_limits<std::size_t>::max()
	Represents the index of a threshold or pattern that is not registered. More...

Private Member Functions
std::size_t	registerThreshold (Threshold_t const &threshold)
	Registers a new threshold in the index and returns its index (unchecked). More...
std::size_t	registerPattern (std::string const &name)
	Registers a new pattern in the index and returns its index (unchecked). More...

Private Attributes
std::vector< std::vector < Counter_t > >	fCounters
	All counters; indices: [threshold][pattern]. More...
std::unordered_map < Threshold_t, std::size_t >	fThresholdIndex
	Map: threshold -> threshold index. More...
std::unordered_map < std::string, std::size_t >	fPatternIndex
	Map: pattern name -> pattern index. More...

Detailed Description

Tracks pass rate by discrimination threshold and trigger pattern name.

Definition at line 100 of file TriggerEfficiencyPlotsBase.h.

Member Typedef Documentation

using icarus::trigger::details::TriggerPassCounters::Counter_t = icarus::ns::util::PassCounter<unsigned int>

Type used as counter for a specific trigger.

Definition at line 106 of file TriggerEfficiencyPlotsBase.h.

using icarus::trigger::details::TriggerPassCounters::IndexPair_t = std::pair<std::size_t, std::size_t>

Definition at line 108 of file TriggerEfficiencyPlotsBase.h.

using icarus::trigger::details::TriggerPassCounters::Threshold_t = std::string

Definition at line 103 of file TriggerEfficiencyPlotsBase.h.

Member Function Documentation

auto icarus::trigger::details::TriggerPassCounters::counter	(	Threshold_t const &	threshold,
		std::string const &	patternName
	)		const

Returns the counter for the specified threshold and pattern.

Exceptions

std::out_of_range

if not registered.

Definition at line 152 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index
    { thresholdIndex(threshold), patternIndex(patternName) };
  if (index.first == NoIndex)
    throw std::out_of_range{ threshold };
  if (index.second == NoIndex)
    throw std::out_of_range{ patternName };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(Threshold_t, string)

auto icarus::trigger::details::TriggerPassCounters::counter	(	std::size_t	threshold,
		std::string const &	patternName
	)		const

Definition at line 167 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index { threshold, patternIndex(patternName) };
  if (index.first == NoIndex)
    throw std::out_of_range{ std::to_string(threshold) };
  if (index.second == NoIndex)
    throw std::out_of_range{ patternName };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(size_t, string)

auto icarus::trigger::details::TriggerPassCounters::counter	(	Threshold_t const &	threshold,
		std::size_t	patternName
	)		const

Definition at line 181 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index
    { thresholdIndex(threshold), pattern };
  if (index.first == NoIndex)
    throw std::out_of_range{ threshold };
  if (index.second == NoIndex)
    throw std::out_of_range{ std::to_string(pattern) };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(Threshold_t, size_t)

auto icarus::trigger::details::TriggerPassCounters::counter	(	std::size_t	threshold,
		std::size_t	patternName
	)		const

Definition at line 196 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index { threshold, pattern };
  if (index.first == NoIndex)
    throw std::out_of_range{ std::to_string(threshold) };
  if (index.second == NoIndex)
    throw std::out_of_range{ std::to_string(pattern) };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(size_t, size_t)

auto icarus::trigger::details::TriggerPassCounters::counter

(

IndexPair_t

indices

)

const

Definition at line 210 of file TriggerEfficiencyPlotsBase.cxx.

{
  if (!hasThreshold(indices.first))
    throw std::out_of_range{ std::to_string(indices.first) };
  
  auto const& thrCounters = fCounters[indices.first];
  if (indices.second >= thrCounters.size())
    throw std::out_of_range{ std::to_string(indices.second) };
  
  return thrCounters[indices.second];
} // icarus::trigger::details::TriggerPassCounters::counter(IndexPair_t)

auto icarus::trigger::details::TriggerPassCounters::counter	(	Threshold_t const &	threshold,
		std::string const &	patternName
	)

Definition at line 225 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index
    { thresholdIndex(threshold), patternIndex(patternName) };
  if (index.first == NoIndex)
    throw std::out_of_range{ threshold };
  if (index.second == NoIndex)
    throw std::out_of_range{ patternName };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(Threshold_t, string)

auto icarus::trigger::details::TriggerPassCounters::counter	(	std::size_t	threshold,
		std::string const &	patternName
	)

Definition at line 239 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index { threshold, patternIndex(patternName) };
  if (index.first == NoIndex)
    throw std::out_of_range{ std::to_string(threshold) };
  if (index.second == NoIndex)
    throw std::out_of_range{ patternName };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(size_t, string)

auto icarus::trigger::details::TriggerPassCounters::counter	(	Threshold_t const &	threshold,
		std::size_t	patternName
	)

Definition at line 252 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index
    { thresholdIndex(threshold), pattern };
  if (index.first == NoIndex)
    throw std::out_of_range{ threshold };
  if (index.second == NoIndex)
    throw std::out_of_range{ std::to_string(pattern) };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(Threshold_t, size_t)

auto icarus::trigger::details::TriggerPassCounters::counter	(	std::size_t	threshold,
		std::size_t	patternName
	)

Definition at line 266 of file TriggerEfficiencyPlotsBase.cxx.

{
  IndexPair_t const index { threshold, pattern };
  if (index.first == NoIndex)
    throw std::out_of_range{ std::to_string(threshold) };
  if (index.second == NoIndex)
    throw std::out_of_range{ std::to_string(pattern) };
  return counter(index);
} // icarus::trigger::details::TriggerPassCounters::counter(size_t, size_t)

auto icarus::trigger::details::TriggerPassCounters::counter

(

IndexPair_t

indices

)

Definition at line 278 of file TriggerEfficiencyPlotsBase.cxx.

{
  if (!hasThreshold(indices.first))
    throw std::out_of_range{ std::to_string(indices.first) };
  
  auto& thrCounters = fCounters[indices.first];
  if (indices.second >= thrCounters.size())
    throw std::out_of_range{ std::to_string(indices.second) };
  
  return thrCounters[indices.second];
} // icarus::trigger::details::TriggerPassCounters::counter(IndexPair_t)

auto icarus::trigger::details::TriggerPassCounters::create	(	Threshold_t const &	threshold,
		std::string const &	patternName
	)

Creates and returns a new counter.

Returns

the specified counter

If the counter already exists, it is returned.

Definition at line 89 of file TriggerEfficiencyPlotsBase.cxx.

{
  
  std::size_t thrIndex = thresholdIndex(threshold);
  if (thrIndex == NoIndex) thrIndex = registerThreshold(threshold);
  
  std::size_t patIndex = patternIndex(patternName);
  if (patIndex == NoIndex) patIndex = registerPattern(patternName);
  
  if (thrIndex >= nThresholds())
    fCounters.resize(thrIndex + 1U, std::vector<Counter_t>{ nPatterns() });
  
  if (patIndex >= nPatterns()) {
    for (auto& thrCounters: fCounters) thrCounters.resize(patIndex + 1U);
  }
  
  assert(hasThreshold(thrIndex));
  assert(hasPattern(patIndex));
  return { thrIndex, patIndex };
  
} // icarus::trigger::details::TriggerPassCounters::create()

void icarus::trigger::details::TriggerPassCounters::dump

(

std::ostream &

out

)

const

Dump all the counters on the specified stream.

Definition at line 358 of file TriggerEfficiencyPlotsBase.cxx.

{
  out << "Triggers for " << nThresholds() << " thresholds and " << nPatterns()
    << " patterns:";
  for (auto const iThr: util::counter(nThresholds())) {
    
    assert(hasThreshold(iThr));
    out << "\n  threshold " << threshold(iThr) << " [#" << iThr << "]:";
    unsigned int nonEmptyPatterns = 0U;
    for (auto const iPat: util::counter(nPatterns())) {
      assert(hasPattern(iPat));
      auto const& counts = counter(iThr, iPat);
      if (counts.empty()) continue;
      out << "\n    " << patternName(iPat) << " [#" << iPat << "]: "
        << counts.passed() << " / " << counts.total();
      ++nonEmptyPatterns;
    } // for patterns
    if (nonEmptyPatterns == 0) out << " no events";
    
  } // for threshold
  out << "\n";
} // icarus::trigger::details::TriggerPassCounters::dump()

bool icarus::trigger::details::TriggerPassCounters::hasPattern

(

std::string const &

patternName

)

const

Returns whether the specified pattern is registered.

Definition at line 306 of file TriggerEfficiencyPlotsBase.cxx.

  { return fPatternIndex.find(patternName) != fPatternIndex.end(); }

bool icarus::trigger::details::TriggerPassCounters::hasPattern

(

std::size_t

patternIndex

)

const

Definition at line 312 of file TriggerEfficiencyPlotsBase.cxx.

  { return patternIndex < nPatterns(); }

bool icarus::trigger::details::TriggerPassCounters::hasThreshold

(

Threshold_t const &

threshold

)

const

Returns whether the specified threshold is registered.

Definition at line 294 of file TriggerEfficiencyPlotsBase.cxx.

  { return fThresholdIndex.find(threshold) != fThresholdIndex.end(); }

bool icarus::trigger::details::TriggerPassCounters::hasThreshold

(

std::size_t

index

)

const

Definition at line 300 of file TriggerEfficiencyPlotsBase.cxx.

  { return thresholdIndex < nThresholds(); }

std::size_t icarus::trigger::details::TriggerPassCounters::nPatterns

(

)

const

Returns the number of patterns currently registered.

Definition at line 118 of file TriggerEfficiencyPlotsBase.cxx.

  { return fCounters.empty()? 0U: fCounters.front().size(); }

std::size_t icarus::trigger::details::TriggerPassCounters::nThresholds

(

)

const

Returns the number of thresholds currently registered.

Definition at line 113 of file TriggerEfficiencyPlotsBase.cxx.

  { return fCounters.size(); }

Counter_t const& icarus::trigger::details::TriggerPassCounters::operator() ( Threshold_t const &  threshold, std::string const &  patternName  ) const

inline

Definition at line 139 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t const& icarus::trigger::details::TriggerPassCounters::operator() ( std::size_t  threshold, std::string const &  patternName  ) const

inline

Definition at line 142 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t const& icarus::trigger::details::TriggerPassCounters::operator() ( Threshold_t const &  threshold, std::size_t  patternName  ) const

inline

Definition at line 145 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t const& icarus::trigger::details::TriggerPassCounters::operator() ( std::size_t  threshold, std::size_t  patternName  ) const

inline

Definition at line 148 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t const& icarus::trigger::details::TriggerPassCounters::operator() ( IndexPair_t  indices ) const

inline

Definition at line 150 of file TriggerEfficiencyPlotsBase.h.

    { return counter(indices); }

Counter_t& icarus::trigger::details::TriggerPassCounters::operator() ( Threshold_t const &  threshold, std::string const &  patternName  )

inline

Definition at line 161 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t& icarus::trigger::details::TriggerPassCounters::operator() ( std::size_t  threshold, std::string const &  patternName  )

inline

Definition at line 163 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t& icarus::trigger::details::TriggerPassCounters::operator() ( Threshold_t const &  threshold, std::size_t  patternName  )

inline

Definition at line 165 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t& icarus::trigger::details::TriggerPassCounters::operator() ( std::size_t  threshold, std::size_t  patternName  )

inline

Definition at line 167 of file TriggerEfficiencyPlotsBase.h.

    { return counter(threshold, patternName); }

Counter_t& icarus::trigger::details::TriggerPassCounters::operator() ( IndexPair_t  indices )

inline

Definition at line 169 of file TriggerEfficiencyPlotsBase.h.

{ return counter(indices); }

std::size_t icarus::trigger::details::TriggerPassCounters::patternIndex

(

std::string const &

patternName

)

const

Returns the index of the specified pattern (max() if not registered).

Definition at line 327 of file TriggerEfficiencyPlotsBase.cxx.

{
  auto const iIndex = fPatternIndex.find(patternName);
  return (iIndex == fPatternIndex.end())? NoIndex: iIndex->second;
} // icarus::trigger::details::TriggerPassCounters::patternIndex()

auto icarus::trigger::details::TriggerPassCounters::patternName

(

std::size_t

index

)

const

Returns the name of the pattern with the specified index.

Exceptions

std::out_of_range

if the index is not available

Definition at line 347 of file TriggerEfficiencyPlotsBase.cxx.

{
  // reverse lookup: slow...
  for (auto const& [ name, patIndex ]: fPatternIndex)
    if (patIndex == index) return name;
  throw std::out_of_range{ std::to_string(index) };
} // icarus::trigger::details::TriggerPassCounters::patternName()

std::size_t icarus::trigger::details::TriggerPassCounters::registerPattern ( std::string const &  name )

private

Registers a new pattern in the index and returns its index (unchecked).

Definition at line 138 of file TriggerEfficiencyPlotsBase.cxx.

{
  assert(!hasPattern(name));
  
  std::size_t const newIndex = nPatterns();
  fPatternIndex[name] = newIndex;
  
  assert(hasPattern(name));
  return newIndex;
} // icarus::trigger::details::TriggerPassCounters::registerPattern()

std::size_t icarus::trigger::details::TriggerPassCounters::registerThreshold ( Threshold_t const &  threshold )

private

Registers a new threshold in the index and returns its index (unchecked).

Definition at line 124 of file TriggerEfficiencyPlotsBase.cxx.

{
  assert(!hasThreshold(threshold));
  
  std::size_t const newIndex = nThresholds();
  fThresholdIndex[threshold] = newIndex;
  
  assert(hasThreshold(threshold));
  return newIndex;
} // icarus::trigger::details::TriggerPassCounters::registerThreshold()

auto icarus::trigger::details::TriggerPassCounters::threshold

(

std::size_t

index

)

const

Returns the value of the threshold with the specified index.

Exceptions

std::out_of_range

if the index is not available

Definition at line 336 of file TriggerEfficiencyPlotsBase.cxx.

{
  // reverse lookup: slow...
  for (auto const& [ threshold, thrIndex ]: fThresholdIndex)
    if (thrIndex == index) return threshold;
  throw std::out_of_range{ std::to_string(index) };
} // icarus::trigger::details::TriggerPassCounters::threshold()

std::size_t icarus::trigger::details::TriggerPassCounters::thresholdIndex

(

Threshold_t const &

threshold

)

const

Returns the index of the specified threshold (max() if not registered).

Definition at line 318 of file TriggerEfficiencyPlotsBase.cxx.

{
  auto const iIndex = fThresholdIndex.find(threshold);
  return (iIndex == fThresholdIndex.end())? NoIndex: iIndex->second;
} // icarus::trigger::details::TriggerPassCounters::thresholdIndex()

Member Data Documentation

std::vector<std::vector<Counter_t> > icarus::trigger::details::TriggerPassCounters::fCounters

private

All counters; indices: [threshold][pattern].

Definition at line 211 of file TriggerEfficiencyPlotsBase.h.

std::unordered_map<std::string, std::size_t> icarus::trigger::details::TriggerPassCounters::fPatternIndex

private

Map: pattern name -> pattern index.

Definition at line 217 of file TriggerEfficiencyPlotsBase.h.

std::unordered_map<Threshold_t, std::size_t> icarus::trigger::details::TriggerPassCounters::fThresholdIndex

private

Map: threshold -> threshold index.

Definition at line 214 of file TriggerEfficiencyPlotsBase.h.

constexpr std::size_t icarus::trigger::details::TriggerPassCounters::NoIndex = std::numeric_limits<std::size_t>::max()

static

Represents the index of a threshold or pattern that is not registered.

Definition at line 112 of file TriggerEfficiencyPlotsBase.h.

---

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

• TriggerEfficiencyPlotsBase.h
• TriggerEfficiencyPlotsBase.cxx