PeakShapeEllipsoid : PeakShape representing a 3D ellipsoid. More...

#include <PeakShapeEllipsoid.h>

Inheritance diagram for Mantid::DataObjects::PeakShapeEllipsoid:

Public Member Functions
const PeakEllipsoidExtent &	abcRadii () const
	Get radii.

const PeakEllipsoidExtent &	abcRadiiBackgroundInner () const
	Get background inner radii.

const PeakEllipsoidExtent &	abcRadiiBackgroundOuter () const
	Get background outer radii.

PeakShapeEllipsoid *	clone () const override
	Clone ellipsoid.

const PeakEllipsoidFrame &	directions () const
	Get ellipsoid directions.

PeakEllipsoidFrame	getDirectionInSpecificFrame (Kernel::Matrix< double > &invertedGoniometerMatrix) const
	Get ellipsoid directions in a specified frame.

bool	operator== (const PeakShapeEllipsoid &other) const
	Equals operator.

	PeakShapeEllipsoid (const PeakEllipsoidFrame &directions, const PeakEllipsoidExtent &abcRadii, const PeakEllipsoidExtent &abcRadiiBackgroundInner, const PeakEllipsoidExtent &abcRadiiBackgroundOuter, Kernel::SpecialCoordinateSystem frame, std::string algorithmName=std::string(), int algorithmVersion=-1, const Mantid::Kernel::V3D &translation={0.0, 0.0, 0.0})
	Constructor.

std::optional< double >	radius (RadiusType type=RadiusType::Radius) const override
	PeakBase interface.

std::string	shapeName () const override
	Get the peak shape.

std::string	toJSON () const override
	PeakShape interface.

const Kernel::V3D &	translation () const
	Get translation of center.

Public Member Functions inherited from Mantid::DataObjects::PeakShapeBase
std::string	algorithmName () const override
	Get the name of the algorithm used to make this shape.

int	algorithmVersion () const override
	Get the version of the algorithm used to make this shape.

Kernel::SpecialCoordinateSystem	frame () const override
	Get the coordinate frame.

	PeakShapeBase (Kernel::SpecialCoordinateSystem frame, std::string algorithmName=std::string(), int algorithmVersion=-1)
	Constructor.

Public Member Functions inherited from Mantid::Geometry::PeakShape
virtual	~PeakShape ()=default
	Destructor.

Static Public Member Functions
static const std::string	ellipsoidShapeName ()

Private Attributes
PeakEllipsoidExtent	m_abc_radii
	radii

PeakEllipsoidExtent	m_abc_radiiBackgroundInner
	inner radii

PeakEllipsoidExtent	m_abc_radiiBackgroundOuter
	outer radii

PeakEllipsoidFrame	m_directions
	principle axis

Mantid::Kernel::V3D	m_translation
	translation of center

Additional Inherited Members
Public Types inherited from Mantid::Geometry::PeakShape
enum	RadiusType { Radius = 0 , OuterRadius = 1 , InnerRadius = 2 }
	For selecting different radius types. More...

Protected Member Functions inherited from Mantid::DataObjects::PeakShapeBase
void	buildCommon (Json::Value &root) const
	Build common parts of outgoing JSON serialization.

PeakShapeBase &	operator= (const PeakShapeBase &)=default
	Assignment operator.

bool	operator== (const PeakShapeBase &other) const
	Equals operator.

	PeakShapeBase (const PeakShapeBase &)=default
	Copy constructor.

Protected Attributes inherited from Mantid::DataObjects::PeakShapeBase
std::string	m_algorithmName
	Generating algorithm name.

int	m_algorithmVersion
	Generating algorithm version.

Mantid::Kernel::SpecialCoordinateSystem	m_frame
	Special coordinate system.

Detailed Description

PeakShapeEllipsoid : PeakShape representing a 3D ellipsoid.

Definition at line 19 of file PeakShapeEllipsoid.h.

Constructor & Destructor Documentation

◆ PeakShapeEllipsoid()

Mantid::DataObjects::PeakShapeEllipsoid::PeakShapeEllipsoid	(	const PeakEllipsoidFrame &	directions,
		const PeakEllipsoidExtent &	abcRadii,
		const PeakEllipsoidExtent &	abcRadiiBackgroundInner,
		const PeakEllipsoidExtent &	abcRadiiBackgroundOuter,
		Kernel::SpecialCoordinateSystem	frame,
		std::string	algorithmName = `std::string()`,
		int	algorithmVersion = `-1`,
		const Mantid::Kernel::V3D &	translation = `{0.0, 0.0, 0.0}`
	)

Constructor.

Definition at line 16 of file PeakShapeEllipsoid.cpp.

Member Function Documentation

◆ abcRadii()

const PeakEllipsoidExtent & Mantid::DataObjects::PeakShapeEllipsoid::abcRadii ( ) const

Get radii.

Definition at line 32 of file PeakShapeEllipsoid.cpp.

References m_abc_radii.

Referenced by operator==().

◆ abcRadiiBackgroundInner()

const PeakEllipsoidExtent & Mantid::DataObjects::PeakShapeEllipsoid::abcRadiiBackgroundInner ( ) const

Get background inner radii.

Definition at line 34 of file PeakShapeEllipsoid.cpp.

References m_abc_radiiBackgroundInner.

Referenced by operator==().

◆ abcRadiiBackgroundOuter()

const PeakEllipsoidExtent & Mantid::DataObjects::PeakShapeEllipsoid::abcRadiiBackgroundOuter ( ) const

Get background outer radii.

Definition at line 36 of file PeakShapeEllipsoid.cpp.

References m_abc_radiiBackgroundOuter.

Referenced by operator==().

◆ clone()

PeakShapeEllipsoid * Mantid::DataObjects::PeakShapeEllipsoid::clone ( ) const

overridevirtual

Clone ellipsoid.

Implements Mantid::Geometry::PeakShape.

Definition at line 83 of file PeakShapeEllipsoid.cpp.

◆ directions()

const PeakEllipsoidFrame & Mantid::DataObjects::PeakShapeEllipsoid::directions ( ) const

Get ellipsoid directions.

Definition at line 38 of file PeakShapeEllipsoid.cpp.

References m_directions.

Referenced by operator==().

◆ ellipsoidShapeName()

const std::string Mantid::DataObjects::PeakShapeEllipsoid::ellipsoidShapeName ( )

static

Definition at line 104 of file PeakShapeEllipsoid.cpp.

Referenced by Mantid::DataObjects::PeakShapeEllipsoidFactory::create(), and shapeName().

◆ getDirectionInSpecificFrame()

PeakEllipsoidFrame Mantid::DataObjects::PeakShapeEllipsoid::getDirectionInSpecificFrame ( Kernel::Matrix< double > & invertedGoniometerMatrix ) const

Get ellipsoid directions in a specified frame.

Definition at line 43 of file PeakShapeEllipsoid.cpp.

References m_directions, Mantid::Kernel::Matrix< T >::numCols(), and Mantid::Kernel::Matrix< T >::numRows().

◆ operator==()

bool Mantid::DataObjects::PeakShapeEllipsoid::operator== ( const PeakShapeEllipsoid & other ) const

Equals operator.

Definition at line 25 of file PeakShapeEllipsoid.cpp.

References abcRadii(), abcRadiiBackgroundInner(), abcRadiiBackgroundOuter(), directions(), Mantid::DataObjects::PeakShapeBase::operator==(), and translation().

◆ radius()

std::optional< double > Mantid::DataObjects::PeakShapeEllipsoid::radius ( RadiusType type = RadiusType::Radius ) const

overridevirtual

PeakBase interface.

Implements Mantid::Geometry::PeakShape.

Definition at line 87 of file PeakShapeEllipsoid.cpp.

References Mantid::Geometry::PeakShape::InnerRadius, m_abc_radii, m_abc_radiiBackgroundInner, m_abc_radiiBackgroundOuter, Mantid::Geometry::PeakShape::OuterRadius, radius(), and Mantid::Geometry::PeakShape::Radius.

Referenced by radius().

◆ shapeName()

std::string Mantid::DataObjects::PeakShapeEllipsoid::shapeName ( ) const

overridevirtual

Get the peak shape.

Implements Mantid::Geometry::PeakShape.

Definition at line 85 of file PeakShapeEllipsoid.cpp.

References ellipsoidShapeName().

◆ toJSON()

std::string Mantid::DataObjects::PeakShapeEllipsoid::toJSON ( ) const

overridevirtual

PeakShape interface.

Implements Mantid::Geometry::PeakShape.

Definition at line 57 of file PeakShapeEllipsoid.cpp.

References Mantid::DataObjects::PeakShapeBase::buildCommon(), m_abc_radii, m_abc_radiiBackgroundInner, m_abc_radiiBackgroundOuter, m_directions, and m_translation.

◆ translation()

const Kernel::V3D & Mantid::DataObjects::PeakShapeEllipsoid::translation ( ) const

Get translation of center.

Definition at line 40 of file PeakShapeEllipsoid.cpp.

References m_translation.

Referenced by operator==().

Member Data Documentation

◆ m_abc_radii

PeakEllipsoidExtent Mantid::DataObjects::PeakShapeEllipsoid::m_abc_radii

private

radii

Definition at line 57 of file PeakShapeEllipsoid.h.

Referenced by abcRadii(), radius(), and toJSON().

◆ m_abc_radiiBackgroundInner

PeakEllipsoidExtent Mantid::DataObjects::PeakShapeEllipsoid::m_abc_radiiBackgroundInner

private

inner radii

Definition at line 59 of file PeakShapeEllipsoid.h.

Referenced by abcRadiiBackgroundInner(), radius(), and toJSON().

◆ m_abc_radiiBackgroundOuter

PeakEllipsoidExtent Mantid::DataObjects::PeakShapeEllipsoid::m_abc_radiiBackgroundOuter

private

outer radii

Definition at line 61 of file PeakShapeEllipsoid.h.

Referenced by abcRadiiBackgroundOuter(), radius(), and toJSON().

◆ m_directions

PeakEllipsoidFrame Mantid::DataObjects::PeakShapeEllipsoid::m_directions

private

principle axis

Definition at line 55 of file PeakShapeEllipsoid.h.

Referenced by directions(), getDirectionInSpecificFrame(), and toJSON().

◆ m_translation

Mantid::Kernel::V3D Mantid::DataObjects::PeakShapeEllipsoid::m_translation

private

translation of center

Definition at line 63 of file PeakShapeEllipsoid.h.

Referenced by toJSON(), and translation().

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

Framework/DataObjects/inc/MantidDataObjects/PeakShapeEllipsoid.h
Framework/DataObjects/src/PeakShapeEllipsoid.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeakShapeEllipsoid()

Member Function Documentation

◆ abcRadii()

◆ abcRadiiBackgroundInner()

◆ abcRadiiBackgroundOuter()

◆ clone()

◆ directions()

◆ ellipsoidShapeName()

◆ getDirectionInSpecificFrame()

◆ operator==()

◆ radius()

◆ shapeName()

◆ toJSON()

◆ translation()

Member Data Documentation

◆ m_abc_radii

◆ m_abc_radiiBackgroundInner

◆ m_abc_radiiBackgroundOuter

◆ m_directions

◆ m_translation