Interface for a class providing readout channel mapping to geometry. More...

#include "ChannelMapAlg.h"

Inheritance diagram for geo::ChannelMapAlg:

Public Member Functions
virtual	~ChannelMapAlg ()=default

virtual GeoObjectSorter const &	Sorter () const =0
	Returns the object to sort geometry with. More...

Geometry and mapping initialization and management
virtual void	Initialize (GeometryData_t const &geodata)=0
	Geometry initialisation. More...

virtual void	Uninitialize ()=0
	Deconfiguration: prepare for a following call of Initialize() More...

Optical detector channel mapping
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...

Mapping of position to wires
virtual double	WireCoordinate (double YPos, double ZPos, PlaneID const &planeID) const =0
	Returns the index of the wire nearest to the specified position. More...

virtual WireID	NearestWireID (Point_t const &worldPos, PlaneID const &planeID) const =0
	Returns the ID of the wire nearest to the specified position. More...

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

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

virtual size_t	ChannelToAuxDet (std::vector< 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< AuxDetGeo > const &auxDets, std::string const &detName, uint32_t const &channel) const
	Returns the index of the sensitive detector containing the channel. More...

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

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

virtual bool	HasTPCset (readout::TPCsetID const &tpcsetid) const =0

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

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

virtual TPCID	FirstTPCinTPCset (readout::TPCsetID const &tpcsetid) const =0
	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 =0
	Returns the total number of ROP in the specified TPC set. More...

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

virtual bool	HasROP (readout::ROPID const &ropid) const =0

virtual readout::ROPID	WirePlaneToROP (PlaneID const &planeid) const =0
	Returns the ID of the ROP planeid belongs to. More...

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

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

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

virtual readout::ROPID	ChannelToROP (raw::ChannelID_t channel) const =0
	Returns the ID of the ROP the channel belongs to. More...

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

Testing (not in the interface)
std::vector< std::vector< std::vector< raw::ChannelID_t > > > const &	FirstChannelInNextPlane () const
	Retrieve the private fFirstChannelInNextPlane vector for testing. More...

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

Protected Types
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
template<typename T >
T const &	AccessElement (PlaneInfoMap_t< T > const &map, PlaneID const &id) const
	Returns the specified element of the plane map. More...

template<typename T >
size_t	AccessElementSize (PlaneInfoMap_t< T > const &map, 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, PlaneID const &id) const
	Returns a pointer to the specified element, or nullptr if invalid. More...

Internal structure data access
These functions allow access to the XxxInfoMap_t types based on geometry element IDs. They are strictly internal.
template<typename T >
T const &	AccessElement (TPCInfoMap_t< T > const &map, TPCID const &id) const
	Returns the specified element of the TPC map. More...

template<typename T >
size_t	AccessElementSize (TPCInfoMap_t< T > const &map, 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, CryostatID const &id) const
	Returns whether the ID specifies a valid entry. More...

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


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

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

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

Protected Attributes
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

TPC channel mapping
virtual unsigned int	Nchannels () const =0
	Returns the total number of channels present (not necessarily contiguous) More...

virtual unsigned int	Nchannels (readout::ROPID const &ropid) const =0
	Returns the number of channels in the specified ROP. 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...

virtual std::vector< WireID >	ChannelToWire (raw::ChannelID_t channel) const =0

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

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

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

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

virtual SigType_t	SignalTypeForChannelImpl (raw::ChannelID_t const channel) const =0
	Return the signal type of the specified channel. More...

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

Detailed Description

Interface for a class providing readout channel mapping to geometry.

Note: A number of methods react specifically when provided with invalid IDs as arguments. An invalid ID is an ID with the isValid flag unset, or, in case of channel IDs, an ID with value raw::InvalidChannelID. An ID that does not present this feature is by definition "valid"; this does not imply that the represented entity (channel, geometry entity or readout group) actually exists. The behaviour of the methods to valid, non-existent IDs should be considered undefined, and it is recommended that the existence of the entity is checked beforehand. Unless the documentation explicitly defines a behaviour, an undefined behaviour should be assumed; nevertheless, the documentation of some of the methods still reminds of this.

Definition at line 48 of file ChannelMapAlg.h.

Member Typedef Documentation

template<typename T >

using geo::ChannelMapAlg::PlaneInfoMap_t = TPCInfoMap_t<std::vector<T>>

protected

Data type for per-plane information.

Definition at line 484 of file ChannelMapAlg.h.

template<typename T >

using geo::ChannelMapAlg::TPCInfoMap_t = std::vector<std::vector<T>>

protected

Data type for per-TPC information.

Definition at line 480 of file ChannelMapAlg.h.

Constructor & Destructor Documentation

virtual geo::ChannelMapAlg::~ChannelMapAlg ( )

virtualdefault

Member Function Documentation

template<typename T >

T const& geo::ChannelMapAlg::AccessElement	(	TPCInfoMap_t< T > const &	map,
		TPCID const &	id
	)		const

inlineprotected

Returns the specified element of the TPC map.

Definition at line 508 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapStandardAlg::FirstChannelInROP(), geo::ChannelMapStandardAlg::NROPs(), geo::ChannelMapStandardAlg::WireCoordinate(), and geo::ChannelMapStandardAlg::WireCount().

     {
       return map[id.Cryostat][id.TPC];
     }

template<typename T >

T const& geo::ChannelMapAlg::AccessElement	(	PlaneInfoMap_t< T > const &	map,
		PlaneID const &	id
	)		const

inlineprotected

Returns the specified element of the plane map.

Definition at line 536 of file ChannelMapAlg.h.

     {
       return map[id.Cryostat][id.TPC][id.Plane];
     }

template<typename T >

size_t geo::ChannelMapAlg::AccessElementSize	(	TPCInfoMap_t< T > const &	map,
		CryostatID const &	id
	)		const

inlineprotected

Returns the number of elements in the specified cryostat of the TPC map.

Definition at line 515 of file ChannelMapAlg.h.

     {
       return map[id.Cryostat].size();
     }

template<typename T >

size_t geo::ChannelMapAlg::AccessElementSize	(	PlaneInfoMap_t< T > const &	map,
		TPCID const &	id
	)		const

inlineprotected

Returns the number of elements in the specified TPC of the plane map.

Definition at line 543 of file ChannelMapAlg.h.

     {
       return map[id.Cryostat][id.TPC].size();
     }

size_t geo::ChannelMapAlg::ChannelToAuxDet	(	std::vector< AuxDetGeo > const &	auxDets,
		std::string const &	detName,
		uint32_t const &	channel
	)		const

virtual

Returns the index of the detector containing the specified channel.

Parameters

auxDets	list of the auxiliary detectors
detName	name of the auxiliary detector being investigated
channel	number of the channel within that auxiliary detector

Returns: index of the sought auxiliary detector within auxDets

Bug:: This function is somehow broken in that it ignores the auxDets in the arguments and instead relies on a cache that is never filled by this class (derived classes can fill it though).

Definition at line 137 of file ChannelMapAlg.cxx.

References fADNameToGeo.

Referenced by ChannelToSensitiveAuxDet(), and HasChannel().

   {
     // loop over the map of AuxDet names to Geo object numbers to determine which auxdet
     // we have.  If no name in the map matches the provided string, throw an exception
     for (auto itr : fADNameToGeo)
       if (itr.first.compare(detName) == 0) return itr.second;
 
     throw cet::exception("Geometry") << "No AuxDetGeo matching name: " << detName;
   }

virtual readout::ROPID geo::ChannelMapAlg::ChannelToROP ( raw::ChannelID_t channel ) const

pure virtual

Returns the ID of the ROP the channel belongs to.

Returns: the ID of the ROP the channel belongs to (invalid if channel is)

See also: HasChannel()

The channel must exist, or be the invalid channel value. With a channel that is not present in the mapping and that is not the invalid channel (raw::InvalidChannelID), the result is undefined.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

std::pair< size_t, size_t > geo::ChannelMapAlg::ChannelToSensitiveAuxDet	(	std::vector< AuxDetGeo > const &	auxDets,
		std::string const &	detName,
		uint32_t const &	channel
	)		const

virtual

Returns the index of the sensitive detector containing the channel.

Parameters

auxDets	list of the sensitive auxiliary detectors
detName	name of the auxiliary detector being investigated
channel	number of the channel within that auxiliary detector

Returns: index of the sought sensitive auxiliary detector within auxDets

Definition at line 152 of file ChannelMapAlg.cxx.

References ChannelToAuxDet(), and fADChannelToSensitiveGeo.

Referenced by HasChannel().

   {
     size_t adGeoIdx = this->ChannelToAuxDet(auxDets, detName, channel);
 
     // look for the index of the sensitive volume for the given channel
     if (fADChannelToSensitiveGeo.count(adGeoIdx) > 0) {
 
       auto itr = fADChannelToSensitiveGeo.find(adGeoIdx);
 
       // get the vector of channels to AuxDetSensitiveGeo index
       if (channel < itr->second.size()) return std::make_pair(adGeoIdx, itr->second[channel]);
 
       throw cet::exception("Geometry")
         << "Given AuxDetSensitive channel, " << channel
         << ", cannot be found in vector associated to AuxDetGeo index: " << adGeoIdx
         << ". Vector has size " << itr->second.size();
     }
 
     throw cet::exception("Geometry") << "Given AuxDetGeo with index " << adGeoIdx
                                      << " does not correspond to any vector of sensitive volumes";
   }

virtual std::vector<WireID> geo::ChannelMapAlg::ChannelToWire ( raw::ChannelID_t channel ) const

pure virtual

Returns a list of TPC wires connected to the specified readout channel ID

Exceptions

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

std::vector<std::vector<std::vector<raw::ChannelID_t> > > const& geo::ChannelMapAlg::FirstChannelInNextPlane ( ) const

inline

Retrieve the private fFirstChannelInNextPlane vector for testing.

Definition at line 462 of file ChannelMapAlg.h.

References fFirstChannelInThisPlane.

     {
       return fFirstChannelInThisPlane;
     }

virtual raw::ChannelID_t geo::ChannelMapAlg::FirstChannelInROP ( readout::ROPID const & ropid ) const

pure virtual

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.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel(), and SignalTypeForROPIDImpl().

std::vector<std::vector<std::vector<raw::ChannelID_t> > > const& geo::ChannelMapAlg::FirstChannelInThisPlane ( ) const

inline

Retrieve the private fFirstChannelInThisPlane vector for testing.

Definition at line 468 of file ChannelMapAlg.h.

References fFirstChannelInNextPlane.

     {
       return fFirstChannelInNextPlane;
     }

virtual TPCID geo::ChannelMapAlg::FirstTPCinTPCset ( readout::TPCsetID const & tpcsetid ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual PlaneID geo::ChannelMapAlg::FirstWirePlaneInROP ( readout::ROPID const & ropid ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

template<typename T >

T const* geo::ChannelMapAlg::GetElementPtr	(	PlaneInfoMap_t< T > const &	map,
		PlaneID const &	id
	)		const

inlineprotected

Returns a pointer to the specified element, or nullptr if invalid.

Definition at line 569 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapStandardAlg::PlaneWireToChannel().

     {
       if (id.Cryostat >= map.size()) return nullptr;
       auto const& cryo_map = map[id.Cryostat];
       if (id.TPC >= cryo_map.size()) return nullptr;
       auto const& TPC_map = cryo_map[id.TPC];
       if (id.Plane >= TPC_map.size()) return nullptr;
       auto const& plane_map = TPC_map[id.Plane];
       return &plane_map;
     } // GetElementPtr()

unsigned int geo::ChannelMapAlg::HardwareChannelFromOpChannel ( unsigned int opChannel ) const

virtual

Returns the hardware channel number of specified optical channel.

Parameters

opChannel the optical detector channel being queried

Returns: the optical detector the specified optical channel belongs to

If the specified optical channel is invalid, behaviour is undefined.

Definition at line 47 of file ChannelMapAlg.cxx.

Referenced by HasChannel(), and IsValidOpChannel().

   {
     return 0;
   }

virtual bool geo::ChannelMapAlg::HasChannel ( raw::ChannelID_t channel ) const

inlinevirtual

Returns whether the specified channel is valid This default implementation assumes all channels up to Nchannels() valid.

Definition at line 77 of file ChannelMapAlg.h.

References ChannelToAuxDet(), ChannelToROP(), ChannelToSensitiveAuxDet(), ChannelToWire(), FirstChannelInROP(), FirstTPCinTPCset(), FirstWirePlaneInROP(), HardwareChannelFromOpChannel(), HasROP(), HasTPCset(), raw::isValidChannelID(), IsValidOpChannel(), MaxOpChannel(), MaxROPs(), MaxTPCsets(), Nchannels(), NearestAuxDet(), NearestSensitiveAuxDet(), NearestWireID(), NOpChannels(), NOpHardwareChannels(), NROPs(), NTPCsets(), OpChannel(), OpDetFromOpChannel(), PlaneIDs(), PlaneWireToChannel(), ROPtoTPCs(), ROPtoWirePlanes(), SignalTypeForChannel(), SignalTypeForChannelImpl(), SignalTypeForROPID(), SignalTypeForROPIDImpl(), Sorter(), TPCsetToTPCs(), TPCtoTPCset(), WireCoordinate(), and WirePlaneToROP().

     {
       return raw::isValidChannelID(channel) ? channel < Nchannels() : false;
     }

virtual bool geo::ChannelMapAlg::HasROP ( readout::ROPID const & ropid ) const

pure virtual

Returns whether we have the specified ROP

Returns: whether the readout plane is valid and exists

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual bool geo::ChannelMapAlg::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

pure virtual

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual void geo::ChannelMapAlg::Initialize ( GeometryData_t const & geodata )

pure virtual

Geometry initialisation.

Implemented in geo::ChannelMapStandardAlg.

template<typename T >

bool geo::ChannelMapAlg::isValidElement	(	TPCInfoMap_t< T > const &	map,
		CryostatID const &	id
	)		const

inlineprotected

Returns whether the ID specifies a valid entry.

Definition at line 523 of file ChannelMapAlg.h.

Referenced by isValidElement().

     {
       return id.Cryostat < map.size();
     }

template<typename T >

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

inlineprotected

Returns the specified element of the TPC map.

Definition at line 528 of file ChannelMapAlg.h.

References isValidElement().

     {
       return isValidElement(map, id.asCryostatID()) && (id.TPC < map[id.Cryostat].size());
     }

template<typename T >

bool geo::ChannelMapAlg::isValidElement	(	PlaneInfoMap_t< T > const &	map,
		CryostatID const &	id
	)		const

inlineprotected

Returns whether the ID specifies a valid entry.

Definition at line 551 of file ChannelMapAlg.h.

     {
       return id.Cryostat < map.size();
     }

template<typename T >

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

inlineprotected

Returns whether the ID specifies a valid entry.

Definition at line 556 of file ChannelMapAlg.h.

References isValidElement().

     {
       return isValidElement(map, id.asCryostatID()) && (id.TPC < map[id.Cryostat].size());
     }

template<typename T >

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

inlineprotected

Returns whether the ID specifies a valid entry.

Definition at line 561 of file ChannelMapAlg.h.

References isValidElement().

     {
       return isValidElement(map, id.asTPCID()) && (id.Plane < AccessSize(map, id.asTPCID()));
     }

bool geo::ChannelMapAlg::IsValidOpChannel	(	unsigned int	opChannel,
		unsigned int	NOpDets
	)		const

virtual

Returns whether the ID identifies a valid optical detector channel.

Parameters

opChannel	channel number
NOpDets	number of optical detectors in the detector

Returns: whether opChannel would be a valid channel

The specification of the number of optical channels reflects the logic described in NOpChannel().

Definition at line 53 of file ChannelMapAlg.cxx.

References HardwareChannelFromOpChannel(), NOpChannels(), NOpHardwareChannels(), and OpDetFromOpChannel().

Referenced by HasChannel().

   {
     // Check channel number
     if (opChannel >= this->NOpChannels(NOpDets)) return false;
 
     // Check opdet number
     unsigned int opdet = this->OpDetFromOpChannel(opChannel);
     if (opdet >= NOpDets) return false;
 
     // Check hardware channel number
     unsigned int hChan = this->HardwareChannelFromOpChannel(opChannel);
     if (hChan >= this->NOpHardwareChannels(opdet)) return false;
 
     return true;
   }

unsigned int geo::ChannelMapAlg::MaxOpChannel ( unsigned int NOpDets ) const

virtual

Returns the number of optical channels contained in some detectors.

Parameters

NOpDets number of optical detectors

Returns: optical channels contained in NOpDets detectors

This function returns the first optical channel ID larger than the last channel ID in a detector with NOpDets optical detectors (with the same logic as NOpChannels()). For example, in a detector with 32 channels with contiguous IDs starting at 0, this function would return 32. If the channels started with ID 1, this function would instead return 33 and if there were a 16 channel gap, so that valid channels are from 0 to 15 and from 32 to 47, this function would return 48.

Definition at line 21 of file ChannelMapAlg.cxx.

References NOpChannels().

Referenced by HasChannel().

   {
     // By default just return the number of optical detectos
     return NOpChannels(NOpDets);
   }

virtual unsigned int geo::ChannelMapAlg::MaxROPs ( ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual unsigned int geo::ChannelMapAlg::MaxTPCsets ( ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual unsigned int geo::ChannelMapAlg::Nchannels ( ) const

pure virtual

Returns the total number of channels present (not necessarily contiguous)

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual unsigned int geo::ChannelMapAlg::Nchannels ( readout::ROPID const & ropid ) const

pure virtual

Returns the number of channels in the specified ROP.

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

Implemented in geo::ChannelMapStandardAlg.

size_t geo::ChannelMapAlg::NearestAuxDet	(	Point_t const &	point,
		std::vector< AuxDetGeo > const &	auxDets,
		double	tolerance = `0`
	)		const

virtual

Returns the auxiliary detector closest to the specified point.

Parameters

point	coordinates of the position to be investigated (x, y, z)
auxDets	list of the sought auxiliary detectors
tolerance	tolerance for comparison. Default 0.

Returns: index of auxiliary detector within auxDets

Definition at line 70 of file ChannelMapAlg.cxx.

References tca::Length().

Referenced by HasChannel(), and NearestSensitiveAuxDet().

   {
     for (size_t a = 0; a < auxDets.size(); ++a) {
       auto const localPoint = auxDets[a].toLocalCoords(point);
 
       double const HalfCenterWidth = 0.5 * (auxDets[a].HalfWidth1() + auxDets[a].HalfWidth2());
 
       if (localPoint.Z() >= -(auxDets[a].Length() / 2 + tolerance) &&
           localPoint.Z() <= (auxDets[a].Length() / 2 + tolerance) &&
           localPoint.Y() >= -auxDets[a].HalfHeight() - tolerance &&
           localPoint.Y() <= auxDets[a].HalfHeight() + tolerance &&
           // if AuxDet a is a box, then HalfSmallWidth = HalfWidth
           localPoint.X() >= -HalfCenterWidth +
                               localPoint.Z() * (HalfCenterWidth - auxDets[a].HalfWidth2()) /
                                 (0.5 * auxDets[a].Length()) -
                               tolerance &&
           localPoint.X() <= HalfCenterWidth -
                               localPoint.Z() * (HalfCenterWidth - auxDets[a].HalfWidth2()) /
                                 (0.5 * auxDets[a].Length()) +
                               tolerance)
         return a;
 
     } // for loop over AudDet a
 
     // throw an exception because we couldn't find the sensitive volume
     throw cet::exception("ChannelMap") << "Can't find AuxDet for position (" << point.X() << ","
                                        << point.Y() << "," << point.Z() << ")\n";
   }

size_t geo::ChannelMapAlg::NearestSensitiveAuxDet	(	Point_t const &	point,
		std::vector< AuxDetGeo > const &	auxDets,
		double	tolerance = `0`
	)		const

virtual

Returns sensitive auxiliary detector closest to specified point.

Parameters

point	coordinates of the position to be investigated (x, y, z)
auxDets	list of the auxiliary detectors
tolerance	tolerance for comparison. Default 0.

Returns: index of sought sensitive auxiliary detector within auxDets

Definition at line 102 of file ChannelMapAlg.cxx.

References geo::AuxDetSensitiveGeo::HalfHeight(), geo::AuxDetSensitiveGeo::HalfWidth1(), geo::AuxDetSensitiveGeo::HalfWidth2(), geo::AuxDetSensitiveGeo::Length(), NearestAuxDet(), geo::AuxDetGeo::NSensitiveVolume(), geo::AuxDetGeo::SensitiveVolume(), and geo::AuxDetSensitiveGeo::toLocalCoords().

Referenced by HasChannel().

   {
     size_t auxDetIdx = NearestAuxDet(point, auxDets, tolerance);
     geo::AuxDetGeo const& adg = auxDets[auxDetIdx];
 
     for (size_t a = 0; a < adg.NSensitiveVolume(); ++a) {
       geo::AuxDetSensitiveGeo const& adsg = adg.SensitiveVolume(a);
       auto const localPoint = adsg.toLocalCoords(point);
 
       double const HalfCenterWidth = 0.5 * (adsg.HalfWidth1() + adsg.HalfWidth2());
 
       if (localPoint.Z() >= -(adsg.Length() / 2 + tolerance) &&
           localPoint.Z() <= (adsg.Length() / 2 + tolerance) &&
           localPoint.Y() >= -adsg.HalfHeight() - tolerance &&
           localPoint.Y() <= adsg.HalfHeight() + tolerance &&
           // if AuxDet a is a box, then HalfSmallWidth = HalfWidth
           localPoint.X() >=
             -HalfCenterWidth +
               localPoint.Z() * (HalfCenterWidth - adsg.HalfWidth2()) / (0.5 * adsg.Length()) -
               tolerance &&
           localPoint.X() <=
             HalfCenterWidth -
               localPoint.Z() * (HalfCenterWidth - adsg.HalfWidth2()) / (0.5 * adsg.Length()) +
               tolerance)
         return a;
     } // for loop over AuxDetSensitive a
 
     // throw an exception because we couldn't find the sensitive volume
     throw cet::exception("Geometry") << "Can't find AuxDetSensitive for position (" << point.X()
                                      << "," << point.Y() << "," << point.Z() << ")\n";
   }

virtual WireID geo::ChannelMapAlg::NearestWireID	(	Point_t const &	worldPos,
		PlaneID const &	planeID
	)		const

pure virtual

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.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

unsigned int geo::ChannelMapAlg::NOpChannels ( unsigned int NOpDets ) const

virtual

Returns the number of optical channels contained in some detectors.

Parameters

NOpDets number of optical detectors

Returns: optical channels contained in NOpDets detectors

This function returns how many channels can be expected to be present in a detector with NOpDets optical detectors. This is an upper limit, as not all channels have necessarily to be present.

For example: if a detector has four channels per optical detector, the returned value will be four times the argument NOpDets. If there is a single channel on each optical detector, the return value will be the value NOpDets (this is in fact the fallback implementation). If each optical detector can have anywhere between 2 and 12 channels, the returned value is 12 times NOpDets, and it will be an overestimation of the number of channels.

Definition at line 14 of file ChannelMapAlg.cxx.

Referenced by HasChannel(), IsValidOpChannel(), and MaxOpChannel().

   {
     // By default just return the number of optical detectos
     return NOpDets;
   }

unsigned int geo::ChannelMapAlg::NOpHardwareChannels ( unsigned int opDet ) const

virtual

Returns the number of channels in the specified optical detectors.

Parameters

opDet ID of the chosen optical detector

Returns: optical channels contained in optical detector with ID opDet

This function returns how many channels are actually present in the optical detector with the specified ID.

For example: if a detector has four channels per optical detector, the returned value will be four, regardless opDet, and . If there is a single channel on each optical detector, the return value will be 1, again ignoring opDet (this is in fact the fallback implementation). If each optical detector can have anywhere between 2 and 12 channels, the returned value will be 2, 12, etc., that is the exact number of channels in opDet.

Although implementations are encouraged to return 0 on invalid optical detectors, the actual return value in that case is undefined.

Definition at line 28 of file ChannelMapAlg.cxx.

Referenced by HasChannel(), and IsValidOpChannel().

   {
     // By defualt, 1 channel per optical detector
     return 1;
   }

virtual unsigned int geo::ChannelMapAlg::NROPs ( readout::TPCsetID const & tpcsetid ) const

pure virtual

Returns the total number of ROP in the specified TPC set.

Parameters

tpcsetid TPC set ID

Returns: number of readout planes in the TPC set, or 0 if no TPC set found

Note that this methods explicitly check the existence of the TPC set.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual unsigned int geo::ChannelMapAlg::NTPCsets ( readout::CryostatID const & cryoid ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

unsigned int geo::ChannelMapAlg::OpChannel	(	unsigned int	detNum,
		unsigned int	hwchannel = `0`
	)		const

virtual

Returns the channel ID of the specified hardware channel.

Parameters

detNum	optical detector ID
hwchannel	hardware channel within the specified optical detector

Returns: ID of the channel identified by detector and hardware channel IDs

If the input IDs identify a non-existing channel, the result is undefined.

Definition at line 35 of file ChannelMapAlg.cxx.

Referenced by HasChannel().

   {
     return detNum;
   }

unsigned int geo::ChannelMapAlg::OpDetFromOpChannel ( unsigned int opChannel ) const

virtual

Returns the optical detector the specified optical channel belongs.

Parameters

opChannel the optical detector channel being queried

Returns: the optical detector the specified optical channel belongs to

If the specified optical channel is invalid, behaviour is undefined.

Definition at line 41 of file ChannelMapAlg.cxx.

Referenced by HasChannel(), and IsValidOpChannel().

   {
     return opChannel;
   }

virtual std::set<PlaneID> const& geo::ChannelMapAlg::PlaneIDs ( ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

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

pure virtual

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.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual std::vector<TPCID> geo::ChannelMapAlg::ROPtoTPCs ( readout::ROPID const & ropid ) const

pure virtual

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

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.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual std::vector<PlaneID> geo::ChannelMapAlg::ROPtoWirePlanes ( readout::ROPID const & ropid ) const

pure virtual

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

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

geo::SigType_t geo::ChannelMapAlg::SignalTypeForChannel ( raw::ChannelID_t const channel ) const

Return the signal type of the specified channel.

Parameters

channel ID of the channel

Returns: signal type of the channel, or geo::kMysteryType if not known

On any type of error (e.g., invalid or unknown channel ID), geo::kMysteryType is returned.

Definition at line 177 of file ChannelMapAlg.cxx.

References SignalTypeForChannelImpl().

Referenced by HasChannel(), and SignalTypeForROPIDImpl().

   {
     return SignalTypeForChannelImpl(channel);
   }

virtual SigType_t geo::ChannelMapAlg::SignalTypeForChannelImpl ( raw::ChannelID_t const channel ) const

protectedpure virtual

Return the signal type of the specified channel.

Parameters

channel ID of the channel

Returns: signal type of the channel, or geo::kMysteryType if not known

On any type of error (e.g., invalid or unknown channel ID), geo::kMysteryType is returned.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel(), and SignalTypeForChannel().

geo::SigType_t geo::ChannelMapAlg::SignalTypeForROPID ( readout::ROPID const & ropid ) const

Return the signal type on the specified readout plane.

Parameters

ropid ID of the readout plane

Returns: signal type on the plane, or geo::kMysteryType if not known

If the readout plane ID is marked invalid, geo::kMysteryType is returned. If the readout plane is not marked invalid, but it does not match an existing readout plane, the result is undefined.

The default implementation uses readout plane to channel mapping. Other implementation may decide to do the opposite.

Definition at line 182 of file ChannelMapAlg.cxx.

References SignalTypeForROPIDImpl().

Referenced by HasChannel().

   {
     return SignalTypeForROPIDImpl(ropid);
   }

geo::SigType_t geo::ChannelMapAlg::SignalTypeForROPIDImpl ( readout::ROPID const & ropid ) const

protectedvirtual

Return the signal type on the specified readout plane.

Parameters

ropid ID of the readout plane

Returns: signal type on the plane, or geo::kMysteryType if not known

If the readout plane ID is marked invalid, geo::kMysteryType is returned. If the readout plane is not marked invalid, but it does not match an existing readout plane, the result is undefined.

The default implementation uses readout plane to channel mapping. Other implementation may decide to do the opposite.

Definition at line 187 of file ChannelMapAlg.cxx.

References FirstChannelInROP(), and SignalTypeForChannel().

Referenced by HasChannel(), and SignalTypeForROPID().

   {
     return SignalTypeForChannel(FirstChannelInROP(ropid));
   }

virtual GeoObjectSorter const& geo::ChannelMapAlg::Sorter ( ) const

pure virtual

Returns the object to sort geometry with.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual std::vector<TPCID> geo::ChannelMapAlg::TPCsetToTPCs ( readout::TPCsetID const & tpcsetid ) const

pure virtual

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

Note that the check is performed on the validity of the TPC set ID, that does not necessarily imply that the TPC set specified by the ID actually exists. Check the existence of the TPC set first (HasTPCset()). Behaviour on valid, non-existent TPC set IDs is undefined.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual readout::TPCsetID geo::ChannelMapAlg::TPCtoTPCset ( TPCID const & tpcid ) const

pure virtual

Returns the ID of the TPC set tpcid belongs to.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual void geo::ChannelMapAlg::Uninitialize ( )

pure virtual

Deconfiguration: prepare for a following call of Initialize()

Implemented in geo::ChannelMapStandardAlg.

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

pure virtual

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.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().

virtual readout::ROPID geo::ChannelMapAlg::WirePlaneToROP ( PlaneID const & planeid ) const

pure virtual

Returns the ID of the ROP planeid belongs to.

Implemented in geo::ChannelMapStandardAlg.

Referenced by HasChannel().