#include <DuneApaChannelMapAlg.h>

Inheritance diagram for geo::DuneApaChannelMapAlg:

Classes
struct	PlaneData_t
	all data we need for each APA More...

Public Member Functions
	DuneApaChannelMapAlg (const fhicl::ParameterSet &pset)

void	setSorter (const geo::GeoObjectSorter &sort)

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

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

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

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

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

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

double	WireCoordinate (double YPos, double ZPos, geo::PlaneID const &planeID) const override
	Returns the index of the wire nearest to the specified position. More...

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

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
	Returns the object to sort geometry with. More...

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

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

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

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

unsigned int	HardwareChannelFromOpChannel (unsigned int opChannel) const override
	Returns the hardware channel number of specified optical channel. 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 WireID	NearestWireID (const TVector3 &worldPos, geo::PlaneID const &planeID) const override
	Returns the ID of the wire nearest to the specified position. 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...

virtual raw::ChannelID_t	PlaneWireToChannel (geo::WireID const &wireID) 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

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

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

virtual unsigned int	MaxROPs () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Types
template<class T >
using	Vector = std::vector< T >

template<class T >
using	TwoVector = Vector< Vector< T >>

template<class T >
using	ThreeVector = Vector< TwoVector< T >>

template<class T >
using	FourVector = Vector< ThreeVector< T >>

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

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

Protected Member Functions
bool	HasCryostat (CryostatID const &cid) const
	Returns whether the specified ID represents a valid cryostat. More...

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
unsigned int	fOpDetFlag

unsigned int	fChannelsPerOpDet
	Flag for OpDet channel map. More...

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

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

unsigned int	fChannelsPerAPA
	number of channels in each APA More...

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

unsigned int	fNTpcMax
	Max # TPCs in any cryostat. More...

unsigned int	fNApaMax
	Max # TPCs in any cryostat. More...

unsigned int	fNRopMax
	Max # ROPs in any APA. More...

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

std::vector< unsigned int >	fNApa
	number of APAs 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...

ThreeVector< unsigned int >	fWiresPerPlane
	wires/TPC plane for each (cry, tpc, pla) More...

TwoVector< unsigned int >	fPlanesPerTpc
	planes for each (cry, tpc) More...

TwoVector< unsigned int >	fRopsPerApa
	ROPs for each (cry, apa) More...

ThreeVector< unsigned int >	fApaTpcs
	TPCs for each APA. More...

ThreeVector< unsigned int >	fPlanesPerRop
	TPC planes for each (cry, apa, rop) More...

FourVector< unsigned int >	fRopTpc
	TPC planes for each (cry, apa, rop, rpl) More...

FourVector< unsigned int >	fRopPlane
	TPC plane index for each (cry, apa, rop, rpl) More...

TwoVector< unsigned int >	fChannelsPerApa
	channels for each APA More...

ThreeVector< unsigned int >	fChannelsPerRop
	channels for each Rop More...

ThreeVector< unsigned int >	fAnchoredWires
	anchored wires for each (cry, tpc, pla) More...

ThreeVector< unsigned int >	fPlaneApa
	APA for each TPC plane (cry, tpc, pla) More...

ThreeVector< unsigned int >	fPlaneRop
	ROP for each TPC plane (cry, tpc, pla) More...

ThreeVector< unsigned int >	fPlaneRopIndex
	Index in ROP for each TPC plane (cry, tpc, pla) More...

ThreeVector< unsigned int >	fAnchoredPlaneRop
	ROP holding the anchored wires for (cry, tpc, pla) More...

ThreeVector< unsigned int >	fWiresPerRop
	wires/ROP for each (cry, apa, rop) More...

PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInThisRop
	(cry, apa, rop) More...

PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInNextRop
	(cry, apa, rop) More...

const geo::GeoObjectSorter *	fSorter
	sorts geo::XXXGeo objects More...

PlaneInfoMap_t< PlaneData_t >	fPlaneData

std::vector< double >	fWirePitch

std::vector< double >	fOrientation

std::vector< double >	fSinOrientation

std::vector< double >	fCosOrientation

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

PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInNextPlane

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

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

Detailed Description

Definition at line 45 of file DuneApaChannelMapAlg.h.

Member Typedef Documentation

template<class T >

using geo::DuneApaChannelMapAlg::FourVector = Vector<ThreeVector<T>>

protected

Definition at line 244 of file DuneApaChannelMapAlg.h.

template<class T >

using geo::DuneApaChannelMapAlg::ThreeVector = Vector<TwoVector<T>>

protected

Definition at line 242 of file DuneApaChannelMapAlg.h.

template<class T >

using geo::DuneApaChannelMapAlg::TwoVector = Vector<Vector<T>>

protected

Definition at line 240 of file DuneApaChannelMapAlg.h.

template<class T >

using geo::DuneApaChannelMapAlg::Vector = std::vector<T>

protected

Definition at line 238 of file DuneApaChannelMapAlg.h.

Constructor & Destructor Documentation

DuneApaChannelMapAlg::DuneApaChannelMapAlg ( const fhicl::ParameterSet & pset )

Definition at line 43 of file DuneApaChannelMapAlg.cxx.

 : fSorter(nullptr) {
   fChannelsPerOpDet = p.get<unsigned int>("ChannelsPerOpDet");
   fOpDetFlag = 0;
   // If DetectorVersion is present, then check if this is 35t.
   string sdet;
   p.get_if_present<string>("DetectorVersion", sdet);
   if ( sdet.substr(0,7) == "dune35t" ) fOpDetFlag = 1;
 }

Member Function Documentation

ROPID DuneApaChannelMapAlg::ChannelToROP ( raw::ChannelID_t channel ) const

overridevirtual

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

Exceptions

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

Implements geo::ChannelMapAlg.

Definition at line 707 of file DuneApaChannelMapAlg.cxx.

                                                                {
   Index ncry = fNcryostat;
   for ( Index icry=0; icry<ncry; ++icry ) {
     Index napa = fNApa[icry];
     for ( Index iapa=0; iapa<napa; ++iapa ) {
       Index nrop = fRopsPerApa[icry][iapa];
       for ( Index irop=0; irop<nrop; ++irop ) {
         Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
         Index icha2 = fFirstChannelInNextRop[icry][iapa][irop];
         if ( icha >= icha1 && icha < icha2 ) return ROPID(icry, iapa, irop);
       }
     }
   }
   return(ROPID(CryostatID::InvalidID, TPCsetID::InvalidID, ROPID::InvalidID));
 }

vector< WireID > DuneApaChannelMapAlg::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 324 of file DuneApaChannelMapAlg.cxx.

                                                                          {
   vector< WireID > wirids;
   if ( icha >= fNchannels ) return wirids;
   // Loop over ROPs to find the one holding this channel.
   Index ncry = fNcryostat;
   Index icry = badIndex;
   Index iapa = badIndex;
   Index irop = badIndex;
   Index ichaRop = badIndex;    // Channel number in the ROP
   bool found = false;
   for ( icry=0; icry<ncry; ++icry ) {
     Index napa = fNApa[icry];
     for ( iapa=0; iapa<napa; ++iapa ) {
       Index nrop = fRopsPerApa[icry][iapa];
       for ( irop=0; irop<nrop; ++irop ) {
         Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
         Index icha2 = fFirstChannelInNextRop[icry][iapa][irop];
         found = icha >= icha1 && icha < icha2;
         if ( found ) {
           ichaRop = icha - icha1;
           break;
         }
       }
       if ( found ) break;
     }
     if ( found ) break;
   }
   if ( icry >= ncry ) {
     mf::LogError("DuneApaChannelMapAlg") << "Unable to find APA plane for channel " << icha;
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Unable to find APA plane for channel " << icha;
     return wirids;
   }
   // Extract TPC(s) from ROP
   Index nrpl = fPlanesPerRop[icry][iapa][irop];
   if ( nrpl == 0 ) throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": No TPC planes.";
   if ( nrpl > 2 ) throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Too many TPC planes.";
   Index itpc1 = fRopTpc[icry][iapa][irop][0];
   Index ipla = fRopPlane[icry][iapa][irop][0];
   Index itpc2 = (nrpl > 1 ) ? fRopTpc[icry][iapa][irop][1] : itpc1;
   Index nAnchored = fAnchoredWires[icry][itpc1][ipla];
   bool wrapped = ipla < 2;
   if ( wrapped && itpc2 == itpc1 )
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": 2nd plane not found for wrapped ROP";
   if ( wrapped && ipla != fRopPlane[icry][iapa][irop][1] )
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Wrapped planes have inconsistent indices.";
   // For now, assume the second TPC plane has the same # anchored wires.
   // Code will need some work if we want to relax this assumption.
   if (  wrapped && fAnchoredWires[icry][itpc2][ipla] != nAnchored )
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Planes have inconsistent anchor counts.";
   // If this is a wrapped ROP and the wire number is larger than nAnchored, then
   // the first wire for this channel is in the other TPC plane.
   Index itpc = itpc1;
   Index iwir = ichaRop;
   if ( wrapped && iwir >= nAnchored ) {
     itpc = itpc2;
     iwir -= nAnchored;
   }
   if ( iwir >= nAnchored ) {
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Invalid channel: iwir =" << iwir;
   }
   // Loop over wires and create IDs.
   while ( iwir < fWiresPerPlane[icry][itpc][ipla] ) {
     WireID wirid(icry, itpc, ipla, iwir);
     wirids.push_back(wirid);
     iwir += fAnchoredWires[icry][itpc][ipla];
     itpc = (itpc == itpc1) ? itpc2 : itpc1;
   }
   return wirids;
 }

ChannelID_t DuneApaChannelMapAlg::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 732 of file DuneApaChannelMapAlg.cxx.

                                                                             {
   Index icry = ropid.Cryostat;
   Index iapa = ropid.TPCset;
   Index irop = ropid.ROP;
   Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
   return icha1;
 }

TPCID DuneApaChannelMapAlg::FirstTPCinTPCset ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

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

Todo:: to be completed

Implements geo::ChannelMapAlg.

Definition at line 637 of file DuneApaChannelMapAlg.cxx.

                                                                          {
   Index icry = apaid.Cryostat;
   Index iapa = apaid.TPCset;
   Index itpc = TPCID::InvalidID;
   if ( fApaTpcs[icry][iapa].size() ) itpc = fApaTpcs[icry][iapa][0];
   return TPCID(icry, itpc);
 }

PlaneID DuneApaChannelMapAlg::FirstWirePlaneInROP ( readout::ROPID const & ropid ) const

overridevirtual

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

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 742 of file DuneApaChannelMapAlg.cxx.

                                                                           {
   vector<PlaneID> plaids = ROPtoWirePlanes(ropid);
   if ( plaids.size() ) return plaids[0];
   return PlaneID(CryostatID::InvalidID, TPCID::InvalidID, PlaneID::InvalidID);
 }

Index DuneApaChannelMapAlg::HardwareChannelFromOpChannel ( unsigned int opChannel ) const

overridevirtual

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.

Reimplemented from geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 589 of file DuneApaChannelMapAlg.cxx.

                                                                                      {
   if ( fOpDetFlag == 1 ) return opChannel%12;
   unsigned int channel = opChannel % fChannelsPerOpDet;
   return channel;
 }

bool geo::DuneApaChannelMapAlg::HasCryostat ( CryostatID const & cid ) const

inlineprotected

Returns whether the specified ID represents a valid cryostat.

Definition at line 298 of file DuneApaChannelMapAlg.h.

299 { return cid.Cryostat < fNcryostat; }

geo::DuneApaChannelMapAlg::fNcryostat

unsigned int fNcryostat

number of cryostats in the detector

Definition: DuneApaChannelMapAlg.h:247

bool DuneApaChannelMapAlg::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 662 of file DuneApaChannelMapAlg.cxx.

                                                           {
   return HasTPCset(ropid) && (ropid.ROP < NROPs(ropid));
 }

bool DuneApaChannelMapAlg::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Todo:: to be completed

Implements geo::ChannelMapAlg.

Definition at line 611 of file DuneApaChannelMapAlg.cxx.

                                                                    {
   return HasCryostat(tpcsetid) && (tpcsetid.TPCset < NTPCsets(tpcsetid));
 }

void DuneApaChannelMapAlg::Initialize ( GeometryData_t const & geodata )

overridevirtual

Geometry initialisation.

Implements geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 61 of file DuneApaChannelMapAlg.cxx.

                                                                    {
   Uninitialize();
     
   vector<CryostatGeo> const& crygeos = geodata.cryostats;
   Index ncry = crygeos.size();
   fNcryostat = ncry;
   if ( ncry == 0 ) {
     mf::LogError("DuneApaChannelMapAlg") << "No cryostats found.";
     return;
   }
   CryostatGeo const& crygeo = crygeos[0];
     
   mf::LogInfo("DuneApaChannelMapAlg") << "Initializing channel map...";
   fNTpc.resize(ncry);
   fNApa.resize(ncry);
   // The first channel array for each APA plane allow the cryostats to differ.
   fPlanesPerTpc.resize(ncry);
   fWiresPerPlane.resize(ncry);
   fApaTpcs.resize(ncry);
   fFirstChannelInThisPlane.resize(ncry);
   fFirstChannelInNextPlane.resize(ncry);
   fAnchoredPlaneRop.resize(ncry);
   fPlaneApa.resize(ncry);
   fPlaneRop.resize(ncry);
   fPlaneRopIndex.resize(ncry);
   fAnchoredWires.resize(ncry);
   fFirstChannelInThisRop.resize(ncry);
   fFirstChannelInNextRop.resize(ncry);
   fRopsPerApa.resize(ncry);
   fChannelsPerApa.resize(ncry);
   fChannelsPerRop.resize(ncry);
   fPlanesPerRop.resize(ncry);
   fRopTpc.resize(ncry);
   fRopPlane.resize(ncry);
   fNTpcMax = 0;
   fNApaMax = 0;
   fNRopMax = 0;
   for ( Index icry=0; icry<ncry; ++icry ) {
     Index ntpc = crygeos[icry].NTPC();
     Index napa = ntpc/2;  // Assume 1 APA for every two TPCs
     fNTpc[icry] = ntpc;
     fNApa[icry] = napa;
     if ( ntpc > fNTpcMax ) fNTpcMax = ntpc;
     if ( napa > fNApaMax ) fNApaMax = napa;
     fPlanesPerTpc[icry].resize(ntpc);
     fWiresPerPlane[icry].resize(ntpc);
     fFirstChannelInThisPlane[icry].resize(ntpc);
     fFirstChannelInNextPlane[icry].resize(ntpc);
     fAnchoredPlaneRop[icry].resize(ntpc);
     fPlaneApa[icry].resize(ntpc);
     fPlaneRop[icry].resize(ntpc);
     fPlaneRopIndex[icry].resize(ntpc);
     fAnchoredWires[icry].resize(ntpc);
     fRopsPerApa[icry].resize(napa, 4);
     fChannelsPerApa[icry].resize(napa, 0);
     fApaTpcs[icry].resize(napa);
     fChannelsPerRop[icry].resize(napa);
     fPlanesPerRop[icry].resize(napa);
     fFirstChannelInThisRop[icry].resize(napa);
     fFirstChannelInNextRop[icry].resize(napa);
     fRopTpc[icry].resize(napa);
     fRopPlane[icry].resize(napa);
     for ( Index itpc=0; itpc<ntpc; ++itpc ) {
       Index npla = crygeo.TPC(itpc).Nplanes();
       if ( npla != 3 ) {
         mf::LogError("DuneApaChannelMapAlg")
           << "# planes/TPC is " << npla << " rather than 3 " << " for TPC " << itpc;
         return;
       }
       fPlaneApa[icry][itpc].resize(npla, badIndex);
       fPlaneRop[icry][itpc].resize(npla, badIndex);
       fPlaneRopIndex[icry][itpc].resize(npla, badIndex);
       fFirstChannelInThisPlane[icry][itpc].resize(npla, 0);
       fFirstChannelInNextPlane[icry][itpc].resize(npla, 0);
       fAnchoredPlaneRop[icry][itpc].resize(npla, 0);
       fAnchoredWires[icry][itpc].resize(npla, 0);
       fWiresPerPlane[icry][itpc].resize(npla, 0);
       fPlanesPerTpc[icry][itpc] = npla;
       for ( Index ipla=0; ipla<npla; ++ipla ) {
         Index nwir = crygeo.TPC(itpc).Plane(ipla).Nwires();
         fWiresPerPlane[icry][itpc][ipla] = nwir;
       }
     }
     Index itpc = 0;
     for ( Index iapa=0; iapa<napa; ++iapa ) {
       Index nrop = fRopsPerApa[icry][iapa];
       if ( nrop > fNRopMax ) fNRopMax = nrop;
       fApaTpcs[icry][iapa].push_back(itpc);
       fApaTpcs[icry][iapa].push_back(itpc+1);
       fChannelsPerRop[icry][iapa].resize(nrop);
       fFirstChannelInThisRop[icry][iapa].resize(nrop, 0);
       fFirstChannelInNextRop[icry][iapa].resize(nrop, 0);
       fPlanesPerRop[icry][iapa].resize(nrop, 0);
       fRopTpc[icry][iapa].resize(nrop);
       fRopPlane[icry][iapa].resize(nrop);
       Index ipla = 0;
       // Induction planes
       for ( Index irop=0; irop<2; ++irop ) {
         fPlanesPerRop[icry][iapa][irop] = 2;
         fRopTpc[icry][iapa][irop].push_back(itpc);
         fRopTpc[icry][iapa][irop].push_back(itpc+1);
         fRopPlane[icry][iapa][irop].push_back(ipla);
         fRopPlane[icry][iapa][irop].push_back(ipla);
         ++ipla;
       }
       // Collection planes.
       for ( Index irop=2; irop<4; ++irop ) {
         fPlanesPerRop[icry][iapa][irop] = 1;
         fRopTpc[icry][iapa][irop].push_back(itpc);
         fRopPlane[icry][iapa][irop].push_back(ipla);
         ++itpc;
       }
     }
   }
   fPlaneIDs.clear();
   fTopChannel = 0;
 
   // Map planes to ROPs and wires to channels.
   // We use the geometry to deduce the numbers of channels/plane.
   // For induction planes, we look for the first adjacent pair of wires
   // with the same center z-position and assume the index of the first
   // of those gives the count of wires read out from one side.
   // These are called anchored wires.
   ChannelID_t icha = 0;
   for ( Index icry=0; icry!=ncry; ++icry ) {
     Index napa = fNApa[icry];
     for ( Index iapa=0; iapa!=napa; ++iapa ) {
       Index nrop = fRopsPerApa[icry][iapa];
       for ( Index irop=0; irop!=nrop; ++irop ) {
         Index nrpl = fPlanesPerRop[icry][iapa][irop];
         fFirstChannelInThisRop[icry][iapa][irop] = icha;
         for ( Index irpl=0; irpl!=nrpl; ++irpl ) {
           Index itpc = fRopTpc[icry][iapa][irop][irpl];
           Index ipla = fRopPlane[icry][iapa][irop][irpl];
           fPlaneApa[icry][itpc][ipla] = iapa;
           fPlaneRop[icry][itpc][ipla] = irop;
           fPlaneRopIndex[icry][itpc][ipla] = irpl;
           const PlaneGeo& plageo = crygeos[icry].TPC(itpc).Plane(ipla);
 #if 0
 const PlaneGeo plageo2 = plageo;
 #endif
           View_t view = plageo.View();
           const Vector<View_t> eview = {geo::kU, geo::kV, geo::kZ};
           if ( view != eview[ipla] ) {
             throw cet::exception("DuneApaChannelMapAlg") << __func__
                   << ": View " << view << " is not the expected " << eview[ipla];
           }
           double xyz[3] = {0.};
           double xyz_next[3] = {0.};
           Index nAnchoredWires = 0;  // # wires from this TPC plane contributing to the ROP
           // Collection plane.
           Index nwir = fWiresPerPlane[icry][itpc][ipla];
           if ( view == geo::kZ ) {
             nAnchoredWires = nwir;
           // Induction planes.
           } else {
             for ( unsigned int iwir=0; iwir+1<nwir; ++iwir ) {
               plageo.Wire(iwir).GetCenter(xyz);
               plageo.Wire(iwir+1).GetCenter(xyz_next);
               if ( xyz[2] == xyz_next[2] ) {
                 nAnchoredWires = iwir;
                 break;
               }
             }
           }
           fAnchoredWires[icry][itpc][ipla] = nAnchoredWires;
           fFirstChannelInThisPlane[icry][itpc][ipla] = icha;
           icha += nAnchoredWires;
           fFirstChannelInNextPlane[icry][itpc][ipla] = icha;
           fAnchoredPlaneRop[icry][itpc][ipla] = irop;
         }
         fFirstChannelInNextRop[icry][iapa][irop] = icha;
       }
     }
   }
   fNchannels = icha;
   fChannelsPerAPA = fNchannels/fNApa[0];
 
   // Assign first channels for the TPCs.
   fPlaneData.resize(ncry);
   for ( Index icry=0; icry<ncry; ++icry ) {
     Index ntpc = fNTpc[icry];
     fPlaneData[icry].resize(ntpc);
     for ( Index itpc=0; itpc<ntpc; ++itpc ) {
       fPlaneData[icry][itpc].resize(crygeos[icry].TPC(itpc).Nplanes());
       for ( Index ipla=0; ipla<crygeos[icry].TPC(itpc).Nplanes(); ++ipla ) {
         PlaneData_t& PlaneData = fPlaneData[icry][itpc][ipla];
         const PlaneGeo& thePlane = crygeos[icry].TPC(itpc).Plane(ipla);
         double xyz[3];
         fPlaneIDs.emplace(icry, itpc, ipla);
         thePlane.Wire(0).GetCenter(xyz);
         PlaneData.fFirstWireCenterY = xyz[1];
         PlaneData.fFirstWireCenterZ = xyz[2];
         // we are interested in the ordering of wire numbers: we find that a
         // point is N wires left of a wire W: is that wire W + N or W - N?
         // In fact, for TPC #0 it is W + N for V and Z planes, W - N for U
         // plane; for TPC #0 it is W + N for V and Z planes, W - N for U
         PlaneData.fWireSortingInZ = thePlane.WireIDincreasesWithZ()? +1.: -1.;
 
           // find boundaries of the outside APAs for this plane by looking at endpoints of wires
 
           double endpoint[3];
           thePlane.Wire(0).GetStart(endpoint);
           PlaneData.fYmax = endpoint[1];
           PlaneData.fYmin = endpoint[1];
           PlaneData.fZmax = endpoint[2];
           PlaneData.fZmin = endpoint[2];
           unsigned int nwires = thePlane.Nwires(); 
           for (unsigned int iwire=0;iwire<nwires;iwire++){
             thePlane.Wire(iwire).GetStart(endpoint);
             PlaneData.fYmax = std::max(PlaneData.fYmax,endpoint[1]);
             PlaneData.fYmin = std::min(PlaneData.fYmin,endpoint[1]);
             PlaneData.fZmax = std::max(PlaneData.fZmax,endpoint[2]);
             PlaneData.fZmin = std::min(PlaneData.fZmin,endpoint[2]);
             thePlane.Wire(iwire).GetEnd(endpoint);
             PlaneData.fYmax = std::max(PlaneData.fYmax,endpoint[1]);
             PlaneData.fYmin = std::min(PlaneData.fYmin,endpoint[1]);
             PlaneData.fZmax = std::max(PlaneData.fZmax,endpoint[2]);
             PlaneData.fZmin = std::min(PlaneData.fZmin,endpoint[2]);        
           } // loop on wire 
 
       } // for plane
     } // for TPC
   } // for cryostat
 
   Index npla = crygeo.TPC(0).Nplanes();
   fWirePitch.resize(npla);
   fOrientation.resize(npla);
   fSinOrientation.resize(npla);
   fCosOrientation.resize(npla);
 
   for ( Index ipla=0; ipla<npla; ++ipla ) {
     fWirePitch[ipla] = crygeo.TPC(0).WirePitch(ipla);
     fOrientation[ipla] = crygeo.TPC(0).Plane(ipla).Wire(0).ThetaZ();
     fSinOrientation[ipla] = sin(fOrientation[ipla]);
     fCosOrientation[ipla] = cos(fOrientation[ipla]);
   }
 
   for ( Index icry=0; icry<ncry; ++icry ) {
     mf::LogVerbatim("DuneApaChannelMapAlg") << "Cryostat " << icry << ":"; 
     mf::LogVerbatim("DuneApaChannelMapAlg") << "  " << fNchannels << " total channels"; 
     mf::LogVerbatim("DuneApaChannelMapAlg") << "  " << fNTpc[icry]/2 << " APAs";       
     mf::LogVerbatim("DuneApaChannelMapAlg") << "  For all identical APA:" ; 
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    Number of channels per APA = " << fChannelsPerAPA ; 
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    U channels per APA = " << 2*fAnchoredWires[0][0][0] ;
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    V channels per APA = " << 2*fAnchoredWires[0][0][1] ;
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    Z channels per APA = " << 2*fAnchoredWires[0][0][2] ;
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    Pitch in U Plane = " << fWirePitch[0] ;
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    Pitch in V Plane = " << fWirePitch[1] ;
     mf::LogVerbatim("DuneApaChannelMapAlg") << "    Pitch in Z Plane = " << fWirePitch[2] ;
   }
 
 }

Index DuneApaChannelMapAlg::MaxROPs ( ) const

overridevirtual

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

Todo:: to be completed

Implements geo::ChannelMapAlg.

Definition at line 656 of file DuneApaChannelMapAlg.cxx.

                                           {
   return fNRopMax;
 }

Index DuneApaChannelMapAlg::MaxTPCsets ( ) const

overridevirtual

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

Todo:: to be completed

Implements geo::ChannelMapAlg.

Definition at line 605 of file DuneApaChannelMapAlg.cxx.

                                              {
   return fNApaMax;
 }

unsigned int DuneApaChannelMapAlg::Nchannels ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 396 of file DuneApaChannelMapAlg.cxx.

                                                    {
    return fNchannels;
 }

unsigned int DuneApaChannelMapAlg::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

Todo:: to be completed

Implements geo::ChannelMapAlg.

Definition at line 402 of file DuneApaChannelMapAlg.cxx.

                                                                      {
   Index icry = ropid.Cryostat;
   Index iapa = ropid.TPCset;
   Index irop = ropid.ROP;
   Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
   Index icha2 = fFirstChannelInNextRop[icry][iapa][irop];
   return icha2 - icha1;
 }

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

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

geo::PlaneID

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::DuneApaChannelMapAlg::NearestWireID

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.

Definition: DuneApaChannelMapAlg.h:77

WireID DuneApaChannelMapAlg::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 446 of file DuneApaChannelMapAlg.cxx.

                                                                {
 
 
     // cap the position to be within the boundaries of the wire endpoints.
     // This simulates charge drifting in from outside of the wire frames inwards towards
     // the first and last collection wires on the side, and towards the right endpoints
 
   const PlaneData_t& PlaneData = AccessElement(fPlaneData, plaid);
   double ycap = std::max(PlaneData.fYmin,std::min(PlaneData.fYmax,xyz.Y()));
   double zcap = std::max(PlaneData.fZmin,std::min(PlaneData.fZmax,xyz.Z()));
 
   int iwirSigned = 0.5 + WireCoordinate(ycap, zcap, plaid);
   Index iwir = (iwirSigned < 0) ? 0 : iwirSigned;
   Index icry = plaid.Cryostat;
   Index itpc = plaid.TPC;
   Index ipla = plaid.Plane;
   Index iwirMax = fWiresPerPlane[icry][itpc][ipla] - 1;
   if ( iwir > iwirMax ) iwir = iwirMax;
   return WireID(plaid, iwir);
 }

Index DuneApaChannelMapAlg::NOpChannels ( unsigned int NOpDets ) const

overridevirtual

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.

Reimplemented from geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 552 of file DuneApaChannelMapAlg.cxx.

                                                                   {
   if ( fOpDetFlag == 1 ) return 12*NOpDets;
   return fChannelsPerOpDet*NOpDets;
 }

Index DuneApaChannelMapAlg::NOpHardwareChannels ( unsigned int opDet ) const

overridevirtual

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.

Reimplemented from geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 559 of file DuneApaChannelMapAlg.cxx.

                                                                         {
   if ( fOpDetFlag == 1 ) {
     // CSU 3-sipm design
     if (opDet == 0 || opDet == 4 || opDet == 6) return 8;
     // LSU 2-sipm design
     if (opDet == 2) return 2;
     // IU 12-sipm design
     return 12;
   }
   return fChannelsPerOpDet;
 }

Index DuneApaChannelMapAlg::NROPs ( readout::TPCsetID const & tpcsetid ) const

overridevirtual

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.

Implements geo::ChannelMapAlg.

Definition at line 647 of file DuneApaChannelMapAlg.cxx.

                                                              {
   if (!HasTPCset(apaid)) return 0;
   Index icry = apaid.Cryostat;
   Index iapa = apaid.TPCset;
   return fRopsPerApa[icry][iapa];
 }

Index DuneApaChannelMapAlg::NTPCsets ( readout::CryostatID const & cryoid ) const

overridevirtual

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

Parameters

cryoid cryostat ID

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

Implements geo::ChannelMapAlg.

Definition at line 597 of file DuneApaChannelMapAlg.cxx.

                                                                   {
   if (!HasCryostat(cryid)) return 0;
   Index icry = cryid.Cryostat;
   return fNApa[icry];
 }

Index DuneApaChannelMapAlg::OpChannel	(	unsigned int	detNum,
		unsigned int	hwchannel = `0`
	)		const

overridevirtual

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.

Reimplemented from geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 573 of file DuneApaChannelMapAlg.cxx.

                                                                                      {
   if ( fOpDetFlag == 1 ) return (detNum * 12) + channel;
   unsigned int uniqueChannel = (detNum * fChannelsPerOpDet) + channel;
   return uniqueChannel;
 }

Index DuneApaChannelMapAlg::OpDetFromOpChannel ( unsigned int opChannel ) const

overridevirtual

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.

Reimplemented from geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 581 of file DuneApaChannelMapAlg.cxx.

                                                                            {
   if ( fOpDetFlag == 1 ) return opChannel/12;
   unsigned int detectorNum = opChannel/fChannelsPerOpDet;
   return detectorNum;
 }

std::set< PlaneID > const & DuneApaChannelMapAlg::PlaneIDs ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 546 of file DuneApaChannelMapAlg.cxx.

                                                             {
   return fPlaneIDs;
 }

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

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

geo::WireID

Definition: geo_types.h:560

geo::DuneApaChannelMapAlg::PlaneWireToChannel

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.

Definition: DuneApaChannelMapAlg.h:86

ChannelID_t DuneApaChannelMapAlg::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 469 of file DuneApaChannelMapAlg.cxx.

                                                                               {
   Index icry = wirid.Cryostat;
   Index itpc = wirid.TPC;
   Index ipla = wirid.Plane;
   Index ichaRop = wirid.Wire;
   Index iapa = fPlaneApa[icry][itpc][ipla];
   Index irop = fPlaneRop[icry][itpc][ipla];
   Index irpl = fPlaneRopIndex[icry][itpc][ipla];
   Index nrpl = fPlanesPerRop[icry][iapa][irop];
   Index ncha = fAnchoredWires[icry][itpc][ipla];
   if ( nrpl > 1 ) {      // Wrapped ROP
     Index ipla1 = fRopPlane[icry][iapa][irop][0];
     Index ipla2 = fRopPlane[icry][iapa][irop][1];
     // Wire is in the back TPC.
     if ( irpl == 1 ) {
       ichaRop += fAnchoredWires[icry][itpc][ipla1];
       ncha += fAnchoredWires[icry][itpc][ipla1];
     // Wire is in the front TPC.
     } else {
       ncha += fAnchoredWires[icry][itpc][ipla2];
     }
   }
   // Channel # in ROP is modulus the # channels in the ROP.
   Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
   Index icha = icha1 + ichaRop%ncha;
   return icha;
 }

vector< TPCID > DuneApaChannelMapAlg::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

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 695 of file DuneApaChannelMapAlg.cxx.

                                                                       {
   vector<TPCID> tpcids;
   vector<PlaneID> plaids = ROPtoWirePlanes(ropid);
   for ( const PlaneID& plaid : plaids ) {
     TPCID tpcid = plaid;
     if ( find(tpcids.begin(), tpcids.end(), tpcid) == tpcids.end() ) tpcids.push_back(tpcid);
   }
   return tpcids;
 }

vector< PlaneID > DuneApaChannelMapAlg::ROPtoWirePlanes ( readout::ROPID const & ropid ) const

overridevirtual

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

Parameters

ropid ID of the readout plane to convert into wire planes

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

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

Implements geo::ChannelMapAlg.

Definition at line 679 of file DuneApaChannelMapAlg.cxx.

                                                                               {
   vector<PlaneID> plaids;
   Index icry = ropid.Cryostat;
   Index iapa = ropid.TPCset;
   Index irop = ropid.ROP;
   Index nrpl = fPlanesPerRop[icry][iapa][irop];
   for ( Index irpl=0; irpl<nrpl; ++irpl ) {
     Index itpc = fRopTpc[icry][iapa][irop][irpl];
     Index ipla = fRopPlane[icry][iapa][irop][irpl];
     plaids.push_back(PlaneID(icry, itpc, ipla));
   }
   return plaids;
 }

void DuneApaChannelMapAlg::setSorter ( const geo::GeoObjectSorter & sort )

Definition at line 55 of file DuneApaChannelMapAlg.cxx.

                                                                    {
   fSorter = &sort;
 }

SigType_t DuneApaChannelMapAlg::SignalTypeForChannelImpl ( raw::ChannelID_t const channel ) const

overridevirtual

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 499 of file DuneApaChannelMapAlg.cxx.

                                                                                      {
   Index ncry = fNcryostat;
   for ( Index icry=0; icry<ncry; ++icry ) {
     Index napa=fNApa[icry];
     for ( Index iapa=0; iapa<napa; ++iapa ) {
       Index nrop = fRopsPerApa[icry][iapa];
       for ( Index irop=0; irop<nrop; ++irop ) {
         Index icha1 = fFirstChannelInThisRop[icry][iapa][irop];
         Index icha2 = fFirstChannelInNextRop[icry][iapa][irop];
         if ( icha >= icha1 && icha < icha2 ) {
           if      ( irop < 2 ) return geo::kInduction;
           else if ( irop < 4 ) return geo::kCollection;
           else return geo::kMysteryType;
         }
       }
     }
   }
   return geo::kMysteryType;
 }

geo::GeoObjectSorter const & DuneApaChannelMapAlg::Sorter ( ) const

overridevirtual

Returns the object to sort geometry with.

Implements geo::ChannelMapAlg.

Definition at line 724 of file DuneApaChannelMapAlg.cxx.

                                                              {
   if ( fSorter == nullptr )
     throw cet::exception("DuneApaChannelMapAlg") << __func__ << ": Sorter is missing.";
   return *fSorter;
 } // DuneApaChannelMapAlg::Sorter()

vector< TPCID > DuneApaChannelMapAlg::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

Implements geo::ChannelMapAlg.

Definition at line 627 of file DuneApaChannelMapAlg.cxx.

                                                                             {
   Index icry = apaid.Cryostat;
   Index iapa = apaid.TPCset;
   vector<TPCID> tpcids;
   for ( Index itpc : fApaTpcs[icry][iapa] ) tpcids.push_back(TPCID(icry, itpc));
   return tpcids;
 }

TPCsetID DuneApaChannelMapAlg::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

Implements geo::ChannelMapAlg.

Definition at line 617 of file DuneApaChannelMapAlg.cxx.

                                                                    {
   Index icry = tpcid.Cryostat;
   Index itpc = tpcid.TPC;
   Index ipla = 0;
   Index iapa = fPlaneApa[icry][itpc][ipla];
   return TPCsetID(icry, iapa);
 }

void DuneApaChannelMapAlg::Uninitialize ( )

overridevirtual

Deconfiguration: prepare for a following call of Initialize()

Implements geo::ChannelMapAlg.

Reimplemented in geo::ProtoDUNEChannelMapAlg, geo::ProtoDUNEChannelMapAlgv7, and geo::ProtoDUNEChannelMapAlgv8.

Definition at line 317 of file DuneApaChannelMapAlg.cxx.

                                         {
   PlaneInfoMap_t<ChannelID_t>().swap(fFirstChannelInThisPlane);
   PlaneInfoMap_t<ChannelID_t>().swap(fFirstChannelInNextPlane);
 }

double DuneApaChannelMapAlg::WireCoordinate	(	double	YPos,
		double	ZPos,
		unsigned int	PlaneNo,
		unsigned int	TPCNo,
		unsigned int	cstat
	)		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
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 414 of file DuneApaChannelMapAlg.cxx.

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

double DuneApaChannelMapAlg::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 422 of file DuneApaChannelMapAlg.cxx.

                                                                      {
   const PlaneData_t& PlaneData = AccessElement(fPlaneData, plaid);
   Index icry = plaid.Cryostat;
   Index itpc = plaid.TPC;
   Index ipla = plaid.Plane;
   // The formula used here is geometric:
   // distance = delta_y cos(theta_z) + delta_z sin(theta_z)
   // with a correction for the orientation of the TPC:
   // odd TPCs have supplementary wire angle (pi-theta_z), changing cosine sign
   double backsign = (fPlaneRopIndex[icry][itpc][ipla] == 1) ? -1.0 : 1.0;
   float distance =
     -(YPos - PlaneData.fFirstWireCenterY) * backsign * fCosOrientation[ipla]
     + (ZPos - PlaneData.fFirstWireCenterZ) * fSinOrientation[ipla]
     ;
   // The sign of this formula is correct if the wire with larger ID is on the
   // "right" (intuitively, larger z; rigorously, smaller intercept)
   // than this one.
   // Of course, we are not always that lucky. fWireSortingInZ fixes our luck.
   return PlaneData.fWireSortingInZ * distance/fWirePitch[ipla];
 }

ROPID DuneApaChannelMapAlg::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 wire plane

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

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

Implements geo::ChannelMapAlg.

Definition at line 668 of file DuneApaChannelMapAlg.cxx.

                                                                      {
   Index icry = plaid.Cryostat;
   Index itpc = plaid.TPC;
   Index ipla = plaid.Plane;
   Index iapa = fPlaneApa[icry][itpc][ipla];
   Index irop = fPlaneRop[icry][itpc][ipla];
   return ROPID(icry, iapa, irop);
 }

Member Data Documentation

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fAnchoredPlaneRop

protected

ROP holding the anchored wires for (cry, tpc, pla)

Definition at line 271 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fAnchoredWires

protected

anchored wires for each (cry, tpc, pla)

Definition at line 267 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fApaTpcs

protected

TPCs for each APA.

Definition at line 261 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fChannelsPerAPA

protected

number of channels in each APA

Definition at line 249 of file DuneApaChannelMapAlg.h.

TwoVector<unsigned int> geo::DuneApaChannelMapAlg::fChannelsPerApa

protected

channels for each APA

Definition at line 265 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fChannelsPerOpDet

protected

Flag for OpDet channel map.

Definition at line 246 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fChannelsPerRop

protected

channels for each Rop

Definition at line 266 of file DuneApaChannelMapAlg.h.

std::vector< double > geo::DuneApaChannelMapAlg::fCosOrientation

protected

Definition at line 295 of file DuneApaChannelMapAlg.h.

PlaneInfoMap_t<raw::ChannelID_t> geo::DuneApaChannelMapAlg::fFirstChannelInNextRop

protected

(cry, apa, rop)

Definition at line 274 of file DuneApaChannelMapAlg.h.

PlaneInfoMap_t<raw::ChannelID_t> geo::DuneApaChannelMapAlg::fFirstChannelInThisRop

protected

(cry, apa, rop)

Definition at line 273 of file DuneApaChannelMapAlg.h.

std::vector<unsigned int> geo::DuneApaChannelMapAlg::fNApa

protected

number of APAs in each cryostat

Definition at line 255 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fNApaMax

protected

Max # TPCs in any cryostat.

Definition at line 252 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fNchannels

protected

number of channels in the detector

Definition at line 248 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fNcryostat

protected

number of cryostats in the detector

Definition at line 247 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fNRopMax

protected

Max # ROPs in any APA.

Definition at line 253 of file DuneApaChannelMapAlg.h.

std::vector<unsigned int> geo::DuneApaChannelMapAlg::fNTpc

protected

number of TPCs in each cryostat

Definition at line 254 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fNTpcMax

protected

Max # TPCs in any cryostat.

Definition at line 251 of file DuneApaChannelMapAlg.h.

unsigned int geo::DuneApaChannelMapAlg::fOpDetFlag

protected

Definition at line 245 of file DuneApaChannelMapAlg.h.

std::vector< double > geo::DuneApaChannelMapAlg::fOrientation

protected

Definition at line 293 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fPlaneApa

protected

APA for each TPC plane (cry, tpc, pla)

Definition at line 268 of file DuneApaChannelMapAlg.h.

PlaneInfoMap_t<PlaneData_t> geo::DuneApaChannelMapAlg::fPlaneData

protected

Definition at line 290 of file DuneApaChannelMapAlg.h.

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

protected

vector of the PlaneIDs present in the detector

Definition at line 257 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fPlaneRop

protected

ROP for each TPC plane (cry, tpc, pla)

Definition at line 269 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fPlaneRopIndex

protected

Index in ROP for each TPC plane (cry, tpc, pla)

Definition at line 270 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fPlanesPerRop

protected

TPC planes for each (cry, apa, rop)

Definition at line 262 of file DuneApaChannelMapAlg.h.

TwoVector<unsigned int> geo::DuneApaChannelMapAlg::fPlanesPerTpc

protected

planes for each (cry, tpc)

Definition at line 259 of file DuneApaChannelMapAlg.h.

FourVector<unsigned int> geo::DuneApaChannelMapAlg::fRopPlane

protected

TPC plane index for each (cry, apa, rop, rpl)

Definition at line 264 of file DuneApaChannelMapAlg.h.

TwoVector<unsigned int> geo::DuneApaChannelMapAlg::fRopsPerApa

protected

ROPs for each (cry, apa)

Definition at line 260 of file DuneApaChannelMapAlg.h.

FourVector<unsigned int> geo::DuneApaChannelMapAlg::fRopTpc

protected

TPC planes for each (cry, apa, rop, rpl)

Definition at line 263 of file DuneApaChannelMapAlg.h.

std::vector< double > geo::DuneApaChannelMapAlg::fSinOrientation

protected

Definition at line 294 of file DuneApaChannelMapAlg.h.

const geo::GeoObjectSorter* geo::DuneApaChannelMapAlg::fSorter

protected

sorts geo::XXXGeo objects

Definition at line 275 of file DuneApaChannelMapAlg.h.

raw::ChannelID_t geo::DuneApaChannelMapAlg::fTopChannel

protected

book keeping highest channel #

Definition at line 250 of file DuneApaChannelMapAlg.h.

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

protected

vector of the views present in the detector

Definition at line 256 of file DuneApaChannelMapAlg.h.

std::vector< double > geo::DuneApaChannelMapAlg::fWirePitch

protected

Definition at line 292 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fWiresPerPlane

protected

wires/TPC plane for each (cry, tpc, pla)

Definition at line 258 of file DuneApaChannelMapAlg.h.

ThreeVector<unsigned int> geo::DuneApaChannelMapAlg::fWiresPerRop

protected

wires/ROP for each (cry, apa, rop)

Definition at line 272 of file DuneApaChannelMapAlg.h.

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

dunecore/dunecore/Geometry/DuneApaChannelMapAlg.h
dunecore/dunecore/Geometry/DuneApaChannelMapAlg.cxx

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

wires/TPC plane for each (cry, tpc, pla)

planes for each (cry, tpc)

ROPs for each (cry, apa)

TPC planes for each (cry, apa, rop)

TPC planes for each (cry, apa, rop, rpl)

TPC plane index for each (cry, apa, rop, rpl)

channels for each APA

channels for each Rop

anchored wires for each (cry, tpc, pla)

wires/ROP for each (cry, apa, rop)

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

anchored wires for each (cry, tpc, pla)

channels for each APA

channels for each Rop

TPC planes for each (cry, apa, rop)

planes for each (cry, tpc)

TPC plane index for each (cry, apa, rop, rpl)

ROPs for each (cry, apa)

TPC planes for each (cry, apa, rop, rpl)

wires/TPC plane for each (cry, tpc, pla)

wires/ROP for each (cry, apa, rop)