PeaksIntersection.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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 "MantidCrystal/DllConfig.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
namespace Crystal {
 
using VecV3D = std::vector<Mantid::Kernel::V3D>;
using VecVecV3D = std::vector<VecV3D>;
 
class MANTID_CRYSTAL_DLL PeaksIntersection : public API::Algorithm {
public:
  static std::string detectorSpaceFrame();
  static std::string qLabFrame();
  static std::string qSampleFrame();
  static std::string hklFrame();
  virtual int numberOfFaces() const = 0;
 
protected:
  ~PeaksIntersection() = default;
  void initBaseProperties();
 
  void executePeaksIntersection(const bool checkPeakExtents = true);
 
  double getPeakRadius() const;
 
private:
  virtual void validateExtentsInput() const = 0;
  virtual VecVecV3D createFaces() const = 0;
  virtual bool pointOutsideAnyExtents(const Mantid::Kernel::V3D &testPoint) const = 0;
  virtual bool pointInsideAllExtents(const Mantid::Kernel::V3D &testPoints,
                                     const Mantid::Kernel::V3D &peakCenter) const = 0;
 
  virtual void checkTouchPoint(const Mantid::Kernel::V3D &touchPoint, const Mantid::Kernel::V3D &normal,
                               const Mantid::Kernel::V3D &faceVertex) const = 0;
 
  // The peak radius.
  double m_peakRadius = 0.0;
};
 
} // namespace Crystal
} // namespace Mantid