A class to filter HKLs according to a space group. More...
#include <BasicHKLFilters.h>
Public Member Functions | |
| std::string | getDescription () const noexcept override |
| Returns a description of the filter that contains the space group symbol. More... | |
| HKLFilterSpaceGroup (SpaceGroup_const_sptr spaceGroup) | |
| Constructor, throws exception if the supplied pointer is invalid. More... | |
| bool | isAllowed (const Kernel::V3D &hkl) const noexcept override |
| Returns true if the reflection is allowed by the space group reflection conditions. 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 | |
| SpaceGroup_const_sptr | m_spaceGroup |
Detailed Description
A class to filter HKLs according to a space group.
HKLFilterSpaceGroup stores a SpaceGroup object and marks those reflections as allowed that are allowed according to the reflection conditions of the space group.
Definition at line 103 of file BasicHKLFilters.h.
Constructor & Destructor Documentation
◆ HKLFilterSpaceGroup()
| Mantid::Geometry::HKLFilterSpaceGroup::HKLFilterSpaceGroup | ( | SpaceGroup_const_sptr | spaceGroup | ) |
Constructor, throws exception if the supplied pointer is invalid.
Definition at line 57 of file BasicHKLFilters.cpp.
References m_spaceGroup.
Member Function Documentation
◆ getDescription()
|
overridevirtualnoexcept |
Returns a description of the filter that contains the space group symbol.
Implements Mantid::Geometry::HKLFilter.
Definition at line 64 of file BasicHKLFilters.cpp.
References m_spaceGroup.
◆ isAllowed()
|
overridevirtualnoexcept |
Returns true if the reflection is allowed by the space group reflection conditions.
Implements Mantid::Geometry::HKLFilter.
Definition at line 70 of file BasicHKLFilters.cpp.
Member Data Documentation
◆ m_spaceGroup
|
protected |
Definition at line 111 of file BasicHKLFilters.h.
Referenced by getDescription(), and HKLFilterSpaceGroup().
The documentation for this class was generated from the following files:
- Framework/Geometry/inc/MantidGeometry/Crystal/BasicHKLFilters.h
- Framework/Geometry/src/Crystal/BasicHKLFilters.cpp
