#include "ChannelMapStandardAlg.h"

Inheritance diagram for geo::ChannelMapStandardAlg:

Public Member Functions
	ChannelMapStandardAlg (fhicl::ParameterSet const &p)

virtual void	Initialize (GeometryData_t const &geodata) override
	Geometry initialisation. More...

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

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

virtual unsigned int	Nchannels () const override
	Returns the total number of channels present (not necessarily contiguous) More...

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

virtual std::set< 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...


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 WireID	NearestWireID (const TVector3 &worldPos, geo::PlaneID const &planeID) const override
	Returns the ID of the wire nearest to the specified position. More...

virtual 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...


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...

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 ROPs 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...

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
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...

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

virtual size_t	NearestSensitiveAuxDet (const double point, std::vector< geo::AuxDetGeo > const &auxDets) 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...

Testing (not in the interface)
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...

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, 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...

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, 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
	Returns the specified element of the TPC map. More...


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
	Returns whether the ID specifies a valid entry. More...

template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::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

Private Member Functions
virtual SigType_t	SignalTypeForChannelImpl (raw::ChannelID_t const channel) const override
	Return the signal type of the specified channel. More...

unsigned int	WireCount (geo::PlaneID const &id) const
	Retrieved the wire cound for the specified plane ID. More...

unsigned int	MaxTPCs () const
	Returns the largest number of TPCs in a single cryostat. More...

Static Private Member Functions
static readout::TPCsetID	ConvertTPCtoTPCset (geo::TPCID const &tpcid)
	Converts a TPC ID into a TPC set ID using the same numerical indices. More...

static geo::TPCID	ConvertTPCsetToTPC (readout::TPCsetID const &tpcsetid)
	Converts a TPC set ID into a TPC ID using the same numerical indices. More...

static readout::ROPID	ConvertWirePlaneToROP (geo::PlaneID const &planeid)
	Converts a ROP ID into a wire plane ID using the same numerical indices. More...

static geo::PlaneID	ConvertROPtoWirePlane (readout::ROPID const &ropid)
	Converts a wire plane ID into a ROP ID using the same numerical indices. More...

Private Attributes
unsigned int	fNcryostat
	number of cryostats in the detector More...

unsigned int	fNchannels
	number of channels in the detector More...

raw::ChannelID_t	fTopChannel
	book keeping highest channel # More...

std::vector< unsigned int >	fNTPC
	number of TPCs in each cryostat More...

std::set< View_t >	fViews
	vector of the views present in the detector More...

std::set< PlaneID >	fPlaneIDs
	vector of the PlaneIDs present in the detector More...

PlaneInfoMap_t< float >	fFirstWireProj

PlaneInfoMap_t< float >	fOrthVectorsY
	Unit vectors orthogonal to wires in. More...

PlaneInfoMap_t< float >	fOrthVectorsZ

PlaneInfoMap_t< float >	fWireCounts

TPCInfoMap_t< unsigned int >	fNPlanes

PlaneInfoMap_t< unsigned int >	fPlaneBaselines

PlaneInfoMap_t< unsigned int >	fWiresPerPlane

geo::GeoObjectSorterStandard	fSorter
	class to sort geo objects More...

TPC channel mapping
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...

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

Detailed Description

Definition at line 21 of file ChannelMapStandardAlg.h.

Member Typedef Documentation

template<typename T >

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

protectedinherited

Data type for per-plane information.

Definition at line 610 of file ChannelMapAlg.h.

template<typename T >

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

protectedinherited

Data type for per-TPC information.

Definition at line 606 of file ChannelMapAlg.h.

Constructor & Destructor Documentation

geo::ChannelMapStandardAlg::ChannelMapStandardAlg ( fhicl::ParameterSet const & p )

Definition at line 21 of file ChannelMapStandardAlg.cxx.

     : fSorter(geo::GeoObjectSorterStandard(p))
   {
   }

Member Function Documentation

template<typename T >

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

inlineprotectedinherited

Returns the specified element of the TPC map.

Definition at line 633 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::AccessElementSize().

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

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

template<typename T >

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

inlineprotectedinherited

Returns the specified element of the plane map.

Definition at line 660 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::AccessElementSize().

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

template<typename T >

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

inlineprotectedinherited

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

Definition at line 639 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::isValidElement().

Referenced by geo::ChannelMapAlg::AccessElement().

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

template<typename T >

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

inlineprotectedinherited

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

Definition at line 666 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::isValidElement().

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

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

virtualinherited

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 151 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::fADNameToGeo.

Referenced by geo::ChannelMapAlg::ChannelToSensitiveAuxDet(), and geo::ChannelMapAlg::NearestWire().

   {
     // 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;
 
     return UINT_MAX;
   }

readout::ROPID geo::ChannelMapStandardAlg::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 430 of file ChannelMapStandardAlg.cxx.

References ChannelToWire(), FirstChannelInROP(), raw::isValidChannelID(), and WirePlaneToROP().

Referenced by PlaneWireToChannel(), and ROPtoTPCs().

   {
     if (!raw::isValidChannelID(channel)) return {}; // invalid ROP returned
     
     // which wires does the channel cover?
     std::vector<geo::WireID> wires = ChannelToWire(channel);
     
     // - none:
     if (wires.empty()) return {}; // invalid ROP returned
     
     // - one: maps its plane ID into a ROP ID
     return WirePlaneToROP(wires[0]);
   } // ChannelMapStandardAlg::ROPtoTPCs()

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

virtualinherited

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 169 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::ChannelToAuxDet(), and geo::ChannelMapAlg::fADChannelToSensitiveGeo.

Referenced by geo::ChannelMapAlg::NearestWire().

   {
     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";
 
     return std::make_pair(adGeoIdx, UINT_MAX);
   }

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

overridevirtual

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

Exceptions

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

Implements geo::ChannelMapAlg.

Definition at line 143 of file ChannelMapStandardAlg.cxx.

References geo::ChannelMapAlg::fFirstChannelInNextPlane, geo::ChannelMapAlg::fFirstChannelInThisPlane, fNcryostat, fNTPC, and fTopChannel.

Referenced by ChannelToROP().

   {
     std::vector< geo::WireID > AllSegments; 
     unsigned int cstat = 0;
     unsigned int tpc   = 0;
     unsigned int plane = 0;
     unsigned int wire  = 0;
     
     // first check if this channel ID is legal
     if(channel > fTopChannel)
       throw cet::exception("Geometry") << "ILLEGAL CHANNEL ID for channel " << channel << "\n";
     
     // then go find which plane, tpc and cryostat it is in from the information we stored earlier
     bool foundWid(false);
     for(unsigned int csloop = 0; csloop != fNcryostat; ++csloop){
       for(unsigned int tpcloop = 0; tpcloop != fNTPC[csloop]; ++tpcloop){
         for(unsigned int planeloop = 0; planeloop != fFirstChannelInNextPlane[csloop][tpcloop].size(); ++planeloop){
           if(channel < fFirstChannelInNextPlane[csloop][tpcloop][planeloop]){
             cstat = csloop;
             tpc   = tpcloop;
             plane = planeloop;
             wire  = channel - fFirstChannelInThisPlane[cstat][tpcloop][planeloop];
             foundWid = true;
             break;
           }            
           if(foundWid) break;
         }// end plane loop
         if(foundWid) break;
       }// end tpc loop
       if(foundWid) break;
     }// end cryostat loop
 
     geo::WireID CodeWire(cstat, tpc, plane, wire);
     
     AllSegments.push_back(CodeWire);
 
     return AllSegments;
   }

geo::PlaneID geo::ChannelMapStandardAlg::ConvertROPtoWirePlane ( readout::ROPID const & ropid )

staticprivate

Converts a wire plane ID into a ROP ID using the same numerical indices.

Definition at line 503 of file ChannelMapStandardAlg.cxx.

References geo::CryostatID::Cryostat, geo::CryostatID::isValid, readout::ROPID::ROP, and readout::TPCsetID::TPCset.

Referenced by ConvertWirePlaneToROP(), FirstChannelInROP(), FirstWirePlaneInROP(), and WireCount().

   {
     if (!ropid.isValid) return {};
     return {
       (geo::CryostatID::CryostatID_t) ropid.Cryostat,
       (geo::TPCID::TPCID_t) ropid.TPCset,
       (geo::PlaneID::PlaneID_t) ropid.ROP
       };
   } // ChannelMapStandardAlg::ConvertROPtoWirePlane()

geo::TPCID geo::ChannelMapStandardAlg::ConvertTPCsetToTPC ( readout::TPCsetID const & tpcsetid )

staticprivate

Converts a TPC set ID into a TPC ID using the same numerical indices.

Definition at line 477 of file ChannelMapStandardAlg.cxx.

References ConvertWirePlaneToROP(), geo::CryostatID::Cryostat, geo::CryostatID::isValid, and readout::TPCsetID::TPCset.

Referenced by ConvertTPCtoTPCset(), FirstTPCinTPCset(), ROPtoTPCs(), TPCsetToTPCs(), and WireCount().

   {
     if (!tpcsetid.isValid) return {};
     return {
       (geo::CryostatID::CryostatID_t) tpcsetid.Cryostat,
       (geo::TPCID::TPCID_t) tpcsetid.TPCset
       };
   } // ChannelMapStandardAlg::ConvertTPCsetToTPC()

readout::TPCsetID geo::ChannelMapStandardAlg::ConvertTPCtoTPCset ( geo::TPCID const & tpcid )

staticprivate

Converts a TPC ID into a TPC set ID using the same numerical indices.

Definition at line 465 of file ChannelMapStandardAlg.cxx.

References ConvertTPCsetToTPC(), geo::CryostatID::Cryostat, geo::CryostatID::isValid, and geo::TPCID::TPC.

Referenced by FirstWirePlaneInROP(), TPCtoTPCset(), and WireCount().

   {
     if (!tpcid.isValid) return {}; // invalid ID, default-constructed
     return {
       (readout::CryostatID::CryostatID_t) tpcid.Cryostat,
       (readout::TPCsetID::TPCsetID_t) tpcid.TPC
       };
   } // ChannelMapStandardAlg::ConvertTPCtoTPCset()

readout::ROPID geo::ChannelMapStandardAlg::ConvertWirePlaneToROP ( geo::PlaneID const & planeid )

staticprivate

Converts a ROP ID into a wire plane ID using the same numerical indices.

Definition at line 489 of file ChannelMapStandardAlg.cxx.

References ConvertROPtoWirePlane(), geo::CryostatID::Cryostat, geo::CryostatID::isValid, geo::PlaneID::Plane, and geo::TPCID::TPC.

Referenced by ConvertTPCsetToTPC(), WireCount(), and WirePlaneToROP().

   {
     if (!planeid.isValid) return {}; // invalid ID, default-constructed
     return {
       (readout::CryostatID::CryostatID_t) planeid.Cryostat,
       (readout::TPCsetID::TPCsetID_t) planeid.TPC,
       (readout::ROPID::ROPID_t) planeid.Plane
       };
     
   } // ChannelMapStandardAlg::ConvertWirePlaneToROP()

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

inlineinherited

Retrieve the private fFirstChannelInNextPlane vector for testing.

Definition at line 591 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::fFirstChannelInThisPlane.

592 { return fFirstChannelInThisPlane; }

geo::ChannelMapAlg::fFirstChannelInThisPlane

PlaneInfoMap_t< raw::ChannelID_t > fFirstChannelInThisPlane

Definition: ChannelMapAlg.h:614

raw::ChannelID_t geo::ChannelMapStandardAlg::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 447 of file ChannelMapStandardAlg.cxx.

References geo::ChannelMapAlg::AccessElement(), ConvertROPtoWirePlane(), FirstWirePlaneInROP(), fPlaneBaselines, raw::InvalidChannelID, and geo::CryostatID::isValid.

Referenced by ChannelToROP(), and PlaneWireToChannel().

   {
     if (!ropid.isValid) return raw::InvalidChannelID;
     return (raw::ChannelID_t)
       AccessElement(fPlaneBaselines, ConvertROPtoWirePlane(ropid));
   } // ChannelMapStandardAlg::FirstChannelInROP()

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

inlineinherited

Retrieve the private fFirstChannelInThisPlane vector for testing.

Definition at line 595 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::fFirstChannelInNextPlane.

596 { return fFirstChannelInNextPlane; }

geo::ChannelMapAlg::fFirstChannelInNextPlane

PlaneInfoMap_t< raw::ChannelID_t > fFirstChannelInNextPlane

Definition: ChannelMapAlg.h:615

geo::TPCID geo::ChannelMapStandardAlg::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 359 of file ChannelMapStandardAlg.cxx.

References ConvertTPCsetToTPC().

Referenced by NROPs(), PlaneWireToChannel(), and TPCsetToTPCs().

   {
     return ConvertTPCsetToTPC(tpcsetid);
   } // ChannelMapStandardAlg::FirstTPCinTPCset()

geo::PlaneID geo::ChannelMapStandardAlg::FirstWirePlaneInROP ( readout::ROPID const & ropid ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 457 of file ChannelMapStandardAlg.cxx.

References ConvertROPtoWirePlane(), and ConvertTPCtoTPCset().

Referenced by FirstChannelInROP(), Nchannels(), PlaneWireToChannel(), and ROPtoWirePlanes().

   {
     return ConvertROPtoWirePlane(ropid);
   } // ChannelMapStandardAlg::FirstWirePlaneInROP()

template<typename T >

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

inlineprotectedinherited

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

Definition at line 693 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapAlg::isValidElement(), and 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

virtualinherited

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 57 of file ChannelMapAlg.cxx.

Referenced by geo::ChannelMapAlg::IsValidOpChannel(), and geo::ChannelMapAlg::PlaneWireToChannel().

   {
     return 0;
   }

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

inlinevirtualinherited

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

Definition at line 90 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::ChannelToWire(), raw::isValidChannelID(), geo::ChannelMapAlg::Nchannels(), geo::ChannelMapAlg::PlaneIDs(), geo::ChannelMapAlg::SignalTypeForChannel(), geo::ChannelMapAlg::SignalTypeForChannelImpl(), geo::ChannelMapAlg::SignalTypeForROPID(), and geo::ChannelMapAlg::SignalTypeForROPIDImpl().

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

geo::ChannelMapAlg::Nchannels

virtual unsigned int Nchannels() const =0

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

raw::isValidChannelID

constexpr bool isValidChannelID(raw::ChannelID_t channel)

Definition: RawTypes.h:36

bool geo::ChannelMapStandardAlg::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 394 of file ChannelMapStandardAlg.cxx.

References NROPs(), readout::ROPID::ROP, and WirePlaneToROP().

Referenced by Nchannels(), and PlaneWireToChannel().

                                                                     {
     return ropid.ROP < NROPs(ropid);
   } // ChannelMapStandardAlg::HasROP()

bool geo::ChannelMapStandardAlg::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 333 of file ChannelMapStandardAlg.cxx.

References NTPCsets(), readout::TPCsetID::TPCset, and TPCtoTPCset().

Referenced by NROPs(), and PlaneWireToChannel().

   {
     return tpcsetid.TPCset < NTPCsets(tpcsetid);
   } // ChannelMapStandardAlg::HasTPCset()

void geo::ChannelMapStandardAlg::Initialize ( GeometryData_t const & geodata )

overridevirtual

Geometry initialisation.

Implements geo::ChannelMapAlg.

Definition at line 27 of file ChannelMapStandardAlg.cxx.

References geo::WireGeo::CosThetaZ(), geo::GeometryData_t::cryostats, geo::ChannelMapAlg::fFirstChannelInNextPlane, geo::ChannelMapAlg::fFirstChannelInThisPlane, fFirstWireProj, fNchannels, fNcryostat, fNPlanes, fNTPC, fOrthVectorsY, fOrthVectorsZ, fPlaneBaselines, fPlaneIDs, fTopChannel, fWireCounts, fWiresPerPlane, geo::WireGeo::GetCenter(), LOG_DEBUG, geo::TPCGeo::Nplanes(), geo::CryostatGeo::NTPC(), geo::PlaneGeo::Nwires(), geo::TPCGeo::Plane(), geo::WireGeo::SinThetaZ(), geo::CryostatGeo::TPC(), Uninitialize(), geo::PlaneGeo::Wire(), and geo::TPCGeo::WirePitch().

   {
     // start over:
     Uninitialize();
     
     std::vector<geo::CryostatGeo> const& cgeo = geodata.cryostats;
     
     fNcryostat = cgeo.size();
     
     mf::LogInfo("ChannelMapStandardAlg") << "Initializing Standard ChannelMap...";
 
     fNTPC.resize(fNcryostat);
     fWireCounts.resize(fNcryostat);
     fNPlanes.resize(fNcryostat);
     fFirstWireProj.resize(fNcryostat);
     fOrthVectorsY.resize(fNcryostat);
     fOrthVectorsZ.resize(fNcryostat);
     fPlaneBaselines.resize(fNcryostat);
     fWiresPerPlane.resize(fNcryostat);
     fFirstChannelInNextPlane.resize(fNcryostat);
     fFirstChannelInThisPlane.resize(fNcryostat);
     fPlaneIDs.clear();
     fTopChannel = 0;
 
     int RunningTotal = 0;
 
     for(unsigned int cs = 0; cs != fNcryostat; ++cs){
       geo::CryostatGeo const& cryo = cgeo[cs];
       fNTPC[cs] = cryo.NTPC();
       
       // Size up all the vectors 
       fWireCounts[cs]             .resize(fNTPC[cs]);
       fFirstWireProj[cs]           .resize(fNTPC[cs]);
       fOrthVectorsY[cs]            .resize(fNTPC[cs]);
       fOrthVectorsZ[cs]            .resize(fNTPC[cs]);
       fPlaneBaselines[cs]          .resize(fNTPC[cs]);
       fWiresPerPlane[cs]           .resize(fNTPC[cs]);
       fNPlanes[cs]                     .resize(fNTPC[cs]);
       fFirstChannelInThisPlane[cs].resize(fNTPC[cs]);
       fFirstChannelInNextPlane[cs].resize(fNTPC[cs]);
 
       for(unsigned int TPCCount = 0; TPCCount != fNTPC[cs]; ++TPCCount){
         geo::TPCGeo const& TPC = cryo.TPC(TPCCount);
         unsigned int PlanesThisTPC = TPC.Nplanes();
         fWireCounts[cs][TPCCount]   .resize(PlanesThisTPC);
         fFirstWireProj[cs][TPCCount].resize(PlanesThisTPC);
         fOrthVectorsY[cs][TPCCount] .resize(PlanesThisTPC);
         fOrthVectorsZ[cs][TPCCount] .resize(PlanesThisTPC);
         fNPlanes[cs][TPCCount]=PlanesThisTPC;
         for(unsigned int PlaneCount = 0; PlaneCount != PlanesThisTPC; ++PlaneCount){
           geo::PlaneGeo const& plane = TPC.Plane(PlaneCount);
 
           fPlaneIDs.emplace(PlaneID(cs, TPCCount, PlaneCount));
           double ThisWirePitch = TPC.WirePitch(PlaneCount);
           fWireCounts[cs][TPCCount][PlaneCount] = plane.Nwires();
           
           double  WireCentre1[3] = {0.,0.,0.};
           double  WireCentre2[3] = {0.,0.,0.};
           
           const geo::WireGeo& firstWire = plane.Wire(0);
           const double sth = firstWire.SinThetaZ(), cth = firstWire.CosThetaZ();
           
           firstWire.GetCenter(WireCentre1,0);
           plane.Wire(1).GetCenter(WireCentre2,0);
           
           // figure out if we need to flip the orthogonal vector 
           // (should point from wire n -> n+1)
           double OrthY = cth, OrthZ = -sth;
           if(((WireCentre2[1] - WireCentre1[1])*OrthY 
               + (WireCentre2[2] - WireCentre1[2])*OrthZ) < 0){
             OrthZ *= -1;
             OrthY *= -1;
           }
           
           // Overall we are trying to build an expression that looks like
           //  int NearestWireNumber = round((worldPos.OrthVector - FirstWire.OrthVector)/WirePitch);     
           // That runs as fast as humanly possible.
           // We predivide everything by the wire pitch so we don't do this in the loop.
           //
           // Putting this together into the useful constants we will use later per plane and tpc:
           fOrthVectorsY[cs][TPCCount][PlaneCount] = OrthY / ThisWirePitch;
           fOrthVectorsZ[cs][TPCCount][PlaneCount] = OrthZ / ThisWirePitch;
           
           fFirstWireProj[cs][TPCCount][PlaneCount]  = WireCentre1[1]*OrthY + WireCentre1[2]*OrthZ;
           fFirstWireProj[cs][TPCCount][PlaneCount] /= ThisWirePitch;
           
           // now to count up wires in each plane and get first channel in each plane
           int WiresThisPlane = plane.Nwires();        
           fWiresPerPlane[cs] .at(TPCCount).push_back(WiresThisPlane);
           fPlaneBaselines[cs].at(TPCCount).push_back(RunningTotal);
           
           RunningTotal += WiresThisPlane;
 
           fFirstChannelInThisPlane[cs].at(TPCCount).push_back(fTopChannel);
           fTopChannel += WiresThisPlane;
           fFirstChannelInNextPlane[cs].at(TPCCount).push_back(fTopChannel);
 
         }// end loop over planes
       }// end loop over TPCs
     }// end loop over cryostats
 
     // calculate the total number of channels in the detector
     fNchannels = fTopChannel;
 
     LOG_DEBUG("ChannelMapStandard") << "# of channels is " << fNchannels;
 
 
     return;
   }

template<typename T >

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

inlineprotectedinherited

Returns whether the ID specifies a valid entry.

Definition at line 646 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapAlg::AccessElementSize(), and geo::ChannelMapAlg::isValidElement().

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

template<typename T >

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

inlineprotectedinherited

Returns the specified element of the TPC map.

Definition at line 649 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::AccessElement(), and geo::ChannelMapAlg::isValidElement().

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

template<typename T >

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

inlineprotectedinherited

Returns whether the ID specifies a valid entry.

Definition at line 673 of file ChannelMapAlg.h.

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

template<typename T >

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

inlineprotectedinherited

Returns whether the ID specifies a valid entry.

Definition at line 676 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::isValidElement().

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

template<typename T >

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

inlineprotectedinherited

Returns whether the ID specifies a valid entry.

Definition at line 683 of file ChannelMapAlg.h.

References geo::ChannelMapAlg::GetElementPtr(), and geo::ChannelMapAlg::isValidElement().

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

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

virtualinherited

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 63 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::HardwareChannelFromOpChannel(), geo::ChannelMapAlg::NOpChannels(), geo::ChannelMapAlg::NOpHardwareChannels(), and geo::ChannelMapAlg::OpDetFromOpChannel().

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

   {
     // 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

virtualinherited

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 29 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::NOpChannels().

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

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

unsigned int geo::ChannelMapStandardAlg::MaxROPs ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 384 of file ChannelMapStandardAlg.cxx.

References fNPlanes, and max.

Referenced by PlaneWireToChannel().

                                                     {
     unsigned int max = 0;
     for (auto const& cryo_tpc: fNPlanes)
       for (unsigned int nPlanes: cryo_tpc)
         if (nPlanes > max) max = nPlanes;
     return max;
   } // ChannelMapStandardAlg::MaxROPs()

unsigned int geo::ChannelMapStandardAlg::MaxTPCs ( ) const

private

Returns the largest number of TPCs in a single cryostat.

Definition at line 366 of file ChannelMapStandardAlg.cxx.

References fNTPC, max, and NROPs().

Referenced by MaxTPCsets(), and WireCount().

   {
     unsigned int max = 0;
     for (unsigned int nTPCs: fNTPC) if (nTPCs > max) max = nTPCs;
     return max;
   } // ChannelMapStandardAlg::MaxTPCs()

unsigned int geo::ChannelMapStandardAlg::MaxTPCsets ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 326 of file ChannelMapStandardAlg.cxx.

References MaxTPCs().

Referenced by PlaneWireToChannel().

   {
     return MaxTPCs();
   } // ChannelMapStandardAlg::MaxTPCsets()

raw::ChannelID_t geo::ChannelMapStandardAlg::Nchannels ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 183 of file ChannelMapStandardAlg.cxx.

References fNchannels.

   {
     return fNchannels;
   }

unsigned int geo::ChannelMapStandardAlg::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 190 of file ChannelMapStandardAlg.cxx.

References FirstWirePlaneInROP(), HasROP(), WireCoordinate(), and WireCount().

   {
     if (!HasROP(ropid)) return 0;
     // The number of channels matches the number of wires. Life is easy.
     return WireCount(FirstWirePlaneInROP(ropid));
   } // ChannelMapStandardAlg::Nchannels(ROPID)

size_t geo::ChannelMapAlg::NearestAuxDet	(	const double *	point,
		std::vector< geo::AuxDetGeo * > const &	auxDets
	)		const

virtualinherited

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

Returns: index of auxiliary detector within auxDets

Definition at line 80 of file ChannelMapAlg.cxx.

Referenced by geo::ChannelMapAlg::NearestSensitiveAuxDet(), and geo::ChannelMapAlg::NearestWire().

   {
     double HalfCenterWidth = 0.;
     double localPoint[3] = {0.};
 
     for(size_t a = 0; a < auxDets.size(); ++a) {
 
       auxDets[a]->WorldToLocal(point, localPoint);
 
       HalfCenterWidth = 0.5 * (auxDets[a]->HalfWidth1() + auxDets[a]->HalfWidth2());
 
       if( localPoint[2] >= - auxDets[a]->Length()/2       &&
           localPoint[2] <=   auxDets[a]->Length()/2       &&
           localPoint[1] >= - auxDets[a]->HalfHeight()     &&
           localPoint[1] <=   auxDets[a]->HalfHeight()     &&
           // if AuxDet a is a box, then HalfSmallWidth = HalfWidth
           localPoint[0] >= - HalfCenterWidth + localPoint[2]*(HalfCenterWidth - auxDets[a]->HalfWidth2())/(0.5 * auxDets[a]->Length()) &&
           localPoint[0] <=   HalfCenterWidth - localPoint[2]*(HalfCenterWidth - auxDets[a]->HalfWidth2())/(0.5 * auxDets[a]->Length())
           ) 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[0] << ","
                                              << point[1] << ","
                                              << point[2] << ")\n";
 
     return UINT_MAX;
 
   }

size_t geo::ChannelMapAlg::NearestSensitiveAuxDet	(	const double *	point,
		std::vector< geo::AuxDetGeo * > const &	auxDets
	)		const

virtualinherited

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

Returns: index of sought sensitive auxiliary detector within auxDets

Definition at line 114 of file ChannelMapAlg.cxx.

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

Referenced by geo::ChannelMapAlg::NearestWire().

   {
     double HalfCenterWidth = 0.;
     double localPoint[3] = {0.};
 
     size_t auxDetIdx = this->NearestAuxDet(point, auxDets);
     
     geo::AuxDetGeo* adg = auxDets[auxDetIdx];
 
     for(size_t a = 0; a < adg->NSensitiveVolume(); ++a) {
 
       geo::AuxDetSensitiveGeo const& adsg = adg->SensitiveVolume(a);
       adsg.WorldToLocal(point, localPoint);    
   
       HalfCenterWidth = 0.5 * (adsg.HalfWidth1() + adsg.HalfWidth2());
 
       if( localPoint[2] >= - adsg.Length()/2       &&
           localPoint[2] <=   adsg.Length()/2       &&
           localPoint[1] >= - adsg.HalfHeight()     &&
           localPoint[1] <=   adsg.HalfHeight()     &&
           // if AuxDet a is a box, then HalfSmallWidth = HalfWidth
           localPoint[0] >= - HalfCenterWidth + localPoint[2]*(HalfCenterWidth - adsg.HalfWidth2())/(0.5 * adsg.Length()) &&
           localPoint[0] <=   HalfCenterWidth - localPoint[2]*(HalfCenterWidth - adsg.HalfWidth2())/(0.5 * adsg.Length())
           ) 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[0] << ","
                                      << point[1] << ","
                                      << point[2] << ")\n";
 
     return UINT_MAX;
   }

unsigned int geo::ChannelMapAlg::NearestWire	(	const TVector3 &	worldPos,
		geo::PlaneID const &	planeID
	)		const

inherited

Returns the index 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

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

Deprecated:: Use NearestWireID(const TVector3&, geo::PlaneID const&) instead.

Definition at line 15 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::NearestWireID(), and geo::WireID::Wire.

Referenced by geo::ChannelMapAlg::NearestWire(), and geo::ChannelMapAlg::NearestWireID().

   {
     return NearestWireID(worldPos, planeID).Wire;
   }

unsigned int geo::ChannelMapAlg::NearestWire	(	const TVector3 &	worldPos,
		unsigned int	PlaneNo,
		unsigned int	TPCNo,
		unsigned int	cstat
	)		const

inlineinherited

Returns the index 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 NearestWireID(const TVector3&, geo::PlaneID const&) instead.

Definition at line 408 of file ChannelMapAlg.h.

412 { return NearestWire(worldPos, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:250

geo::ChannelMapAlg::NearestWire

unsigned int NearestWire(const TVector3 &worldPos, geo::PlaneID const &planeID) const

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

Definition: ChannelMapAlg.cxx:15

WireID geo::ChannelMapStandardAlg::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 213 of file ChannelMapStandardAlg.cxx.

References PlaneWireToChannel(), WireCoordinate(), and WireCount().

Referenced by NearestWireID(), and WireCoordinate().

   {
 
     // This part is the actual calculation of the nearest wire number, where we assume
     //  uniform wire pitch and angle within a wireplane
     
     // add 0.5 to have the correct rounding
     int NearestWireNumber = int
       (0.5 + WireCoordinate(worldPos.Y(), worldPos.Z(), planeID));
     
     // If we are outside of the wireplane range, throw an exception
     // (this response maintains consistency with the previous
     // implementation based on geometry lookup)
     if(NearestWireNumber < 0 ||
        (unsigned int) NearestWireNumber >= WireCount(planeID))
     {
       int wireNumber = NearestWireNumber; // save for the output
       
       if(NearestWireNumber < 0 ) NearestWireNumber = 0;
       else                       NearestWireNumber = WireCount(planeID) - 1;
       
       throw InvalidWireIDError("Geometry", wireNumber, NearestWireNumber)
         << "Can't Find Nearest Wire for position (" 
         << worldPos[0] << "," << worldPos[1] << "," << worldPos[2] << ")"
         << " in plane " << std::string(planeID) << " approx wire number # "
         << wireNumber << " (capped from " << NearestWireNumber << ")\n";
     }
 
     return geo::WireID(planeID, (geo::WireID::WireID_t) NearestWireNumber);
   }

virtual WireID geo::ChannelMapStandardAlg::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 49 of file ChannelMapStandardAlg.h.

References NearestWireID(), and PlaneWireToChannel().

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

geo::ChannelMapStandardAlg::NearestWireID

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

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

Definition: ChannelMapStandardAlg.cxx:213

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:250

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

virtualinherited

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 22 of file ChannelMapAlg.cxx.

Referenced by geo::ChannelMapAlg::IsValidOpChannel(), geo::ChannelMapAlg::MaxOpChannel(), and geo::ChannelMapAlg::PlaneWireToChannel().

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

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

virtualinherited

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 36 of file ChannelMapAlg.cxx.

Referenced by geo::ChannelMapAlg::IsValidOpChannel(), and geo::ChannelMapAlg::PlaneWireToChannel().

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

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

overridevirtual

Returns the total number of ROPs 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

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

In this mapping, planes have independent readout and there is one wire plane in each readout plane and one readout plane for each wire plane.

Implements geo::ChannelMapAlg.

Definition at line 376 of file ChannelMapStandardAlg.cxx.

References geo::ChannelMapAlg::AccessElement(), FirstTPCinTPCset(), fNPlanes, and HasTPCset().

Referenced by HasROP(), MaxTPCs(), and PlaneWireToChannel().

   {
     if (!HasTPCset(tpcsetid)) return 0;
     return AccessElement(fNPlanes, FirstTPCinTPCset(tpcsetid));
   } // ChannelMapStandardAlg::NROPs()

unsigned int geo::ChannelMapStandardAlg::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

In this mapping, TPCs have independent readout and there is one TPC in each TPC set and one TPC set for each TPC.

Implements geo::ChannelMapAlg.

Definition at line 317 of file ChannelMapStandardAlg.cxx.

References geo::CryostatID::Cryostat, fNTPC, and geo::CryostatID::isValid.

Referenced by HasTPCset(), PlaneIDs(), and PlaneWireToChannel().

   {
     // return the same number as the number of TPCs
     return (cryoid.isValid && cryoid.Cryostat < fNTPC.size())?
       fNTPC[cryoid.Cryostat]: 0;
   } // ChannelMapStandardAlg::NTPCsets()

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

virtualinherited

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 45 of file ChannelMapAlg.cxx.

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

   {
     return detNum;
   }

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

virtualinherited

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 51 of file ChannelMapAlg.cxx.

Referenced by geo::ChannelMapAlg::IsValidOpChannel(), and geo::ChannelMapAlg::PlaneWireToChannel().

   {
     return opChannel;
   }

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 309 of file ChannelMapStandardAlg.cxx.

References fPlaneIDs, and NTPCsets().

Referenced by PlaneWireToChannel().

   {
     return fPlaneIDs;
   }

raw::ChannelID_t geo::ChannelMapStandardAlg::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 258 of file ChannelMapStandardAlg.cxx.

References fPlaneBaselines, geo::ChannelMapAlg::GetElementPtr(), raw::InvalidChannelID, and geo::WireID::Wire.

Referenced by NearestWireID(), and PlaneWireToChannel().

   {
     unsigned int const* pBaseLine = GetElementPtr(fPlaneBaselines, wireID);
     // This is the actual lookup part - first make sure coordinates are legal
     if (pBaseLine) {
       // if the channel has legal coordinates, its ID is given by the wire
       // number above the number of wires in lower planes, tpcs and cryostats
       return *pBaseLine + wireID.Wire;
     }
     else{  
       // if the coordinates were bad, throw an exception
       throw cet::exception("ChannelMapStandardAlg")
         << "NO CHANNEL FOUND for " << std::string(wireID);
     }
     
     // made it here, that shouldn't happen, return raw::InvalidChannelID
     mf::LogWarning("ChannelMapStandardAlg") << "should not be at the point in the function, returning "
                                             << "invalid channel";
     return raw::InvalidChannelID;
 
   }

virtual raw::ChannelID_t geo::ChannelMapStandardAlg::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 59 of file ChannelMapStandardAlg.h.

References ChannelToROP(), FirstChannelInROP(), FirstTPCinTPCset(), FirstWirePlaneInROP(), HasROP(), HasTPCset(), MaxROPs(), MaxTPCsets(), NROPs(), NTPCsets(), PlaneIDs(), PlaneWireToChannel(), ROPtoTPCs(), ROPtoWirePlanes(), TPCsetToTPCs(), TPCtoTPCset(), and WirePlaneToROP().

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

geo::WireID

Definition: geo_types.h:305

geo::ChannelMapStandardAlg::PlaneWireToChannel

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

Returns the channel ID a wire is connected to.

Definition: ChannelMapStandardAlg.cxx:258

std::vector< geo::TPCID > geo::ChannelMapStandardAlg::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 419 of file ChannelMapStandardAlg.cxx.

References readout::ROPID::asTPCsetID(), ChannelToROP(), ConvertTPCsetToTPC(), and geo::CryostatID::isValid.

Referenced by PlaneWireToChannel(), and ROPtoWirePlanes().

   {
     std::vector<geo::TPCID> IDs;
     // we take the TPC set of the ROP and convert it straight into a TPC ID
     if (ropid.isValid) IDs.emplace_back(ConvertTPCsetToTPC(ropid.asTPCsetID()));
     return IDs;
   } // ChannelMapStandardAlg::ROPtoTPCs()

std::vector< geo::PlaneID > geo::ChannelMapStandardAlg::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

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.

Implements geo::ChannelMapAlg.

Definition at line 409 of file ChannelMapStandardAlg.cxx.

References FirstWirePlaneInROP(), geo::CryostatID::isValid, and ROPtoTPCs().

Referenced by PlaneWireToChannel(), and WirePlaneToROP().

   {
     std::vector<geo::PlaneID> IDs;
     if (ropid.isValid) IDs.emplace_back(FirstWirePlaneInROP(ropid));
     return IDs;
   } // ChannelMapStandardAlg::ROPtoWirePlanes()

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

inherited

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 195 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::SignalTypeForChannelImpl().

Referenced by geo::ChannelMapAlg::HasChannel(), and geo::ChannelMapAlg::SignalTypeForROPIDImpl().

   {
     return SignalTypeForChannelImpl(channel);
   }

SigType_t geo::ChannelMapStandardAlg::SignalTypeForChannelImpl ( raw::ChannelID_t const channel ) const

overrideprivatevirtual

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.

Implements geo::ChannelMapAlg.

Definition at line 282 of file ChannelMapStandardAlg.cxx.

References geo::ChannelMapAlg::fFirstChannelInNextPlane, geo::ChannelMapAlg::fFirstChannelInThisPlane, fNchannels, fNPlanes, fNTPC, geo::kCollection, geo::kInduction, and geo::kMysteryType.

   {
 
     // still assume one cryostat for now -- faster
     unsigned int nChanPerTPC = fNchannels/fNTPC[0];
     // casting wil trunc towards 0 -- faster than floor
     unsigned int tpc = channel / nChanPerTPC;  
     //need number of planes to know Collection 
     unsigned int PlanesThisTPC = fNPlanes[0][tpc];
     
       
     
     SigType_t sigt = geo::kMysteryType;
     if(      (channel >= fFirstChannelInThisPlane[0][tpc][0]) &&
              (channel <  fFirstChannelInNextPlane[0][tpc][PlanesThisTPC-2])    ){ sigt = geo::kInduction; }
     else if( (channel >= fFirstChannelInThisPlane[0][tpc][PlanesThisTPC-1]) &&
              (channel <  fFirstChannelInNextPlane[0][tpc][PlanesThisTPC-1])    ){ sigt = geo::kCollection; }
     else
       mf::LogWarning("BadChannelSignalType") << "Channel " << channel
                                              << " not given signal type." << std::endl;
             
 
     return sigt;
   }

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

inherited

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 200 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::SignalTypeForROPIDImpl().

Referenced by geo::ChannelMapAlg::HasChannel().

   {
     return SignalTypeForROPIDImpl(ropid);
   }

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

protectedvirtualinherited

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 205 of file ChannelMapAlg.cxx.

References geo::ChannelMapAlg::FirstChannelInROP(), and geo::ChannelMapAlg::SignalTypeForChannel().

Referenced by geo::ChannelMapAlg::HasChannel(), and geo::ChannelMapAlg::SignalTypeForROPID().

   {
     return SignalTypeForChannel(FirstChannelInROP(ropid));
   }

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

inlineoverridevirtual

Return the sorter.

Implements geo::ChannelMapAlg.

Definition at line 227 of file ChannelMapStandardAlg.h.

References fSorter.

228 { return fSorter; }

geo::ChannelMapStandardAlg::fSorter

geo::GeoObjectSorterStandard fSorter

class to sort geo objects

Definition: ChannelMapStandardAlg.h:254

std::vector< geo::TPCID > geo::ChannelMapStandardAlg::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

In this mapping, TPC sets and TPCs are mapped one-to-one. The returned list contains always one entry, unless the specified TPC set ID is invalid, in which case the list is empty. 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.

Implements geo::ChannelMapAlg.

Definition at line 349 of file ChannelMapStandardAlg.cxx.

References ConvertTPCsetToTPC(), FirstTPCinTPCset(), and geo::CryostatID::isValid.

Referenced by PlaneWireToChannel(), and TPCtoTPCset().

   {
     std::vector<geo::TPCID> IDs;
     if (tpcsetid.isValid) IDs.emplace_back(ConvertTPCsetToTPC(tpcsetid));
     return IDs;
   } // ChannelMapStandardAlg::TPCsetToTPCs()

readout::TPCsetID geo::ChannelMapStandardAlg::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

In this mapping, TPC sets and TPCs are mapped one-to-one. The returned value mirrors the TPC ID in the readout space. 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 341 of file ChannelMapStandardAlg.cxx.

References ConvertTPCtoTPCset(), and TPCsetToTPCs().

Referenced by HasTPCset(), and PlaneWireToChannel().

   {
     return ConvertTPCtoTPCset(tpcid);
   } // ChannelMapStandardAlg::TPCtoTPCset()

void geo::ChannelMapStandardAlg::Uninitialize ( )

overridevirtual

Deconfiguration: prepare for a following call of Initialize()

Implements geo::ChannelMapAlg.

Definition at line 138 of file ChannelMapStandardAlg.cxx.

Referenced by Initialize().

139 {

140 }

double geo::ChannelMapStandardAlg::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 200 of file ChannelMapStandardAlg.cxx.

References geo::ChannelMapAlg::AccessElement(), fFirstWireProj, fOrthVectorsY, fOrthVectorsZ, and NearestWireID().

Referenced by Nchannels(), NearestWireID(), and WireCoordinate().

   {
     // Returns the wire number corresponding to a (Y,Z) position in PlaneNo 
     // with float precision.
     // B. Baller August 2014
     return YPos*AccessElement(fOrthVectorsY, planeID) 
          + ZPos*AccessElement(fOrthVectorsZ, planeID)
          - AccessElement(fFirstWireProj, planeID);
   }

virtual double geo::ChannelMapStandardAlg::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 39 of file ChannelMapStandardAlg.h.

References NearestWireID(), and WireCoordinate().

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

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:250

geo::ChannelMapStandardAlg::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: ChannelMapStandardAlg.cxx:200

unsigned int geo::ChannelMapStandardAlg::WireCount ( geo::PlaneID const & id ) const

inlineprivate

Retrieved the wire cound for the specified plane ID.

Definition at line 260 of file ChannelMapStandardAlg.h.

References geo::ChannelMapAlg::AccessElement(), ConvertROPtoWirePlane(), ConvertTPCsetToTPC(), ConvertTPCtoTPCset(), ConvertWirePlaneToROP(), and MaxTPCs().

Referenced by Nchannels(), and NearestWireID().

261 { return AccessElement(fWireCounts, id); }

geo::ChannelMapStandardAlg::fWireCounts

PlaneInfoMap_t< float > fWireCounts

Definition: ChannelMapStandardAlg.h:244

geo::ChannelMapAlg::AccessElement

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

Returns the specified element of the TPC map.

Definition: ChannelMapAlg.h:633

readout::ROPID geo::ChannelMapStandardAlg::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

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 401 of file ChannelMapStandardAlg.cxx.

References ConvertWirePlaneToROP(), and ROPtoWirePlanes().

Referenced by ChannelToROP(), HasROP(), and PlaneWireToChannel().

   {
     return ConvertWirePlaneToROP(planeid);
   } // ChannelMapStandardAlg::WirePlaneToROP()

Member Data Documentation

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

protectedinherited

map the AuxDetGeo index to a vector of indices corresponding to the AuxDetSensitiveGeo index

Definition at line 618 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapAlg::ChannelToSensitiveAuxDet().

std::map<std::string, size_t> geo::ChannelMapAlg::fADNameToGeo

protectedinherited

map the names of the dets to the AuxDetGeo objects

Definition at line 617 of file ChannelMapAlg.h.

Referenced by geo::ChannelMapAlg::ChannelToAuxDet().

PlaneInfoMap_t<raw::ChannelID_t> geo::ChannelMapAlg::fFirstChannelInNextPlane

protectedinherited

Definition at line 615 of file ChannelMapAlg.h.

Referenced by ChannelToWire(), geo::ChannelMapAlg::FirstChannelInThisPlane(), Initialize(), and SignalTypeForChannelImpl().

PlaneInfoMap_t<raw::ChannelID_t> geo::ChannelMapAlg::fFirstChannelInThisPlane

protectedinherited

Definition at line 614 of file ChannelMapAlg.h.

Referenced by ChannelToWire(), geo::ChannelMapAlg::FirstChannelInNextPlane(), Initialize(), and SignalTypeForChannelImpl().

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fFirstWireProj

private

Distance (0,0,0) to first wire along orth vector per plane per TPC

Definition at line 238 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), and WireCoordinate().

unsigned int geo::ChannelMapStandardAlg::fNchannels

private

number of channels in the detector

Definition at line 233 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), Nchannels(), and SignalTypeForChannelImpl().

unsigned int geo::ChannelMapStandardAlg::fNcryostat

private

number of cryostats in the detector

Definition at line 232 of file ChannelMapStandardAlg.h.

Referenced by ChannelToWire(), and Initialize().

TPCInfoMap_t<unsigned int> geo::ChannelMapStandardAlg::fNPlanes

private

Number of planes in each TPC - for range checking after calculation

Definition at line 246 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), MaxROPs(), NROPs(), and SignalTypeForChannelImpl().

std::vector<unsigned int> geo::ChannelMapStandardAlg::fNTPC

private

number of TPCs in each cryostat

Definition at line 235 of file ChannelMapStandardAlg.h.

Referenced by ChannelToWire(), Initialize(), MaxTPCs(), NTPCsets(), and SignalTypeForChannelImpl().

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fOrthVectorsY

private

Unit vectors orthogonal to wires in.

Definition at line 240 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), and WireCoordinate().

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fOrthVectorsZ

private

each plane - stored as 2 components to avoid having to invoke any bulky TObjects / CLHEP vectors etc

Definition at line 241 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), and WireCoordinate().

PlaneInfoMap_t<unsigned int> geo::ChannelMapStandardAlg::fPlaneBaselines

private

The number of wires in all the tpcs and planes up to this one in the heirachy

Definition at line 248 of file ChannelMapStandardAlg.h.

Referenced by FirstChannelInROP(), Initialize(), and PlaneWireToChannel().

std::set<PlaneID> geo::ChannelMapStandardAlg::fPlaneIDs

private

vector of the PlaneIDs present in the detector

Definition at line 237 of file ChannelMapStandardAlg.h.

Referenced by Initialize(), and PlaneIDs().

geo::GeoObjectSorterStandard geo::ChannelMapStandardAlg::fSorter

private

class to sort geo objects

Definition at line 254 of file ChannelMapStandardAlg.h.

Referenced by Sorter().

raw::ChannelID_t geo::ChannelMapStandardAlg::fTopChannel

private

book keeping highest channel #

Definition at line 234 of file ChannelMapStandardAlg.h.

Referenced by ChannelToWire(), and Initialize().

std::set<View_t> geo::ChannelMapStandardAlg::fViews

private

vector of the views present in the detector

Definition at line 236 of file ChannelMapStandardAlg.h.

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fWireCounts

private

Number of wires in each plane - for range checking after calculation

Definition at line 244 of file ChannelMapStandardAlg.h.

Referenced by Initialize().

PlaneInfoMap_t<unsigned int> geo::ChannelMapStandardAlg::fWiresPerPlane

private

The number of wires in this plane in the heirachy

Definition at line 251 of file ChannelMapStandardAlg.h.

Referenced by Initialize().

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

/cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/Geometry/ChannelMapStandardAlg.h
/cvmfs/larsoft.opensciencegrid.org/products/larcorealg/v07_03_00/source/larcorealg/Geometry/ChannelMapStandardAlg.cxx

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

TPC channel mapping

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation