Skip to content

Namespace ILLIXR::data_format::units

Namespace List > ILLIXR > data_format > units

Public Types

Type Name
enum int eyes
enum int measurement_unit

Public Attributes

Type Name
constexpr float conversion_factor = /* multi line expression */
constexpr int last_convertable_unit = FOOT
const std::map< measurement_unit, const std::string > unit_str = /* multi line expression */

Public Functions

Type Name
float convert (const int from, const int to, float val)
eyes non_primary (eyes eye)

Public Types Documentation

enum eyes

enum ILLIXR::data_format::units::eyes {
    LEFT_EYE = 0,
    RIGHT_EYE = 1
};

Enumeration for eyes

enum measurement_unit

enum ILLIXR::data_format::units::measurement_unit {
    MILLIMETER = 0,
    CENTIMETER = 1,
    METER = 2,
    INCH = 3,
    FOOT = 4,
    PERCENT = 5,
    PIXEL = 6,
    UNSET = 7
};

Enumeration for units of distance

Public Attributes Documentation

variable conversion_factor

constexpr float ILLIXR::data_format::units::conversion_factor[5][5];

Array of unit conversions, using measurement_unit as indices. The first index is the "from" unit and the second index is the "to" unit. For example conversion_factor[MILLIMETER][INCH] would yield 0.039, the conversion factor for millimeters to inches.

variable last_convertable_unit

constexpr int ILLIXR::data_format::units::last_convertable_unit;

variable unit_str

const std::map<measurement_unit, const std::string> ILLIXR::data_format::units::unit_str;

Mapping of measurement_unit to a string representation.

Public Functions Documentation

function convert

inline float ILLIXR::data_format::units::convert (
    const int from,
    const int to,
    float val
)

Convenience function for converting measurements.

Parameters:

  • from The measurement_unit to convert from
  • to The measurement_unit to convert to
  • val The value to convert

Returns:

The converted value

function non_primary

inline eyes ILLIXR::data_format::units::non_primary (
    eyes eye
)

The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR/include/illixr/data_format/unit.hpp