Mantid
Loading...
Searching...
No Matches
PeaksInRegion.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2013 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10
11namespace Mantid {
12namespace Crystal {
13
17class MANTID_CRYSTAL_DLL PeaksInRegion : public PeaksIntersection {
18public:
19 const std::string name() const override;
21 const std::string summary() const override { return "Find peaks intersecting a box region."; }
22
23 int version() const override;
24 const std::vector<std::string> seeAlso() const override { return {"PeaksOnSurface"}; }
25 const std::string category() const override;
26
27private:
28 void init() override;
29 void exec() override;
30
31 // Overriden base class methods.
32 void validateExtentsInput() const override;
33 int numberOfFaces() const override;
34 VecVecV3D createFaces() const override;
35 bool pointOutsideAnyExtents(const Mantid::Kernel::V3D &testPoint) const override;
36 bool pointInsideAllExtents(const Mantid::Kernel::V3D &testPoint,
37 const Mantid::Kernel::V3D &peakCenter) const override;
38 void checkTouchPoint(const Mantid::Kernel::V3D &touchPoint, const Mantid::Kernel::V3D &normal,
39 const Mantid::Kernel::V3D &faceVertex) const override;
40
42 std::vector<double> m_extents;
43};
44
45} // namespace Crystal
46} // namespace Mantid
PeaksInRegion : Find peaks that are either inside a box region, or that have a radius of sufficent si...
Definition: PeaksInRegion.h:17
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: PeaksInRegion.h:24
std::vector< double > m_extents
Extents.
Definition: PeaksInRegion.h:42
const std::string summary() const override
Summary of algorithms purpose.
Definition: PeaksInRegion.h:21
PeaksIntersection : Abstract base algorithm class for algorithms that identify peaks interacting with...
Class for 3D vectors.
Definition: V3D.h:34
std::vector< VecV3D > VecVecV3D
Helper class which provides the Collimation Length for SANS instruments.