icarus::trigger::WindowTopologyVerification Class Reference

Algorithm verifying the topology from trigger gates. More...

#include <WindowTopologyAlg.h>

Inheritance diagram for icarus::trigger::WindowTopologyVerification:

Public Types
using	TriggerGates_t = icarus::trigger::WindowTopologyAlg::TriggerGates_t
	Type of sets of trigger gates. More...
using	TriggerGatesPerCryostat_t = icarus::trigger::WindowTopologyAlg::TriggerGatesPerCryostat_t
	Type of sets of trigger gates, grouped by cryostat. More...

Public Member Functions
	WindowTopologyVerification (icarus::trigger::WindowChannelMap topology, std::string const &logCategory="WindowTopologyVerification")
	Constructor. More...
	WindowTopologyVerification (std::string const &logCategory="WindowTopologyVerification")
	Constructor. More...
bool	hasTopology () const
	Returns whether a window topology is set (see setTopology()). More...
void	setTopology (icarus::trigger::WindowChannelMap topology)
	Resets the topology to be verified against. More...
void	clearTopology ()
	Forgets the current topology. Set a new one with setTopology(). More...
WindowChannelMap const &	getTopology () const
std::string	verify (TriggerGatesPerCryostat_t const &gates) const
	Verifies that gates match the topology current set up. More...
std::string	verify (TriggerGates_t const &gates) const
void	operator() (TriggerGatesPerCryostat_t const &gates) const
	Verifies that gates match the topology current set up. More...
void	operator() (TriggerGates_t const &gates) const

Private Types
using	InputTriggerGate_t = icarus::trigger::WindowTopologyAlg::InputTriggerGate_t
	Type of trigger gate used for input to the algorithm. More...

Private Member Functions
std::string	verifyGate (std::size_t iWindow, InputTriggerGate_t const &gate) const
template<typename Gates >
void	verifyOrThrow (Gates const &gates) const
	Implementation of operator(). More...

Private Attributes
std::optional < icarus::trigger::WindowChannelMap >	fWindowMap
	The reference topology to check against. More...

Additional Inherited Members
Protected Member Functions inherited from icarus::ns::util::mfLoggingClass
	mfLoggingClass (std::string const &logCategory)
	Constructor: initializes with the specified log category. More...
std::string	logCategory () const
	Returns the logging category string for this object. More...
mfLoggingClass const &	loggingClass () const
	Returns this object (as a logging class object). More...
mf::LogError	mfLogError (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogError() stream for logging. More...
mf::LogWarning	mfLogWarning (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogWarning() stream for logging. More...
mf::LogProblem	mfLogProblem (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogProblem() stream for logging. More...
mf::LogInfo	mfLogInfo (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogInfo() stream for logging. More...
mf::LogVerbatim	mfLogVerbatim (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogVerbatim() stream for logging. More...
mf::LogDebug	mfLogDebug (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogDebug() stream for logging. More...
mf::LogTrace	mfLogTrace (std::string const &file={}, int const lineNumber=0) const
	Returns a mf::LogTrace() stream for logging. More...

Detailed Description

Algorithm verifying the topology from trigger gates.

The algorithm needs to be provided a reference topology information. It will then analyze any set of trigger gates to confirm that their grouping matches the one defined in that topology.

Definition at line 215 of file WindowTopologyAlg.h.

Member Typedef Documentation

using icarus::trigger::WindowTopologyVerification::InputTriggerGate_t = icarus::trigger::WindowTopologyAlg::InputTriggerGate_t

private

Type of trigger gate used for input to the algorithm.

Definition at line 300 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyVerification::TriggerGates_t = icarus::trigger::WindowTopologyAlg::TriggerGates_t

Type of sets of trigger gates.

Definition at line 225 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyVerification::TriggerGatesPerCryostat_t = icarus::trigger::WindowTopologyAlg::TriggerGatesPerCryostat_t

Type of sets of trigger gates, grouped by cryostat.

Definition at line 229 of file WindowTopologyAlg.h.

Constructor & Destructor Documentation

icarus::trigger::WindowTopologyVerification::WindowTopologyVerification ( icarus::trigger::WindowChannelMap  topology, std::string const &  logCategory = "WindowTopologyVerification"  )

inline

Constructor.

Parameters

topology	the window topology to be verified against
logCategory	category tag for messages from this algorithm

Definition at line 407 of file WindowTopologyAlg.h.

  : icarus::ns::util::mfLoggingClass(logCategory)
  , fWindowMap(std::move(topology))
{}

icarus::trigger::WindowTopologyVerification::WindowTopologyVerification ( std::string const &  logCategory = "WindowTopologyVerification" )

inline

Constructor.

Parameters

logCategory

category tag for messages from this algorithm

Topology must be set up with setTopology() before any verification can occur.

Definition at line 417 of file WindowTopologyAlg.h.

  : icarus::ns::util::mfLoggingClass(logCategory)
{}

Member Function Documentation

void icarus::trigger::WindowTopologyVerification::clearTopology ( )

inline

Forgets the current topology. Set a new one with setTopology().

Definition at line 442 of file WindowTopologyAlg.h.

  { return fWindowMap.reset(); }

auto icarus::trigger::WindowTopologyVerification::getTopology ( ) const

inline

Returns the current window topology.

Exceptions

std::bad_optional_access

if no topology has been set

Definition at line 436 of file WindowTopologyAlg.h.

  { return fWindowMap.value(); }

bool icarus::trigger::WindowTopologyVerification::hasTopology ( ) const

inline

Returns whether a window topology is set (see setTopology()).

Definition at line 425 of file WindowTopologyAlg.h.

  { return fWindowMap.has_value(); }

void icarus::trigger::WindowTopologyVerification::operator() ( TriggerGatesPerCryostat_t const &  gates ) const

inline

Verifies that gates match the topology current set up.

Parameters

gates

the set of gates to match to the topology

Exceptions

cet::exception	(category: WindowTopologyVerification) if no window topology is set up yet
cet::exception	(category: WindowTopologyVerification) if verification fails

See Also

verify()

Definition at line 454 of file WindowTopologyAlg.h.

  { verifyOrThrow(gates); }

void icarus::trigger::WindowTopologyVerification::operator() ( TriggerGates_t const &  gates ) const

inline

Definition at line 448 of file WindowTopologyAlg.h.

  { verifyOrThrow(gates); }

void icarus::trigger::WindowTopologyVerification::setTopology ( icarus::trigger::WindowChannelMap  topology )

inline

Resets the topology to be verified against.

Definition at line 431 of file WindowTopologyAlg.h.

  { fWindowMap = std::move(topology); }

std::string icarus::trigger::WindowTopologyVerification::verify

(

TriggerGatesPerCryostat_t const &

gates

)

const

Verifies that gates match the topology current set up.

Parameters

gates

the set of gates to match to the topology

Returns

a composite error message (empty on success)

Exceptions

cet::exception

(category: WindowTopologyVerification) if no window topology is set up yet

Gates can be specified either as a collection, or as a set of collections, one per cryostat.

Definition at line 344 of file WindowTopologyAlg.cxx.

{
  /*
   * Verifies that the `gates` are in the expected order and have
   * the expected channel content.
   */

  if (!hasTopology()) {
    throw cet::exception("WindowTopologyVerification")
      << "verify() called without any window topology set to be verified.\n";
  }
  
  std::size_t iWindow = 0U;
  std::string errorMsg; // if this stays `empty()` there is no error
  for (auto const& cryoGates: gates) {
    for (auto const& gate: cryoGates) {
      
      // if error message is `empty()` there is no error
      std::string const windowError = verifyGate(iWindow++, gate);
      
      if (!windowError.empty()) errorMsg += windowError + '\n';
      
    } // for gates in cryostat
  } // for cryostats
  
  return errorMsg;
  
} // icarus::trigger::WindowTopologyVerification::verifyTopologicalMap()

std::string icarus::trigger::WindowTopologyVerification::verify

(

TriggerGates_t const &

gates

)

const

Definition at line 314 of file WindowTopologyAlg.cxx.

{
  /*
   * Verifies that the `gates` are in the expected order and have
   * the expected channel content.
   */

  if (!hasTopology()) {
    throw cet::exception("WindowTopologyVerification")
      << "verify() called without any window topology set to be verified.\n";
  }
  
  std::size_t iWindow = 0U;
  std::string errorMsg; // if this stays `empty()` there is no error
  for (auto const& gate: gates) {
    
    // if error message is `empty()` there is no error
    std::string const windowError = verifyGate(iWindow++, gate);
    
    if (!windowError.empty()) errorMsg += windowError + '\n';
    
  } // for gates
  
  return errorMsg;
  
} // icarus::trigger::WindowTopologyVerification::verify()

std::string icarus::trigger::WindowTopologyVerification::verifyGate ( std::size_t  iWindow, InputTriggerGate_t const &  gate  ) const

private

Checks that the specified gate matched the window with index iWindow.

Returns

message describing the failure, empty on success

Definition at line 376 of file WindowTopologyAlg.cxx.

{
  std::string errors; // if this stays `empty()` there is no error
  
  WindowChannelMap::WindowInfo_t const& windowInfo = fWindowMap->info(iWindow);
  
  auto const channelInWindow
    = [begin=windowInfo.channels.cbegin(),end=windowInfo.channels.cend()]
    (raw::Channel_t channel)
    { return std::binary_search(begin, end, channel); }
    ;
  
  for (raw::Channel_t const channel: gate.channels()) {
    if (channelInWindow(channel)) continue;
    if (errors.empty()) {
      errors =
        "channels not in window #" + std::to_string(windowInfo.index)
        + ":";
    } // if first error
    errors += " " + std::to_string(channel);
  } // for all channels in gate
  
  return errors;
} // icarus::trigger::WindowTopologyVerification::verifyGate()

template<typename Gates >

void icarus::trigger::WindowTopologyVerification::verifyOrThrow ( Gates const &  gates ) const

private

Implementation of operator().

Definition at line 490 of file WindowTopologyAlg.h.

{
  
  std::string const errorMsg = verify(gates);
  if (errorMsg.empty()) return;
  
  // put together the exception message and throw it.
  throw cet::exception("WindowTopologyVerification")
    << "Some channels from trigger gates do not match the previous window allocation:\n"
    << errorMsg
    << "\n"
    << "Window allocation: "
    << fWindowMap.value()
    ;
  
} // icarus::trigger::WindowTopologyVerification::operator()

Member Data Documentation

std::optional<icarus::trigger::WindowChannelMap> icarus::trigger::WindowTopologyVerification::fWindowMap

private

The reference topology to check against.

Definition at line 220 of file WindowTopologyAlg.h.

---

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

• WindowTopologyAlg.h
• WindowTopologyAlg.cxx