icarus::trigger::WindowTopologyAlg Class Reference

Algorithm to create trigger window topology information. More...

#include <WindowTopologyAlg.h>

Inheritance diagram for icarus::trigger::WindowTopologyAlg:

Public Types
using	InputTriggerGate_t = icarus::trigger::TrackedOpticalTriggerGate< sbn::OpDetWaveformMeta >
	Type of trigger gate extracted from the input event. More...
using	TriggerGates_t = std::vector< InputTriggerGate_t >
	A list of trigger gates from input. More...
using	TriggerGatesPerCryostat_t = std::vector< TriggerGates_t >
	Type of lists of gates, one list per cryostat (outer index: cryostat no). More...

Public Member Functions
	WindowTopologyAlg (geo::GeometryCore const &geom, std::string const &logCategory="WindowTopologyAlg")
	Constructor. More...
WindowChannelMap	createFromGates (TriggerGatesPerCryostat_t const &gates) const
	Returns the topology of the windows described by the gates. More...
WindowChannelMap	createFromGates (TriggerGates_t const &gates) const
	Returns the topology of the windows described by the gates. More...
WindowChannelMap	createFromCryostatGates (TriggerGates_t const &windowChannels, geo::CryostatGeo const &cryo) const
	Returns the topology of the windows described by the gates. More...
WindowChannelMap	createFromCryostatGates (TriggerGates_t const &windowChannels, geo::CryostatID cryoID) const
	Returns the topology of the windows described by the gates. More...
template<typename... Args>
auto	emplaceAndDumpMap (Args &&...args) const -> WindowChannelMap

Private Types
using	WindowChannels_t = std::vector< raw::Channel_t >
	All channels in a gate. More...
using	WindowChannelColl_t = std::vector< WindowChannels_t >
	All channels in many gates (one list per gate). More...

Private Member Functions
template<typename... Args>
WindowChannelMap	emplaceAndDumpMap (Args &&...args) const

Static Private Member Functions
static std::vector < WindowChannelMap::WindowInfo_t >	createWindowsFromCryostat (WindowChannelColl_t const &windowChannels, geo::CryostatGeo const &cryo, geo::GeometryCore const &geom, std::size_t firstWindowIndex=0U)
	Extracts topology information from a set of windows. More...
static WindowChannelColl_t	extractGateChannels (TriggerGates_t const &gates)
	Extracts the channel ID from a collection of gates. More...
static WindowChannelMap::WindowInfo_t const *	findClosestWindow (std::vector< WindowChannelMap::WindowInfo_t * > const &windowList, WindowChannelMap::WindowInfo_t const *targetWindow)
	Returns the window in windowList closest to the targetWindow. More...

Private Attributes
geo::GeometryCore const *const	fGeom
	Geometry service provider. 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 to create trigger window topology information.

The algorithm defines the windows based on trigger gates and their channels, and establishes their topology cryostat by cryostat.

Definition at line 50 of file WindowTopologyAlg.h.

Member Typedef Documentation

using icarus::trigger::WindowTopologyAlg::InputTriggerGate_t = icarus::trigger::TrackedOpticalTriggerGate<sbn::OpDetWaveformMeta>

Type of trigger gate extracted from the input event.

Definition at line 58 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyAlg::TriggerGates_t = std::vector<InputTriggerGate_t>

A list of trigger gates from input.

Definition at line 61 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyAlg::TriggerGatesPerCryostat_t = std::vector<TriggerGates_t>

Type of lists of gates, one list per cryostat (outer index: cryostat no).

Definition at line 64 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyAlg::WindowChannelColl_t = std::vector<WindowChannels_t>

private

All channels in many gates (one list per gate).

Definition at line 148 of file WindowTopologyAlg.h.

using icarus::trigger::WindowTopologyAlg::WindowChannels_t = std::vector<raw::Channel_t>

private

All channels in a gate.

Definition at line 145 of file WindowTopologyAlg.h.

Constructor & Destructor Documentation

icarus::trigger::WindowTopologyAlg::WindowTopologyAlg	(	geo::GeometryCore const &	geom,
		std::string const &	logCategory = "WindowTopologyAlg"
	)

Constructor.

Parameters

geom	geometry service provider
logCategory	category tag for messages from this algorithm

Definition at line 54 of file WindowTopologyAlg.cxx.

  : icarus::ns::util::mfLoggingClass(logCategory)
  , fGeom(&geom)
{}

Member Function Documentation

auto icarus::trigger::WindowTopologyAlg::createFromCryostatGates	(	TriggerGates_t const &	windowChannels,
		geo::CryostatGeo const &	cryo
	)		const

Returns the topology of the windows described by the gates.

Parameters

gates	a set of gates within a single cryostat
cryo	the cryostat the gates (and their channels) belong to

Returns

topology of the windows described by the gates

The input gates is a collection with all the gates from the specified cryostat cryo.

Each gate covers one or more channels: each window is made out of all the channels in a gate. The opening content of the gates is not considered.

Definition at line 121 of file WindowTopologyAlg.cxx.

{
  return emplaceAndDumpMap(
    createWindowsFromCryostat(extractGateChannels(windowChannels), cryo, *fGeom)
    );
} // icarus::trigger::WindowTopologyAlg::createFromCryostatGates()

auto icarus::trigger::WindowTopologyAlg::createFromCryostatGates	(	TriggerGates_t const &	windowChannels,
		geo::CryostatID	cryoID
	)		const

Returns the topology of the windows described by the gates.

Parameters

gates	a set of gates within a single cryostat
cryoID	ID of the cryostat the gates (and their channels) belong to

Returns

topology of the windows described by the gates

See Also

createFromCryostatGates(TriggerGates_t const&, geo::CryostatGeo const&)

The input gates is a collection with all the gates from the specified cryostat with ID cryoID.

See createFromCryostatGates(WindowChannelsPerCryostat_t const&, geo::CryostatGeo const&) for more information.

Definition at line 132 of file WindowTopologyAlg.cxx.

{
  return createFromCryostatGates(windowChannels, fGeom->Cryostat(cryoID));
} // icarus::trigger::WindowTopologyAlg::createFromCryostatGates()

auto icarus::trigger::WindowTopologyAlg::createFromGates

(

TriggerGatesPerCryostat_t const &

gates

)

const

Returns the topology of the windows described by the gates.

Parameters

gates

a set of gates, grouped by cryostat

Returns

topology of the windows described by the gates

The input gates is a collection with as many entries as there are cryostats in the detector, the first entry collecting all gates from the first cryostat (C:0), the next all the gates from the second one (C:2), and so on.

Each gate covers one or more channels: each window is made out of all the channels in a gate. The opening content of the gates is not considered.

Definition at line 65 of file WindowTopologyAlg.cxx.

{
  
  // store the window topology information here:
  std::vector<WindowChannelMap::WindowInfo_t> windows;
  
  for (auto const& [ cryoGates, cryo ]
    : util::zip(gates, fGeom->IterateCryostats()))
  {
    
    append(
      windows,
      createWindowsFromCryostat
        (extractGateChannels(cryoGates), cryo, *fGeom, windows.size())
      );
    
  } // for cryostats
  
  return emplaceAndDumpMap(std::move(windows));
  
} // icarus::trigger::WindowTopologyAlg::createFromGates()

auto icarus::trigger::WindowTopologyAlg::createFromGates

(

TriggerGates_t const &

gates

)

const

Returns the topology of the windows described by the gates.

Parameters

gates

a set of gates

Returns

topology of the windows described by the gates

The input gates is a collection with all relevant gates in the detector.

Each gate covers one or more channels: each window is made out of all the channels in a gate. The opening content of the gates is not considered.

Gates are first split by the cryostat they belong to (cross-cryostat gates are forbidden), and then the window topology is extracted.

Definition at line 90 of file WindowTopologyAlg.cxx.

{
  
  // split gates by cryostat
  TriggerGatesPerCryostat_t gatesByCryostat { fGeom->Ncryostats() };
  for (InputTriggerGate_t const& gate: gates) {
    
    geo::CryostatID cid; // invalid
    assert(!cid.isValid);
    
    for (raw::Channel_t const channel: gate.channels()) {
      geo::OpDetGeo const& opDet = fGeom->OpDetGeoFromOpChannel(channel);
      geo::OpDetID const oid = opDet.ID();
      if (!cid) cid = oid;
      else if (cid != oid) { // just in case
        throw cet::exception("WindowTopologyAlg")
          << "Input gate includes gates from different cryostats!!\n";
      }
    } // for channels in gate
    if (!cid) continue; // gate with no channels does not contribute
    
    gatesByCryostat.at(cid.Cryostat).push_back(gate); // (copy)
  } // for gates
  
  return createFromGates(gatesByCryostat);
  
} // icarus::trigger::WindowTopologyAlg::createFromGates()

auto icarus::trigger::WindowTopologyAlg::createWindowsFromCryostat ( WindowChannelColl_t const &  windowChannels, geo::CryostatGeo const &  cryo, geo::GeometryCore const &  geom, std::size_t  firstWindowIndex = 0U  )

staticprivate

Extracts topology information from a set of windows.

Parameters

windowChannels	the windows, specified by composition in channel ID
cryo	the cryostat the windows belong to
geom	geometry service provider
firstWindowIndex	(default: 0) the index assigned to the first window

Returns

window topology information, one entry per window

Definition at line 151 of file WindowTopologyAlg.cxx.

{
  /*
   * 1.     fill the window information with local information
   * 2.     sort the windows in drift plane (first cryostat TPC as reference)
   * 3.     split the windows per plane
   * 4.     for each window plane:
   * 4.1.     sort windows on beam direction (TPC width direction)
   * 4.2.     fill the neighbour information on each window
   */
  std::vector<WindowChannelMap::WindowInfo_t> windows;
  windows.reserve(windowChannels.size());
  
  // use the first TPC of the cryostat as reference for directions
  assert(cryo.NTPC() > 0U);
  geo::TPCGeo const& refTPC = cryo.TPC(0U);
  
  //
  // 1. fill the window information with local information
  //
  using WindowInfoPtrs_t = std::vector<WindowChannelMap::WindowInfo_t*>;
  
  WindowInfoPtrs_t cryoWindowInfo;
  cryoWindowInfo.reserve(windowChannels.size());
  
  std::size_t iWindow = firstWindowIndex;
  for (auto const& channels: windowChannels) {
    
    WindowChannelMap::WindowInfo_t wInfo;
    
    wInfo.index = iWindow++;
    wInfo.channels = channels;
    std::sort(wInfo.channels.begin(), wInfo.channels.end());
    wInfo.cryoid = channels.empty()
      ? geo::CryostatID{}
      : geom.OpDetGeoFromOpChannel(channels.front()).ID().asCryostatID()
      ;
    
    geo::vect::MiddlePointAccumulator middlePoint;
    for (raw::Channel_t const channel: channels) {
      // documentation of OpDetGeoFromOpChannel() does not say what on error...
      geo::OpDetGeo const& opDet = geom.OpDetGeoFromOpChannel(channel);
      middlePoint.add(opDet.GetCenter());
      if (opDet.ID() != wInfo.cryoid) wInfo.cryoid = geo::CryostatID{};
    } // for channel
    wInfo.center = middlePoint.middlePoint();
    
    windows.push_back(std::move(wInfo));
    cryoWindowInfo.push_back(&windows.back());
    
  } // for windows
  
  //
  // 2. sort the windows in drift plane (first cryostat TPC as reference)
  //
  auto const normalProjection = [&refTPC](auto const* info)
    { return refTPC.DistanceFromReferencePlane(info->center); };
  WindowInfoPtrs_t const windowsByNormal
    = util::sortCollBy(cryoWindowInfo, normalProjection);
  
  //
  // 3. split the windows per plane
  //
  // split the list in two; there is a good deal of faith here
  auto const beamCoordinate
    = [&refPlane=refTPC.ReferencePlane()](auto const* info)
      { return refPlane.PointWidthDepthProjection(info->center).X(); }
    ;

  //
  // 4. for each plane:
  //
  // 4.1. sort windows on beam direction (TPC width direction)
  //
  auto const iMiddleWindow
    = std::next(windowsByNormal.cbegin(), windowsByNormal.size() / 2U);
  std::array<WindowInfoPtrs_t, 2U> const windowsByPlane = {
    util::sortBy(windowsByNormal.cbegin(), iMiddleWindow, beamCoordinate),
    util::sortBy(iMiddleWindow, windowsByNormal.cend(), beamCoordinate)
  };
  
  for (auto const& [ iPlane, planeWindows ]: util::enumerate(windowsByPlane)) {
    //
    // 4.2.     fill the neighbour information on each window
    //
    auto const& otherPlaneWindows
      = windowsByPlane.at(windowsByPlane.size() - 1U - iPlane);
    std::size_t const iLastPlaneWindow = planeWindows.size() - 1U;
    for (auto [ iPlaneWindow, windowInfo ]: util::enumerate(planeWindows)) {
      
      // assumes all topology information is InvalidWindowIndex by default
      
      if (WindowChannelMap::WindowInfo_t const* closestOppositeWindow
        = findClosestWindow(otherPlaneWindows, windowInfo)
      ) {
        windowInfo->opposite = closestOppositeWindow->index;
      }

      if (iPlaneWindow > 0U)
        windowInfo->upstream = planeWindows[iPlaneWindow - 1U]->index;
      
      if (iPlaneWindow < iLastPlaneWindow)
        windowInfo->downstream = planeWindows[iPlaneWindow + 1U]->index;
      
    } // for window in plane
  } // for planes
  
  return windows;
  
} // icarus::trigger::WindowTopologyAlg::createWindowsFromCryostat()

template<typename... Args>

auto icarus::trigger::WindowTopologyAlg::emplaceAndDumpMap

(

Args &&...

args

)

const -> WindowChannelMap

Definition at line 141 of file WindowTopologyAlg.cxx.

{
  WindowChannelMap const map { std::forward<Args>(args)... };
  mfLogTrace() << "Window map: << " << map;
  return map;
} // icarus::trigger::WindowTopologyAlg::emplaceAndDumpMap()

template<typename... Args>

WindowChannelMap icarus::trigger::WindowTopologyAlg::emplaceAndDumpMap ( Args &&...  args ) const

private

Convenience function: creates and returns a WindowChannelMap from the arguments (args); in the meanwhile, it also dumps it into debug stream.

auto icarus::trigger::WindowTopologyAlg::extractGateChannels ( TriggerGates_t const &  gates )

staticprivate

Extracts the channel ID from a collection of gates.

Parameters

gates

a collection of gates

Returns

a collection of channel lists

The returned collection has one entry per input gate in gates: each entry is the list of channels that the corresponding gate covers.

Definition at line 270 of file WindowTopologyAlg.cxx.

{
  
  WindowChannelColl_t windowChannels;
  windowChannels.reserve(gates.size());
  
  for (InputTriggerGate_t const& gate: gates) {
    auto const& gateChannels = gate.channels();
    windowChannels.emplace_back(gateChannels.begin(), gateChannels.end());
  } // for gates
  
  return windowChannels;
  
} // icarus::trigger::WindowTopologyAlg::extractGateChannels()

auto icarus::trigger::WindowTopologyAlg::findClosestWindow ( std::vector< WindowChannelMap::WindowInfo_t * > const &  windowList, WindowChannelMap::WindowInfo_t const *  targetWindow  )

staticprivate

Returns the window in windowList closest to the targetWindow.

Parameters

windowList	list of (pointers to) the candidate windows
targetWindow	the reference window

Returns

a pointer to the closest among windowList, nullptr if none

A pointer to the window with the smallest distance from targetWindow is returned. The distance is computed between the centers of the windows as reported by the windows themselves.

The only case where no window (nullptr) is returned is when the window candidate list windowList is empty.

Definition at line 287 of file WindowTopologyAlg.cxx.

{
  
  if (!targetWindow || windowList.empty()) return nullptr;
  
  WindowChannelMap::WindowInfo_t const* closest = nullptr;
  double minDistance2 = std::numeric_limits<double>::max();
  for (auto const* window: windowList) {
    if (!window) continue;
    
    double const d2 = (window->center - targetWindow->center).mag2();
    if (minDistance2 <= d2) continue;
    minDistance2 = d2;
    closest = window;
  } // for
  
  return closest;
} // icarus::trigger::WindowTopologyAlg::findClosestWindow()

Member Data Documentation

geo::GeometryCore const* const icarus::trigger::WindowTopologyAlg::fGeom

private

Geometry service provider.

Definition at line 151 of file WindowTopologyAlg.h.

---

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

• WindowTopologyAlg.h
• WindowTopologyAlg.cxx