Mapping of ROP channels into wires. More...

#include <ChannelToWireMap.h>

Classes
struct	ChannelsInROPStruct

Public Member Functions
ChannelsInROPStruct const *	find (raw::ChannelID_t channel) const
	Returns data of the ROP including `channel`, `nullptr` if none. More...

ChannelsInROPStruct const *	find (readout::ROPID const &ropid) const
	Returns data of the ROP `ropid`, `nullptr` if none. More...

raw::ChannelID_t	endChannel () const
	Returns the ID of the first invalid channel (the last channel, plus 1). More...

unsigned int	nChannels () const
	Returns the number of mapped channels. More...

void	addROP (readout::ROPID const &rid, raw::ChannelID_t firstROPchannel, unsigned int nChannels)

void	setEndChannel (raw::ChannelID_t channel)
	Sets the ID of the channels after the last valid one. More...

void	clear ()
	Resets the data of the map to like just constructed. More...

Private Attributes
std::vector< ChannelsInROPStruct >	fROPfirstChannel
	Collection of channel ROP channel information, sorted by first channel. More...

raw::ChannelID_t	fEndChannel = 0
	ID of the first invalid channel. More...

Detailed Description

Mapping of ROP channels into wires.

For each readout plane, we store its first channel (the last one can be found from the next ROP), and for all wire planes after the first one, the first channel that is shared (with the previous plane, that is) and the first channel on that plane that is not shared.

Definition at line 34 of file ChannelToWireMap.h.

Member Function Documentation

void icarus::details::ChannelToWireMap::addROP	(	readout::ROPID const &	rid,
		raw::ChannelID_t	firstROPchannel,
		unsigned int	nChannels
	)

inline

Adds the next ROP with its first channel ID (must be larger than previous).

Definition at line 97 of file ChannelToWireMap.h.

     {
       assert(
         fROPfirstChannel.empty()
         || (firstROPchannel > fROPfirstChannel.back().firstChannel)
         );
       fROPfirstChannel.emplace_back(firstROPchannel, nChannels, rid);
     }

void icarus::details::ChannelToWireMap::clear ( )

Resets the data of the map to like just constructed.

Definition at line 47 of file ChannelToWireMap.cxx.

                                           {
   fROPfirstChannel.clear();
   fEndChannel = raw::ChannelID_t{ 0 };
 } // icarus::details::ChannelToWireMap::clear()

raw::ChannelID_t icarus::details::ChannelToWireMap::endChannel ( ) const

inline

Returns the ID of the first invalid channel (the last channel, plus 1).

Definition at line 89 of file ChannelToWireMap.h.

89 { return fEndChannel; }

icarus::details::ChannelToWireMap::fEndChannel

raw::ChannelID_t fEndChannel

ID of the first invalid channel.

Definition: ChannelToWireMap.h:120

auto icarus::details::ChannelToWireMap::find ( raw::ChannelID_t channel ) const

Returns data of the ROP including channel, nullptr if none.

Definition at line 19 of file ChannelToWireMap.cxx.

 {
   // find the first element whose channel is _not_ included
   auto const dbegin = fROPfirstChannel.begin(), dend = fROPfirstChannel.end();
   auto const iNextData = std::upper_bound
     (dbegin, dend, channel, ChannelsInROPStruct::Compare{});
   assert(iNextData != dbegin);
   
   return ((iNextData == dend) && (channel >= endChannel()))
     ? nullptr: &*std::prev(iNextData);
   
 } // icarus::details::ChannelToWireMap::find(raw::ChannelID_t)

auto icarus::details::ChannelToWireMap::find ( readout::ROPID const & ropid ) const

Returns data of the ROP ropid, nullptr if none.

Definition at line 34 of file ChannelToWireMap.cxx.

 {
   // find the first element whose channel is _not_ included
   auto const dend = fROPfirstChannel.end();
   auto const iData = std::find_if(
     fROPfirstChannel.begin(), dend,
     [&ropid](ChannelsInROPStruct const& data){ return data.ropid == ropid; }
     );
   return (iData == dend)? nullptr: &*iData;
 } // icarus::details::ChannelToWireMap::find(readout::ROPID)