gar::geo::GeometryTestAlg Class Reference

Performs tests on the geometry as seen by Geometry service. More...

#include <GeometryTestAlg.h>

Public Member Functions
	GeometryTestAlg (fhicl::ParameterSet const &pset)
virtual	~GeometryTestAlg ()=default
	Virtual destructor. More...
virtual void	Setup (geo::GeometryCore const &new_geo)
	Runs the test. More...
virtual unsigned int	Run ()
	Runs the test, returns a number of errors (very unlikely!) More...

Private Member Functions
void	printChannelSummary ()
void	printVolBounds ()
void	printDetDim ()
void	printAllGeometry () const
void	testFindVolumes ()
void	testNearestChannel ()
void	testStepping ()
bool	shouldRunTests (std::string test_name) const
unsigned int	testFindWorldVolumes ()
unsigned int	testFindTPCvolumePaths ()

Private Attributes
gar::geo::GeometryCore const *	geom
	pointer to geometry service provider More...
std::set< std::string >	fNonFatalExceptions
testing::NameSelector	fRunTests
	test filter More...

Detailed Description

Performs tests on the geometry as seen by Geometry service.

---

Configuration parameters

• ForgiveExceptions (list of strings, default: empty): the categories of exceptions in this list are "forgiven" (non-fatal)
• RunTests (string list): marks which tests to run; each entry can be specified with a "+" or "-" prepended, to indicate to add or to remove the test from the set to be run, respectively. The directives act against a pre-existing default set that executes all tests, except the ones explicitly marked as excluded by default in the list below:
  • CheckOverlaps (not in default) perform overlap checks
  • ThoroughCheck (not in default) makes ROOT perform full geometry check
  • FindVolumes: checks it can find the volumes corresponding to world
  • NearestChannel:
  • default: represents the default set (optionally prepended by '@')
  • ! (special): means to forget the tests configured so far; used as the first test name, removes the default list but leaves unchanged the default behaviour (the one specified with "+*" or "-*")
• CheckForOverlaps (boolean, default: false): equivalent to enabling +CheckOverlaps in RunTests

Definition at line 64 of file GeometryTestAlg.h.

Constructor & Destructor Documentation

gar::geo::GeometryTestAlg::GeometryTestAlg ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 131 of file GeometryTestAlg.cxx.

    : geom(nullptr)
    {
      // initialize the list of non-fatal exceptions
      std::vector<std::string> NonFatalErrors(pset.get<std::vector<std::string>>
                                              ("ForgiveExceptions", std::vector<std::string>()));
      std::copy(NonFatalErrors.begin(), NonFatalErrors.end(),
                std::inserter(fNonFatalExceptions, fNonFatalExceptions.end()));

      // initialize the list of tests to be run
      //
      // our name selector accepts everything by default;
      // the default set skips the following:
      fRunTests.AddToDefinition("default",
                                "-CheckOverlaps",
                                "-ThoroughCheck");

      fRunTests.ParseNames("@default"); // let's start from default

      // read and parse the test list from the configuration parameters (if any)
      fRunTests.Parse(pset.get<std::vector<std::string>>("RunTests", {}));

      std::ostringstream sstr;
      fRunTests.PrintConfiguration(sstr);

      MF_LOG_INFO("GeometryTestAlg") << "Test selection:" << sstr.str();

    } // GeometryTestAlg::GeometryTestAlg()

virtual gar::geo::GeometryTestAlg::~GeometryTestAlg ( )

virtualdefault

Virtual destructor.

Member Function Documentation

void gar::geo::GeometryTestAlg::printAllGeometry ( ) const

private

Definition at line 295 of file GeometryTestAlg.cxx.

                                                 {
      MF_LOG_VERBATIM("GeometryTest")
      << "Detector " << geom->DetectorName();
    } // GeometryTestAlg::printAllGeometry()

void gar::geo::GeometryTestAlg::printChannelSummary ( )

private

Definition at line 261 of file GeometryTestAlg.cxx.

    {
      uint32_t channels = geom->NChannels();
      MF_LOG_VERBATIM("GeometryTest")
      << "there are "
      << channels
      << " channels";

      return;
    }

void gar::geo::GeometryTestAlg::printDetDim ( )

private

Definition at line 274 of file GeometryTestAlg.cxx.

    {
      MF_LOG_VERBATIM("GeometryTest")
      << "  TPC:    radius: "
      << geom->TPCRadius()
      << "    length: "
      << geom->TPCLength();

      TVector3 origin(0., 0., 0.);
      TVector3 outside(1.e6, 1.e6, 1.e6);

      MF_LOG_VERBATIM("GeometryTest")
      << "test check of point in world: \n(0, 0, 0) is in volume "
      << geom->VolumeName(origin)
      << "\n (1e6, 1e6, 1e6) is in volume "
      << geom->VolumeName(outside);

      return;
    }

void gar::geo::GeometryTestAlg::printVolBounds ( )

private

unsigned int gar::geo::GeometryTestAlg::Run ( )

virtual

Runs the test, returns a number of errors (very unlikely!)

Definition at line 161 of file GeometryTestAlg.cxx.

    {

      if (!geom) {
        throw cet::exception("GeometryTestAlg")
        << "GeometryTestAlg not configured: no valid geometry provided.\n";
      }

      unsigned int nErrors = 0; // currently unused

      // change the printed version number when changing the "GeometryTest" output
      MF_LOG_VERBATIM("GeometryTest")
      << "GeometryTest version 1.0";

      MF_LOG_VERBATIM("GeometryTest")
      << "\tRunning on detector: '"
      << geom->DetectorName()
      << "'"
      << "\n\tGeometry file: "
      << geom->ROOTFile();

      try{
        if (shouldRunTests("CheckOverlaps")) {
          MF_LOG_INFO("GeometryTest") << "test for overlaps ...";
          gGeoManager->CheckOverlaps(1e-5);
          gGeoManager->PrintOverlaps();
          if (!gGeoManager->GetListOfOverlaps()->IsEmpty()) {
            mf::LogError("GeometryTest")
            << gGeoManager->GetListOfOverlaps()->GetSize()
            << " overlaps found in geometry during overlap test!";
            ++nErrors;
          }
          MF_LOG_INFO("GeometryTest") << "complete.";
        }

        if (shouldRunTests("ThoroughCheck")) {
          MF_LOG_INFO("GeometryTest") << "thorough geometry test ...";
          gGeoManager->CheckGeometryFull();
          if (!gGeoManager->GetListOfOverlaps()->IsEmpty()) {
            mf::LogError("GeometryTest")
            << gGeoManager->GetListOfOverlaps()->GetSize()
            << " overlaps found in geometry during thorough test!";
            ++nErrors;
          }
          MF_LOG_INFO("GeometryTest") << "complete.";
        }

        if (shouldRunTests("FindVolumes")) {
          MF_LOG_INFO("GeometryTest") << "test FindAllVolumes method ...";
          testFindVolumes();
          MF_LOG_INFO("GeometryTest") << "complete.";
        }

        if (shouldRunTests("NearestWire")) {
          MF_LOG_INFO("GeometryTest") << "testNearestChannel...";
          testNearestChannel();
          MF_LOG_INFO("GeometryTest") << "complete.";
        }

        if (shouldRunTests("Stepping")) {
          MF_LOG_INFO("GeometryTest") << "testStepping...";
          testStepping();
          MF_LOG_INFO("GeometryTest") << "complete.";
        }

      }
      catch (cet::exception &e) {
        mf::LogWarning("GeometryTest") << "exception caught: \n" << e;
        if (fNonFatalExceptions.count(e.category()) == 0) throw;
      }

      std::ostringstream out;
      if (!fRunTests.CheckQueryRegistry(out)) {
        throw cet::exception("GeometryTest")
        << "(postumous) configuration error detected!\n"
        << out.rdbuf();
      }

      mf::LogInfo log("GeometryTest");
      log << "Tests completed:";
      auto tests_run = fRunTests.AcceptedNames();
      if (tests_run.empty()) {
        log << "\n  no test run";
      }
      else {
        log << "\n  " << tests_run.size() << " tests run:\t ";
        for (std::string const& test_name: tests_run) log << " " << test_name;
      }
      auto tests_skipped = fRunTests.RejectedNames();
      if (!tests_skipped.empty()) {
        log << "\n  " << tests_skipped.size() << " tests skipped:\t ";
        for (std::string const& test_name: tests_skipped) log << " " << test_name;
      }

      return nErrors;
    } // GeometryTestAlg::Run()

virtual void gar::geo::GeometryTestAlg::Setup ( geo::GeometryCore const &  new_geo )

inlinevirtual

Runs the test.

Definition at line 72 of file GeometryTestAlg.h.

{ geom = &new_geo; }

bool gar::geo::GeometryTestAlg::shouldRunTests ( std::string  test_name ) const

inlineprivate

Definition at line 530 of file GeometryTestAlg.cxx.

                                                                         {
      return fRunTests(test_name);
    } // GeometryTestAlg::shouldRunTests()

unsigned int gar::geo::GeometryTestAlg::testFindTPCvolumePaths ( )

private

Definition at line 336 of file GeometryTestAlg.cxx.

                                                         {

      unsigned int nErrors = 0;

      // search the full path of all TPCs
      std::set<std::string> volume_names({"volTPC"});
      std::vector<std::vector<TGeoNode const*>> node_paths = geom->FindAllVolumePaths(volume_names);

      mf::LogVerbatim log("GeometryTest");
      log
      << "Found "
      << node_paths.size()
      << " TPC volumes:";
      for (auto const& path: node_paths) {
        TGeoNode const* node = path.back();
        TGeoVolume const* pVolume = node->GetVolume();
        log << "\n - '" << pVolume->GetName() << "' (a "
        << pVolume->GetShape()->GetName() << ") with " << (path.size()-1)
        << " ancestors";
        for (TGeoNode const* pNode: path) {
          TGeoVolume const* pVolume_loc = pNode->GetVolume();
          log << "\n      * '" << pVolume_loc->GetName() << "' (a "
          << pVolume_loc->GetShape()->GetName() << ") with a "
          << pNode->GetMatrix()->IsA()->GetName() << " that "
          << (pNode->GetMatrix()->IsTranslation()? "is": "is not")
          << " a simple translation";
        } // for node
      } // for path

      return nErrors;
    } // GeometryTestAlg::testFindTPCvolumePaths()

void gar::geo::GeometryTestAlg::testFindVolumes ( )

private

Definition at line 369 of file GeometryTestAlg.cxx.

                                          {
      /*
       * Finds and checks a selected number of volumes by name:
       * - world volume
       * - cryostat volumes
       * - TPCs (returns full paths)
       */

      unsigned int nErrors = 0;

      nErrors += testFindWorldVolumes();
      nErrors += testFindTPCvolumePaths();

      if (nErrors != 0) {
        throw cet::exception("FindVolumes")
        << "Collected " << nErrors << " errors during FindAllVolumes() test!\n";
      }

    } // GeometryTestAlg::testFindVolumes()

unsigned int gar::geo::GeometryTestAlg::testFindWorldVolumes ( )

private

Definition at line 302 of file GeometryTestAlg.cxx.

                                                       {

      unsigned int nErrors = 0;

      std::set<std::string> volume_names;
      std::vector<TGeoNode const*> nodes;

      // world
      volume_names.insert(geom->GetWorldVolumeName());
      nodes = geom->FindAllVolumes(volume_names);
      {
        mf::LogVerbatim log("GeometryTest");
        log
        << "Found "
        << nodes.size()
        << " world volumes '"
        << geom->GetWorldVolumeName() << "':";
        for (TGeoNode const* node: nodes) {
          TGeoVolume const* pVolume = node->GetVolume();
          log << "\n - '" << pVolume->GetName() << "' (a "
          << pVolume->GetShape()->GetName() << ")";
        } // for
      } // anonymous block
      if (nodes.size() != 1) {
        ++nErrors;
        mf::LogError("GeometryTest")
        << "Found " << nodes.size() << " world volumes '"
        << geom->GetWorldVolumeName() << "! [expecting: one!!]";
      } // if nodes

      return nErrors;
    } // GeometryTestAlg::testFindWorldVolumes()

void gar::geo::GeometryTestAlg::testNearestChannel ( )

private

Definition at line 391 of file GeometryTestAlg.cxx.

    {
      // Even if you comment it out, please leave the TStopWatch code
      // in this code for additional testing. The NearestChannel routine
      // is the most frequently called in the simulation, so its execution time
      // is an important component of GArSoft's speed.
      //TStopwatch stopWatch;
      //stopWatch.Start();

      float posWorld[3] = {0.0,0.0,0.0};
      posWorld[1] = 0.5 * geom->TPCRadius();
      posWorld[2] = 0.5 * geom->TPCLength();

      try{

        MF_LOG_VERBATIM("GeometryTestAlg")
        << " find nearest channel to point ("
        << posWorld[0]
        << ", "
        << posWorld[1]
        << ", "
        << posWorld[2]
        << ")";

        // The float[] version tested here is used by the TVector3 version, so this test both.
        unsigned int nearest = geom->NearestChannel(posWorld);

        MF_LOG_VERBATIM("GeometryTestAlg")
        << "\t ...nearest channel to point: "
        << nearest;

        // We also want to test the std::vector<float> version
        std::array<float, 3> posWorldV;
        for (int i = 0; i < 3; ++i) posWorldV[i] = posWorld[i];

        nearest = geom->NearestChannel(posWorldV.data());

        MF_LOG_VERBATIM("GeometryTestAlg")
        << "\t ...nearest channel to point: "
        << nearest;

      }
      catch(cet::exception &e){
        mf::LogWarning("GeoTestCaughtException") << e;
        if (fNonFatalExceptions.count(e.category()) == 0) throw;
      }

      //stopWatch.Stop();
      MF_LOG_DEBUG("GeometryTest") << "\tdone testing nearest channel";
      //stopWatch.Print();

      // trigger an exception with NearestChannel
      MF_LOG_VERBATIM("GeometryTest")
      << "\tattempt to cause an exception to be caught "
      << "when looking for a nearest channel";

      // pick a position out of the world
      geom->WorldBox(nullptr, posWorld + 0,
                     nullptr, posWorld + 1,
                     nullptr, posWorld + 2);
      for (int i = 0; i < 3; ++i) posWorld[i] *= 2.;

      bool hasThrown = false;
      unsigned int nearest_to_what = 0;
      try{
        nearest_to_what = geom->NearestChannel(posWorld);
      }
      catch(const cet::exception& e){
        MF_LOG_WARNING("GeoTestCaughtException")
        << "caught execpetion: "
        << e;
        hasThrown = true;
      }

      if (!hasThrown) {
        MF_LOG_WARNING("GeoTestErrorNearestChannel")
        << "GeometryCore::NearestChannel() did not raise an exception on out-of-world position ("
        << posWorld[0]
        << "; "
        << posWorld[1]
        << "; "
        << posWorld[2]
        << "), and returned "
        << nearest_to_what
        << " instead.\n This is normally considered a failure.";
      }

      return;
    }

void gar::geo::GeometryTestAlg::testStepping ( )

private

Definition at line 482 of file GeometryTestAlg.cxx.

    {
      //
      // Test stepping.
      //
      double xyz[3]  = {0.};
      double dxyz[3] = {0., 0., 1.};


      MF_LOG_VERBATIM("GeometryTest")
      << "initial"
      << "\n\tposition:"  << xyz[0]  << "\t" << xyz[1]  << "\t" << xyz[2]
      << "\n\tdirection:" << dxyz[0] << "\t" << dxyz[1] << "\t" << dxyz[2];

      gGeoManager->InitTrack(xyz, dxyz);
      for (int i=0; i<10; ++i) {
        const double* pos = gGeoManager->GetCurrentPoint();
        const double* dir = gGeoManager->GetCurrentDirection();
        MF_LOG_VERBATIM("GeometryTest") << "\tnode = "
        << gGeoManager->GetCurrentNode()->GetName()
        << "\n\t\tpos=" << "\t"
        << pos[0] << "\t"
        << pos[1] << "\t"
        << pos[2]
        << "\n\t\tdir=" << "\t"
        << dir[0] << "\t"
        << dir[1] << "\t"
        << dir[2]
        << "\n\t\tmat = "
        << gGeoManager->GetCurrentNode()->GetVolume()->GetMaterial()->GetName();

        gGeoManager->FindNextBoundary();
        gGeoManager->FindNormal();
        gGeoManager->Step(kTRUE,kTRUE);
      }

      xyz[0] = 306.108; xyz[1] = -7.23775; xyz[2] = 856.757;
      gGeoManager->InitTrack(xyz, dxyz);
      MF_LOG_VERBATIM("GeometryTest") << "\tnode = "
      << gGeoManager->GetCurrentNode()->GetName()
      << "\n\tmat = "
      << gGeoManager->GetCurrentNode()->GetVolume()->GetMaterial()->GetName();

      gGeoManager->GetCurrentNode()->GetVolume()->GetMaterial()->Print();

    }

Member Data Documentation

std::set<std::string> gar::geo::GeometryTestAlg::fNonFatalExceptions

private

Definition at line 80 of file GeometryTestAlg.h.

testing::NameSelector gar::geo::GeometryTestAlg::fRunTests

private

test filter

Definition at line 83 of file GeometryTestAlg.h.

gar::geo::GeometryCore const* gar::geo::GeometryTestAlg::geom

private

pointer to geometry service provider

Definition at line 79 of file GeometryTestAlg.h.

---

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

• garsoft/test/Geometry/GeometryTestAlg.h
• garsoft/test/Geometry/GeometryTestAlg.cxx