geo::ChannelMapStandardTestAlg Class Reference

#include <ChannelMapStandardTestAlg.h>

Public Member Functions
	ChannelMapStandardTestAlg (fhicl::ParameterSet const &)
	Constructor: reads configuration, does nothing. More...
virtual	~ChannelMapStandardTestAlg ()=default
	Virtual destructor. More...
virtual void	Setup (geo::GeometryCore const &new_geo)
	Algorithm set up. More...
virtual unsigned int	Run ()
	Executes the test. More...
void	TPCsetMappingTest () const
	Tests TPCset mappings. More...
void	ROPMappingTest () const
	Tests ROP mappings. More...
void	ChannelMappingTest () const
	Tests channel mappings (very, very partial) More...

Protected Attributes
GeometryCore const *	geom = nullptr
	pointer to the geometry description More...

Detailed Description

Definition at line 22 of file ChannelMapStandardTestAlg.h.

Constructor & Destructor Documentation

geo::ChannelMapStandardTestAlg::ChannelMapStandardTestAlg ( fhicl::ParameterSet const &  )

inline

Constructor: reads configuration, does nothing.

Definition at line 26 of file ChannelMapStandardTestAlg.h.

{}

virtual geo::ChannelMapStandardTestAlg::~ChannelMapStandardTestAlg ( )

virtualdefault

Virtual destructor.

Member Function Documentation

void geo::ChannelMapStandardTestAlg::ChannelMappingTest

(

)

const

Tests channel mappings (very, very partial)

Definition at line 298 of file ChannelMapStandardTestAlg.cxx.

                                                            {

  /*
   * ChannelMapStandardAlg interface being tested (via GeometryCore):
   *
   *     unsigned int Nchannels() const
   *       (only called, not checked)
   *
   *     unsigned int HasChannel(raw::ChannelID_t) const
   *
   * The rest is not tested here.
   */

  // check for invalid input
  BOOST_TEST(!geom->HasChannel(raw::InvalidChannelID));

  //
  // channel-wide checks
  //
  unsigned int const NChannels = geom->Nchannels();
  for (unsigned int iChannel = 0; iChannel < NChannels; ++iChannel) {
    raw::ChannelID_t channel = (raw::ChannelID_t) iChannel;

    BOOST_TEST_MESSAGE("channel: " << channel);

    BOOST_TEST(geom->HasChannel(iChannel));

  } // for channels
  BOOST_TEST(!geom->HasChannel((raw::ChannelID_t) NChannels));

} // ChannelMapStandardTestAlg::ChannelMappingTest()

void geo::ChannelMapStandardTestAlg::ROPMappingTest

(

)

const

Tests ROP mappings.

Definition at line 182 of file ChannelMapStandardTestAlg.cxx.

                                                        {

  /*
   * ChannelMapStandardAlg interface to be tested (via GeometryCore):
   *
   *     unsigned int Nchannels(readout::ROPID const& ropid) const
   *
   *     readout::ROPID WirePlaneToROP(geo::PlaneID const& planeid) const
   *
   *     std::vector<geo::PlaneID> ROPtoWirePlanes
   *       (readout::ROPID const& ropid) const
   *
   *     std::vector<geo::TPCID> ROPtoTPCs(readout::ROPID const& ropid) const
   *
   *     readout::ROPID ChannelToROP(raw::ChannelID_t channel) const
   *
   *     raw::ChannelID_t FirstChannelInROP(readout::ROPID const& ropid) const
   *
   *     geo::PlaneID FirstWirePlaneInROP(readout::ROPID const& ropid) const
   *       can't do (not exposed!)
   *
   */

  // check for invalid input
  BOOST_TEST(geom->Nchannels({}) == 0U);
  BOOST_TEST(!geom->WirePlaneToROP({}).isValid);
  BOOST_TEST(geom->ROPtoWirePlanes({}).empty());
  BOOST_TEST(geom->ROPtoTPCs({}).empty());
  BOOST_TEST(!geom->ChannelToROP(raw::InvalidChannelID).isValid);
  BOOST_TEST(!raw::isValidChannelID(geom->FirstChannelInROP({})));

  //
  // TPC-wide checks
  //
  for (geo::TPCID const& tpcID: geom->IterateTPCIDs()) {
    BOOST_TEST_CHECKPOINT("TPC: " << std::string(tpcID));

    // build a non-existent ROP ID (but we pretend it valid)
    readout::TPCsetID const tpcsetID = geom->TPCtoTPCset(tpcID);
    unsigned int const NROPs = geom->NROPs(tpcsetID);
    readout::ROPID NonexistingROPID(tpcsetID, (readout::ROPID::ROPID_t) NROPs);

    // check that we don't have ROPs beyond the last one
    BOOST_TEST(!geom->HasROP(NonexistingROPID));
    // the behaviour of the other methods is undefined for non-existent ROPs
  //  BOOST_TEST(geom->ROPtoTPCs(NonexistingROPID).empty());
  //  BOOST_TEST(geom->ROPtoWirePlanes(NonexistingROPID).empty());
  //  BOOST_TEST(geom->Nchannels(NonexistingROPID) == 0U);
  //  BOOST_TEST
  //    (!raw::isValidChannelID(geom->FirstChannelInROP(NonexistingROPID)));

  } // for TPCs


  //
  // plane-wide checks
  //
  for (geo::PlaneID const& planeID: geom->IteratePlaneIDs()) {
    BOOST_TEST_MESSAGE("plane: " << std::string(planeID));

    // check that the ROP of this plane matches the plane itself
    readout::ROPID const ropID = geom->WirePlaneToROP(planeID);
    CheckMatchingPlaneLevelIDs(ropID, planeID);

    /*
    // ChannelMapStandardAlg::FirstWirePlaneInROP() is not accessible from
    // GeometryCore: this test is disabled
    // check that the first (and only) plane is the expected one
    BOOST_TEST(geom->FirstWirePlaneInROP(ropID) == planeID);
    */

    // check that there is only one plane in this ROP
    std::vector<geo::PlaneID> const PlanesInROP = geom->ROPtoWirePlanes(ropID);
    BOOST_TEST(PlanesInROP.size() == 1U);
    BOOST_TEST(PlanesInROP.front() == planeID);

    // check that the number of channels in the ROP matches the number of wires
    unsigned int const NChannels = geom->Nchannels(ropID);
    BOOST_TEST(NChannels == geom->Nwires(planeID));

    // check that the TPC is one, and the right one
    std::vector<geo::TPCID> const TPCs = geom->ROPtoTPCs(ropID);
    BOOST_TEST(TPCs.size() == 1U);
    BOOST_TEST(TPCs.front() == planeID.asTPCID());

    // check that the first channel is valid
    raw::ChannelID_t const FirstChannelID = geom->FirstChannelInROP(ropID);
    BOOST_TEST(raw::isValidChannelID(FirstChannelID) == ropID.isValid);

    // check all the channels:
    for (
      unsigned int iChannelInROP = 0; iChannelInROP < NChannels; ++iChannelInROP
    ) {
      raw::ChannelID_t const channelID = FirstChannelID + iChannelInROP;

      BOOST_TEST_CHECKPOINT("channel: " << channelID);

      // is it in the right plane? and only one?
      std::vector<geo::WireID> const ChannelWires
        = geom->ChannelToWire(channelID);
      BOOST_TEST(ChannelWires.size() == 1U);
      BOOST_TEST(ChannelWires.front() == planeID);

      // does the channel map back to the right ROP?
      readout::ROPID const ChannelROPID = geom->ChannelToROP(channelID);
      BOOST_TEST(ChannelROPID == ropID);

    } // for channels

  } // for planes


} // ChannelMapStandardTestAlg::ROPMappingTest()

unsigned int geo::ChannelMapStandardTestAlg::Run ( )

virtual

Executes the test.

Definition at line 51 of file ChannelMapStandardTestAlg.cxx.

                                               {
  // All the tests

  TPCsetMappingTest();
  ROPMappingTest();
  ChannelMappingTest();

  return 0;
} // ChannelMapStandardTestAlg::Run()

virtual void geo::ChannelMapStandardTestAlg::Setup ( geo::GeometryCore const &  new_geo )

inlinevirtual

Algorithm set up.

Definition at line 32 of file ChannelMapStandardTestAlg.h.

{ geom = &new_geo; }

void geo::ChannelMapStandardTestAlg::TPCsetMappingTest

(

)

const

Tests TPCset mappings.

Definition at line 64 of file ChannelMapStandardTestAlg.cxx.

                                                           {

  /*
   * ChannelMapStandardAlg interface to be tested (via GeometryCore):
   *
   *     unsigned int NTPCsets(readout::CryostatID const& cryoid) const
   *
   *     unsigned int MaxTPCsets() const
   *
   *     bool HasTPCset(readout::TPCsetID const& tpcsetid) const
   *
   *     readout::TPCsetID TPCtoTPCset(geo::TPCID const& tpcid) const
   *
   *     std::vector<geo::TPCID> TPCsetToTPCs
   *       (readout::TPCsetID const& tpcsetid) const
   *
   *     geo::TPCID FirstTPCinTPCset(readout::TPCsetID const& tpcsetid) const
   *       can't do (not exposed!)
   *
   *     unsigned int NROPs(readout::TPCsetID const& tpcsetid) const
   *
   *     unsigned int MaxROPs() const
   *
   *     bool HasROP(readout::ROPID const& ropid) const
   *       (invalid input is checked in ROPMappingTest())
   *
   *     std::vector<geo::TPCID> ROPtoTPCs(readout::ROPID const& ropid) const
   *
   */

  // check for invalid input
  BOOST_TEST(geom->NTPCsets({}) == 0U);
  BOOST_TEST(!geom->HasTPCset({}));
  BOOST_TEST(!geom->TPCtoTPCset({}).isValid);
  BOOST_TEST(geom->TPCsetToTPCs({}).empty());
  BOOST_TEST(geom->NROPs({}) == 0U);
  BOOST_TEST(!geom->HasROP({}));
  BOOST_TEST(geom->ROPtoTPCs({}).empty());

  //
  // detector-wide checks
  //
  // check that the maximum size of TPC and TPC sets in the detector match
  BOOST_TEST(geom->MaxTPCsets() == geom->MaxTPCs());

  // check that the maximum size of planes and ROPs in the detector match
  BOOST_TEST(geom->MaxROPs() == geom->MaxPlanes());

  // check that we have no TPC set in cryostats after the last one
  readout::CryostatID const NonexistingCryostatID(geom->Ncryostats());
  BOOST_TEST(geom->NTPCsets(NonexistingCryostatID) == 0U);

  //
  // cryostat-wide checks
  //
  for (geo::CryostatID const& cryostatID: geom->IterateCryostatIDs()) {
    BOOST_TEST_CHECKPOINT("cryostat: " << std::string(cryostatID));

    readout::CryostatID const ROcryostatID
      = static_cast<readout::CryostatID const&>(cryostatID);

    // check that the number of TPC and TPC sets in each cryostat match
    unsigned int const NTPCsets = geom->NTPCsets(ROcryostatID);
    BOOST_TEST(NTPCsets == geom->NTPC(cryostatID));

    // check that we have no TPC set after the last one
    readout::TPCsetID const NonexistingTPCsetID
      (ROcryostatID, (readout::TPCsetID::TPCsetID_t) NTPCsets);
    BOOST_TEST(!geom->HasTPCset(NonexistingTPCsetID));
    BOOST_TEST(geom->NROPs(NonexistingTPCsetID) == 0U);
    // the behaviour of the other methods is undefined for non-existent ROPs
  //  BOOST_TEST(geom->TPCsetToTPCs(NonexistingTPCsetID).empty());

  } // for cryostats

  //
  // TPC-wide checks
  //
  for (geo::TPCID const& tpcID: geom->IterateTPCIDs()) {
    BOOST_TEST_CHECKPOINT("TPC: " << std::string(tpcID));

    // check that the IDs of this TPC and of the TPC set including it match
    readout::TPCsetID const tpcsetID = geom->TPCtoTPCset(tpcID);
    CheckMatchingTPClevelIDs(tpcsetID, tpcID);

    // check that this TPC set maps to only one (and the right one) TPC
    std::vector<geo::TPCID> TPCs = geom->TPCsetToTPCs(tpcsetID);
    BOOST_TEST(TPCs.size() == 1U);
    BOOST_TEST(TPCs.front() == tpcID);

    // check that the number of ROP in the TPC set matches the planes in the TPC
    unsigned int const NROPs = geom->NROPs(tpcsetID);
    BOOST_TEST(NROPs == geom->Nplanes(tpcID));

    // check all the ROPs:
    for (unsigned int iROPinTPCset = 0; iROPinTPCset < NROPs; ++iROPinTPCset) {
      readout::ROPID const ropID
        (tpcsetID, (readout::ROPID::ROPID_t) iROPinTPCset);

      BOOST_TEST_CHECKPOINT("ROP: " << std::string(ropID));

      // do we have it?
      BOOST_TEST(geom->HasROP(ropID));

      // is it in the right TPC? and only one?
      std::vector<geo::TPCID> TPCs = geom->ROPtoTPCs(ropID);
      BOOST_TEST(TPCs.size() == 1U);
      BOOST_TEST(TPCs.front() == tpcID);

    } // for channels

  } // for TPCs


} // ChannelMapStandardTestAlg::TPCsetMappingTest()

Member Data Documentation

GeometryCore const* geo::ChannelMapStandardTestAlg::geom = nullptr

protected

pointer to the geometry description

Definition at line 47 of file ChannelMapStandardTestAlg.h.

---

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

• ChannelMapStandardTestAlg.h
• ChannelMapStandardTestAlg.cxx