DetectorSearcher.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/DllConfig.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidGeometry/Objects/InstrumentRayTracer.h"
#include "MantidKernel/NearestNeighbours.h"
#include "MantidKernel/V3D.h"
 
#include <Eigen/Core>
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL DetectorSearcher {
public:
  using DetectorSearchResult = std::tuple<bool, size_t>;
 
  DetectorSearcher(const Geometry::Instrument_const_sptr &instrument, const Geometry::DetectorInfo &detInfo);
  DetectorSearchResult findDetectorIndex(const Kernel::V3D &q);
 
private:
  DetectorSearchResult searchUsingInstrumentRayTracing(const Kernel::V3D &q);
  DetectorSearchResult searchUsingNearestNeighbours(const Kernel::V3D &q);
  std::tuple<bool, size_t>
  checkInteceptWithNeighbours(const Kernel::V3D &direction,
                              const Kernel::NearestNeighbours<3>::NearestNeighbourResults &neighbours) const;
  void createDetectorCache();
  Kernel::V3D convertQtoDirection(const Kernel::V3D &q) const;
  DetectorSearchResult handleTubeGap(const Kernel::V3D &detectorDir,
                                     const Kernel::NearestNeighbours<3>::NearestNeighbourResults &neighbours);
 
  // Instance variables
 
  const bool m_usingFullRayTrace;
  const double m_crystallography_convention;
  const Geometry::DetectorInfo &m_detInfo;
  Geometry::Instrument_const_sptr m_instrument;
  std::vector<size_t> m_indexMap;
  std::unique_ptr<Kernel::NearestNeighbours<3>> m_detectorCacheSearch;
  std::unique_ptr<Geometry::InstrumentRayTracer> m_rayTracer;
};
} // namespace API
} // namespace Mantid