Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mantid::Geometry::PeakTransform Class Referenceabstract

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

#include <PeakTransform.h>

Inheritance diagram for Mantid::Geometry::PeakTransform:
Mantid::Geometry::PeakTransformHKL Mantid::Geometry::PeakTransformQLab Mantid::Geometry::PeakTransformQSample

Public Member Functions

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
 

Protected Member Functions

 PeakTransform (const PeakTransform &)=default
 

Protected Attributes

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 21 of file PeakTransform.h.

Constructor & Destructor Documentation

◆ PeakTransform() [1/2]

Mantid::Geometry::PeakTransform::PeakTransform ( std::string  xPlotLabel,
std::string  yPlotLabel,
const boost::regex &  regexOne,
const boost::regex &  regexTwo,
const boost::regex &  regexThree 
)

Definition at line 12 of file PeakTransform.cpp.

References m_FirstRegex, m_indexOfPeakX, m_indexOfPeakY, m_indexOfPeakZ, m_indexOfPlotX, m_indexOfPlotY, m_indexOfPlotZ, m_SecondRegex, m_ThirdRegex, m_xPlotLabel, and m_yPlotLabel.

◆ ~PeakTransform()

virtual Mantid::Geometry::PeakTransform::~PeakTransform ( )
virtualdefault

◆ PeakTransform() [2/2]

Mantid::Geometry::PeakTransform::PeakTransform ( const PeakTransform &  )
protecteddefault

Member Function Documentation

◆ clone()

virtual std::shared_ptr< PeakTransform > Mantid::Geometry::PeakTransform::clone ( ) const
pure virtual

Virtual constructor.

Implemented in Mantid::Geometry::PeakTransformHKL, Mantid::Geometry::PeakTransformQLab, and Mantid::Geometry::PeakTransformQSample.

◆ getCoordinateSystem()

virtual Mantid::Kernel::SpecialCoordinateSystem Mantid::Geometry::PeakTransform::getCoordinateSystem ( ) const
pure virtual

Getter for the special coordinate representation of this transform type.

Implemented in Mantid::Geometry::PeakTransformHKL, Mantid::Geometry::PeakTransformQLab, and Mantid::Geometry::PeakTransformQSample.

◆ getFreePeakAxisRegex()

boost::regex Mantid::Geometry::PeakTransform::getFreePeakAxisRegex ( ) const

Get a regex to find the axis of the free peak.

Definition at line 83 of file PeakTransform.cpp.

References m_FirstRegex, m_indexOfPlotZ, m_SecondRegex, and m_ThirdRegex.

◆ getFriendlyName()

virtual std::string Mantid::Geometry::PeakTransform::getFriendlyName ( ) const
pure virtual

Getter for a friendly name to describe the transform type.

Implemented in Mantid::Geometry::PeakTransformHKL, Mantid::Geometry::PeakTransformQLab, and Mantid::Geometry::PeakTransformQSample.

◆ transform()

Mantid::Kernel::V3D Mantid::Geometry::PeakTransform::transform ( const Mantid::Kernel::V3D &  original) const
virtual

Perform Transform.

Definition at line 94 of file PeakTransform.cpp.

References m_indexOfPlotX, m_indexOfPlotY, m_indexOfPlotZ, Mantid::Kernel::V3D::setX(), Mantid::Kernel::V3D::setY(), and Mantid::Kernel::V3D::setZ().

Referenced by Mantid::Geometry::PeakTransformHKL::transformPeak(), Mantid::Geometry::PeakTransformQLab::transformPeak(), and Mantid::Geometry::PeakTransformQSample::transformPeak().

◆ transformBack()

Mantid::Kernel::V3D Mantid::Geometry::PeakTransform::transformBack ( const Mantid::Kernel::V3D &  transformed) const

Perform reverse transform.

Definition at line 103 of file PeakTransform.cpp.

References m_indexOfPeakX, m_indexOfPeakY, m_indexOfPeakZ, Mantid::Kernel::V3D::setX(), Mantid::Kernel::V3D::setY(), and Mantid::Kernel::V3D::setZ().

◆ transformPeak()

virtual Mantid::Kernel::V3D Mantid::Geometry::PeakTransform::transformPeak ( const Mantid::Geometry::IPeak &  peak) const
pure virtual

Perform Transform.

Implemented in Mantid::Geometry::PeakTransformHKL, Mantid::Geometry::PeakTransformQLab, and Mantid::Geometry::PeakTransformQSample.

Member Data Documentation

◆ m_FirstRegex

boost::regex Mantid::Geometry::PeakTransform::m_FirstRegex
protected

Definition at line 53 of file PeakTransform.h.

Referenced by getFreePeakAxisRegex(), and PeakTransform().

◆ m_indexOfPeakX

int Mantid::Geometry::PeakTransform::m_indexOfPeakX
protected

Definition at line 50 of file PeakTransform.h.

Referenced by PeakTransform(), and transformBack().

◆ m_indexOfPeakY

int Mantid::Geometry::PeakTransform::m_indexOfPeakY
protected

Definition at line 51 of file PeakTransform.h.

Referenced by PeakTransform(), and transformBack().

◆ m_indexOfPeakZ

int Mantid::Geometry::PeakTransform::m_indexOfPeakZ
protected

Definition at line 52 of file PeakTransform.h.

Referenced by PeakTransform(), and transformBack().

◆ m_indexOfPlotX

int Mantid::Geometry::PeakTransform::m_indexOfPlotX
protected

Definition at line 46 of file PeakTransform.h.

Referenced by PeakTransform(), and transform().

◆ m_indexOfPlotY

int Mantid::Geometry::PeakTransform::m_indexOfPlotY
protected

Definition at line 47 of file PeakTransform.h.

Referenced by PeakTransform(), and transform().

◆ m_indexOfPlotZ

int Mantid::Geometry::PeakTransform::m_indexOfPlotZ
protected

Definition at line 48 of file PeakTransform.h.

Referenced by getFreePeakAxisRegex(), PeakTransform(), and transform().

◆ m_SecondRegex

boost::regex Mantid::Geometry::PeakTransform::m_SecondRegex
protected

Definition at line 54 of file PeakTransform.h.

Referenced by getFreePeakAxisRegex(), and PeakTransform().

◆ m_ThirdRegex

boost::regex Mantid::Geometry::PeakTransform::m_ThirdRegex
protected

Definition at line 55 of file PeakTransform.h.

Referenced by getFreePeakAxisRegex(), and PeakTransform().

◆ m_xPlotLabel

std::string Mantid::Geometry::PeakTransform::m_xPlotLabel
protected

Definition at line 43 of file PeakTransform.h.

Referenced by PeakTransform().

◆ m_yPlotLabel

std::string Mantid::Geometry::PeakTransform::m_yPlotLabel
protected

Definition at line 44 of file PeakTransform.h.

Referenced by PeakTransform().

The documentation for this class was generated from the following files:
Generated on Tue Jan 3 2023 12:00:21 for Mantid by doxygen 1.9.5