geo::ChannelMapStandardAlg Class Reference

#include <ChannelMapStandardAlg.h>

Inheritance diagram for geo::ChannelMapStandardAlg:

Public Member Functions
	ChannelMapStandardAlg (fhicl::ParameterSet const &p)
virtual void	Initialize (GeometryData_t const &geodata) override
	Geometry initialisation. More...
virtual void	Uninitialize () override
	Deconfiguration: prepare for a following call of Initialize() More...
virtual std::vector< WireID >	ChannelToWire (raw::ChannelID_t channel) const override
virtual unsigned int	Nchannels () const override
	Returns the total number of channels present (not necessarily contiguous) More...
virtual unsigned int	Nchannels (readout::ROPID const &ropid) const override
	Returns the number of channels in the specified ROP. More...
virtual std::set< PlaneID > const &	PlaneIDs () const override
	Returns a list of the plane IDs in the whole detector. More...
virtual geo::GeoObjectSorter const &	Sorter () const override
	Return the sorter. More...
virtual double	WireCoordinate (double YPos, double ZPos, geo::PlaneID const &planeID) const override
	Returns the index of the wire nearest to the specified position. More...
virtual double	WireCoordinate (double YPos, double ZPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the index of the wire nearest to the specified position. More...
virtual WireID	NearestWireID (const TVector3 &worldPos, geo::PlaneID const &planeID) const override
	Returns the ID of the wire nearest to the specified position. More...
virtual WireID	NearestWireID (const TVector3 &worldPos, unsigned int PlaneNo, unsigned int TPCNo, unsigned int cstat) const override
	Returns the ID of the wire nearest to the specified position. More...
virtual raw::ChannelID_t	PlaneWireToChannel (geo::WireID const &wireID) const override
	Returns the channel ID a wire is connected to. More...
virtual raw::ChannelID_t	PlaneWireToChannel (unsigned int plane, unsigned int wire, unsigned int tpc, unsigned int cstat) const override
	Returns the channel ID a wire is connected to. More...
TPC set mapping
virtual unsigned int	NTPCsets (readout::CryostatID const &cryoid) const override
	Returns the total number of TPC sets in the specified cryostat. More...
virtual unsigned int	MaxTPCsets () const override
	Returns the largest number of TPC sets any cryostat in the detector has. More...
virtual bool	HasTPCset (readout::TPCsetID const &tpcsetid) const override
virtual readout::TPCsetID	TPCtoTPCset (geo::TPCID const &tpcid) const override
	Returns the ID of the TPC set the specified TPC belongs to. More...
virtual std::vector< geo::TPCID >	TPCsetToTPCs (readout::TPCsetID const &tpcsetid) const override
	Returns a list of ID of TPCs belonging to the specified TPC set. More...
virtual geo::TPCID	FirstTPCinTPCset (readout::TPCsetID const &tpcsetid) const override
	Returns the ID of the first TPC belonging to the specified TPC set. More...
Readout plane mapping
virtual unsigned int	NROPs (readout::TPCsetID const &tpcsetid) const override
	Returns the total number of ROPs in the specified TPC set. More...
virtual unsigned int	MaxROPs () const override
	Returns the largest number of ROPs a TPC set in the detector has. More...
virtual bool	HasROP (readout::ROPID const &ropid) const override
virtual readout::ROPID	WirePlaneToROP (geo::PlaneID const &planeid) const override
	Returns the ID of the ROP planeid belongs to, or invalid if none. More...
virtual std::vector< geo::PlaneID >	ROPtoWirePlanes (readout::ROPID const &ropid) const override
	Returns a list of ID of wire planes belonging to the specified ROP. More...
virtual std::vector< geo::TPCID >	ROPtoTPCs (readout::ROPID const &ropid) const override
	Returns a list of ID of TPCs the specified ROP spans. More...
virtual readout::ROPID	ChannelToROP (raw::ChannelID_t channel) const override
	Returns the ID of the ROP the channel belongs to (invalid if none) More...
virtual raw::ChannelID_t	FirstChannelInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first channel in the specified readout plane. More...
virtual geo::PlaneID	FirstWirePlaneInROP (readout::ROPID const &ropid) const override
	Returns the ID of the first plane belonging to the specified ROP. More...
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 Member Functions
virtual SigType_t	SignalTypeForChannelImpl (raw::ChannelID_t const channel) const override
	Return the signal type of the specified channel. More...
unsigned int	WireCount (geo::PlaneID const &id) const
	Retrieved the wire cound for the specified plane ID. More...
unsigned int	MaxTPCs () const
	Returns the largest number of TPCs in a single cryostat. More...

Static Private Member Functions
static readout::TPCsetID	ConvertTPCtoTPCset (geo::TPCID const &tpcid)
	Converts a TPC ID into a TPC set ID using the same numerical indices. More...
static geo::TPCID	ConvertTPCsetToTPC (readout::TPCsetID const &tpcsetid)
	Converts a TPC set ID into a TPC ID using the same numerical indices. More...
static readout::ROPID	ConvertWirePlaneToROP (geo::PlaneID const &planeid)
	Converts a ROP ID into a wire plane ID using the same numerical indices. More...
static geo::PlaneID	ConvertROPtoWirePlane (readout::ROPID const &ropid)
	Converts a wire plane ID into a ROP ID using the same numerical indices. More...

Private Attributes
unsigned int	fNcryostat
	number of cryostats in the detector More...
unsigned int	fNchannels
	number of channels in the detector More...
raw::ChannelID_t	fTopChannel
	book keeping highest channel # More...
std::vector< unsigned int >	fNTPC
	number of TPCs in each cryostat More...
std::set< View_t >	fViews
	vector of the views present in the detector More...
std::set< PlaneID >	fPlaneIDs
	vector of the PlaneIDs present in the detector More...
PlaneInfoMap_t< float >	fFirstWireProj
PlaneInfoMap_t< float >	fOrthVectorsY
	Unit vectors orthogonal to wires in. More...
PlaneInfoMap_t< float >	fOrthVectorsZ
PlaneInfoMap_t< float >	fWireCounts
TPCInfoMap_t< unsigned int >	fNPlanes
PlaneInfoMap_t< unsigned int >	fPlaneBaselines
PlaneInfoMap_t< unsigned int >	fWiresPerPlane
geo::GeoObjectSorterStandard	fSorter
	class to sort geo objects More...

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 22 of file ChannelMapStandardAlg.h.

Constructor & Destructor Documentation

geo::ChannelMapStandardAlg::ChannelMapStandardAlg

(

fhicl::ParameterSet const &

p

)

Definition at line 24 of file ChannelMapStandardAlg.cxx.

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

Member Function Documentation

readout::ROPID geo::ChannelMapStandardAlg::ChannelToROP ( raw::ChannelID_t  channel ) const

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 433 of file ChannelMapStandardAlg.cxx.

  {
    if (!raw::isValidChannelID(channel)) return {}; // invalid ROP returned

    // which wires does the channel cover?
    std::vector<geo::WireID> wires = ChannelToWire(channel);

    // - none:
    if (wires.empty()) return {}; // invalid ROP returned

    // - one: maps its plane ID into a ROP ID
    return WirePlaneToROP(wires[0]);
  } // ChannelMapStandardAlg::ROPtoTPCs()

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

overridevirtual

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

Exceptions

cet::exception

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

Implements geo::ChannelMapAlg.

Definition at line 146 of file ChannelMapStandardAlg.cxx.

  {
    std::vector< geo::WireID > AllSegments;
    unsigned int cstat = 0;
    unsigned int tpc   = 0;
    unsigned int plane = 0;
    unsigned int wire  = 0;

    // first check if this channel ID is legal
    if(channel > fTopChannel)
      throw cet::exception("Geometry") << "ILLEGAL CHANNEL ID for channel " << channel << "\n";

    // then go find which plane, tpc and cryostat it is in from the information we stored earlier
    bool foundWid(false);
    for(unsigned int csloop = 0; csloop != fNcryostat; ++csloop){
      for(unsigned int tpcloop = 0; tpcloop != fNTPC[csloop]; ++tpcloop){
        for(unsigned int planeloop = 0; planeloop != fFirstChannelInNextPlane[csloop][tpcloop].size(); ++planeloop){
          if(channel < fFirstChannelInNextPlane[csloop][tpcloop][planeloop]){
            cstat = csloop;
            tpc   = tpcloop;
            plane = planeloop;
            wire  = channel - fFirstChannelInThisPlane[cstat][tpcloop][planeloop];
            foundWid = true;
            break;
          }
          if(foundWid) break;
        }// end plane loop
        if(foundWid) break;
      }// end tpc loop
      if(foundWid) break;
    }// end cryostat loop

    geo::WireID CodeWire(cstat, tpc, plane, wire);

    AllSegments.push_back(CodeWire);

    return AllSegments;
  }

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

staticprivate

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

Definition at line 506 of file ChannelMapStandardAlg.cxx.

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

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

staticprivate

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

Definition at line 480 of file ChannelMapStandardAlg.cxx.

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

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

staticprivate

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

Definition at line 468 of file ChannelMapStandardAlg.cxx.

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

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

staticprivate

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

Definition at line 492 of file ChannelMapStandardAlg.cxx.

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

  } // ChannelMapStandardAlg::ConvertWirePlaneToROP()

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

overridevirtual

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

Parameters

ropid

ID of the readout plane

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 450 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 362 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 460 of file ChannelMapStandardAlg.cxx.

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

bool geo::ChannelMapStandardAlg::HasROP ( readout::ROPID const &  ropid ) const

overridevirtual

Returns whether we have the specified ROP

Returns

whether the readout plane is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 397 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

Returns whether we have the specified TPC set

Returns

whether the TPC set is valid and exists

Implements geo::ChannelMapAlg.

Definition at line 336 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

Geometry initialisation.

Implements geo::ChannelMapAlg.

Definition at line 30 of file ChannelMapStandardAlg.cxx.

  {
    // start over:
    Uninitialize();

    std::vector<geo::CryostatGeo> const& cgeo = geodata.cryostats;

    fNcryostat = cgeo.size();

    mf::LogInfo("ChannelMapStandardAlg") << "Initializing Standard ChannelMap...";

    fNTPC.resize(fNcryostat);
    fWireCounts.resize(fNcryostat);
    fNPlanes.resize(fNcryostat);
    fFirstWireProj.resize(fNcryostat);
    fOrthVectorsY.resize(fNcryostat);
    fOrthVectorsZ.resize(fNcryostat);
    fPlaneBaselines.resize(fNcryostat);
    fWiresPerPlane.resize(fNcryostat);
    fFirstChannelInNextPlane.resize(fNcryostat);
    fFirstChannelInThisPlane.resize(fNcryostat);
    fPlaneIDs.clear();
    fTopChannel = 0;

    int RunningTotal = 0;

    for(unsigned int cs = 0; cs != fNcryostat; ++cs){
      geo::CryostatGeo const& cryo = cgeo[cs];
      fNTPC[cs] = cryo.NTPC();

      // Size up all the vectors
      fWireCounts[cs]             .resize(fNTPC[cs]);
      fFirstWireProj[cs]           .resize(fNTPC[cs]);
      fOrthVectorsY[cs]            .resize(fNTPC[cs]);
      fOrthVectorsZ[cs]            .resize(fNTPC[cs]);
      fPlaneBaselines[cs]          .resize(fNTPC[cs]);
      fWiresPerPlane[cs]           .resize(fNTPC[cs]);
      fNPlanes[cs]                     .resize(fNTPC[cs]);
      fFirstChannelInThisPlane[cs].resize(fNTPC[cs]);
      fFirstChannelInNextPlane[cs].resize(fNTPC[cs]);

      for(unsigned int TPCCount = 0; TPCCount != fNTPC[cs]; ++TPCCount){
        geo::TPCGeo const& TPC = cryo.TPC(TPCCount);
        unsigned int PlanesThisTPC = TPC.Nplanes();
        fWireCounts[cs][TPCCount]   .resize(PlanesThisTPC);
        fFirstWireProj[cs][TPCCount].resize(PlanesThisTPC);
        fOrthVectorsY[cs][TPCCount] .resize(PlanesThisTPC);
        fOrthVectorsZ[cs][TPCCount] .resize(PlanesThisTPC);
        fNPlanes[cs][TPCCount]=PlanesThisTPC;
        for(unsigned int PlaneCount = 0; PlaneCount != PlanesThisTPC; ++PlaneCount){
          geo::PlaneGeo const& plane = TPC.Plane(PlaneCount);

          fPlaneIDs.emplace(PlaneID(cs, TPCCount, PlaneCount));
          double ThisWirePitch = TPC.WirePitch(PlaneCount);
          fWireCounts[cs][TPCCount][PlaneCount] = plane.Nwires();

          double  WireCentre1[3] = {0.,0.,0.};
          double  WireCentre2[3] = {0.,0.,0.};

          const geo::WireGeo& firstWire = plane.Wire(0);
          const double sth = firstWire.SinThetaZ(), cth = firstWire.CosThetaZ();

          firstWire.GetCenter(WireCentre1,0);
          plane.Wire(1).GetCenter(WireCentre2,0);

          // figure out if we need to flip the orthogonal vector
          // (should point from wire n -> n+1)
          double OrthY = cth, OrthZ = -sth;
          if(((WireCentre2[1] - WireCentre1[1])*OrthY
              + (WireCentre2[2] - WireCentre1[2])*OrthZ) < 0){
            OrthZ *= -1;
            OrthY *= -1;
          }

          // Overall we are trying to build an expression that looks like
          //  int NearestWireNumber = round((worldPos.OrthVector - FirstWire.OrthVector)/WirePitch);
          // That runs as fast as humanly possible.
          // We predivide everything by the wire pitch so we don't do this in the loop.
          //
          // Putting this together into the useful constants we will use later per plane and tpc:
          fOrthVectorsY[cs][TPCCount][PlaneCount] = OrthY / ThisWirePitch;
          fOrthVectorsZ[cs][TPCCount][PlaneCount] = OrthZ / ThisWirePitch;

          fFirstWireProj[cs][TPCCount][PlaneCount]  = WireCentre1[1]*OrthY + WireCentre1[2]*OrthZ;
          fFirstWireProj[cs][TPCCount][PlaneCount] /= ThisWirePitch;

          // now to count up wires in each plane and get first channel in each plane
          int WiresThisPlane = plane.Nwires();
          fWiresPerPlane[cs] .at(TPCCount).push_back(WiresThisPlane);
          fPlaneBaselines[cs].at(TPCCount).push_back(RunningTotal);

          RunningTotal += WiresThisPlane;

          fFirstChannelInThisPlane[cs].at(TPCCount).push_back(fTopChannel);
          fTopChannel += WiresThisPlane;
          fFirstChannelInNextPlane[cs].at(TPCCount).push_back(fTopChannel);

        }// end loop over planes
      }// end loop over TPCs
    }// end loop over cryostats

    // calculate the total number of channels in the detector
    fNchannels = fTopChannel;

    MF_LOG_DEBUG("ChannelMapStandard") << "# of channels is " << fNchannels;


    return;
  }

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 387 of file ChannelMapStandardAlg.cxx.

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

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

private

Returns the largest number of TPCs in a single cryostat.

Definition at line 369 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 329 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 186 of file ChannelMapStandardAlg.cxx.

  {
    return fNchannels;
  }

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

overridevirtual

Returns the number of channels in the specified ROP.

Returns

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

Implements geo::ChannelMapAlg.

Definition at line 193 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Parameters

worldPos	position to be tested
planeID	plane containing the wire

Returns

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

Exceptions

InvalidWireIDError

the ID found is not present in the detector

See also

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

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

Reimplemented from geo::ChannelMapAlg.

Definition at line 216 of file ChannelMapStandardAlg.cxx.

  {

    // This part is the actual calculation of the nearest wire number, where we assume
    //  uniform wire pitch and angle within a wireplane

    // add 0.5 to have the correct rounding
    int NearestWireNumber = int
      (0.5 + WireCoordinate(worldPos.Y(), worldPos.Z(), planeID));

    // If we are outside of the wireplane range, throw an exception
    // (this response maintains consistency with the previous
    // implementation based on geometry lookup)
    if(NearestWireNumber < 0 ||
       (unsigned int) NearestWireNumber >= WireCount(planeID))
    {
      int wireNumber = NearestWireNumber; // save for the output

      if(NearestWireNumber < 0 ) NearestWireNumber = 0;
      else                       NearestWireNumber = WireCount(planeID) - 1;

      throw InvalidWireIDError("Geometry", wireNumber, NearestWireNumber)
        << "Can't Find Nearest Wire for position ("
        << worldPos[0] << "," << worldPos[1] << "," << worldPos[2] << ")"
        << " in plane " << std::string(planeID) << " approx wire number # "
        << wireNumber << " (capped from " << NearestWireNumber << ")\n";
    }

    return geo::WireID(planeID, (geo::WireID::WireID_t) NearestWireNumber);
  }

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

inlineoverridevirtual

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

Parameters

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

Returns

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

See also

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

Deprecated:

Use the version with geo::PlaneID instead

Implements geo::ChannelMapAlg.

Definition at line 50 of file ChannelMapStandardAlg.h.

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

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

overridevirtual

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

Parameters

tpcsetid

TPC set ID

Returns

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

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

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

Implements geo::ChannelMapAlg.

Definition at line 379 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Parameters

cryoid

cryostat ID

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 320 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Implements geo::ChannelMapAlg.

Definition at line 312 of file ChannelMapStandardAlg.cxx.

  {
    return fPlaneIDs;
  }

raw::ChannelID_t geo::ChannelMapStandardAlg::PlaneWireToChannel ( geo::WireID const &  wireID ) const

overridevirtual

Returns the channel ID a wire is connected to.

Parameters

wireID

ID of the wire

Returns

the ID of the channel

See also

PlaneWireToChannel(geo::WireID const&)

Behaviour on an invalid or not present wires is undefined.

Deprecated:

Use the version with geo::WireID

Reimplemented from geo::ChannelMapAlg.

Definition at line 261 of file ChannelMapStandardAlg.cxx.

  {
    unsigned int const* pBaseLine = GetElementPtr(fPlaneBaselines, wireID);
    // This is the actual lookup part - first make sure coordinates are legal
    if (pBaseLine) {
      // if the channel has legal coordinates, its ID is given by the wire
      // number above the number of wires in lower planes, tpcs and cryostats
      return *pBaseLine + wireID.Wire;
    }
    else{
      // if the coordinates were bad, throw an exception
      throw cet::exception("ChannelMapStandardAlg")
        << "NO CHANNEL FOUND for " << std::string(wireID);
    }

    // made it here, that shouldn't happen, return raw::InvalidChannelID
    mf::LogWarning("ChannelMapStandardAlg") << "should not be at the point in the function, returning "
                                            << "invalid channel";
    return raw::InvalidChannelID;

  }

virtual raw::ChannelID_t geo::ChannelMapStandardAlg::PlaneWireToChannel ( unsigned int  plane, unsigned int  wire, unsigned int  tpc, unsigned int  cstat  ) const

inlineoverridevirtual

Returns the channel ID a wire is connected to.

Parameters

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

Returns

the ID of the channel

See also

PlaneWireToChannel(geo::WireID const&)

Deprecated:

Use the version with geo::WireID

Implements geo::ChannelMapAlg.

Definition at line 60 of file ChannelMapStandardAlg.h.

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

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

overridevirtual

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

Parameters

ropid

ID of the readout plane

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 422 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Parameters

ropid

ID of the readout plane to convert into wire planes

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 412 of file ChannelMapStandardAlg.cxx.

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

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

overrideprivatevirtual

Return the signal type of the specified channel.

Parameters

channel

ID of the channel

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 285 of file ChannelMapStandardAlg.cxx.

  {

    // still assume one cryostat for now -- faster
    unsigned int nChanPerTPC = fNchannels/fNTPC[0];
    // casting wil trunc towards 0 -- faster than floor
    unsigned int tpc = channel / nChanPerTPC;
    //need number of planes to know Collection
    unsigned int PlanesThisTPC = fNPlanes[0][tpc];



    SigType_t sigt = geo::kMysteryType;
    if(      (channel >= fFirstChannelInThisPlane[0][tpc][0]) &&
             (channel <  fFirstChannelInNextPlane[0][tpc][PlanesThisTPC-2])    ){ sigt = geo::kInduction; }
    else if( (channel >= fFirstChannelInThisPlane[0][tpc][PlanesThisTPC-1]) &&
             (channel <  fFirstChannelInNextPlane[0][tpc][PlanesThisTPC-1])    ){ sigt = geo::kCollection; }
    else
      mf::LogWarning("BadChannelSignalType") << "Channel " << channel
                                             << " not given signal type." << std::endl;


    return sigt;
  }

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

inlineoverridevirtual

Return the sorter.

Implements geo::ChannelMapAlg.

Definition at line 228 of file ChannelMapStandardAlg.h.

      { return fSorter; }

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

overridevirtual

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

Parameters

tpcsetid

ID of the TPC set to convert into TPC IDs

Returns

the list of TPCs, empty if TPC set is invalid

In this mapping, TPC sets and TPCs are mapped one-to-one. The returned list contains always one entry, unless the specified TPC set ID is invalid, in which case the list is empty. Note that the check is performed on the validity of the TPC set ID, that does not necessarily imply that the TPC set specified by the ID actually exists. Check the existence of the TPC set first (HasTPCset()). Behaviour on valid, non-existent TPC set IDs is undefined.

Implements geo::ChannelMapAlg.

Definition at line 352 of file ChannelMapStandardAlg.cxx.

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

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

overridevirtual

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

Parameters

tpcid

ID of the TPC

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 344 of file ChannelMapStandardAlg.cxx.

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

void geo::ChannelMapStandardAlg::Uninitialize ( )

overridevirtual

Deconfiguration: prepare for a following call of Initialize()

Implements geo::ChannelMapAlg.

Definition at line 141 of file ChannelMapStandardAlg.cxx.

  {
  }

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

overridevirtual

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

Parameters

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

Returns

an index interpolation between the two nearest wires

See also

NearestWireID()

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

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

Reimplemented from geo::ChannelMapAlg.

Definition at line 203 of file ChannelMapStandardAlg.cxx.

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

virtual double geo::ChannelMapStandardAlg::WireCoordinate ( double  YPos, double  ZPos, unsigned int  PlaneNo, unsigned int  TPCNo, unsigned int  cstat  ) const

inlineoverridevirtual

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

Parameters

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

Returns

an index interpolation between the two nearest wires

See also

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

Deprecated:

Use the version with geo::PlaneID instead

Implements geo::ChannelMapAlg.

Definition at line 40 of file ChannelMapStandardAlg.h.

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

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

inlineprivate

Retrieved the wire cound for the specified plane ID.

Definition at line 261 of file ChannelMapStandardAlg.h.

      { return AccessElement(fWireCounts, id); }

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

overridevirtual

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

Parameters

planeid

ID of the plane

Returns

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

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

Implements geo::ChannelMapAlg.

Definition at line 404 of file ChannelMapStandardAlg.cxx.

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

Member Data Documentation

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fFirstWireProj

private

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

Definition at line 239 of file ChannelMapStandardAlg.h.

unsigned int geo::ChannelMapStandardAlg::fNchannels

private

number of channels in the detector

Definition at line 234 of file ChannelMapStandardAlg.h.

unsigned int geo::ChannelMapStandardAlg::fNcryostat

private

number of cryostats in the detector

Definition at line 233 of file ChannelMapStandardAlg.h.

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

private

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

Definition at line 247 of file ChannelMapStandardAlg.h.

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

private

number of TPCs in each cryostat

Definition at line 236 of file ChannelMapStandardAlg.h.

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fOrthVectorsY

private

Unit vectors orthogonal to wires in.

Definition at line 241 of file ChannelMapStandardAlg.h.

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fOrthVectorsZ

private

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

Definition at line 242 of file ChannelMapStandardAlg.h.

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

private

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

Definition at line 249 of file ChannelMapStandardAlg.h.

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

private

vector of the PlaneIDs present in the detector

Definition at line 238 of file ChannelMapStandardAlg.h.

geo::GeoObjectSorterStandard geo::ChannelMapStandardAlg::fSorter

private

class to sort geo objects

Definition at line 255 of file ChannelMapStandardAlg.h.

raw::ChannelID_t geo::ChannelMapStandardAlg::fTopChannel

private

book keeping highest channel #

Definition at line 235 of file ChannelMapStandardAlg.h.

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

private

vector of the views present in the detector

Definition at line 237 of file ChannelMapStandardAlg.h.

PlaneInfoMap_t<float> geo::ChannelMapStandardAlg::fWireCounts

private

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

Definition at line 245 of file ChannelMapStandardAlg.h.

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

private

The number of wires in this plane in the heirachy

Definition at line 252 of file ChannelMapStandardAlg.h.

---

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

• larcorealg/larcorealg/Geometry/ChannelMapStandardAlg.h
• larcorealg/larcorealg/Geometry/ChannelMapStandardAlg.cxx