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

Phi that has degrees as unit and "Phi" as title. More...

#include <Unit.h>

Inheritance diagram for Mantid::Kernel::Units::Phi:
Mantid::Kernel::Units::Degrees Mantid::Kernel::Units::Empty Mantid::Kernel::Unit

Private Member Functions

const std::string caption () const override
 < Degrees More...
 
Unitclone () const override
 
const std::string unitID () const override
 "Empty" More...
 

Additional Inherited Members

- Public Member Functions inherited from Mantid::Kernel::Units::Degrees
const std::string caption () const override
 < Degrees More...
 
Unitclone () const override
 
double conversionTOFMax () const override
 
double conversionTOFMin () const override
 
 Degrees ()
 
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
 "Empty" More...
 
- Public Member Functions inherited from Mantid::Kernel::Units::Empty
const std::string caption () const override
 The full name of the unit. More...
 
Unitclone () const override
 
double conversionTOFMax () const override
 
double conversionTOFMin () const override
 
 Empty ()
 Constructor. More...
 
void init () override
 Finalize the initialization. More...
 
bool isConvertible () const override
 Returns if the unit can be used in conversions. 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
 "Empty" 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 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::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

Phi that has degrees as unit and "Phi" as title.

Definition at line 655 of file Unit.h.

Member Function Documentation

◆ caption()

const std::string Mantid::Kernel::Units::Phi::caption ( ) const
inlineoverrideprivatevirtual

< Degrees

Reimplemented from Mantid::Kernel::Units::Degrees.

Definition at line 657 of file Unit.h.

◆ clone()

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

Reimplemented from Mantid::Kernel::Units::Degrees.

Definition at line 658 of file Unit.h.

◆ unitID()

const std::string Mantid::Kernel::Units::Phi::unitID ( ) const
overrideprivatevirtual

"Empty"

Reimplemented from Mantid::Kernel::Units::Degrees.


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