WorkspaceNearestNeighbours.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/IDTypes.h"
#include "MantidKernel/V3D.h"
#include <memory>
// Boost graphing
#ifndef Q_MOC_RUN
#define BOOST_ALLOW_DEPRECATED_HEADERS
#include <boost/graph/adjacency_list.hpp>
#undef BOOST_ALLOW_DEPRECATED_HEADERS
#include <unordered_map>
#endif
 
namespace Mantid {
namespace Geometry {
class Instrument;
class IDetector;
} // namespace Geometry
namespace API {
class SpectrumInfo;
class MANTID_API_DLL WorkspaceNearestNeighbours {
public:
  WorkspaceNearestNeighbours(int nNeighbours, const SpectrumInfo &spectrumInfo, std::vector<specnum_t> spectrumNumbers,
                             bool ignoreMaskedDetectors = false);
 
  // Neighbouring spectra by radius
  std::map<specnum_t, Mantid::Kernel::V3D> neighboursInRadius(specnum_t spectrum, double radius = 0.0) const;
 
  // Neighbouring spectra by
  std::map<specnum_t, Mantid::Kernel::V3D> neighbours(specnum_t spectrum) const;
 
protected:
  std::vector<size_t> getSpectraDetectors();
 
private:
  const SpectrumInfo &m_spectrumInfo;
  const std::vector<specnum_t> m_spectrumNumbers;
 
  using Graph =
      boost::adjacency_list<boost::vecS, boost::vecS, boost::directedS, boost::property<boost::vertex_name_t, int64_t>,
                            boost::property<boost::edge_name_t, Mantid::Kernel::V3D>>;
  using Vertex = boost::graph_traits<Graph>::vertex_descriptor;
  using MapIV = std::unordered_map<specnum_t, Vertex>;
 
  void build(const int noNeighbours);
  std::map<specnum_t, Mantid::Kernel::V3D> defaultNeighbours(const specnum_t spectrum) const;
  int m_noNeighbours;
  double m_cutoff;
  MapIV m_specToVertex;
  Graph m_graph;
  boost::property_map<Graph, boost::vertex_name_t>::type m_vertexID;
  boost::property_map<Graph, boost::edge_name_t>::type m_edgeLength;
  Kernel::V3D m_scale;
  mutable double m_radius;
  bool m_bIgnoreMaskedDetectors;
};
 
} // namespace API
} // namespace Mantid