Atomic Distance in Angstroms. More...

Inheritance diagram for Mantid::Kernel::Units::AtomicDistance:

Public Member Functions
	AtomicDistance ()

const std::string	caption () const override
	The full name of the unit.

Unit *	clone () const override

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

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

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

const std::string	unitID () const override
	"AtomicDistance"

Public Member Functions inherited from Mantid::Kernel::Units::Empty
const std::string	caption () const override
	The full name of the unit.

Unit *	clone () const override

double	conversionTOFMax () const override

double	conversionTOFMin () const override

	Empty ()
	Constructor.

void	init () override
	Finalize the initialization.

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

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

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

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

const std::string	unitID () const override
	"Empty"

Public Member Functions inherited from Mantid::Kernel::Unit
virtual std::pair< double, double >	conversionRange () const
	The range where conversion to TOF from given units is monotonic and reversible.

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

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

template<typename Iterator >
void	fromTOF (Iterator const xbegin, Iterator const xend, double const l1, int const emode, UnitParametersMap const &params)
	Convert a range of X values in place from time-of-flight to the concrete unit.

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

void	fromTOF (std::vector< double > &xdata, std::vector< double > const &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.

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

bool	isInitialized () const

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?

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

template<typename Iterator >
void	toTOF (Iterator const xbegin, Iterator const xend, double const l1, int const emode, UnitParametersMap const &params)
	Convert a range of X values in place from the concrete unit to time-of-flight.

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

void	toTOF (std::vector< double > &xdata, std::vector< double > const &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.

	Unit ()
	(Empty) Constructor

virtual	~Unit ()=default
	Virtual destructor.

Private Attributes
UnitLabel	m_label

Additional Inherited Members
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.

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

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

bool	initialized
	The unit values have been initialized.

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

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

Detailed Description

Atomic Distance in Angstroms.

Definition at line 685 of file Unit.h.

Constructor & Destructor Documentation

◆ AtomicDistance()

Mantid::Kernel::Units::AtomicDistance::AtomicDistance ( )

Definition at line 1412 of file Unit.cpp.

Referenced by clone().

Member Function Documentation

◆ caption()

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

inlineoverridevirtual

The full name of the unit.

Returns: The unit caption

Implements Mantid::Kernel::Unit.

Definition at line 689 of file Unit.h.

◆ clone()

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

overridevirtual

Returns: a cloned instance of the other

Implements Mantid::Kernel::Unit.

Definition at line 1416 of file Unit.cpp.

References AtomicDistance().

◆ label()

const UnitLabel Mantid::Kernel::Units::AtomicDistance::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 1414 of file Unit.cpp.

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

◆ singleFromTOF()

double Mantid::Kernel::Units::AtomicDistance::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 1423 of file Unit.cpp.

References UNUSED_ARG.

◆ singleToTOF()

double Mantid::Kernel::Units::AtomicDistance::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 1418 of file Unit.cpp.

References UNUSED_ARG, and Mantid::Geometry::x.

◆ unitID()

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

overridevirtual

"AtomicDistance"

Implements Mantid::Kernel::Unit.

Member Data Documentation

◆ m_label

UnitLabel Mantid::Kernel::Units::AtomicDistance::m_label

private

Definition at line 698 of file Unit.h.

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

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AtomicDistance()

Member Function Documentation

◆ caption()

◆ clone()

◆ label()

◆ singleFromTOF()

◆ singleToTOF()

◆ unitID()

Member Data Documentation

◆ m_label