A class to filter HKLs according to structure factor magnitudes. More...

#include <BasicHKLFilters.h>

Inheritance diagram for Mantid::Geometry::HKLFilterStructureFactor:

Public Member Functions
std::string	getDescription () const noexcept override
	Returns a description for the filter that contains the minimum F^2. More...

	HKLFilterStructureFactor (StructureFactorCalculator_sptr calculator, double fSquaredMin=1.0e-6)
	Constructor, throws exception if the calculator pointer is invalid. More...

bool	isAllowed (const Kernel::V3D &hkl) const noexcept override
	Returns true if F^2(hkl) is larger than the stored minimum. 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
StructureFactorCalculator_sptr	m_calculator

double	m_fSquaredMin

Detailed Description

A class to filter HKLs according to structure factor magnitudes.

This filter takes a StructureFactorCalculator and calculates the structure factor for each HKL. If F^2 is larger than the specified minimum, the reflection is considered allowed. The default minimum is 1e-6.

Definition at line 122 of file BasicHKLFilters.h.

Constructor & Destructor Documentation

◆ HKLFilterStructureFactor()

Mantid::Geometry::HKLFilterStructureFactor::HKLFilterStructureFactor	(	StructureFactorCalculator_sptr	calculator,
		double	fSquaredMin = `1.0e-6`
	)

Constructor, throws exception if the calculator pointer is invalid.

Definition at line 75 of file BasicHKLFilters.cpp.

References m_calculator.

Member Function Documentation

◆ getDescription()

std::string Mantid::Geometry::HKLFilterStructureFactor::getDescription ( ) const

overridevirtualnoexcept

Returns a description for the filter that contains the minimum F^2.

Implements Mantid::Geometry::HKLFilter.

Definition at line 83 of file BasicHKLFilters.cpp.

References m_fSquaredMin.

◆ isAllowed()

bool Mantid::Geometry::HKLFilterStructureFactor::isAllowed ( const Kernel::V3D & hkl ) const

overridevirtualnoexcept

Returns true if F^2(hkl) is larger than the stored minimum.

Implements Mantid::Geometry::HKLFilter.

Definition at line 91 of file BasicHKLFilters.cpp.

Member Data Documentation

◆ m_calculator

StructureFactorCalculator_sptr Mantid::Geometry::HKLFilterStructureFactor::m_calculator

protected

Definition at line 130 of file BasicHKLFilters.h.

Referenced by HKLFilterStructureFactor().

◆ m_fSquaredMin

double Mantid::Geometry::HKLFilterStructureFactor::m_fSquaredMin

protected

Definition at line 131 of file BasicHKLFilters.h.

Referenced by getDescription().

The documentation for this class was generated from the following files:

Framework/Geometry/inc/MantidGeometry/Crystal/BasicHKLFilters.h
Framework/Geometry/src/Crystal/BasicHKLFilters.cpp

Public Member Functions

Protected Attributes