A class to filter HKLs according to a lattice centering. More...
#include <BasicHKLFilters.h>
Public Member Functions | |
| std::string | getDescription () const noexcept override |
| Returns a description with the centering symbol. More... | |
| HKLFilterCentering (ReflectionCondition_sptr centering) | |
| Constructor, throws exception if pointer is null. More... | |
| bool | isAllowed (const Kernel::V3D &hkl) const noexcept override |
| Returns true if the HKL is allowed according to the lattice centering. More... | |
 Public Member Functions inherited from Mantid::Geometry::HKLFilter | |
| std::function< bool(const Kernel::V3D &)> | fn () const noexcept |
| Returns a function object that wraps HKLFilter::isAllowed. More... | |
| virtual std::string | getDescription () const =0 |
| virtual bool | isAllowed (const Kernel::V3D &hkl) const =0 |
| virtual | ~HKLFilter ()=default |
Protected Attributes | |
| ReflectionCondition_sptr | m_centering |
Detailed Description
A class to filter HKLs according to a lattice centering.
HKLFilterCentering is a filter that stores a ReflectionCondition object internally and filters the HKLs according to that.
Definition at line 140 of file BasicHKLFilters.h.
Constructor & Destructor Documentation
◆ HKLFilterCentering()
| Mantid::Geometry::HKLFilterCentering::HKLFilterCentering | ( | ReflectionCondition_sptr | centering | ) |
Constructor, throws exception if pointer is null.
Definition at line 96 of file BasicHKLFilters.cpp.
References m_centering.
Member Function Documentation
◆ getDescription()
|
overridevirtualnoexcept |
Returns a description with the centering symbol.
Implements Mantid::Geometry::HKLFilter.
Definition at line 103 of file BasicHKLFilters.cpp.
References m_centering.
◆ isAllowed()
|
overridevirtualnoexcept |
Returns true if the HKL is allowed according to the lattice centering.
Implements Mantid::Geometry::HKLFilter.
Definition at line 108 of file BasicHKLFilters.cpp.
Member Data Documentation
◆ m_centering
|
protected |
Definition at line 148 of file BasicHKLFilters.h.
Referenced by getDescription(), and HKLFilterCentering().
The documentation for this class was generated from the following files:
- Framework/Geometry/inc/MantidGeometry/Crystal/BasicHKLFilters.h
- Framework/Geometry/src/Crystal/BasicHKLFilters.cpp
