Time of flight in microseconds. More...

Inheritance diagram for Mantid::Kernel::Units::TOF:

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

Unit *	clone () const override

double	conversionTOFMax () const override

double	conversionTOFMin () const override

void	init () override
	Finalize the initialization.

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.

	TOF ()

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

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()

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

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.

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

Time of flight in microseconds.

Definition at line 293 of file Unit.h.

Constructor & Destructor Documentation

◆ TOF()

Mantid::Kernel::Units::TOF::TOF ( )

Definition at line 280 of file Unit.cpp.

Referenced by clone().

Member Function Documentation

◆ caption()

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

inlineoverridevirtual

The full name of the unit.

Returns: The unit caption

Implements Mantid::Kernel::Unit.

Definition at line 296 of file Unit.h.

◆ clone()

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

overridevirtual

Returns: a cloned instance of the other

Implements Mantid::Kernel::Unit.

Definition at line 294 of file Unit.cpp.

References TOF().

◆ conversionTOFMax()

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

overridevirtual

Returns: DBL_MAX as ToF convertible to TOF for in any time range; DBL_MAX as ToF convetanble to TOF for in any time range

Implements Mantid::Kernel::Unit.

Definition at line 297 of file Unit.cpp.

◆ conversionTOFMin()

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

overridevirtual

Returns: -DBL_MAX as ToF convertible to TOF for in any time range

Implements Mantid::Kernel::Unit.

Definition at line 295 of file Unit.cpp.

◆ init()

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

overridevirtual

Finalize the initialization.

This will be overridden by subclasses as needed.

Implements Mantid::Kernel::Unit.

Definition at line 282 of file Unit.cpp.

◆ label()

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

References Mantid::Kernel::Units::Symbol::Microsecond.

◆ singleFromTOF()

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

◆ singleToTOF()

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

References Mantid::Geometry::x.

◆ unitID()

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

overridevirtual

"TOF"

Implements Mantid::Kernel::Unit.

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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TOF()

Member Function Documentation

◆ caption()

◆ clone()

◆ conversionTOFMax()

◆ conversionTOFMin()

◆ init()

◆ label()

◆ singleFromTOF()

◆ singleToTOF()

◆ unitID()