Channel mapping for ICARUS detector with split wires. More...

#include <ICARUSChannelMapAlg.h>

Inheritance diagram for icarus::ICARUSChannelMapAlg:

Classes
struct	Config

struct	PlaneInfo_t
	Collection of information on one plane. More...

struct	ReadoutMappingInfo_t
	Collected information about TPC sets and readout planes in the geometry. More...

Public Types
using	Parameters = fhicl::Table< Config >
	Type of FHiCL configuration table for this object. More...

Public Member Functions
	ICARUSChannelMapAlg (Config const &config)
	Constructor: taked a configuration object. More...

	ICARUSChannelMapAlg (Parameters const &config)
	Constructor: takes a FHiCL table object. More...

virtual void	Initialize (geo::GeometryData_t const &geodata) override
	Prepares the algorithm extracting information from the geometry. More...

virtual void	Uninitialize () override
	Frees the resources of this algorithm. More...

virtual std::set< geo::PlaneID > const &	PlaneIDs () const override
	Returns a list of the plane IDs in the whole detector. More...

virtual geo::GeoObjectSorter const &	Sorter () const override
	Return the sorter. More...

Channel mapping
virtual std::vector< geo::WireID >	ChannelToWire (raw::ChannelID_t channel) const override
	Returns a collection of ID of wires connected to the `channel`. More...

virtual unsigned int	Nchannels () const override
	Returns the number of readout channels (ID's go `0` to `Nchannels()`). More...

virtual unsigned int	Nchannels (readout::ROPID const &ropid) const override
	Returns the number of channels in the specified ROP. More...

virtual raw::ChannelID_t	PlaneWireToChannel (geo::WireID const &wireID) const override
	Returns the channel ID a wire is connected to. More...

virtual raw::ChannelID_t	PlaneWireToChannel (unsigned int plane, unsigned int wire, unsigned int tpc, unsigned int cstat) const override
	Returns the channel ID a wire is connected to. More...

Deprecated functions.
These methods are legacy and might be replaced by `geo::GeometryCore` calls.
virtual double	WireCoordinate (double YPos, double ZPos, geo::PlaneID const &planeID) const override
	Returns the index of the wire nearest to the specified position. More...

virtual double	WireCoordinate (double YPos, double ZPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the index of the wire nearest to the specified position. More...


virtual geo::WireID	NearestWireID (const TVector3 &worldPos, geo::PlaneID const &planeID) const override
	Returns the ID of the wire nearest to the specified position. More...

virtual geo::WireID	NearestWireID (const TVector3 &worldPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the ID of the wire nearest to the specified position. More...

TPC set mapping
virtual unsigned int	NTPCsets (readout::CryostatID const &cryoid) const override
	Returns the total number of TPC sets in the specified cryostat. More...

virtual unsigned int	MaxTPCsets () const override
	Returns the largest number of TPC sets any cryostat in the detector has. More...

virtual bool	HasTPCset (readout::TPCsetID const &tpcsetid) const override

virtual readout::TPCsetID	TPCtoTPCset (geo::TPCID const &tpcid) const override
	Returns the ID of the TPC set the specified TPC belongs to. More...

virtual std::vector< geo::TPCID >	TPCsetToTPCs (readout::TPCsetID const &tpcsetid) const override
	Returns a list of ID of TPCs belonging to the specified TPC set. More...

virtual geo::TPCID	FirstTPCinTPCset (readout::TPCsetID const &tpcsetid) const override
	Returns the ID of the first TPC belonging to the specified TPC set. More...

Readout plane mapping
virtual unsigned int	NROPs (readout::TPCsetID const &tpcsetid) const override
	Returns the total number of readout planes in the specified TPC set. More...

virtual unsigned int	MaxROPs () const override
	Returns the largest number of ROPs a TPC set in the detector has. More...

virtual bool	HasROP (readout::ROPID const &ropid) const override

virtual readout::ROPID	WirePlaneToROP (geo::PlaneID const &planeid) const override
	Returns the ID of the ROP planeid belongs to, or invalid if none. More...

virtual std::vector< geo::PlaneID >	ROPtoWirePlanes (readout::ROPID const &ropid) const override
	Returns a list of ID of wire planes belonging to the specified ROP. More...

virtual std::vector< geo::TPCID >	ROPtoTPCs (readout::ROPID const &ropid) const override
	Returns a list of ID of TPCs the specified ROP spans. More...

virtual readout::ROPID	ChannelToROP (raw::ChannelID_t channel) const override
	Returns the ID of the ROP the channel belongs to (invalid if none). More...

virtual raw::ChannelID_t	FirstChannelInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first channel in the specified readout plane. More...

virtual geo::PlaneID	FirstWirePlaneInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first plane belonging to the specified ROP. More...

Public Member Functions inherited from geo::ChannelMapAlg
virtual	~ChannelMapAlg ()=default
	Virtual destructor. More...

virtual unsigned int	NOpChannels (unsigned int NOpDets) const
	Returns the number of optical channels contained in some detectors. More...

virtual unsigned int	MaxOpChannel (unsigned int NOpDets) const
	Returns the number of optical channels contained in some detectors. More...

virtual unsigned int	NOpHardwareChannels (unsigned int opDet) const
	Returns the number of channels in the specified optical detectors. More...

virtual bool	IsValidOpChannel (unsigned int opChannel, unsigned int NOpDets) const
	Returns whether the ID identifies a valid optical detector channel. More...

virtual unsigned int	OpChannel (unsigned int detNum, unsigned int hwchannel=0) const
	Returns the channel ID of the specified hardware channel. More...

virtual unsigned int	OpDetFromOpChannel (unsigned int opChannel) const
	Returns the optical detector the specified optical channel belongs. More...

virtual unsigned int	HardwareChannelFromOpChannel (unsigned int opChannel) const
	Returns the hardware channel number of specified optical channel. More...

unsigned int	NearestWire (const TVector3 &worldPos, geo::PlaneID const &planeID) const
	Returns the index of the wire nearest to the specified position. More...

unsigned int	NearestWire (const TVector3 &worldPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const
	Returns the index of the wire nearest to the specified position. More...

virtual size_t	NearestAuxDet (const double *point, std::vector< geo::AuxDetGeo > const &auxDets, double tolerance=0) const
	Returns the auxiliary detector closest to the specified point. More...

virtual size_t	NearestSensitiveAuxDet (const double *point, std::vector< geo::AuxDetGeo > const &auxDets, double tolerance=0) const
	Returns sensitive auxiliary detector closest to specified point. More...

virtual size_t	ChannelToAuxDet (std::vector< geo::AuxDetGeo > const &auxDets, std::string const &detName, uint32_t const &channel) const
	Returns the index of the detector containing the specified channel. More...

virtual std::pair< size_t, size_t >	ChannelToSensitiveAuxDet (std::vector< geo::AuxDetGeo > const &auxDets, std::string const &detName, uint32_t const &channel) const
	Returns the index of the sensitive detector containing the channel. More...

const std::vector< std::vector < std::vector < raw::ChannelID_t > > >	FirstChannelInNextPlane () const
	Retrieve the private fFirstChannelInNextPlane vector for testing. More...

const std::vector< std::vector < std::vector < raw::ChannelID_t > > >	FirstChannelInThisPlane () const
	Retrieve the private fFirstChannelInThisPlane vector for testing. More...

virtual bool	HasChannel (raw::ChannelID_t channel) const
	Returns whether the specified channel is valid This default implementation assumes all channels up to Nchannels() valid. More...

geo::SigType_t	SignalTypeForChannel (raw::ChannelID_t const channel) const
	Return the signal type of the specified channel. More...

geo::SigType_t	SignalTypeForROPID (readout::ROPID const &ropid) const
	Return the signal type on the specified readout plane. More...

Private Types
using	TPCColl_t = icarus::details::TPCColl_t

using	PlaneColl_t = icarus::details::PlaneColl_t

using	WirelessChannelCounts_t = std::array< std::array< std::pair< unsigned int, unsigned int >, 3U >, 2U >

using	PlaneType_t = std::size_t
	Type for plane type identifier. More...

Private Member Functions
bool	HasCryostat (readout::CryostatID const &cryoid) const
	Returns whether the specified cryostat is known to the mapping. More...

void	fillChannelToWireMap (geo::GeometryData_t::CryostatList_t const &Cryostats)
	Fills the information about readout channel mapping. More...

void	buildReadoutPlanes (geo::GeometryData_t::CryostatList_t const &Cryostats)
	Fills information about the TPC set and readout plane structure. More...

PlaneType_t	findPlaneType (readout::ROPID const &ropid) const
	Returns the "type" of readout plane. More...

virtual geo::SigType_t	SignalTypeForChannelImpl (raw::ChannelID_t const channel) const override
	Returns the type of signal on the specified `channel`. More...

Readout element information access
std::vector< unsigned int > const &	TPCsetCount () const
	Returns the number of TPC sets in each cryostat. More...

unsigned int	TPCsetCount (readout::CryostatID const &cid) const
	Returns the number of TPC sets in the specified cryostat `cid`. More...

readout::TPCsetDataContainer < TPCColl_t > const &	TPCsetTPCs () const
	All `geo::TPCGeo` objects in each TPC set, sorted by increasing z. More...

TPCColl_t const &	TPCsetTPCs (readout::TPCsetID const &sid) const
	All `geo::TPCGeo` objects in the specified TPC set `sid`. More...

readout::TPCsetDataContainer < unsigned int > const &	ROPcount () const
	Number of readout planes in each TPC set. More...

unsigned int	ROPcount (readout::TPCsetID const &sid) const
	Number of readout planes in the specified TPC set `sid`. More...

readout::ROPDataContainer < PlaneColl_t > const &	ROPplanes () const
	All `geo::PlaneGeo` objects in each readout plane, sorted by z. More...

PlaneColl_t const &	ROPplanes (readout::ROPID const &rid) const
	All `geo::PlaneGeo` objects in the specified readout plane `rid`. More...

geo::TPCDataContainer < readout::TPCsetID > const &	TPCtoTPCset () const
	The TPC set including each TPC. More...

geo::PlaneDataContainer < readout::ROPID > const &	PlaneToROP () const
	The readout plane including each wire plane. More...

readout::ROPID const &	PlaneToROP (geo::PlaneID const &pid) const
	The readout plane the specified wire plane `pid` belongs to. More...

Static Private Member Functions
static WirelessChannelCounts_t	extractWirelessChannelParams (Config::WirelessChannelStruct const &params)

static std::string	PlaneTypeName (PlaneType_t planeType)
	Returns the name of the specified plane type. More...

Private Attributes
WirelessChannelCounts_t const	fWirelessChannelCounts
	Count of wireless channels on each plane. More...

icarus::GeoObjectSorterPMTasTPC	fSorter
	Algorithms to sort geometry elements. More...

Static Private Attributes
static constexpr PlaneType_t	kFirstInductionType = 0U
	Identifier for first induction plane type. More...

static constexpr PlaneType_t	kSecondInductionType = 1U
	Identifier for second induction plane type. More...

static constexpr PlaneType_t	kCollectionType = 2U
	Identifier for collection plane type. More...

static constexpr PlaneType_t	kUnknownType = std::numeric_limits<PlaneType_t>::max()
	Identifier for unknown plane type. More...

Readout element information
The geometry and readout data containers have currently no support for resizing and their size is assigned on construction. Access should happen via the corresponding member functions.
using	ChannelRange_t = icarus::details::ChannelRange_t

ReadoutMappingInfo_t	fReadoutMapInfo
	Information about TPC sets and readout planes in the geometry. More...

icarus::details::ChannelToWireMap	fChannelToWireMap
	Mapping of channels to wire planes and ROP's. More...

geo::PlaneDataContainer < PlaneInfo_t >	fPlaneInfo
	Range of channels covered by each of the wire planes. More...

Additional Inherited Members
Protected Types inherited from geo::ChannelMapAlg
template<typename T >
using	TPCInfoMap_t = std::vector< std::vector< T >>
	Data type for per-TPC information. More...

template<typename T >
using	PlaneInfoMap_t = TPCInfoMap_t< std::vector< T >>
	Data type for per-plane information. More...

Protected Member Functions inherited from geo::ChannelMapAlg
template<typename T >
T const &	AccessElement (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const
	Returns the specified element of the plane map. More...

template<typename T >
size_t	AccessElementSize (PlaneInfoMap_t< T > const &map, geo::TPCID const &id) const
	Returns the number of elements in the specified TPC of the plane map. More...

template<typename T >
T const *	GetElementPtr (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const
	Returns a pointer to the specified element, or nullptr if invalid. More...

template<typename T >
T const &	AccessElement (TPCInfoMap_t< T > const &map, geo::TPCID const &id) const
	Returns the specified element of the TPC map. More...

template<typename T >
size_t	AccessElementSize (TPCInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns the number of elements in the specified cryostat of the TPC map. More...

template<typename T >
bool	isValidElement (TPCInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns whether the ID specifies a valid entry. More...

template<typename T >
bool	isValidElement (TPCInfoMap_t< T > const &map, geo::TPCID const &id) const

template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns whether the ID specifies a valid entry. More...

template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::TPCID const &id) const

template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const

virtual geo::SigType_t	SignalTypeForROPIDImpl (readout::ROPID const &ropid) const
	Return the signal type on the specified readout plane. More...

Protected Attributes inherited from geo::ChannelMapAlg
PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInThisPlane

PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInNextPlane

std::map< std::string, size_t >	fADNameToGeo
	map the names of the dets to the AuxDetGeo objects More...

std::map< size_t, std::vector < size_t > >	fADChannelToSensitiveGeo

Detailed Description

Channel mapping for ICARUS detector with split wires.

This channel mapping is designed for a detector description including two TPC volumes in each drift volume.

Each of the four drift volumes in the ICARUS detector (one on each of the two side of the cathode, on each of the two cryostats/modules) is described by two "logical" TPC volumes. The division of the drift volume in two TPCs is not physical, but it is a convenient description to accommodate the fact that the first induction plane wires are split in two 9-meter halves which are read independently.

In this scheme, the physical wires from the second induction and the collection planes may be described by two geo::WireGeo objects associated to the same readout channel, with the two geo::WireGeo belonging to a different geo::TPCGeo and geo::PlaneGeo (but the planes are of the same type and on the same view). Therefore, physical wires on the second induction and collection planes are associated with a single geo::WireGeo unless they cross the virtual border between TPCs half way on the beam direction, in which case they are associated with two geo::WireGeo. The first induction wires are always associated with a single geo::WireGeo. Each physical wire is associated and identified with a single TPC readout channel.

The numbering of channels is as follows:

the numbering is driven by physical wire planes
plane 0 goes first, then planes 1 and 2 follow; plane 0 is the plane closest to the drift volume, that is the first induction plane;
the internal order of the channels is defined by geo::PlaneGeo internal sorting algorithms, but it is guaranteed to be such that contiguous wires within the same logical wire plane have contiguous wire numbers, with no jumps and holes allowed;
TPC 0 and 1, which are "logical" TPCs describing the same drift volume, go first, then TPCs 2 and 3
cryostat 0 goes first, then cryostat 1

This implies that the first wire plane being enumerated is C:0 T:0 P:0, and then C:0 T:1 P:0, that cover the first induction plane of the first drift volume, then the C:0 T:0 P:1 and C:0 T:1 P:1 are grouped together for the second induction plane, and finally C:0 T:0 P:2 and C:0 T:1 P:2 for the collection. Thereafter, the enumeration proceeds through C:0 T:2 and C:0 T:3 starting with C:0 T:2 P:0, and then with the other cryostat in the same TPC and plane order.

Wireless channels

It is possible to specify that some channels at the beginning and at the end of a readout plane are not connected to wires.

When a readout plane is extended to include "wireless" channels, additional channel IDs are included in the sequence of channels. Channel mapping does not distinguish between wireless channels (which have readout, cable but no wire), ghost channels (which have no bable either) and virtual channels (which do not have even readout): the count of wireless channels includes all of these categories, i.e. all the categories that have a readout channel ID but no physical wire.

The range of channels belonging to the readout plane (intended in LArSoft fashion as readout::ROPID) is extended to include these wireless channels, but each of the wire planes does not include them: they are orphaned of wire planes (no geo::PlaneID). The total number of channels reported by the mapping (and by the geometry service) includes these wireless channels as well: they are "valid" readout channels. Nevertheless, mapping them to a wire list will return an empty list. The ChannelStatus services should be utilized to find out the actual category of the channels when needed.

Configuration

These channels are assigned to each logical readout plane: in the standard ICARUS geometry, for example, in each TPC set (i.e. drift volume) there are two first induction readout planes with 1056 wires each, and one second induction and one collection readout planes with 5600 wires each, and each spanning two logical wire planes. Assigning pre- or post-channels to the first induction planes will increase each of them from 1056 channels to whatever is requested. Assigning pre- or post-channels to the second induction or collection planes will increase them from 5600 channels to whatever is requested.

The channel mapping configuration of the "standard" ICARUS detector should include:

WirelessChannels: {

  FirstInductionPreChannels:        0
  FirstInductionPostChannels:      96 # 32 ghost, then 64 virtual

  # C:x S:0 (east TPC)
  SecondInductionEvenPreChannels:  96 # 32 ghost, then 64 wireless
  SecondInductionEvenPostChannels: 64 # 64 wireless
  CollectionEvenPreChannels:       64 # 64 wireless
  CollectionEvenPostChannels:      96 # 64 wireless, then 32 ghost

  # C:x S:1 (west TPC)
  SecondInductionOddPreChannels:   64 # 64 wireless
  SecondInductionOddPostChannels:  96 # 64 wireless, then 32 ghost
  CollectionOddPreChannels:        96 # 32 ghost, then 64 wireless
  CollectionOddPostChannels:       64 # 64 wireless

} # WirelessChannels

The configuration parameters must be specified in the WirelessChannels configuration table, as FirstInductionPreChannels, FirstInductionPostChannels, SecondInductionEvenPreChannels, SecondInductionEvenPostChannels, CollectionEvenPreChannels, CollectionEvenPostChannels, SecondInductionOddPreChannels, SecondInductionOddPostChannels, CollectionOddPreChannels and CollectionOddPostChannels. They are all 0 by default.

Definition at line 166 of file ICARUSChannelMapAlg.h.

Member Typedef Documentation

using icarus::ICARUSChannelMapAlg::ChannelRange_t = icarus::details::ChannelRange_t

private

Definition at line 530 of file ICARUSChannelMapAlg.h.

using icarus::ICARUSChannelMapAlg::Parameters = fhicl::Table<Config>

Type of FHiCL configuration table for this object.

Definition at line 267 of file ICARUSChannelMapAlg.h.

using icarus::ICARUSChannelMapAlg::PlaneColl_t = icarus::details::PlaneColl_t

private

Definition at line 170 of file ICARUSChannelMapAlg.h.

using icarus::ICARUSChannelMapAlg::PlaneType_t = std::size_t

private

Type for plane type identifier.

Definition at line 658 of file ICARUSChannelMapAlg.h.

using icarus::ICARUSChannelMapAlg::TPCColl_t = icarus::details::TPCColl_t

private

Definition at line 169 of file ICARUSChannelMapAlg.h.

using icarus::ICARUSChannelMapAlg::WirelessChannelCounts_t = std::array<std::array<std::pair<unsigned int, unsigned int>, 3U>, 2U>

private

Type for counts of wireless channels: per TPC set (even/odd), then per plane starting from the closest to the cathode; first is the number of wireless channels before the regular ones, second is the one after them.

Definition at line 514 of file ICARUSChannelMapAlg.h.

Constructor & Destructor Documentation

icarus::ICARUSChannelMapAlg::ICARUSChannelMapAlg ( Config const & config )

Constructor: taked a configuration object.

Definition at line 78 of file ICARUSChannelMapAlg.cxx.

   : fWirelessChannelCounts
     (extractWirelessChannelParams(config.WirelessChannels()))
   , fSorter(getOptionalParameterSet(config.Sorter))
   {}

icarus::ICARUSChannelMapAlg::ICARUSChannelMapAlg ( Parameters const & config )

inline

Constructor: takes a FHiCL table object.

Definition at line 273 of file ICARUSChannelMapAlg.h.

274 : ICARUSChannelMapAlg(config()) {}

icarus::ICARUSChannelMapAlg::ICARUSChannelMapAlg

ICARUSChannelMapAlg(Config const &config)

Constructor: taked a configuration object.

Definition: ICARUSChannelMapAlg.cxx:78

Member Function Documentation

void icarus::ICARUSChannelMapAlg::buildReadoutPlanes ( geo::GeometryData_t::CryostatList_t const & Cryostats )

private

Fills information about the TPC set and readout plane structure.

Parameters

Cryostats the sorted list of cryostats in the detector

This method extracts and fills the following information:

the number of TPC sets in each cryostat (fTPCsetCount);
all geo::TPCGeo objects in each TPC set, sorted by increasing z (fTPCsetTPCs);
the number of readout planes in each TPC set (fROPcount);
all geo::PlaneGeo objects in each readout plane, sorted by increasing z (fROPplanes).

Cryostats and its components are expected to be already in the final order and with all their ID's set.

Definition at line 577 of file ICARUSChannelMapAlg.cxx.

 {
   // the algorithm is delegated:
   icarus::details::ROPandTPCsetBuildingAlg builder("ICARUSChannelMapAlg");
   
   auto results = builder.run(Cryostats);
   
   fReadoutMapInfo.set(
     std::move(results).TPCsetCount(), std::move(results).TPCsetTPCs(),
     std::move(results).ROPcount(), std::move(results).ROPplanes(),
     std::move(results).TPCtoTPCset(), std::move(results).PlaneToROP()
     );
   
 } // icarus::ICARUSChannelMapAlg::buildReadoutPlanes()

readout::ROPID icarus::ICARUSChannelMapAlg::ChannelToROP ( raw::ChannelID_t channel ) const

overridevirtual

Returns the ID of the ROP the channel belongs to (invalid if none).

Implements geo::ChannelMapAlg.

Definition at line 398 of file ICARUSChannelMapAlg.cxx.

 {
   if (!raw::isValidChannelID(channel)) return {};
   icarus::details::ChannelToWireMap::ChannelsInROPStruct const* info
     = fChannelToWireMap.find(channel);
   return info? info->ropid: readout::ROPID{};
 } // icarus::ICARUSChannelMapAlg::ChannelToROP()

std::vector< geo::WireID > icarus::ICARUSChannelMapAlg::ChannelToWire ( raw::ChannelID_t channel ) const

overridevirtual

Returns a collection of ID of wires connected to the channel.

Parameters

channel TPC readout channel number

Returns: collection of the wire IDs associated with channel

Exceptions

cet::exception (category: "Geometry") if non-existent channel

If the TPC readout channel is invalid or non-existing, an exception is thrown. In ICARUS valid channels are expected to be associated with at least one wire.

Implements geo::ChannelMapAlg.

Definition at line 118 of file ICARUSChannelMapAlg.cxx.

 {
   //
   // input check
   //
   assert(!fPlaneInfo.empty());
   
   //
   // output
   //
   std::vector<geo::WireID> AllSegments;
   
   //
   // find the ROP with that channel
   //
   icarus::details::ChannelToWireMap::ChannelsInROPStruct const* channelInfo
     = fChannelToWireMap.find(channel);
   if (!channelInfo) {
     throw cet::exception("Geometry")
       << "icarus::ICARUSChannelMapAlg::ChannelToWire(" << channel
       << "): invalid channel requested (must be lower than "
       << Nchannels() << ")\n";
   }
   
   //
   // find the wire planes in that ROP
   //
   PlaneColl_t const& planes = ROPplanes(channelInfo->ropid);
   
   //
   // associate one wire for each of those wire planes to the channel
   //
   AllSegments.reserve(planes.size()); // this is sometimes (often?) too much
   for (geo::PlaneGeo const* plane: planes) {
     
     geo::PlaneID const& pid = plane->ID();
     ChannelRange_t const& channelRange = fPlaneInfo[pid].channelRange();
     
     if (!channelRange.contains(channel)) continue;
     AllSegments.emplace_back
       (pid, static_cast<geo::WireID::WireID_t>(channel - channelRange.begin()));
     
   } // for planes in ROP
   
   return AllSegments;
   
 } // icarus::ICARUSChannelMapAlg::ChannelToWire()

auto icarus::ICARUSChannelMapAlg::extractWirelessChannelParams ( Config::WirelessChannelStruct const & params )

staticprivate

Definition at line 647 of file ICARUSChannelMapAlg.cxx.

 {
   return {
     // even TPC sets (e.g. C:0 S:0)
     std::array{
       std::make_pair(
         params.FirstInductionPreChannels(),
         params.FirstInductionPostChannels()
         ),
       std::make_pair(
         params.SecondInductionEvenPreChannels(),
         params.SecondInductionEvenPostChannels()
         ),
       std::make_pair(
         params.CollectionEvenPreChannels(),
         params.CollectionEvenPostChannels()
         )
     },
     // odd TPC sets (e.g. C:0 S:1)
     std::array{
       std::make_pair(
         params.FirstInductionPreChannels(),
         params.FirstInductionPostChannels()
         ),
       std::make_pair(
         params.SecondInductionOddPreChannels(),
         params.SecondInductionOddPostChannels()
         ),
       std::make_pair(
         params.CollectionOddPreChannels(),
         params.CollectionOddPostChannels()
         )
     }
     };
   
 } // icarus::ICARUSChannelMapAlg::extractWirelessChannelParams()

void icarus::ICARUSChannelMapAlg::fillChannelToWireMap ( geo::GeometryData_t::CryostatList_t const & Cryostats )

private

Fills the information about readout channel mapping.

Parameters

Cryostats the sorted list of cryostats in the detector

The readout information must have been already filled (buildReadoutPlanes()).

Definition at line 439 of file ICARUSChannelMapAlg.cxx.

 {
   
   //
   // input check
   //
   assert(fReadoutMapInfo);
   assert(!Cryostats.empty());
   
   //
   // output setup
   //
   assert(fPlaneInfo.empty());
   std::array<unsigned int, 3U> maxSizes
     = geo::details::extractMaxGeometryElements<3U>(Cryostats);
 
   fPlaneInfo.resize(maxSizes[0U], maxSizes[1U], maxSizes[2U]);
   
   
   raw::ChannelID_t nextChannel = 0; // next available channel
   
   // once again we do not have iteration facilities from `geo::GeometryCore`
   // available yet, so we go the nested loop way and bite it
   for (geo::CryostatGeo const& cryo: Cryostats) {
     
     readout::CryostatID const cid { cryo.ID() };
     
     auto const nTPCsets 
       = static_cast<readout::TPCsetID::TPCsetID_t>(TPCsetCount(cid));
     
     for (readout::TPCsetID::TPCsetID_t s: util::counter(nTPCsets)) {
       
       readout::TPCsetID const sid { cid, s };
       
       // select the channel count according to whether the TPC set is even or
       // odd; the selected structure is an array with one element for wire
       // plane signal type (first induction, second induction and collection):
       auto const& TPCsetChannelCounts
         = fWirelessChannelCounts.at(sid.TPCset & 1);
       
       auto const nROPs = static_cast<readout::ROPID::ROPID_t>(ROPcount(sid));
       
       for (readout::ROPID::ROPID_t r: util::counter(nROPs)) {
         
         mf::LogTrace log("ICARUSChannelMapAlg");
         
         readout::ROPID const rid { sid, r };
         auto const planeType = findPlaneType(rid);
         log << "ROP: " << rid
           << " (plane type: " << PlaneTypeName(planeType) << ")";
         
         auto const& WirelessChannelCounts
           = TPCsetChannelCounts.at(planeType);
         
         PlaneColl_t const& planes = ROPplanes(rid);
         log << " (" << planes.size() << " planes):";
         assert(!planes.empty());
         
         raw::ChannelID_t const firstROPchannel = nextChannel;
         
         auto iPlane = util::begin(planes);
         auto const pend = util::end(planes);
         
         // assign available channels to all wires of the first plane
         nextChannel += WirelessChannelCounts.first + (*iPlane)->Nwires();
         fPlaneInfo[(*iPlane)->ID()] = {
           ChannelRange_t
             { firstROPchannel + WirelessChannelCounts.first, nextChannel },
           rid
           };
         log << " [" << (*iPlane)->ID() << "] "
           << fPlaneInfo[(*iPlane)->ID()].firstChannel()
           << " -- " << fPlaneInfo[(*iPlane)->ID()].lastChannel() << ";";
         
         geo::Point_t lastWirePos = (*iPlane)->LastWire().GetCenter<geo::Point_t>();
         
         while (++iPlane != pend) {
           
           geo::PlaneGeo const& plane = **iPlane;
           
           // find out which wire matches the last wire from the previous plane;
           // if there is no such wire, an exception will be thrown,
           // which is ok to us since we believe it should not happen.
           geo::WireID const lastMatchedWireID
             = plane.NearestWireID(lastWirePos);
           
           /*
           mf::LogTrace("ICARUSChannelMapAlg")
             << (*std::prev(iPlane))->ID() << " W:" << ((*std::prev(iPlane))->Nwires() - 1)
             << " ending at " << (*std::prev(iPlane))->LastWire().GetEnd<geo::Point_t>()
             << " matched " << lastMatchedWireID
             << " which starts at " << plane.Wire(lastMatchedWireID).GetStart<geo::Point_t>()
             ;
           */
           
           //
           // the first channel in this plane (`iPlane`) is the one associated
           // to the first wire in the plane, which has local wire number `0`;
           // the last channel from the previous plane (`nextChannel - 1`)
           // is associated to the matched wire (`lastMatchedWireID`),
           // which has some wire number (`lastMatchedWireID.Wire`).
           //
           auto const nWires = plane.Nwires();
           raw::ChannelID_t const firstChannel
             = (nextChannel - 1) - lastMatchedWireID.Wire;
           nextChannel = firstChannel + nWires;
           
           fPlaneInfo[plane.ID()] = { { firstChannel, nextChannel }, rid };
           log << " [" << plane.ID() << "] "
             << fPlaneInfo[plane.ID()].firstChannel() << " -- "
             << fPlaneInfo[plane.ID()].lastChannel() << ";";
           
           // update for the next iteration
           lastWirePos = plane.LastWire().GetCenter<geo::Point_t>();
           
         } // while
         
         nextChannel += WirelessChannelCounts.second;
         unsigned int const nChannels = nextChannel - firstROPchannel;
         fChannelToWireMap.addROP(rid, firstROPchannel, nChannels);
         log
           << " => " << nChannels << " channels starting at " << firstROPchannel;
         
       } // for readout plane
       
     } // for TPC set
     
   } // for cryostat
   
   fChannelToWireMap.setEndChannel(nextChannel);
   mf::LogTrace("ICARUSChannelMapAlg")
     << "Counted " << fChannelToWireMap.nChannels() << " channels.";
   
 } // icarus::ICARUSChannelMapAlg::fillChannelToWireMap()

auto icarus::ICARUSChannelMapAlg::findPlaneType ( readout::ROPID const & ropid ) const

private

Returns the "type" of readout plane.

Parameters

ropid ID of the readout plane to query

Here the "type" refers to the position of the plane in the TPC and as a consequence to its signal type. The type of the readout plane is deduced from the type of the planes it contains.

The returned value is kFirstInductionType, kSecondInductionType, kCollectionType or kUnknownType.

Definition at line 594 of file ICARUSChannelMapAlg.cxx.

 {
   /*
    * This implementation is very fragile, relying on the fact that the first
    * induction plane numbers are `kFirstInductionType`, the second induction
    * plane numbers are `kSecondInductionType` and the collection plane numbers
    * are `kCollectionType`. This assumption is not checked anywhere.
    * 
    */
   constexpr std::array PlaneTypes = { // let's C++ figure out type and size
     kFirstInductionType,  // P:0
     kSecondInductionType, // P:1
     kCollectionType       // P:2
   };
   
   PlaneColl_t const& planes = ROPplanes(rid);
   if (planes.empty()) return kUnknownType;
   if (auto const planeNo = planes.front()->ID().Plane; planeNo < PlaneTypes.size())
     return PlaneTypes[planeNo];
   else return kUnknownType;
   
 } // icarus::ICARUSChannelMapAlg::findPlaneType()

raw::ChannelID_t icarus::ICARUSChannelMapAlg::FirstChannelInROP ( readout::ROPID const & ropid ) const

overridevirtual

Returns the ID of the first channel in the specified readout plane.

Parameters

ropid ID of the readout plane

Returns: ID of first channel, or raw::InvalidChannelID if ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour for non-existing readout planes is undefined.

Implements geo::ChannelMapAlg.

Definition at line 409 of file ICARUSChannelMapAlg.cxx.

 {
   if (!ropid) return raw::InvalidChannelID;
   icarus::details::ChannelToWireMap::ChannelsInROPStruct const* info
     = fChannelToWireMap.find(ropid);
   return info? info->firstChannel: raw::InvalidChannelID;
 } // icarus::ICARUSChannelMapAlg::FirstChannelInROP()

geo::TPCID icarus::ICARUSChannelMapAlg::FirstTPCinTPCset ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns the ID of the first TPC belonging to the specified TPC set.

Implements geo::ChannelMapAlg.

Definition at line 303 of file ICARUSChannelMapAlg.cxx.

 {
   if (!tpcsetid) return {};
   
   auto const& TPClist = TPCsetTPCs(tpcsetid);
   return TPClist.empty()? geo::TPCID{}: TPClist.front()->ID();
   
 } // icarus::ICARUSChannelMapAlg::FirstTPCinTPCset()

geo::PlaneID icarus::ICARUSChannelMapAlg::FirstWirePlaneInROP ( readout::ROPID const & ropid ) const

overridevirtual

Returns the ID of the first plane belonging to the specified ROP.

The wire planes within a readout plane are supposed to be sorted by beam (z) coordinate, so that the first one should be the closest to the beam entrance point.

Implements geo::ChannelMapAlg.

Definition at line 420 of file ICARUSChannelMapAlg.cxx.

 {
   if (!ropid) return {};
   PlaneColl_t const& planes = ROPplanes(ropid);
   return planes.empty()? geo::PlaneID{}: planes.front()->ID();
 } // icarus::ICARUSChannelMapAlg::FirstWirePlaneInROP()

bool icarus::ICARUSChannelMapAlg::HasCryostat ( readout::CryostatID const & cryoid ) const

private

Returns whether the specified cryostat is known to the mapping.

Definition at line 430 of file ICARUSChannelMapAlg.cxx.

 {
   assert(fReadoutMapInfo);
   return cryoid.Cryostat < fReadoutMapInfo.NCryostats();
 } // icarus::ICARUSChannelMapAlg::HasCryostat()

bool icarus::ICARUSChannelMapAlg::HasROP ( readout::ROPID const & ropid ) const

overridevirtual

Returns whether we have the specified ROP

Returns: whether the readout plane is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 328 of file ICARUSChannelMapAlg.cxx.

                                                                       {
   return HasTPCset(ropid)? (ropid.ROP < ROPcount(ropid)): false;
 } // icarus::ICARUSChannelMapAlg::HasROP()

bool icarus::ICARUSChannelMapAlg::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns whether we have the specified TPC set.

Returns: whether the TPC set is valid and exists

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 270 of file ICARUSChannelMapAlg.cxx.

 {
   return
     HasCryostat(tpcsetid)? (tpcsetid.TPCset < TPCsetCount(tpcsetid)): false;
 } // icarus::ICARUSChannelMapAlg::HasTPCset()

void icarus::ICARUSChannelMapAlg::Initialize ( geo::GeometryData_t const & geodata )

overridevirtual

Prepares the algorithm extracting information from the geometry.

Implements geo::ChannelMapAlg.

Definition at line 86 of file ICARUSChannelMapAlg.cxx.

 {
   // This is the only INFO level message we want this object to produce;
   // given the dynamic nature of the channel mapping choice,
   // it's better for the log to have some indication of chosen channel mapping.
   mf::LogInfo("ICARUSChannelMapAlg")
     << "Initializing ICARUSChannelMapAlg channel mapping algorithm.";
   
   buildReadoutPlanes(geodata.cryostats);
   
   fillChannelToWireMap(geodata.cryostats);
   
   MF_LOG_TRACE("ICARUSChannelMapAlg")
     << "ICARUSChannelMapAlg::Initialize() completed.";
   
 } // icarus::ICARUSChannelMapAlg::Initialize()

unsigned int icarus::ICARUSChannelMapAlg::MaxROPs ( ) const

overridevirtual

Returns the largest number of ROPs a TPC set in the detector has.

Implements geo::ChannelMapAlg.

Definition at line 322 of file ICARUSChannelMapAlg.cxx.

                                                       {
   assert(fReadoutMapInfo);
   return fReadoutMapInfo.MaxROPs();
 } // icarus::ICARUSChannelMapAlg::MaxROPs()

unsigned int icarus::ICARUSChannelMapAlg::MaxTPCsets ( ) const

overridevirtual

Returns the largest number of TPC sets any cryostat in the detector has.

Implements geo::ChannelMapAlg.

Definition at line 260 of file ICARUSChannelMapAlg.cxx.

                                                          {
   assert(fReadoutMapInfo);
   return fReadoutMapInfo.MaxTPCsets();
 } // icarus::ICARUSChannelMapAlg::MaxTPCsets()

unsigned int icarus::ICARUSChannelMapAlg::Nchannels ( ) const

overridevirtual

Returns the number of readout channels (ID's go 0 to Nchannels()).

Implements geo::ChannelMapAlg.

Definition at line 168 of file ICARUSChannelMapAlg.cxx.

                                                         {
   
   return fChannelToWireMap.nChannels();
   
 } // icarus::ICARUSChannelMapAlg::Nchannels()

unsigned int icarus::ICARUSChannelMapAlg::Nchannels ( readout::ROPID const & ropid ) const

overridevirtual

Returns the number of channels in the specified ROP.

Returns: number of channels in the specified ROP, 0 if non-existent

Implements geo::ChannelMapAlg.

Definition at line 177 of file ICARUSChannelMapAlg.cxx.

 {
   icarus::details::ChannelToWireMap::ChannelsInROPStruct const* ROPinfo
     = fChannelToWireMap.find(ropid);
   return ROPinfo? ROPinfo->nChannels: 0U;
 } // icarus::ICARUSChannelMapAlg::Nchannels(ROPID)

geo::WireID icarus::ICARUSChannelMapAlg::NearestWireID	(	const TVector3 &	worldPos,
		geo::PlaneID const &	planeID
	)		const

overridevirtual

Returns the ID of the wire nearest to the specified position.

Parameters

worldPos	position to be tested
planeID	plane containing the wire

Returns: the ID of the wire closest to worldPos in the specified plane

Exceptions

InvalidWireIDError the ID found is not present in the detector

See Also: WireCoordinate(double, double, geo::PlaneID const&)

The plane is required to be valid and exist in the detector. Otherwise, the behaviour is undefined. An exception is thrown if the wire that would be the closest is actually not present; but no check is performed whether the specified position is outside the wire plane: wires are extrapolated to be infinitely long. In other words, the result can be trusted only as long as the position is within the specified wire plane.

Reimplemented from geo::ChannelMapAlg.

Definition at line 206 of file ICARUSChannelMapAlg.cxx.

 {
   /*
    * this should NOT be called... it shouldn't be here at all!
    */
   
   cet::exception e("ICARUSChannelMapAlg");
   e << "ICARUSChannelMapAlg does not support `NearestWireID()` call."
     "\nPlease update calling software to use geo::PlaneGeo::NearestWireID()`:"
     "\n";
   
   lar::debug::printBacktrace(e, 3U);
   
   throw e;
 } // icarus::ICARUSChannelMapAlg::NearestWireID()

virtual geo::WireID icarus::ICARUSChannelMapAlg::NearestWireID	(	const TVector3 &	worldPos,
		unsigned int	PlaneNo,
		unsigned int	TPCNo,
		unsigned int	cstat
	)		const

inlineoverridevirtual

Returns the ID of the wire nearest to the specified position.

Parameters

worldPos	position to be tested
PlaneNo	number of plane containing the wire
TPCNo	number of TPC containing the wire
cstat	number of cryostat containing the wire

Returns: the ID of the wire closest to worldPos in the specified plane

See Also: NearestWireID(const TVector3&, geo::PlaneID const&)

Deprecated:: Use the version with geo::PlaneID instead

Implements geo::ChannelMapAlg.

Definition at line 343 of file ICARUSChannelMapAlg.h.

347 { return NearestWireID(worldPos, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

icarus::ICARUSChannelMapAlg::NearestWireID

virtual geo::WireID NearestWireID(const TVector3 &worldPos, geo::PlaneID const &planeID) const override

Returns the ID of the wire nearest to the specified position.

Definition: ICARUSChannelMapAlg.cxx:206

unsigned int icarus::ICARUSChannelMapAlg::NROPs ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns the total number of readout planes in the specified TPC set.

Parameters

tpcsetid TPC set ID

Returns: number of readout planes in the TPC sets, or 0 if ID is invalid

The validity of the requested TPC set is performed like in HasTPCset().

Implements geo::ChannelMapAlg.

Definition at line 315 of file ICARUSChannelMapAlg.cxx.

 {
   return HasTPCset(tpcsetid)? ROPcount(tpcsetid): 0U;
 } // icarus::ICARUSChannelMapAlg::NROPs()

unsigned int icarus::ICARUSChannelMapAlg::NTPCsets ( readout::CryostatID const & cryoid ) const

overridevirtual

Returns the total number of TPC sets in the specified cryostat.

Parameters

cryoid cryostat ID

Returns: number of TPC sets in the cryostat, or 0 if no cryostat found

Implements geo::ChannelMapAlg.

Definition at line 252 of file ICARUSChannelMapAlg.cxx.

 {
   return HasCryostat(cryoid)? TPCsetCount(cryoid): 0U;
 } // icarus::ICARUSChannelMapAlg::NTPCsets()

std::set< geo::PlaneID > const & icarus::ICARUSChannelMapAlg::PlaneIDs ( ) const

overridevirtual

Returns a list of the plane IDs in the whole detector.

Implements geo::ChannelMapAlg.

Definition at line 232 of file ICARUSChannelMapAlg.cxx.

                                                                     {
   
   /*
    * this should NOT be called... it shouldn't be here at all!
    */
   
   cet::exception e("ICARUSChannelMapAlg");
   e << "ICARUSChannelMapAlg does not support `PlaneIDs()` call."
     "\nPlease update calling software to use geo::GeometryCore::IteratePlanes()`"
     "\n";
   
   lar::debug::printBacktrace(e, 3U);
   
   throw e;
   
 } // icarus::ICARUSChannelMapAlg::PlaneIDs()

geo::PlaneDataContainer<readout::ROPID> const& icarus::ICARUSChannelMapAlg::PlaneToROP ( ) const

inlineprivate

The readout plane including each wire plane.

Definition at line 718 of file ICARUSChannelMapAlg.h.

719 { assert(fReadoutMapInfo); return fReadoutMapInfo.fPlaneToROP; }

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fPlaneToROP

geo::PlaneDataContainer< readout::ROPID > fPlaneToROP

The ROP each wire plane belongs to.

Definition: ICARUSChannelMapAlg.h:550

readout::ROPID const& icarus::ICARUSChannelMapAlg::PlaneToROP ( geo::PlaneID const & pid ) const

inlineprivate

The readout plane the specified wire plane pid belongs to.

Definition at line 722 of file ICARUSChannelMapAlg.h.

723 { return PlaneToROP()[pid]; }

icarus::ICARUSChannelMapAlg::PlaneToROP

geo::PlaneDataContainer< readout::ROPID > const & PlaneToROP() const

The readout plane including each wire plane.

Definition: ICARUSChannelMapAlg.h:718

std::string icarus::ICARUSChannelMapAlg::PlaneTypeName ( PlaneType_t planeType )

staticprivate

Returns the name of the specified plane type.

Definition at line 686 of file ICARUSChannelMapAlg.cxx.

                                                                         {
   
   using namespace std::string_literals;
   switch (planeType) {
     case kFirstInductionType:  return "first induction"s;
     case kSecondInductionType: return "second induction"s;
     case kCollectionType:      return "collection induction"s;
     case kUnknownType:         return "unknown"s;
     default:
       return "unsupported ("s + std::to_string(planeType) + ")"s;
   } // switch
   
 } // icarus::ICARUSChannelMapAlg::PlaneTypeName()

raw::ChannelID_t icarus::ICARUSChannelMapAlg::PlaneWireToChannel ( geo::WireID const & wireID ) const

overridevirtual

Returns the channel ID a wire is connected to.

Parameters

wireID ID of the wire

Returns: the ID of the channel

See Also: PlaneWireToChannel(geo::WireID const&)

Behaviour on an invalid or not present wires is undefined.

Deprecated:: Use the version with geo::WireID

Reimplemented from geo::ChannelMapAlg.

Definition at line 225 of file ICARUSChannelMapAlg.cxx.

 {
   return fPlaneInfo[wireID].firstChannel() + wireID.Wire;
 } // icarus::ICARUSChannelMapAlg::PlaneWireToChannel()

virtual raw::ChannelID_t icarus::ICARUSChannelMapAlg::PlaneWireToChannel	(	unsigned int	plane,
		unsigned int	wire,
		unsigned int	tpc,
		unsigned int	cstat
	)		const

inlineoverridevirtual

Returns the channel ID a wire is connected to.

Parameters

plane	number of plane
wire	number of wire
tpc	number of TPC
cstat	number of cryostat

Returns: the ID of the channel

See Also: PlaneWireToChannel(geo::WireID const&)

Deprecated:: Use the version with geo::WireID

Implements geo::ChannelMapAlg.

Definition at line 312 of file ICARUSChannelMapAlg.h.

316 { return PlaneWireToChannel(geo::WireID(cstat, tpc, plane, wire)); }

geo::WireID

Definition: geo_types.h:560

icarus::ICARUSChannelMapAlg::PlaneWireToChannel

virtual raw::ChannelID_t PlaneWireToChannel(geo::WireID const &wireID) const override

Returns the channel ID a wire is connected to.

Definition: ICARUSChannelMapAlg.cxx:225

readout::TPCsetDataContainer<unsigned int> const& icarus::ICARUSChannelMapAlg::ROPcount ( ) const

inlineprivate

Number of readout planes in each TPC set.

Definition at line 692 of file ICARUSChannelMapAlg.h.

693 { assert(fReadoutMapInfo); return fReadoutMapInfo.fROPcount; }

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fROPcount

readout::TPCsetDataContainer< unsigned int > fROPcount

Number of readout planes in each TPC set.

Definition: ICARUSChannelMapAlg.h:541

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

unsigned int icarus::ICARUSChannelMapAlg::ROPcount ( readout::TPCsetID const & sid ) const

inlineprivate

Number of readout planes in the specified TPC set sid.

Definition at line 696 of file ICARUSChannelMapAlg.h.

697 { return ROPcount()[sid]; }

icarus::ICARUSChannelMapAlg::ROPcount

readout::TPCsetDataContainer< unsigned int > const & ROPcount() const

Number of readout planes in each TPC set.

Definition: ICARUSChannelMapAlg.h:692

readout::ROPDataContainer<PlaneColl_t> const& icarus::ICARUSChannelMapAlg::ROPplanes ( ) const

inlineprivate

All geo::PlaneGeo objects in each readout plane, sorted by z.

Definition at line 700 of file ICARUSChannelMapAlg.h.

701 { assert(fReadoutMapInfo); return fReadoutMapInfo.fROPplanes; }

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fROPplanes

readout::ROPDataContainer< PlaneColl_t > fROPplanes

All geo::PlaneGeo objects in each readout plane, sorted by z.

Definition: ICARUSChannelMapAlg.h:544

PlaneColl_t const& icarus::ICARUSChannelMapAlg::ROPplanes ( readout::ROPID const & rid ) const

inlineprivate

All geo::PlaneGeo objects in the specified readout plane rid.

Definition at line 704 of file ICARUSChannelMapAlg.h.

705 { return ROPplanes()[rid]; }

icarus::ICARUSChannelMapAlg::ROPplanes

readout::ROPDataContainer< PlaneColl_t > const & ROPplanes() const

All geo::PlaneGeo objects in each readout plane, sorted by z.

Definition: ICARUSChannelMapAlg.h:700

std::vector< geo::TPCID > icarus::ICARUSChannelMapAlg::ROPtoTPCs ( readout::ROPID const & ropid ) const

overridevirtual

Returns a list of ID of TPCs the specified ROP spans.

Parameters

ropid ID of the readout plane

Returns: the list of TPC IDs, empty if readout plane ID is invalid

In this mapping, readout planes and wire planes are mapped one-to-one. The returned list contains always one entry, unless the specified readout plane ID is invalid, in which case the list is empty. Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour on non-existing readout planes is undefined.

Implements geo::ChannelMapAlg.

Definition at line 371 of file ICARUSChannelMapAlg.cxx.

 {
   std::vector<geo::TPCID> TPCs;
   if (!ropid) return TPCs;
   
   /*
    * We use the same algorithm as for extracting the plane IDs
    * (they implicitly convert to TPC ID... kind of them).
    * The algorithm does not test for duplication, i.e. in theory it could
    * produce lists with the same TPC ID being present multiple times
    * from different planes.
    * But this is not expected in this mapping, where each TPC holds at most
    * one wire plane for each view, and the planes in a ROP are all on the same
    * view. It might be matter of an assertion, but it's too complex to fit in an
    * `assert()` call.
    */
   auto const& PlaneList = ROPplanes(ropid);
   TPCs.reserve(PlaneList.size());
   std::transform(PlaneList.begin(), PlaneList.end(), std::back_inserter(TPCs),
     std::mem_fn(&geo::PlaneGeo::ID)
     );
   return TPCs;
 } // icarus::ICARUSChannelMapAlg::ROPtoTPCs()

std::vector< geo::PlaneID > icarus::ICARUSChannelMapAlg::ROPtoWirePlanes ( readout::ROPID const & ropid ) const

overridevirtual

Returns a list of ID of wire planes belonging to the specified ROP.

Parameters

ropid ID of the readout plane to convert into wire planes

Returns: the list of wire plane IDs, empty if readout plane ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists.

In this mapping, readout planes contain one or two wire planes each, depending on the view.

Implements geo::ChannelMapAlg.

Definition at line 355 of file ICARUSChannelMapAlg.cxx.

 {
   std::vector<geo::PlaneID> Planes;
   if (!ropid) return Planes;
   
   auto const& PlaneList = ROPplanes(ropid);
   Planes.reserve(PlaneList.size());
   std::transform(PlaneList.begin(), PlaneList.end(), std::back_inserter(Planes),
     std::mem_fn(&geo::PlaneGeo::ID)
     );
   return Planes;
 } // icarus::ICARUSChannelMapAlg::ROPtoWirePlanes()

geo::SigType_t icarus::ICARUSChannelMapAlg::SignalTypeForChannelImpl ( raw::ChannelID_t const channel ) const

overrideprivatevirtual

Returns the type of signal on the specified channel.

Implements geo::ChannelMapAlg.

Definition at line 621 of file ICARUSChannelMapAlg.cxx.

 {
   /*
    * We rely on the accuracy of `findPlaneType()` (which is admittedly less than
    * great) to assign signal type accordingly.
    */
   
   icarus::details::ChannelToWireMap::ChannelsInROPStruct const* channelInfo
     = fChannelToWireMap.find(channel);
   if (!channelInfo) return geo::kMysteryType;
   
   switch (findPlaneType(channelInfo->ropid)) {
     case kFirstInductionType:
     case kSecondInductionType:
       return geo::kInduction;
     case kCollectionType:
       return geo::kCollection;
     default:
       return geo::kMysteryType;
   } // switch
   
 } // icarus::ICARUSChannelMapAlg::SignalTypeForChannelImpl()

virtual geo::GeoObjectSorter const& icarus::ICARUSChannelMapAlg::Sorter ( ) const

inlineoverridevirtual

Return the sorter.

Implements geo::ChannelMapAlg.

Definition at line 505 of file ICARUSChannelMapAlg.h.

506 { return fSorter; }

icarus::ICARUSChannelMapAlg::fSorter

icarus::GeoObjectSorterPMTasTPC fSorter

Algorithms to sort geometry elements.

Definition: ICARUSChannelMapAlg.h:653

std::vector<unsigned int> const& icarus::ICARUSChannelMapAlg::TPCsetCount ( ) const

inlineprivate

Returns the number of TPC sets in each cryostat.

Definition at line 676 of file ICARUSChannelMapAlg.h.

677 { assert(fReadoutMapInfo); return fReadoutMapInfo.fTPCsetCount; }

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fTPCsetCount

std::vector< unsigned int > fTPCsetCount

Number of TPC sets in each cryostat.

Definition: ICARUSChannelMapAlg.h:535

unsigned int icarus::ICARUSChannelMapAlg::TPCsetCount ( readout::CryostatID const & cid ) const

inlineprivate

Returns the number of TPC sets in the specified cryostat cid.

Definition at line 680 of file ICARUSChannelMapAlg.h.

681 { return TPCsetCount()[cid.Cryostat]; }

icarus::ICARUSChannelMapAlg::TPCsetCount

std::vector< unsigned int > const & TPCsetCount() const

Returns the number of TPC sets in each cryostat.

Definition: ICARUSChannelMapAlg.h:676

std::vector< geo::TPCID > icarus::ICARUSChannelMapAlg::TPCsetToTPCs ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns a list of ID of TPCs belonging to the specified TPC set.

Parameters

tpcsetid ID of the TPC set to convert into TPC IDs

Returns: the list of TPCs, empty if TPC set is invalid

Each TPC set contains one TPC if on first induction plane, where wires are split, or two in the second induction and collection planes, which have shared channels.

Implements geo::ChannelMapAlg.

Definition at line 287 of file ICARUSChannelMapAlg.cxx.

 {
   std::vector<geo::TPCID> TPCs;
   if (!tpcsetid) return TPCs;
   
   auto const& TPClist = TPCsetTPCs(tpcsetid);
   TPCs.reserve(TPClist.size());
   std::transform(TPClist.begin(), TPClist.end(), std::back_inserter(TPCs),
     std::mem_fn(&geo::TPCGeo::ID)
     );
   return TPCs;
 } // icarus::ICARUSChannelMapAlg::TPCsetToTPCs()

readout::TPCsetDataContainer<TPCColl_t> const& icarus::ICARUSChannelMapAlg::TPCsetTPCs ( ) const

inlineprivate

All geo::TPCGeo objects in each TPC set, sorted by increasing z.

Definition at line 684 of file ICARUSChannelMapAlg.h.

685 { assert(fReadoutMapInfo); return fReadoutMapInfo.fTPCsetTPCs; }

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fTPCsetTPCs

readout::TPCsetDataContainer< TPCColl_t > fTPCsetTPCs

All geo::TPCGeo objects in each TPC set, sorted by increasing z.

Definition: ICARUSChannelMapAlg.h:538

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

TPCColl_t const& icarus::ICARUSChannelMapAlg::TPCsetTPCs ( readout::TPCsetID const & sid ) const

inlineprivate

All geo::TPCGeo objects in the specified TPC set sid.

Definition at line 688 of file ICARUSChannelMapAlg.h.

689 { return TPCsetTPCs()[sid]; }

icarus::ICARUSChannelMapAlg::TPCsetTPCs

readout::TPCsetDataContainer< TPCColl_t > const & TPCsetTPCs() const

All geo::TPCGeo objects in each TPC set, sorted by increasing z.

Definition: ICARUSChannelMapAlg.h:684

readout::TPCsetID icarus::ICARUSChannelMapAlg::TPCtoTPCset ( geo::TPCID const & tpcid ) const

overridevirtual

Returns the ID of the TPC set the specified TPC belongs to.

Parameters

tpcid ID of the TPC

Returns: the ID of the corresponding TPC set, or invalid ID when tpcid is

If the TPC ID is not valid, an invalid TPC set ID is returned. Note that this check is performed on the validity of the TPC ID, that does not necessarily imply that the TPC specified by the ID actually exists.

Implements geo::ChannelMapAlg.

Definition at line 279 of file ICARUSChannelMapAlg.cxx.

 {
   return tpcid? TPCtoTPCset()[tpcid]: readout::TPCsetID{};
 } // icarus::ICARUSChannelMapAlg::TPCtoTPCset()

geo::TPCDataContainer<readout::TPCsetID> const& icarus::ICARUSChannelMapAlg::TPCtoTPCset ( ) const

inlineprivate

The TPC set including each TPC.

Definition at line 708 of file ICARUSChannelMapAlg.h.

709 { assert(fReadoutMapInfo); return fReadoutMapInfo.fTPCtoTPCset; }

icarus::ICARUSChannelMapAlg::ReadoutMappingInfo_t::fTPCtoTPCset

geo::TPCDataContainer< readout::TPCsetID > fTPCtoTPCset

The TPC set each TPC belongs to.

Definition: ICARUSChannelMapAlg.h:547

icarus::ICARUSChannelMapAlg::fReadoutMapInfo

ReadoutMappingInfo_t fReadoutMapInfo

Information about TPC sets and readout planes in the geometry.

Definition: ICARUSChannelMapAlg.h:631

void icarus::ICARUSChannelMapAlg::Uninitialize ( )

overridevirtual

Frees the resources of this algorithm.

Implements geo::ChannelMapAlg.

Definition at line 105 of file ICARUSChannelMapAlg.cxx.

                                              {
   
   fReadoutMapInfo.clear();
   
   fChannelToWireMap.clear();
   
   fPlaneInfo.clear();
   
 } // icarus::ICARUSChannelMapAlg::Uninitialize()

double icarus::ICARUSChannelMapAlg::WireCoordinate	(	double	YPos,
		double	ZPos,
		geo::PlaneID const &	planeID
	)		const

overridevirtual

Returns the index of the wire nearest to the specified position.

Parameters

YPos	y coordinate on the wire plane
ZPos	z coordinate on the wire plane
planeID	ID of the plane

Returns: an index interpolation between the two nearest wires

See Also: NearestWireID()

Respect to NearestWireID(), this method returns a real number, representing a continuous coordinate in the wire axis, with the round values corresponding to the actual wires.

The plane is required to be valid and exist in the detector. Otherwise, the behaviour is undefined.

Reimplemented from geo::ChannelMapAlg.

Definition at line 187 of file ICARUSChannelMapAlg.cxx.

 {
   /*
    * this should NOT be called... it shouldn't be here at all!
    */
   
   cet::exception e("ICARUSChannelMapAlg");
   e << "ICARUSChannelMapAlg does not support `WireCoordinate()` call."
     "\nPlease update calling software to use geo::PlaneGeo::WireCoordinate()`:"
     "\n";
   
   lar::debug::printBacktrace(e, 4U);
   
   throw e;
 } // icarus::ICARUSChannelMapAlg::WireCoordinate()

virtual double icarus::ICARUSChannelMapAlg::WireCoordinate	(	double	YPos,
		double	ZPos,
		unsigned int	PlaneNo,
		unsigned int	TPCNo,
		unsigned int	cstat
	)		const

inlineoverridevirtual

Returns the index of the wire nearest to the specified position.

Parameters

YPos	y coordinate on the wire plane
ZPos	z coordinate on the wire plane
PlaneNo	number of plane
TPCNo	number of TPC
cstat	number of cryostat

Returns: an index interpolation between the two nearest wires

See Also: WireCoordinate(double, double, geo::PlaneID const&)

Deprecated:: Use the version with geo::PlaneID instead

Implements geo::ChannelMapAlg.

Definition at line 333 of file ICARUSChannelMapAlg.h.

337 { return WireCoordinate(YPos, ZPos, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

icarus::ICARUSChannelMapAlg::WireCoordinate

virtual double WireCoordinate(double YPos, double ZPos, geo::PlaneID const &planeID) const override

Returns the index of the wire nearest to the specified position.

Definition: ICARUSChannelMapAlg.cxx:187

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

readout::ROPID icarus::ICARUSChannelMapAlg::WirePlaneToROP ( geo::PlaneID const & planeid ) const

overridevirtual

Returns the ID of the ROP planeid belongs to, or invalid if none.

Parameters

planeid ID of the plane

Returns: the ID of the corresponding ROP, or invalid ID when planeid is

If the plane ID is not valid, an invalid readout plane ID is returned. Note that this check is performed on the validity of the plane ID, that does not necessarily imply that the plane specified by the ID actually exists.

Parameters

planeid ID of the plane

Returns: the ID of the corresponding ROP, or invalid ID when planeid is

In this mapping, readout planes and wire planes are mapped one-to-one. The returned value mirrors the plane ID in the readout space. If the plane ID is not valid, an invalid readout plane ID is returned. Note that this check is performed on the validity of the plane ID, that does not necessarily imply that the plane specified by the ID actually exists.

Implements geo::ChannelMapAlg.

Definition at line 347 of file ICARUSChannelMapAlg.cxx.

 {
   return planeid? PlaneToROP(planeid): readout::ROPID{};
 } // icarus::ICARUSChannelMapAlg::WirePlaneToROP()

Member Data Documentation

icarus::details::ChannelToWireMap icarus::ICARUSChannelMapAlg::fChannelToWireMap

private

Mapping of channels to wire planes and ROP's.

Definition at line 634 of file ICARUSChannelMapAlg.h.

geo::PlaneDataContainer<PlaneInfo_t> icarus::ICARUSChannelMapAlg::fPlaneInfo

private

Range of channels covered by each of the wire planes.

Definition at line 637 of file ICARUSChannelMapAlg.h.

ReadoutMappingInfo_t icarus::ICARUSChannelMapAlg::fReadoutMapInfo

private

Information about TPC sets and readout planes in the geometry.

Definition at line 631 of file ICARUSChannelMapAlg.h.

icarus::GeoObjectSorterPMTasTPC icarus::ICARUSChannelMapAlg::fSorter

private

Algorithms to sort geometry elements.

Definition at line 653 of file ICARUSChannelMapAlg.h.

WirelessChannelCounts_t const icarus::ICARUSChannelMapAlg::fWirelessChannelCounts

private

Count of wireless channels on each plane.

Definition at line 646 of file ICARUSChannelMapAlg.h.

constexpr PlaneType_t icarus::ICARUSChannelMapAlg::kCollectionType = 2U

staticprivate

Identifier for collection plane type.

Definition at line 665 of file ICARUSChannelMapAlg.h.

constexpr PlaneType_t icarus::ICARUSChannelMapAlg::kFirstInductionType = 0U

staticprivate

Identifier for first induction plane type.

Definition at line 661 of file ICARUSChannelMapAlg.h.

constexpr PlaneType_t icarus::ICARUSChannelMapAlg::kSecondInductionType = 1U

staticprivate

Identifier for second induction plane type.

Definition at line 663 of file ICARUSChannelMapAlg.h.

constexpr PlaneType_t icarus::ICARUSChannelMapAlg::kUnknownType = std::numeric_limits<PlaneType_t>::max()

staticprivate

Identifier for unknown plane type.

Definition at line 668 of file ICARUSChannelMapAlg.h.

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Readout element information

Additional Inherited Members

Detailed Description

Wireless channels

Configuration

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation