Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mantid::Kernel::Units::Momentum Class Reference

Momentum in Angstrom^-1. More...

#include <Unit.h>

Inheritance diagram for Mantid::Kernel::Units::Momentum:
Mantid::Kernel::Unit

Public Member Functions

const std::string caption () const override
 The full name of the unit. More...
 
Unitclone () 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...
 
void init () override
 Finalize the initialization. More...
 
const UnitLabel label () const override
 A label for the unit to be printed on axes,. More...
 
 Momentum ()
 Constructor. More...
 
double singleFromTOF (const double tof) const override
 Convert a single tof value to this unit. More...
 
double singleToTOF (const double ki) const override
 Convert a single X value to TOF. More...
 
const std::string unitID () const override
 "Momentum" More...
 
- Public Member Functions inherited from Mantid::Kernel::Unit
virtual const std::string caption () const =0
 The full name of the unit. More...
 
virtual Unitclone () 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

bool do_sfpFrom
 Apply the sfpFrom value. More...
 
double efixed
 
double factorFrom
 Constant factor for from conversion. More...
 
double factorTo
 Constant factor for to conversion. More...
 
double sfpFrom
 Extra correction factor in from conversion. More...
 
double sfpTo
 Extra correction factor in to conversion. More...
 
- 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 UnitParametersMapm_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

Momentum in Angstrom^-1.

Definition at line 538 of file Unit.h.

Constructor & Destructor Documentation

◆ Momentum()

Mantid::Kernel::Units::Momentum::Momentum ( )

Member Function Documentation

◆ caption()

const std::string Mantid::Kernel::Units::Momentum::caption ( ) const
inlineoverridevirtual

The full name of the unit.

Returns
The unit caption

Implements Mantid::Kernel::Unit.

Definition at line 541 of file Unit.h.

◆ clone()

Unit * Mantid::Kernel::Units::Momentum::clone ( ) const
overridevirtual
Returns
a cloned instance of the other

Implements Mantid::Kernel::Unit.

Definition at line 1213 of file Unit.cpp.

References Momentum().

◆ conversionTOFMax()

double Mantid::Kernel::Units::Momentum::conversionTOFMax ( ) const
overridevirtual

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

Implements Mantid::Kernel::Unit.

Definition at line 1195 of file Unit.cpp.

References Mantid::Kernel::Unit::emode, factorTo, and sfpFrom.

◆ conversionTOFMin()

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

References Mantid::Kernel::Unit::emode, factorFrom, and sfpFrom.

◆ init()

void Mantid::Kernel::Units::Momentum::init ( )
overridevirtual

◆ label()

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

References Mantid::Kernel::Units::Symbol::InverseAngstrom.

◆ singleFromTOF()

double Mantid::Kernel::Units::Momentum::singleFromTOF ( const double  tof) const
overridevirtual

Convert a single tof value to this unit.

Parameters
tofvalue to convert
Returns
the value in this unit as converted.

Implements Mantid::Kernel::Unit.

Definition at line 1203 of file Unit.cpp.

References do_sfpFrom, factorFrom, sfpFrom, and Mantid::Geometry::x.

◆ singleToTOF()

double Mantid::Kernel::Units::Momentum::singleToTOF ( const double  x) const
overridevirtual

Convert a single X value to TOF.

Parameters
xvalue to convert
Returns
the TOF as converted.

Implements Mantid::Kernel::Unit.

Definition at line 1182 of file Unit.cpp.

References Mantid::Kernel::Unit::emode, factorTo, and sfpTo.

◆ unitID()

const std::string Mantid::Kernel::Units::Momentum::unitID ( ) const
overridevirtual

"Momentum"

Implements Mantid::Kernel::Unit.

◆ validateUnitParams()

void Mantid::Kernel::Units::Momentum::validateUnitParams ( const int  emode,
const UnitParametersMap params 
)
overrideprotectedvirtual

Reimplemented from Mantid::Kernel::Unit.

Definition at line 1117 of file Unit.cpp.

References Mantid::Kernel::efixed, Mantid::Kernel::Unit::emode, and Mantid::Kernel::l2.

Member Data Documentation

◆ do_sfpFrom

bool Mantid::Kernel::Units::Momentum::do_sfpFrom
protected

Apply the sfpFrom value.

Definition at line 561 of file Unit.h.

Referenced by init(), and singleFromTOF().

◆ efixed

double Mantid::Kernel::Units::Momentum::efixed
protected

Definition at line 556 of file Unit.h.

Referenced by init().

◆ factorFrom

double Mantid::Kernel::Units::Momentum::factorFrom
protected

Constant factor for from conversion.

Definition at line 560 of file Unit.h.

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

◆ factorTo

double Mantid::Kernel::Units::Momentum::factorTo
protected

Constant factor for to conversion.

Definition at line 558 of file Unit.h.

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

◆ sfpFrom

double Mantid::Kernel::Units::Momentum::sfpFrom
protected

Extra correction factor in from conversion.

Definition at line 559 of file Unit.h.

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

◆ sfpTo

double Mantid::Kernel::Units::Momentum::sfpTo
protected

Extra correction factor in to conversion.

Definition at line 557 of file Unit.h.

Referenced by init(), and singleToTOF().


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