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

Energy transfer in units of wavenumber (cm^-1) More...

#include <Unit.h>

Inheritance diagram for Mantid::Kernel::Units::DeltaE_inWavenumber:
Mantid::Kernel::Units::DeltaE 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...
 
 DeltaE_inWavenumber ()
 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...
 
const std::string unitID () const override
 "DeltaE_inWavenumber" More...
 
- Public Member Functions inherited from Mantid::Kernel::Units::DeltaE
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...
 
 DeltaE ()
 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
 "DeltaE" 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...
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::Kernel::Units::DeltaE
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 inherited from Mantid::Kernel::Units::DeltaE
double efixed
 
double factorFrom
 Constant factor for from conversion. More...
 
double factorTo
 Constant factor for to conversion. More...
 
double t_other
 Energy mode dependent factor in to conversion. More...
 
double t_otherFrom
 Energy mode dependent factor in from conversion. More...
 
double unitScaling
 Apply unit scaling to energy value. 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

Energy transfer in units of wavenumber (cm^-1)

Definition at line 506 of file Unit.h.

Constructor & Destructor Documentation

◆ DeltaE_inWavenumber()

Mantid::Kernel::Units::DeltaE_inWavenumber::DeltaE_inWavenumber ( )

Constructor.

Definition at line 1060 of file Unit.cpp.

References Mantid::Kernel::Unit::addConversion(), and Mantid::PhysicalConstants::meVtoWavenumber.

Referenced by clone().

Member Function Documentation

◆ caption()

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

The full name of the unit.

Returns
The unit caption

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 509 of file Unit.h.

◆ clone()

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

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 1058 of file Unit.cpp.

References DeltaE_inWavenumber().

◆ conversionTOFMax()

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

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

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 1066 of file Unit.cpp.

References Mantid::Kernel::Units::DeltaE::conversionTOFMax().

◆ conversionTOFMin()

double Mantid::Kernel::Units::DeltaE_inWavenumber::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.

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 1064 of file Unit.cpp.

References Mantid::Kernel::Units::DeltaE::conversionTOFMin().

◆ init()

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

Finalize the initialization.

This will be overridden by subclasses as needed.

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 1052 of file Unit.cpp.

References Mantid::Kernel::Units::DeltaE::init(), Mantid::PhysicalConstants::meVtoWavenumber, and Mantid::Kernel::Units::DeltaE::unitScaling.

◆ label()

const UnitLabel Mantid::Kernel::Units::DeltaE_inWavenumber::label ( ) const
overridevirtual

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

See also
UnitLabel
Returns
The unit label

Reimplemented from Mantid::Kernel::Units::DeltaE.

Definition at line 1050 of file Unit.cpp.

References Mantid::Kernel::Units::Symbol::InverseCM.

◆ unitID()

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

"DeltaE_inWavenumber"

Reimplemented from Mantid::Kernel::Units::DeltaE.


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