SpatialGrouping.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/Algorithm.h"
#include "MantidAPI/WorkspaceNearestNeighbourInfo.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/V3D_fwd.h"
 
namespace Mantid {
namespace Geometry {
class IDetector;
class BoundingBox;
} // namespace Geometry
 
namespace Algorithms {
class MANTID_ALGORITHMS_DLL SpatialGrouping final : public API::Algorithm {
public:
  const std::string name() const override { return "SpatialGrouping"; }
  const std::string summary() const override {
    return "This algorithm creates an XML grouping file, which can be used in "
           "GroupDetectors or ReadGroupsFromFile, which groups the detectors "
           "of an instrument based on the distance between the detectors. It "
           "does this by querying the getNeighbours method on the Detector "
           "object.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"GroupDetectors"}; }
  const std::string category() const override { return "Transforms\\Grouping"; }
 
private:
  void init() override;
  void exec() override;
 
  bool expandNet(std::map<specnum_t, Mantid::Kernel::V3D> &nearest, specnum_t spec, const size_t noNeighbours,
                 const Mantid::Geometry::BoundingBox &bbox);
  void sortByDistance(std::map<specnum_t, Mantid::Kernel::V3D> &nearest, const size_t noNeighbours);
  void createBox(const Geometry::IDetector &det, Geometry::BoundingBox &bndbox, double searchDist);
  void growBox(double &min, double &max, const double factor);
 
  std::map<specnum_t, Kernel::V3D> m_positions;
  std::set<specnum_t> m_included;
  std::vector<std::vector<int>> m_groups;
 
  std::unique_ptr<API::WorkspaceNearestNeighbourInfo> m_neighbourInfo;
};
 
} // namespace Algorithms
} // namespace Mantid