Information about composition and topology of trigger sliding windows. More...

#include <WindowChannelMap.h>

Classes
struct	WindowComposition_t
	Geometric location and composition of the window. More...

struct	WindowInfo_t
	Information of a single window. More...

struct	WindowTopology_t
	Information of the identity and neighbourhood of a window. More...

Public Types
using	WindowIndex_t = std::size_t
	Type of window index. More...

Public Member Functions
	WindowChannelMap (std::vector< WindowInfo_t > &&windows)
	Construction: moves the `windows` information into the map. More...

Access to window information.
std::size_t	nWindows () const
	Number of sliding windows. More...

bool	hasWindow (WindowIndex_t index) const
	Returns whether a window with the specified index is present. More...

WindowInfo_t const &	info (WindowIndex_t index) const
	Returns the information for the window with specified `index` (unchecked). More...


void	dump (std::ostream &out, std::string const &indent, std::string const &firstIndent) const
	Prints the content of the full mapping. More...

void	dump (std::ostream &out, std::string const &indent="") const

Static Public Member Functions
static bool	isValidWindow (WindowIndex_t index)
	Returns whether the specified index is not the invalid window index. More...

Static Public Attributes
static const WindowIndex_t	InvalidWindowIndex = std::numeric_limits<WindowIndex_t>::max()
	Special index denoting an invalid window. More...

Private Attributes
std::vector< WindowInfo_t >	fWindows

Iterable standard interface
using	value_type = WindowInfo_t

using	reference_type = WindowInfo_t const &

using	pointer_type = WindowInfo_t const *

std::size_t	size () const

bool	empty () const

auto	begin () const

auto	end () const

auto	cbegin () const

auto	cend () const

Detailed Description

Information about composition and topology of trigger sliding windows.

This class collects optical detector windows defined as a collection of channels, supposedly contiguous in space. A rudimentary topology is described with each window having upstream, downstream windows (with respect to the nominal beam direction) and a single opposite window.

The class exposes a minimal collection interface and is therefore iterable. Windows are identified by an index that matches their position in the collection.

This is just a data structure, and algorithms building the composition and topology of the windows are not part of it.

Definition at line 52 of file WindowChannelMap.h.

Member Typedef Documentation

using icarus::trigger::WindowChannelMap::pointer_type = WindowInfo_t const*

Definition at line 150 of file WindowChannelMap.h.

using icarus::trigger::WindowChannelMap::reference_type = WindowInfo_t const&

Definition at line 149 of file WindowChannelMap.h.

using icarus::trigger::WindowChannelMap::value_type = WindowInfo_t

Definition at line 148 of file WindowChannelMap.h.

using icarus::trigger::WindowChannelMap::WindowIndex_t = std::size_t

Type of window index.

Definition at line 56 of file WindowChannelMap.h.

Constructor & Destructor Documentation

icarus::trigger::WindowChannelMap::WindowChannelMap ( std::vector< WindowInfo_t > && windows )

inlineexplicit

Construction: moves the windows information into the map.

Definition at line 116 of file WindowChannelMap.h.

117 : fWindows(std::move(windows)) {}

icarus::trigger::WindowChannelMap::fWindows

std::vector< WindowInfo_t > fWindows

Definition: WindowChannelMap.h:167

Member Function Documentation

auto icarus::trigger::WindowChannelMap::begin ( ) const

inline

Definition at line 154 of file WindowChannelMap.h.

154 { return fWindows.begin(); }

icarus::trigger::WindowChannelMap::fWindows

std::vector< WindowInfo_t > fWindows

Definition: WindowChannelMap.h:167

auto icarus::trigger::WindowChannelMap::cbegin ( ) const

inline

Definition at line 156 of file WindowChannelMap.h.

156 { return begin(); }

icarus::trigger::WindowChannelMap::begin

auto begin() const

Definition: WindowChannelMap.h:154

auto icarus::trigger::WindowChannelMap::cend ( ) const

inline

Definition at line 157 of file WindowChannelMap.h.

157 { return end(); }

icarus::trigger::WindowChannelMap::end

auto end() const

Definition: WindowChannelMap.h:155

void icarus::trigger::WindowChannelMap::dump	(	std::ostream &	out,
		std::string const &	indent,
		std::string const &	firstIndent
	)		const

Prints the content of the full mapping.

Definition at line 39 of file WindowChannelMap.cxx.

 {
   out << firstIndent << "Map has " << nWindows() << " windows:";
   for (WindowInfo_t const& info: fWindows) {
     out << "\n  "; // additional indentation
     info.dump(out, indent);
   } // for
   out << '\n';
 } // icarus::trigger::WindowChannelMap::dump()