Mantid::Geometry::PeakTransformHKL Class Reference

Used to remap coordinates into a form consistent with an axis reordering. More...

#include <PeakTransformHKL.h>

Inheritance diagram for Mantid::Geometry::PeakTransformHKL:

Public Member Functions
PeakTransform_sptr	clone () const override
	Virtual constructor. More...
Mantid::Kernel::SpecialCoordinateSystem	getCoordinateSystem () const override
	Getter for the special coordinate representation of this transform type. More...
std::string	getFriendlyName () const override
	Getter for a friendly name to describe the transform type. More...
	PeakTransformHKL ()
	Constructor. More...
	PeakTransformHKL (const std::string &xPlotLabel, const std::string &yPlotLabel)
	Constructor. More...
Mantid::Kernel::V3D	transformPeak (const Mantid::Geometry::IPeak &peak) const override
	Transform peak. More...
Public Member Functions inherited from Mantid::Geometry::PeakTransform
virtual std::shared_ptr< PeakTransform >	clone () const =0
	Virtual constructor. More...
virtual Mantid::Kernel::SpecialCoordinateSystem	getCoordinateSystem () const =0
	Getter for the special coordinate representation of this transform type. More...
boost::regex	getFreePeakAxisRegex () const
	Get a regex to find the axis of the free peak. More...
virtual std::string	getFriendlyName () const =0
	Getter for a friendly name to describe the transform type. More...
	PeakTransform (std::string xPlotLabel, std::string yPlotLabel, const boost::regex &regexOne, const boost::regex &regexTwo, const boost::regex &regexThree)
virtual Mantid::Kernel::V3D	transform (const Mantid::Kernel::V3D &original) const
	Perform Transform. More...
Mantid::Kernel::V3D	transformBack (const Mantid::Kernel::V3D &transformed) const
	Perform reverse transform. More...
virtual Mantid::Kernel::V3D	transformPeak (const Mantid::Geometry::IPeak &peak) const =0
	Perform Transform. More...
virtual	~PeakTransform ()=default

Static Public Member Functions
static std::string	name ()

Additional Inherited Members
Protected Member Functions inherited from Mantid::Geometry::PeakTransform
	PeakTransform (const PeakTransform &)=default
Protected Attributes inherited from Mantid::Geometry::PeakTransform
boost::regex	m_FirstRegex
int	m_indexOfPeakX
int	m_indexOfPeakY
int	m_indexOfPeakZ
int	m_indexOfPlotX
int	m_indexOfPlotY
int	m_indexOfPlotZ
boost::regex	m_SecondRegex
boost::regex	m_ThirdRegex
std::string	m_xPlotLabel
std::string	m_yPlotLabel

Detailed Description

Used to remap coordinates into a form consistent with an axis reordering.

Definition at line 18 of file PeakTransformHKL.h.

Constructor & Destructor Documentation

PeakTransformHKL() [1/2]

Mantid::Geometry::PeakTransformHKL::PeakTransformHKL

(

)

Constructor.

Definition at line 14 of file PeakTransformHKL.cpp.

PeakTransformHKL() [2/2]

Mantid::Geometry::PeakTransformHKL::PeakTransformHKL	(	const std::string &	xPlotLabel,
		const std::string &	yPlotLabel
	)

Constructor.

Definition at line 18 of file PeakTransformHKL.cpp.

Member Function Documentation

clone()

PeakTransform_sptr Mantid::Geometry::PeakTransformHKL::clone ( ) const

overridevirtual

Virtual constructor.

Clone the PeakTransformHKL.

Implements Mantid::Geometry::PeakTransform.

Definition at line 25 of file PeakTransformHKL.cpp.

getCoordinateSystem()

Mantid::Kernel::SpecialCoordinateSystem Mantid::Geometry::PeakTransformHKL::getCoordinateSystem ( ) const

overridevirtual

Getter for the special coordinate representation of this transform type.

Returns

Special coordinate system associated with this type of transform.

Implements Mantid::Geometry::PeakTransform.

Definition at line 38 of file PeakTransformHKL.cpp.

References Mantid::Kernel::HKL.

getFriendlyName()

std::string Mantid::Geometry::PeakTransformHKL::getFriendlyName ( ) const

inlineoverridevirtual

Getter for a friendly name to describe the transform type.

Implements Mantid::Geometry::PeakTransform.

Definition at line 30 of file PeakTransformHKL.h.

name()

static std::string Mantid::Geometry::PeakTransformHKL::name ( )

inlinestatic

Definition at line 20 of file PeakTransformHKL.h.

transformPeak()

Mantid::Kernel::V3D Mantid::Geometry::PeakTransformHKL::transformPeak ( const Mantid::Geometry::IPeak &  peak ) const

overridevirtual

Transform peak.

Parameters

peak	: peak to transform according to internal mapping.

Returns

re-mapped coordinates.

Implements Mantid::Geometry::PeakTransform.

Definition at line 31 of file PeakTransformHKL.cpp.

References Mantid::Geometry::IPeak::getHKL(), and Mantid::Geometry::PeakTransform::transform().

---

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

• Framework/Geometry/inc/MantidGeometry/Crystal/PeakTransformHKL.h
• Framework/Geometry/src/Crystal/PeakTransformHKL.cpp