d-SpacingPerpendicular in Angstrom More...

#include <Unit.h>

Inheritance diagram for Mantid::Kernel::Units::dSpacingPerpendicular:

Public Member Functions
const std::string	caption () const override
	The full name of the unit. More...

Unit *	clone () const override

double	conversionTOFMax () const override
	This function returns maximal TOF value still reversibly convertible into the unit. More...

double	conversionTOFMin () const override
	some units can be converted from TOF only in the range of TOF ; This function returns minimal TOF value still reversibly convertible into the unit. More...

	dSpacingPerpendicular ()
	Constructor. More...

void	init () override
	Finalize the initialization. More...

const UnitLabel	label () const override
	A label for the unit to be printed on axes,. More...

double	singleFromTOF (const double tof) const override
	Convert a single tof value to this unit. More...

double	singleToTOF (const double x) const override
	Convert a single X value to TOF. More...

const std::string	unitID () const override
	"dSpacingPerpendicular" More...

Public Member Functions inherited from Mantid::Kernel::Unit
virtual const std::string	caption () const =0
	The full name of the unit. More...

virtual Unit *	clone () const =0

virtual std::pair< double, double >	conversionRange () const
	The range where conversion to TOF from given units is monotonic and reversible. More...

virtual double	conversionTOFMax () const =0
	This function returns maximal TOF value still reversibly convertible into the unit. More...

virtual double	conversionTOFMin () const =0
	some units can be converted from TOF only in the range of TOF ; This function returns minimal TOF value still reversibly convertible into the unit. More...

double	convertSingleFromTOF (const double xvalue, const double &l1, const int &emode, const UnitParametersMap &params)
	Convert from the time-of-flight to the concrete unit. More...

double	convertSingleToTOF (const double xvalue, const double &l1, const int &emode, const UnitParametersMap &params)
	Convert from the concrete unit to time-of-flight. More...

void	fromTOF (std::vector< double > &xdata, std::vector< double > &ydata, const double &_l1, const int &_emode, const UnitParametersMap &params)

void	fromTOF (std::vector< double > &xdata, std::vector< double > &ydata, const double &_l1, const int &_emode, std::initializer_list< std::pair< const UnitParams, double > > params)
	Convert from time-of-flight to the concrete unit. More...

virtual void	init ()=0
	Finalize the initialization. More...

void	initialize (const double &_l1, const int &_emode, const UnitParametersMap &params)
	Initialize the unit to perform conversion using singleToTof() and singleFromTof() More...

virtual bool	isConvertible () const
	Returns if the unit can be used in conversions. More...

bool	isInitialized () const

virtual const UnitLabel	label () const =0
	A label for the unit to be printed on axes,. More...

bool	operator!= (const Unit &u) const

bool	operator== (const Unit &u) const

bool	quickConversion (const Unit &destination, double &factor, double &power) const
	Is conversion by constant multiplication possible? More...

bool	quickConversion (std::string destUnitName, double &factor, double &power) const
	Is conversion by constant multiplication possible? More...

virtual double	singleFromTOF (const double tof) const =0
	Convert a single tof value to this unit. More...

virtual double	singleToTOF (const double x) const =0
	Convert a single X value to TOF. More...

void	toTOF (std::vector< double > &xdata, std::vector< double > &ydata, const double &_l1, const int &_emode, const UnitParametersMap &params)

void	toTOF (std::vector< double > &xdata, std::vector< double > &ydata, const double &_l1, const int &_emode, std::initializer_list< std::pair< const UnitParams, double > > params)
	Convert from the concrete unit to time-of-flight. More...

	Unit ()
	(Empty) Constructor More...

virtual const std::string	unitID () const =0
	The name of the unit. More...

virtual	~Unit ()=default
	Virtual destructor. More...

Protected Member Functions
void	validateUnitParams (const int emode, const UnitParametersMap &params) override

Protected Member Functions inherited from Mantid::Kernel::Unit
void	addConversion (std::string to, const double &factor, const double &power=1.0) const
	Add a 'quick conversion' from the unit class on which this method is called. More...

virtual void	validateUnitParams (const int emode, const UnitParametersMap &params)

Protected Attributes
double	factorFrom
	Constant factor for from conversion. More...

double	factorTo
	Constant factor for to conversion. More...

double	sfpFrom
	Extra correction factor in to conversion. More...

double	sfpTo
	Extra correction factor in to conversion. More...

double	twoTheta

Protected Attributes inherited from Mantid::Kernel::Unit
int	emode
	emode :: The energy mode (0=elastic, 1=direct geometry, 2=indirect geometry) More...

bool	initialized
	The unit values have been initialized. More...

double	l1
	l1 :: The source-sample distance (in metres) More...

const UnitParametersMap *	m_params
	additional parameters l2 :: distance from sample to detector (in metres) twoTheta :: scattering angle in radians efixed :: Value of fixed energy: EI (emode=1) or EF (emode=2) (in meV) difc :: diffractometer constant DIFC More...

Detailed Description

d-SpacingPerpendicular in Angstrom

Definition at line 410 of file Unit.h.

Constructor & Destructor Documentation

◆ dSpacingPerpendicular()

Mantid::Kernel::Units::dSpacingPerpendicular::dSpacingPerpendicular ( )

Constructor.

Definition at line 778 of file Unit.cpp.

Referenced by clone().

Member Function Documentation

◆ caption()

const std::string Mantid::Kernel::Units::dSpacingPerpendicular::caption ( ) const

inlineoverridevirtual

The full name of the unit.

Returns: The unit caption

Implements Mantid::Kernel::Unit.

Definition at line 413 of file Unit.h.

◆ clone()

Unit * Mantid::Kernel::Units::dSpacingPerpendicular::clone ( ) const

overridevirtual

Returns: a cloned instance of the other

Implements Mantid::Kernel::Unit.

Definition at line 827 of file Unit.cpp.

References dSpacingPerpendicular().

◆ conversionTOFMax()

double Mantid::Kernel::Units::dSpacingPerpendicular::conversionTOFMax ( ) const

overridevirtual

This function returns maximal TOF value still reversibly convertible into the unit.

Implements Mantid::Kernel::Unit.

Definition at line 825 of file Unit.cpp.

References factorFrom.

◆ conversionTOFMin()

double Mantid::Kernel::Units::dSpacingPerpendicular::conversionTOFMin ( ) const

overridevirtual

some units can be converted from TOF only in the range of TOF ; This function returns minimal TOF value still reversibly convertible into the unit.

Implements Mantid::Kernel::Unit.

Definition at line 824 of file Unit.cpp.

References sfpFrom.

◆ init()

void Mantid::Kernel::Units::dSpacingPerpendicular::init ( )

overridevirtual

Finalize the initialization.

This will be overridden by subclasses as needed.

Implements Mantid::Kernel::Unit.

Definition at line 793 of file Unit.cpp.

References factorFrom, factorTo, Mantid::PhysicalConstants::h, Mantid::Kernel::Unit::l1, Mantid::Kernel::l2, Mantid::Kernel::Unit::m_params, Mantid::PhysicalConstants::NeutronMass, sfpFrom, sfpTo, Mantid::Kernel::twoTheta, and twoTheta.

◆ label()

const UnitLabel Mantid::Kernel::Units::dSpacingPerpendicular::label ( ) const

overridevirtual

A label for the unit to be printed on axes,.

See also: UnitLabel

Returns: The unit label

Implements Mantid::Kernel::Unit.

Definition at line 776 of file Unit.cpp.

References Mantid::Kernel::Units::Symbol::Angstrom.

◆ singleFromTOF()

double Mantid::Kernel::Units::dSpacingPerpendicular::singleFromTOF ( const double tof ) const

overridevirtual

Convert a single tof value to this unit.

Parameters

tof	value to convert

Returns: the value in this unit as converted.

Implements Mantid::Kernel::Unit.

Definition at line 820 of file Unit.cpp.

References factorFrom, and sfpFrom.

◆ singleToTOF()

double Mantid::Kernel::Units::dSpacingPerpendicular::singleToTOF ( const double x ) const

overridevirtual

Convert a single X value to TOF.

Parameters

x	value to convert

Returns: the TOF as converted.

Implements Mantid::Kernel::Unit.

Definition at line 813 of file Unit.cpp.

References factorTo, sfpTo, and Mantid::Geometry::x.

◆ unitID()

const std::string Mantid::Kernel::Units::dSpacingPerpendicular::unitID ( ) const

overridevirtual

"dSpacingPerpendicular"

Implements Mantid::Kernel::Unit.

Referenced by validateUnitParams().

◆ validateUnitParams()

void Mantid::Kernel::Units::dSpacingPerpendicular::validateUnitParams	(	const int	emode,
		const UnitParametersMap &	params
	)

overrideprotectedvirtual

Reimplemented from Mantid::Kernel::Unit.

Definition at line 780 of file Unit.cpp.

References Mantid::Kernel::l2, Mantid::Kernel::twoTheta, and unitID().

Member Data Documentation

◆ factorFrom

double Mantid::Kernel::Units::dSpacingPerpendicular::factorFrom

protected

Constant factor for from conversion.

Definition at line 431 of file Unit.h.

Referenced by conversionTOFMax(), init(), and singleFromTOF().

◆ factorTo

double Mantid::Kernel::Units::dSpacingPerpendicular::factorTo

protected

Constant factor for to conversion.

Definition at line 429 of file Unit.h.

Referenced by init(), and singleToTOF().

◆ sfpFrom

double Mantid::Kernel::Units::dSpacingPerpendicular::sfpFrom

protected

Extra correction factor in to conversion.

Definition at line 432 of file Unit.h.

Referenced by conversionTOFMin(), init(), and singleFromTOF().

◆ sfpTo

double Mantid::Kernel::Units::dSpacingPerpendicular::sfpTo

protected

Extra correction factor in to conversion.

Definition at line 430 of file Unit.h.

Referenced by init(), and singleToTOF().

◆ twoTheta

double Mantid::Kernel::Units::dSpacingPerpendicular::twoTheta

protected

Definition at line 428 of file Unit.h.

Referenced by init().

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

Framework/Kernel/inc/MantidKernel/Unit.h
Framework/Kernel/src/Unit.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ dSpacingPerpendicular()

Member Function Documentation

◆ caption()

◆ clone()

◆ conversionTOFMax()

◆ conversionTOFMin()

◆ init()

◆ label()

◆ singleFromTOF()

◆ singleToTOF()

◆ unitID()

◆ validateUnitParams()

Member Data Documentation

◆ factorFrom

◆ factorTo

◆ sfpFrom

◆ sfpTo

◆ twoTheta