Struct ILLIXR::data_format::point_with_units

ClassList > ILLIXR > data_format > point_with_units

Inherits the following classes: ILLIXR::data_format::point_with_validity

Public Attributes

Type	Name
units::measurement_unit	unit The units this point is in.

Public Functions

Type	Name
point_with_units	operator* (const float val) const
point_with_units	operator+ (const point_with_units & pnt) const
point_with_units	operator+ (const Eigen::Vector3f & pnt) const
point_with_units	operator- (const point_with_units & pnt) const
point_with_units	operator- (const Eigen::Vector3f & pnt) const
point_with_units	operator/ (const float val) const
	point_with_units (units::measurement_unit unit_=units::UNSET)
	point_with_units (const float x, const float y, const float z, units::measurement_unit unit_=units::UNSET, bool valid_=true, const float confidence_=0.)
	point_with_units (const point & pnt, units::measurement_unit unit_=units::UNSET, bool valid_=true, const float confidence_=0.)
	point_with_units (const point_with_validity & pnt, units::measurement_unit unit_=units::UNSET)
void	set (const float x_, const float y_, const float z_, units::measurement_unit unit_, bool valid_=true)
void	set (const Eigen::Vector3f & vec)
void	set (const point_with_units & pnt)

Public Attributes Documentation

variable unit

The units this point is in.

units::measurement_unit ILLIXR::data_format::point_with_units::unit;

Public Functions Documentation

function operator*

inline point_with_units ILLIXR::data_format::point_with_units::operator* (
    const float val
) const

Multiplication operator to multiply a point_with_units by a constant value

Parameters:

val The value to multiply by

Returns:

The new point

function operator+

inline point_with_units ILLIXR::data_format::point_with_units::operator+ (
    const point_with_units & pnt
) const

Addition operator between two points_with_units, units are not checked, but the validity flag is an AND of the two flags

Parameters:

pnt The point to add to this one

Returns:

The new point

function operator+

inline point_with_units ILLIXR::data_format::point_with_units::operator+ (
    const Eigen::Vector3f & pnt
) const

Addition operator between a points_with_units and Eigen::Vector

Parameters:

pnt The point to add to this one

Returns:

The new point

function operator-

inline point_with_units ILLIXR::data_format::point_with_units::operator- (
    const point_with_units & pnt
) const

Subtraction operator between two points_with_units, units are not checked, but the validity flag is an AND of the two flags

Parameters:

pnt The point to subtract from this one

Returns:

The new point

function operator-

inline point_with_units ILLIXR::data_format::point_with_units::operator- (
    const Eigen::Vector3f & pnt
) const

Subtraction operator between a points_with_units and Eigen::Vector

Parameters:

pnt The point to subtract from this one

Returns:

The new point

function operator/

inline point_with_units ILLIXR::data_format::point_with_units::operator/ (
    const float val
) const

Division operator to divide a point_with_units by a constant value

Parameters:

val The value to divide by

Returns:

The new point

function point_with_units [1/4]

inline explicit ILLIXR::data_format::point_with_units::point_with_units (
    units::measurement_unit unit_=units::UNSET
)

Default constructor, places point at the origin

function point_with_units [2/4]

inline ILLIXR::data_format::point_with_units::point_with_units (
    const float x,
    const float y,
    const float z,
    units::measurement_unit unit_=units::UNSET,
    bool valid_=true,
    const float confidence_=0.
)

Initial point based on the given x, y, and z coordinates

Parameters:

x The x coordinate in arbitrary units
y The y coordinate in arbitrary units
z The z coordinate in arbitrary units
unit_ The units of the point, default is UNSET
valid_ Whether the point contains valid data, default is true
confidence_ Confidence level of the point's value, default is 0.

function point_with_units [3/4]

inline ILLIXR::data_format::point_with_units::point_with_units (
    const point & pnt,
    units::measurement_unit unit_=units::UNSET,
    bool valid_=true,
    const float confidence_=0.
)

Construct a point_with_units from another point

Parameters:

pnt The point to construct it from
unit_ The units of the point, default is UNSET
valid_ Whether the point contains valid data, default is true
confidence_ Confidence level of the point's value, default is 0.

function point_with_units [4/4]

inline explicit ILLIXR::data_format::point_with_units::point_with_units (
    const point_with_validity & pnt,
    units::measurement_unit unit_=units::UNSET
)

Construct a point_with_units from a point_with_validity

Parameters:

pnt The point to construct it from
unit_ The units of the point, default is UNSET

function set [1/3]

inline void ILLIXR::data_format::point_with_units::set (
    const float x_,
    const float y_,
    const float z_,
    units::measurement_unit unit_,
    bool valid_=true
)

Set the coordinates based on the given x, y, and z coordinates

Parameters:

x The x coordinate in arbitrary units
y The y coordinate in arbitrary units
z The z coordinate in arbitrary units
unit_ The units of the point
valid_ Whether the point contains valid data, default is true

function set [2/3]

inline void ILLIXR::data_format::point_with_units::set (
    const Eigen::Vector3f & vec
)

Set the coordinates based on the given Eigen::Vector

Parameters:

vec The vector to set the point from

function set [3/3]

inline void ILLIXR::data_format::point_with_units::set (
    const point_with_units & pnt
)

Set the coordinates from another point_with_units

Parameters:

pnt The point to set this one to

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