geo::ColdBoxChannelMapAlg Class Reference

#include <ColdBoxChannelMapAlg.h>

Inheritance diagram for geo::ColdBoxChannelMapAlg:

Classes
struct	ChannelRange_t
struct	PlaneInfo_t
	Collection of information on one plane. More...
struct	ReadoutMappingInfo_t
	Collected information about TPC sets and readout planes in the geometry. More...

Public Member Functions
	ColdBoxChannelMapAlg (fhicl::ParameterSet const &p)
virtual void	Initialize (geo::GeometryData_t const &geodata) override
	Prepares the algorithm extracting information from the geometry. More...
virtual void	Uninitialize () override
	Frees the resources of this algorithm. More...
virtual std::vector< geo::WireID >	ChannelToWire (raw::ChannelID_t channel) const override
	Returns a collection of ID of wires connected to the channel. More...
virtual unsigned int	Nchannels () const override
	Returns the number of readout channels (ID's go 0 to Nchannels()). More...
virtual unsigned int	Nchannels (readout::ROPID const &ropid) const override
	Returns the number of channels in the specified ROP. More...
virtual std::set< geo::PlaneID > const &	PlaneIDs () const override
	Returns a list of the plane IDs in the whole detector. More...
virtual geo::GeoObjectSorter const &	Sorter () const override
	Return the sorter. More...
virtual raw::ChannelID_t	PlaneWireToChannel (geo::WireID const &wireID) const override
	Returns the channel ID a wire is connected to. More...
virtual raw::ChannelID_t	PlaneWireToChannel (unsigned int plane, unsigned int wire, unsigned int tpc, unsigned int cstat) const override
	Returns the channel ID a wire is connected to. More...
Deprecated functions.
These methods are legacy and might be replaced by geo::GeometryCore calls.
virtual double	WireCoordinate (double YPos, double ZPos, geo::PlaneID const &planeID) const override
	Returns the index of the wire nearest to the specified position. More...
virtual double	WireCoordinate (double YPos, double ZPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the index of the wire nearest to the specified position. More...
virtual geo::WireID	NearestWireID (const TVector3 &worldPos, geo::PlaneID const &planeID) const override
	Returns the ID of the wire nearest to the specified position. More...
virtual geo::WireID	NearestWireID (const TVector3 &worldPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the ID of the wire nearest to the specified position. More...
TPC set mapping
virtual unsigned int	NTPCsets (readout::CryostatID const &cryoid) const override
	Returns the total number of TPC sets in the specified cryostat. More...
virtual unsigned int	MaxTPCsets () const override
	Returns the largest number of TPC sets any cryostat in the detector has. More...
virtual bool	HasTPCset (readout::TPCsetID const &tpcsetid) const override
virtual readout::TPCsetID	TPCtoTPCset (geo::TPCID const &tpcid) const override
	Returns the ID of the TPC set the specified TPC belongs to. More...
virtual std::vector< geo::TPCID >	TPCsetToTPCs (readout::TPCsetID const &tpcsetid) const override
	Returns a list of ID of TPCs belonging to the specified TPC set. More...
virtual geo::TPCID	FirstTPCinTPCset (readout::TPCsetID const &tpcsetid) const override
	Returns the ID of the first TPC belonging to the specified TPC set. More...
Readout plane mapping
virtual unsigned int	NROPs (readout::TPCsetID const &tpcsetid) const override
	Returns the total number of readout planes in the specified TPC set. More...
virtual unsigned int	MaxROPs () const override
	Returns the largest number of ROPs a TPC set in the detector has. More...
virtual bool	HasROP (readout::ROPID const &ropid) const override
virtual readout::ROPID	WirePlaneToROP (geo::PlaneID const &planeid) const override
	Returns the ID of the ROP planeid belongs to, or invalid if none. More...
virtual std::vector< geo::PlaneID >	ROPtoWirePlanes (readout::ROPID const &ropid) const override
	Returns a list of ID of wire planes belonging to the specified ROP. More...
virtual std::vector< geo::TPCID >	ROPtoTPCs (readout::ROPID const &ropid) const override
	Returns a list of ID of TPCs the specified ROP spans. More...
virtual readout::ROPID	ChannelToROP (raw::ChannelID_t channel) const override
	Returns the ID of the ROP the channel belongs to (invalid if none). More...
virtual raw::ChannelID_t	FirstChannelInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first channel in the specified readout plane. More...
virtual geo::PlaneID	FirstWirePlaneInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first plane belonging to the specified ROP. More...
Public Member Functions inherited from geo::ChannelMapAlg
virtual	~ChannelMapAlg ()=default
	Virtual destructor. More...
virtual unsigned int	NOpChannels (unsigned int NOpDets) const
	Returns the number of optical channels contained in some detectors. More...
virtual unsigned int	MaxOpChannel (unsigned int NOpDets) const
	Returns the number of optical channels contained in some detectors. More...
virtual unsigned int	NOpHardwareChannels (unsigned int opDet) const
	Returns the number of channels in the specified optical detectors. More...
virtual bool	IsValidOpChannel (unsigned int opChannel, unsigned int NOpDets) const
	Returns whether the ID identifies a valid optical detector channel. More...
virtual unsigned int	OpChannel (unsigned int detNum, unsigned int hwchannel=0) const
	Returns the channel ID of the specified hardware channel. More...
virtual unsigned int	OpDetFromOpChannel (unsigned int opChannel) const
	Returns the optical detector the specified optical channel belongs. More...
virtual unsigned int	HardwareChannelFromOpChannel (unsigned int opChannel) const
	Returns the hardware channel number of specified optical channel. More...
unsigned int	NearestWire (const TVector3 &worldPos, geo::PlaneID const &planeID) const
	Returns the index of the wire nearest to the specified position. More...
unsigned int	NearestWire (const TVector3 &worldPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const
	Returns the index of the wire nearest to the specified position. More...
virtual size_t	NearestAuxDet (const double *point, std::vector< geo::AuxDetGeo > const &auxDets, double tolerance=0) const
	Returns the auxiliary detector closest to the specified point. More...
virtual size_t	NearestSensitiveAuxDet (const double *point, std::vector< geo::AuxDetGeo > const &auxDets, double tolerance=0) const
	Returns sensitive auxiliary detector closest to specified point. More...
virtual size_t	ChannelToAuxDet (std::vector< geo::AuxDetGeo > const &auxDets, std::string const &detName, uint32_t const &channel) const
	Returns the index of the detector containing the specified channel. More...
virtual std::pair< size_t, size_t >	ChannelToSensitiveAuxDet (std::vector< geo::AuxDetGeo > const &auxDets, std::string const &detName, uint32_t const &channel) const
	Returns the index of the sensitive detector containing the channel. More...
const std::vector< std::vector< std::vector< raw::ChannelID_t > > >	FirstChannelInNextPlane () const
	Retrieve the private fFirstChannelInNextPlane vector for testing. More...
const std::vector< std::vector< std::vector< raw::ChannelID_t > > >	FirstChannelInThisPlane () const
	Retrieve the private fFirstChannelInThisPlane vector for testing. More...
virtual bool	HasChannel (raw::ChannelID_t channel) const
	Returns whether the specified channel is valid This default implementation assumes all channels up to Nchannels() valid. More...
geo::SigType_t	SignalTypeForChannel (raw::ChannelID_t const channel) const
	Return the signal type of the specified channel. More...
geo::SigType_t	SignalTypeForROPID (readout::ROPID const &ropid) const
	Return the signal type on the specified readout plane. More...

Private Types
using	TPCColl_t = std::vector< geo::TPCID >
using	PlaneColl_t = std::vector< geo::PlaneID >

Private Member Functions
bool	HasCryostat (readout::CryostatID const &cryoid) const
	Returns whether the specified cryostat is known to the mapping. More...
void	fillChannelToWireMap (geo::GeometryData_t::CryostatList_t const &Cryostats)
	Fills the information about readout channel mapping. More...
void	buildReadoutPlanes (geo::GeometryData_t::CryostatList_t const &Cryostats)
	Fills information about the TPC set and readout plane structure. More...
PlaneType_t	findPlaneType (readout::ROPID const &ropid) const
	Returns the "type" of readout plane. More...
virtual geo::SigType_t	SignalTypeForChannelImpl (raw::ChannelID_t const channel) const override
	Returns the type of signal on the specified channel. More...
Readout element information access
std::vector< unsigned int > const &	TPCsetCount () const
	Returns the number of TPC sets in each cryostat. More...
unsigned int	TPCsetCount (readout::CryostatID const &cid) const
	Returns the number of TPC sets in the specified cryostat cid. More...
readout::TPCsetDataContainer< TPCColl_t > const &	TPCsetTPCs () const
	All geo::TPCGeo objects in each TPC set. More...
TPCColl_t const &	TPCsetTPCs (readout::TPCsetID const &sid) const
	All geo::TPCID objects in the specified TPC set sid. More...
readout::TPCsetDataContainer< unsigned int > const &	ROPcount () const
	Number of readout planes in each TPC set. More...
unsigned int	ROPcount (readout::TPCsetID const &sid) const
	Number of readout planes in the specified TPC set sid. More...
readout::ROPDataContainer< PlaneColl_t > const &	ROPplanes () const
	All geo::PlaneGeo objects in each readout plane. More...
PlaneColl_t const &	ROPplanes (readout::ROPID const &rid) const
	All geo::PlaneId objects in the specified readout plane rid. More...
geo::TPCDataContainer< readout::TPCsetID > const &	TPCtoTPCset () const
	The TPC set including each TPC. More...
geo::PlaneDataContainer< readout::ROPID > const &	PlaneToROP () const
	The readout plane including each wire plane. More...
readout::ROPID const &	PlaneToROP (geo::PlaneID const &pid) const
	The readout plane the specified wire plane pid belongs to. More...

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

Private Attributes
std::string	fLogCategory = "ColdBoxChannelMapAlg"

Readout element information
Type for counts of wireless channels: per TPC set (even/odd), then per plane starting from the closest to the cathode; first is the number of wireless channels before the regular ones, second is the one after them. The geometry and readout data containers have currently no support for resizing and their size is assigned on construction. Access should happen via the corresponding member functions.
using	PlaneType_t = std::size_t
	Type for plane type identifier. More...
ReadoutMappingInfo_t	fReadoutMapInfo
	Information about TPC sets and readout planes in the geometry. More...
geo::dune::vd::ChannelToWireMap	fChannelToWireMap
	Mapping of channels and ROP's. More...
geo::PlaneDataContainer< PlaneInfo_t >	fPlaneInfo
	Range of channels covered by each of the wire planes. More...
geo::GeoObjectSorterCRU	fSorter
	class to sort geo objects More...
static constexpr PlaneType_t	kFirstInductionType = 0U
	Identifier for first induction plane type. More...
static constexpr PlaneType_t	kSecondInductionType = 1U
	Identifier for second induction plane type. More...
static constexpr PlaneType_t	kCollectionType = 2U
	Identifier for collection plane type. More...
static constexpr PlaneType_t	kUnknownType = std::numeric_limits<PlaneType_t>::max()
	Identifier for unknown plane type. More...

Additional Inherited Members
Protected Types inherited from geo::ChannelMapAlg
template<typename T >
using	TPCInfoMap_t = std::vector< std::vector< T >>
	Data type for per-TPC information. More...
template<typename T >
using	PlaneInfoMap_t = TPCInfoMap_t< std::vector< T >>
	Data type for per-plane information. More...
Protected Member Functions inherited from geo::ChannelMapAlg
template<typename T >
T const &	AccessElement (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const
	Returns the specified element of the plane map. More...
template<typename T >
size_t	AccessElementSize (PlaneInfoMap_t< T > const &map, geo::TPCID const &id) const
	Returns the number of elements in the specified TPC of the plane map. More...
template<typename T >
T const *	GetElementPtr (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const
	Returns a pointer to the specified element, or nullptr if invalid. More...
template<typename T >
T const &	AccessElement (TPCInfoMap_t< T > const &map, geo::TPCID const &id) const
	Returns the specified element of the TPC map. More...
template<typename T >
size_t	AccessElementSize (TPCInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns the number of elements in the specified cryostat of the TPC map. More...
template<typename T >
bool	isValidElement (TPCInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns whether the ID specifies a valid entry. More...
template<typename T >
bool	isValidElement (TPCInfoMap_t< T > const &map, geo::TPCID const &id) const
template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::CryostatID const &id) const
	Returns whether the ID specifies a valid entry. More...
template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::TPCID const &id) const
template<typename T >
bool	isValidElement (PlaneInfoMap_t< T > const &map, geo::PlaneID const &id) const
virtual geo::SigType_t	SignalTypeForROPIDImpl (readout::ROPID const &ropid) const
	Return the signal type on the specified readout plane. More...
Protected Attributes inherited from geo::ChannelMapAlg
PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInThisPlane
PlaneInfoMap_t< raw::ChannelID_t >	fFirstChannelInNextPlane
std::map< std::string, size_t >	fADNameToGeo
	map the names of the dets to the AuxDetGeo objects More...
std::map< size_t, std::vector< size_t > >	fADChannelToSensitiveGeo

Detailed Description

Definition at line 121 of file ColdBoxChannelMapAlg.h.

Member Typedef Documentation

using geo::ColdBoxChannelMapAlg::PlaneColl_t = std::vector<geo::PlaneID>

private

Definition at line 125 of file ColdBoxChannelMapAlg.h.

using geo::ColdBoxChannelMapAlg::PlaneType_t = std::size_t

private

Type for plane type identifier.

Definition at line 509 of file ColdBoxChannelMapAlg.h.

using geo::ColdBoxChannelMapAlg::TPCColl_t = std::vector<geo::TPCID>

private

Definition at line 124 of file ColdBoxChannelMapAlg.h.

Constructor & Destructor Documentation

geo::ColdBoxChannelMapAlg::ColdBoxChannelMapAlg

(

fhicl::ParameterSet const &

p

)

Definition at line 61 of file ColdBoxChannelMapAlg.cxx.

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

Member Function Documentation

void geo::ColdBoxChannelMapAlg::buildReadoutPlanes ( geo::GeometryData_t::CryostatList_t const &  Cryostats )

private

Fills information about the TPC set and readout plane structure.

Parameters

Cryostats

the sorted list of cryostats in the detector

Definition at line 522 of file ColdBoxChannelMapAlg.cxx.

{
  auto const [ NCryostats, MaxTPCs, MaxPlanes ]
    = geo::details::extractMaxGeometryElements<3U>(Cryostats);
  
  //mf::LogInfo("ColdBoxChannelMapAlg")
  //<< "Build readout planes for "<<NCryostats<<" "<<MaxTPCs<<" "<<MaxPlanes<<"\n";
  

  if( Cryostats.size() > 1 ){
    throw cet::exception("Geometry")
      << "geo::ColdBoxChannelMapAlg::buildReadoutPlanes " << Cryostats.size()
      << ": more than one cryostat is currently not supported\n";
  }
  
  if( Cryostats[0].NTPC() != 4 ){
    throw cet::exception("Geometry")
      << "geo::ColdBoxChannelMapAlg::buildReadoutPlanes " << Cryostats[0].NTPC()
      << ": more than four TPCs is currently not supported\n";
  }
  
  // currently do it by hand for CB --> to be generalized for FD
  auto cryo = Cryostats[0];
  //unsigned int MaxTPCs = cryo.NTPC();
  //unsigned int MaxPlanes = 3;
  unsigned int MaxROPs    = 3;
  unsigned int MaxTPCsets = MaxTPCs/2;
  std::vector<unsigned int> TPCsetCount = {2};
  std::vector<std::vector<const geo::TPCGeo*>> AllTPCsInTPCsets( MaxTPCsets );       // TPCs belonging to a set
  // the standard CRU sorter is assumed (fixing this another "todo")
  AllTPCsInTPCsets[0] = {cryo.TPCPtr(0), cryo.TPCPtr(2)};
  AllTPCsInTPCsets[1] = {cryo.TPCPtr(1), cryo.TPCPtr(3)};
  readout::TPCsetDataContainer<TPCColl_t> TPCsetTPCs(NCryostats, MaxTPCsets);
  
  for( auto&& [s, TPClist ]: util::enumerate(AllTPCsInTPCsets) ){
    readout::TPCsetID const tpcsetid
    { cryo.ID(), static_cast<readout::TPCsetID::TPCsetID_t>(s) };
    //mf::LogInfo("ColdBoxChannelMapAlg")<< tpcsetid <<" "<<TPCPtrs.size()<<"\n";
    std::vector<geo::TPCID> TPCs;
    TPCs.reserve(TPClist.size());
    std::transform(TPClist.begin(), TPClist.end(), std::back_inserter(TPCs),
                   std::mem_fn(&geo::TPCGeo::ID));

    TPCsetTPCs[tpcsetid] = std::move(TPCs);
  }

  //  number of readout planes in each TPC set
  readout::TPCsetDataContainer<unsigned int> ROPcount;
  ROPcount.resize( TPCsetTPCs.dimSize<0U>(), TPCsetTPCs.dimSize<1U>(), 0U );
  
  // geo::PlaneGeo objects in each readout plane
  readout::ROPDataContainer<PlaneColl_t> ROPplanes;
  ROPplanes.resize(TPCsetTPCs.dimSize<0U>(), TPCsetTPCs.dimSize<1U>(), MaxROPs);

  for (auto [ c, nTPCsets ]: util::enumerate(TPCsetCount)) {
    readout::CryostatID const cryoid
    { static_cast<readout::CryostatID::CryostatID_t>(c) };
    for (readout::TPCsetID::TPCsetID_t s = 0; s < nTPCsets; ++s) {
      readout::TPCsetID const tpcsetid { cryoid, s };
      unsigned int nROP  = MaxROPs;
      ROPcount[tpcsetid] = nROP;

      auto TPCs = AllTPCsInTPCsets[s];
      for( unsigned r = 0; r<nROP;++r ){ // assuming the number of rops == number of planes per TPC
        // get PlaneColl_t for each set for each plane
        PlaneColl_t planes;
        
        for ( const geo::TPCGeo* TPC: TPCs){ 
          planes.push_back( TPC->Plane(r).ID() );
        }
        readout::ROPID const ropid { tpcsetid, r };
        mf::LogTrace log(fLogCategory);
        log << "Readout plane " << ropid << " assigned with " << planes.size()
            << " planes:";
        for (auto const plane: planes)
          log << "  (" << plane << ")";
        
        if(!ROPplanes[ropid].empty()) {
          //
          // If this happens, it may be that the geometry is not compatible
          // with the algorithm, or just a bug.
          // Enabling the debug stream will show which planes are assigned
          // each time, including the two conflicting assignments.
          //
          throw cet::exception(fLogCategory)
            << "Logic error: ROPID " << ropid
            << " has already been assigned!\n";
        }
        
        ROPplanes[ ropid ] = std::move( planes );
      } // ROPs/ planes
    } // tpcs in tpcset
  }//cryo, TPCSets
      
  //
  // the TPC set each TPC belongs to 
  geo::TPCDataContainer<readout::TPCsetID> TPCtoTPCset;
  TPCtoTPCset.resize( NCryostats, MaxTPCs, {});
  for (auto c
         : util::counter<geo::CryostatID::CryostatID_t>(TPCsetTPCs.dimSize<0>())){
    
    geo::CryostatID const cid { c };
    for (auto s: util::counter<readout::TPCsetID::TPCsetID_t>(TPCsetTPCs.dimSize<1>()))
      {
        readout::TPCsetID const sid { cid, s };
        for (auto const TPCid: TPCsetTPCs[sid]) {
          TPCtoTPCset[TPCid] = sid;
          MF_LOG_TRACE(fLogCategory) << TPCid << " => " << sid;
        } // for TPCs in TPC set
      } // for TPC sets in cryostat
  } // for cryostats
  
  // ROP each wire belongs to
  geo::PlaneDataContainer<readout::ROPID> PlaneToROP;
  PlaneToROP.resize( NCryostats, MaxTPCs, MaxPlanes, {} );
  for (auto c
    : util::counter<geo::CryostatID::CryostatID_t>(ROPplanes.dimSize<0>())
       )
    {
      geo::CryostatID const cid { c };
      for (auto s: util::counter<readout::TPCsetID::TPCsetID_t>(ROPplanes.dimSize<1>()))
        {
          readout::TPCsetID const sid { cid, s };
          for (auto r: util::counter<readout::ROPID::ROPID_t>(ROPplanes.dimSize<2>()))
            {
              readout::ROPID const rid { sid, r };
              for (auto const plane: ROPplanes[rid]) {
                //assert(plane && plane->ID());
                PlaneToROP[plane] = rid;
                MF_LOG_TRACE(fLogCategory) << plane << " => " << rid;
              } // for planes in readout plane
            } // for readout planes in TPC set
        } // for TPC sets in cryostat
    } // for cryostats
  
  // copy to ReadoutMapInfo struct
  fReadoutMapInfo.set(
                      std::move(TPCsetCount), std::move(TPCsetTPCs),
                      std::move(ROPcount), std::move(ROPplanes),
                      std::move(TPCtoTPCset), std::move(PlaneToROP)
                      );
} // geo::ColdBoxChannelMapAlg::buildReadoutPlanes()

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

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

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

overridevirtual

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

Parameters

channel

TPC readout channel number

Returns

collection of the wire IDs associated with channel

Exceptions

cet::exception

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

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

Implements geo::ChannelMapAlg.

Definition at line 92 of file ColdBoxChannelMapAlg.cxx.

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

void geo::ColdBoxChannelMapAlg::fillChannelToWireMap ( geo::GeometryData_t::CryostatList_t const &  Cryostats )

private

Fills the information about readout channel mapping.

Parameters

Cryostats

the sorted list of cryostats in the detector

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

Definition at line 394 of file ColdBoxChannelMapAlg.cxx.

{
  
  //
  // input check
  //
  assert(fReadoutMapInfo);
  assert(!Cryostats.empty());
  
  //mf::LogInfo("ColdBoxChannelMapAlg")<<"fillChannelToWireMap\n";
  //
  // output setup
  //
  assert(fPlaneInfo.empty());
  std::array<unsigned int, 3U> maxSizes
    = geo::details::extractMaxGeometryElements<3U>(Cryostats);
 
  fPlaneInfo.resize(maxSizes[0U], maxSizes[1U], maxSizes[2U]);
  
  raw::ChannelID_t nextChannel = 0; // next available channel
  for (geo::CryostatGeo const& cryo: Cryostats) {
    
    readout::CryostatID const cid { cryo.ID() };
    
    auto const nTPCsets 
      = static_cast<readout::TPCsetID::TPCsetID_t>(TPCsetCount(cid));

    for (readout::TPCsetID::TPCsetID_t s: util::counter(nTPCsets)) {
      
      readout::TPCsetID const sid { cid, s };
      auto const nROPs = static_cast<readout::ROPID::ROPID_t>(ROPcount(sid));

      for (readout::ROPID::ROPID_t r: util::counter(nROPs)) {
        
        mf::LogTrace log("ColdBoxChannelMapAlg");
        
        readout::ROPID const rid { sid, r };
        auto const planeType = findPlaneType(rid);
        log << "ROP: " << rid
          << " (plane type: " << PlaneTypeName(planeType) << ")";

        PlaneColl_t const& plane_ids = ROPplanes(rid);
        assert(!plane_ids.empty());
        log << " (" << plane_ids.size() << " planes):";
        
        std::vector<geo::PlaneGeo const*> planes;
        planes.reserve( plane_ids.size() );
        for( auto const pid : plane_ids ){
          planes.push_back( cryo.TPC( pid ).PlanePtr( pid ) );
        }
        
        raw::ChannelID_t const firstROPchannel = nextChannel;
        
        auto iPlane = util::begin(planes);
        auto const pend = util::end(planes);
        
        // assign available channels to all wires of the first plane
        nextChannel += (*iPlane)->Nwires();
        fPlaneInfo[(*iPlane)->ID()] = {
          ChannelRange_t{ firstROPchannel, nextChannel }, rid };
        log << " [" << (*iPlane)->ID() << "] "
          << fPlaneInfo[(*iPlane)->ID()].firstChannel()
          << " -- " << fPlaneInfo[(*iPlane)->ID()].lastChannel() << ";";
        
        geo::Point_t lastWirePos = (*iPlane)->LastWire().GetCenter<geo::Point_t>();
        
        while (++iPlane != pend) {
          
          geo::PlaneGeo const& plane = **iPlane;
          
          // find out which wire matches the last wire from the previous plane;
          // if there is no such wire, an exception will be thrown,
          // which is ok to us since we believe it should not happen.
          geo::WireID const lastMatchedWireID
            = plane.NearestWireID(lastWirePos);
          
          /*
          mf::LogTrace("ColdBoxChannelMapAlg")
            << (*std::prev(iPlane))->ID() << " W:" << ((*std::prev(iPlane))->Nwires() - 1)
            << " ending at " << (*std::prev(iPlane))->LastWire().GetEnd<geo::Point_t>()
            << " matched " << lastMatchedWireID
            << " which starts at " << plane.Wire(lastMatchedWireID).GetStart<geo::Point_t>()
            ;
          */
          
          // For ROP = 0 (1st induction)
          // the first channel in this plane (`iPlane`) is the one associated
          // to the first wire in the plane, which has local wire number `0`;
          // the last channel from the previous plane (`nextChannel - 1`)
          // is associated to the matched wire (`lastMatchedWireID`),
          // which has some wire number (`lastMatchedWireID.Wire`).
          //
          auto const nWires = plane.Nwires();
          raw::ChannelID_t const firstChannel = 
            (r == 0)?((nextChannel - 1) - lastMatchedWireID.Wire):nextChannel;

          nextChannel = firstChannel + nWires;
          
          fPlaneInfo[plane.ID()] = { { firstChannel, nextChannel }, rid };
          log << " [" << plane.ID() << "] "
            << fPlaneInfo[plane.ID()].firstChannel() << " -- "
            << fPlaneInfo[plane.ID()].lastChannel() << ";";
          
          // update for the next iteration
          lastWirePos = plane.LastWire().GetCenter<geo::Point_t>();
          
        } // while
        
        unsigned int const nChannels = nextChannel - firstROPchannel;
        fChannelToWireMap.addROP(rid, firstROPchannel, nChannels);
        log
          << " => " << nChannels << " channels starting at " << firstROPchannel;
        
      } // for readout plane
      
    } // for TPC set
    
  } // for cryostat
  
  fChannelToWireMap.setEndChannel(nextChannel);
  mf::LogInfo("ColdBoxChannelMapAlg")
    << "Counted " << fChannelToWireMap.nChannels() << " channels.";
  
} // geo::ColdBoxChannelMapAlg::fillChannelToWireMap()

std::size_t geo::ColdBoxChannelMapAlg::findPlaneType ( readout::ROPID const &  ropid ) const

private

Returns the "type" of readout plane.

Parameters

ropid

ID of the readout plane to query

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

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

Definition at line 667 of file ColdBoxChannelMapAlg.cxx.

{
  /*
   * This implementation is very fragile, relying on the fact that the first
   * induction plane numbers are `kFirstInductionType`, the second induction
   * plane numbers are `kSecondInductionType` and the collection plane numbers
   * are `kCollectionType`. This assumption is not checked anywhere.
   * 
   */
  constexpr std::array PlaneTypes = { // let's C++ figure out type and size
    kFirstInductionType,  // P:0
    kSecondInductionType, // P:1
    kCollectionType       // P:2
  };
  
  PlaneColl_t const& planes = ROPplanes(rid);
  //std::cout<<"findPlaneType: "<<rid<<" "<<planes.size()<<" @ "<<planes.front()
  //<<" "<<planes.front()->ID().Plane<<"\n";
  //for (geo::PlaneGeo const* plane: planes)
  //std::cout <<" (" << plane->ID() << ")";
  //std::cout<<"\n";

  if (planes.empty()) return kUnknownType;
  if (auto const planeNo = planes.front().Plane; planeNo < PlaneTypes.size())
    return PlaneTypes[planeNo];
  else return kUnknownType;
  
} // geo::ColdBoxChannelMapAlg::findPlaneType()

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

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

geo::TPCID geo::ColdBoxChannelMapAlg::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 271 of file ColdBoxChannelMapAlg.cxx.

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

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

overridevirtual

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

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

Implements geo::ChannelMapAlg.

Definition at line 375 of file ColdBoxChannelMapAlg.cxx.

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

bool geo::ColdBoxChannelMapAlg::HasCryostat ( readout::CryostatID const &  cryoid ) const

private

Returns whether the specified cryostat is known to the mapping.

Definition at line 385 of file ColdBoxChannelMapAlg.cxx.

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

bool geo::ColdBoxChannelMapAlg::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 296 of file ColdBoxChannelMapAlg.cxx.

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

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

overridevirtual

Returns whether we have the specified TPC set.

Returns

whether the TPC set is valid and exists

Returns whether we have the specified TPC set

Returns

whether the TPC set is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 243 of file ColdBoxChannelMapAlg.cxx.

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

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

overridevirtual

Prepares the algorithm extracting information from the geometry.

Implements geo::ChannelMapAlg.

Definition at line 67 of file ColdBoxChannelMapAlg.cxx.

{
  mf::LogInfo("ColdBoxChannelMapAlg")
    << "Initializing ColdBoxChannelMapAlg channel mapping algorithm.";
  
  buildReadoutPlanes(geodata.cryostats);
  fillChannelToWireMap(geodata.cryostats);
  
  MF_LOG_TRACE("ColdBoxChannelMapAlg")
    << "ColdBoxChannelMapAlg::Initialize() completed.";
} // geo::ColdBoxChannelMapAlg::Initialize()

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 290 of file ColdBoxChannelMapAlg.cxx.

                                                    {
  assert(fReadoutMapInfo);
  return fReadoutMapInfo.MaxROPs();
} // geo::ColdBoxChannelMapAlg::MaxROPs()

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 233 of file ColdBoxChannelMapAlg.cxx.

                                                       {
  assert(fReadoutMapInfo);
  return fReadoutMapInfo.MaxTPCsets();
} // geo::ColdBoxChannelMapAlg::MaxTPCsets()

unsigned int geo::ColdBoxChannelMapAlg::Nchannels ( ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 142 of file ColdBoxChannelMapAlg.cxx.

                                                      {
  
  return fChannelToWireMap.nChannels();
} // geo::ColdBoxChannelMapAlg::Nchannels()

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

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

geo::WireID geo::ColdBoxChannelMapAlg::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 179 of file ColdBoxChannelMapAlg.cxx.

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

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

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

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

overridevirtual

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

Parameters

tpcsetid

TPC set ID

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 283 of file ColdBoxChannelMapAlg.cxx.

{
  return HasTPCset(tpcsetid)? ROPcount(tpcsetid): 0U;
} // geo::ColdBoxChannelMapAlg::NROPs()

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

{
  return HasCryostat(cryoid)? TPCsetCount(cryoid): 0U;
} // geo::ColdBoxChannelMapAlg::NTPCsets()

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 205 of file ColdBoxChannelMapAlg.cxx.

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

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

inlineprivate

The readout plane including each wire plane.

Definition at line 563 of file ColdBoxChannelMapAlg.h.

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

readout::ROPID const& geo::ColdBoxChannelMapAlg::PlaneToROP ( geo::PlaneID const &  pid ) const

inlineprivate

The readout plane the specified wire plane pid belongs to.

Definition at line 567 of file ColdBoxChannelMapAlg.h.

    { return PlaneToROP()[pid]; }

std::string geo::ColdBoxChannelMapAlg::PlaneTypeName ( PlaneType_t  planeType )

staticprivate

Returns the name of the specified plane type.

Definition at line 720 of file ColdBoxChannelMapAlg.cxx.

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

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

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

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

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

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

inlineprivate

Number of readout planes in each TPC set.

Definition at line 543 of file ColdBoxChannelMapAlg.h.

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

unsigned int geo::ColdBoxChannelMapAlg::ROPcount ( readout::TPCsetID const &  sid ) const

inlineprivate

Number of readout planes in the specified TPC set sid.

Definition at line 547 of file ColdBoxChannelMapAlg.h.

    { return ROPcount()[sid]; }

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

inlineprivate

All geo::PlaneGeo objects in each readout plane.

Definition at line 551 of file ColdBoxChannelMapAlg.h.

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

PlaneColl_t const& geo::ColdBoxChannelMapAlg::ROPplanes ( readout::ROPID const &  rid ) const

inlineprivate

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

Definition at line 555 of file ColdBoxChannelMapAlg.h.

    { return ROPplanes()[rid]; }

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

{
  std::vector<geo::TPCID> TPCs;
  if (!ropid) return TPCs;
  
  auto const& PlaneList = ROPplanes(ropid);
  TPCs.reserve(PlaneList.size());
  for( auto const pid : PlaneList ){
    TPCs.push_back( pid );
  }

  return TPCs;
} // geo::ColdBoxChannelMapAlg::ROPtoTPCs()

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

overridevirtual

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

Parameters

ropid

ID of the readout plane to convert into wire planes

Returns

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

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

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

Implements geo::ChannelMapAlg.

Definition at line 324 of file ColdBoxChannelMapAlg.cxx.

{
  std::vector<geo::PlaneID> Planes;
  if (!ropid) return Planes;
  return ROPplanes(ropid);
} // geo::ColdBoxChannelMapAlg::ROPtoWirePlanes()

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

overrideprivatevirtual

Returns the type of signal on the specified channel.

Implements geo::ChannelMapAlg.

Definition at line 699 of file ColdBoxChannelMapAlg.cxx.

{
  ChannelToWireMap::ChannelsInROPStruct const* channelInfo
    = fChannelToWireMap.find(channel);
  if (!channelInfo) return geo::kMysteryType;
  
  switch (findPlaneType(channelInfo->ropid)) {
    case kFirstInductionType:
    case kSecondInductionType:
      return geo::kInduction;
    case kCollectionType:
      return geo::kCollection;
    default:
      return geo::kMysteryType;
  } // switch
  
  return geo::kMysteryType;
} // geo::ColdBoxChannelMapAlg::SignalTypeForChannelImpl()

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

inlineoverridevirtual

Return the sorter.

Implements geo::ChannelMapAlg.

Definition at line 356 of file ColdBoxChannelMapAlg.h.

    { return fSorter; }

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

inlineprivate

Returns the number of TPC sets in each cryostat.

Definition at line 527 of file ColdBoxChannelMapAlg.h.

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

unsigned int geo::ColdBoxChannelMapAlg::TPCsetCount ( readout::CryostatID const &  cid ) const

inlineprivate

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

Definition at line 531 of file ColdBoxChannelMapAlg.h.

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

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

overridevirtual

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

Parameters

tpcsetid

ID of the TPC set to convert into TPC IDs

Returns

the list of TPCs, empty if TPC set is invalid

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

Implements geo::ChannelMapAlg.

Definition at line 260 of file ColdBoxChannelMapAlg.cxx.

{
  std::vector<geo::TPCID> TPCs;
  if (!tpcsetid) return TPCs;
  
  return TPCsetTPCs(tpcsetid);
} // geo::ColdBoxChannelMapAlg::TPCsetToTPCs()

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

inlineprivate

All geo::TPCGeo objects in each TPC set.

Definition at line 535 of file ColdBoxChannelMapAlg.h.

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

TPCColl_t const& geo::ColdBoxChannelMapAlg::TPCsetTPCs ( readout::TPCsetID const &  sid ) const

inlineprivate

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

Definition at line 539 of file ColdBoxChannelMapAlg.h.

    { return TPCsetTPCs()[sid]; }

readout::TPCsetID geo::ColdBoxChannelMapAlg::TPCtoTPCset ( geo::TPCID const &  tpcid ) const

overridevirtual

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

Parameters

tpcid

ID of the TPC

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 252 of file ColdBoxChannelMapAlg.cxx.

{
  return tpcid? TPCtoTPCset()[tpcid]: readout::TPCsetID{};
} // geo::ColdBoxChannelMapAlg::TPCtoTPCset()

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

inlineprivate

The TPC set including each TPC.

Definition at line 559 of file ColdBoxChannelMapAlg.h.

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

void geo::ColdBoxChannelMapAlg::Uninitialize ( )

overridevirtual

Frees the resources of this algorithm.

Implements geo::ChannelMapAlg.

Definition at line 81 of file ColdBoxChannelMapAlg.cxx.

                                           {
  
  fReadoutMapInfo.clear();
  fChannelToWireMap.clear();
  fPlaneInfo.clear();
  
} // geo::ColdBoxChannelMapAlg::Uninitialize()

double geo::ColdBoxChannelMapAlg::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 160 of file ColdBoxChannelMapAlg.cxx.

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

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

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

readout::ROPID geo::ColdBoxChannelMapAlg::WirePlaneToROP ( geo::PlaneID const &  planeid ) const

overridevirtual

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

Parameters

planeid

ID of the plane

Returns

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

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

Parameters

planeid

ID of the plane

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 315 of file ColdBoxChannelMapAlg.cxx.

{
  return planeid? PlaneToROP(planeid): readout::ROPID{};
  //return planeid?fReadoutMapInfo.fPlaneToROP[planeid]:readout::ROPID{};
} // geo::ColdBoxChannelMapAlg::WirePlaneToROP()

Member Data Documentation

geo::dune::vd::ChannelToWireMap geo::ColdBoxChannelMapAlg::fChannelToWireMap

private

Mapping of channels and ROP's.

Definition at line 501 of file ColdBoxChannelMapAlg.h.

std::string geo::ColdBoxChannelMapAlg::fLogCategory = "ColdBoxChannelMapAlg"

private

Definition at line 623 of file ColdBoxChannelMapAlg.h.

geo::PlaneDataContainer<PlaneInfo_t> geo::ColdBoxChannelMapAlg::fPlaneInfo

private

Range of channels covered by each of the wire planes.

Definition at line 504 of file ColdBoxChannelMapAlg.h.

ReadoutMappingInfo_t geo::ColdBoxChannelMapAlg::fReadoutMapInfo

private

Information about TPC sets and readout planes in the geometry.

Definition at line 498 of file ColdBoxChannelMapAlg.h.

geo::GeoObjectSorterCRU geo::ColdBoxChannelMapAlg::fSorter

private

class to sort geo objects

Definition at line 506 of file ColdBoxChannelMapAlg.h.

constexpr PlaneType_t geo::ColdBoxChannelMapAlg::kCollectionType = 2U

staticprivate

Identifier for collection plane type.

Definition at line 516 of file ColdBoxChannelMapAlg.h.

constexpr PlaneType_t geo::ColdBoxChannelMapAlg::kFirstInductionType = 0U

staticprivate

Identifier for first induction plane type.

Definition at line 512 of file ColdBoxChannelMapAlg.h.

constexpr PlaneType_t geo::ColdBoxChannelMapAlg::kSecondInductionType = 1U

staticprivate

Identifier for second induction plane type.

Definition at line 514 of file ColdBoxChannelMapAlg.h.

constexpr PlaneType_t geo::ColdBoxChannelMapAlg::kUnknownType = std::numeric_limits<PlaneType_t>::max()

staticprivate

Identifier for unknown plane type.

Definition at line 519 of file ColdBoxChannelMapAlg.h.

---

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

• dunecore/dunecore/Geometry/ColdBoxChannelMapAlg.h
• dunecore/dunecore/Geometry/ColdBoxChannelMapAlg.cxx