Struct ILLIXR::data_format::points_with_units
ClassList > ILLIXR > data_format > points_with_units
Inherited by the following classes: ILLIXR::data_format::ht::hand_points
Public Attributes
Type | Name |
---|---|
bool | fixed = false indicates whther the size of the vector has been set |
std::vector< point_with_units > | points The points. |
units::measurement_unit | unit The unit of all points. |
bool | valid |
Public Functions
Type | Name |
---|---|
point_with_units & | at (const size_t idx) |
const point_with_units & | at (const size_t idx) const |
void | check_validity () |
void | enforce_bounds (const float x_lim=-1., const float y_lim=-1, const float z_lim=-1) |
void | mult (const Eigen::Matrix3f & ref_frm) |
points_with_units & | operator= (const points_with_units & other) |
point_with_units & | operator[] (const size_t idx) |
points_with_units (units::measurement_unit unit_=units::UNSET) |
|
points_with_units (const int size, units::measurement_unit unit_=units::UNSET) |
|
points_with_units (std::vector< point_with_units > points_) |
|
points_with_units (const points_with_units & points_) |
|
points_with_units (std::vector< point_with_validity > & points_, units::measurement_unit unit_=units::UNSET) |
|
points_with_units (std::vector< point > & points_, units::measurement_unit unit_=units::UNSET, bool valid_=true) |
|
size_t | size () const |
void | transform (const pose_data & pose) |
Public Attributes Documentation
variable fixed
indicates whther the size of the vector has been set
bool ILLIXR::data_format::points_with_units::fixed;
variable points
The points.
std::vector<point_with_units> ILLIXR::data_format::points_with_units::points;
variable unit
The unit of all points.
units::measurement_unit ILLIXR::data_format::points_with_units::unit;
variable valid
bool ILLIXR::data_format::points_with_units::valid;
Indicates the validity of all points, will be true if any point is valid, false indicates no points are valid
Public Functions Documentation
function at [1/2]
inline point_with_units & ILLIXR::data_format::points_with_units::at (
const size_t idx
)
Get the point_with_unit at the given index
Parameters:
idx
The index of the requested point_with_units
Returns:
A reference to requested point_with_units
function at [2/2]
inline const point_with_units & ILLIXR::data_format::points_with_units::at (
const size_t idx
) const
Get a const version of the point_with_unit at the given index
Parameters:
idx
The index of the requested point_with_units
Returns:
A const reference to requested point_with_units
function check_validity
inline void ILLIXR::data_format::points_with_units::check_validity ()
Update the struct validity flag based on the point's flags
function enforce_bounds
inline void ILLIXR::data_format::points_with_units::enforce_bounds (
const float x_lim=-1.,
const float y_lim=-1,
const float z_lim=-1
)
Enforce point bounds to be valid for an image (e.g. no negative values
Parameters:
x_lim
upper limit of x valuesy_lim
upper limit of y valuesz_lim
upper limit of z values
function mult
inline void ILLIXR::data_format::points_with_units::mult (
const Eigen::Matrix3f & ref_frm
)
Multiply all points by a matrix
Parameters:
ref_frm
The matrix to multiply all points by
function operator=
inline points_with_units & ILLIXR::data_format::points_with_units::operator= (
const points_with_units & other
)
Copy operator
Parameters:
other
The object to copy into this one
Returns:
A reference to the updated points_with_units
function operator[]
inline point_with_units & ILLIXR::data_format::points_with_units::operator[] (
const size_t idx
)
Indexing operator to get a specific point_with_units based on index
Parameters:
idx
The index of the requested point_with_units
Returns:
A reference to requested point_with_units
function points_with_units [1/6]
inline explicit ILLIXR::data_format::points_with_units::points_with_units (
units::measurement_unit unit_=units::UNSET
)
Construct a points_with_units with an empty list
Parameters:
unit_
The units for the points, default is UNSET
function points_with_units [2/6]
inline explicit ILLIXR::data_format::points_with_units::points_with_units (
const int size,
units::measurement_unit unit_=units::UNSET
)
Construct a points_with_units with a list of points with the given size
Parameters:
size
The number of points to initializeunit_
The units for the points, default is UNSET
function points_with_units [3/6]
inline explicit ILLIXR::data_format::points_with_units::points_with_units (
std::vector< point_with_units > points_
)
Construct a points_with_units from a vector of point_with_units objects, units are determined from the points, as is validity
Parameters:
points_
The points to move into this object
function points_with_units [4/6]
inline ILLIXR::data_format::points_with_units::points_with_units (
const points_with_units & points_
)
Copy constructor
Parameters:
points_
function points_with_units [5/6]
inline explicit ILLIXR::data_format::points_with_units::points_with_units (
std::vector< point_with_validity > & points_,
units::measurement_unit unit_=units::UNSET
)
Construct a points_with_units from a vector of point_with_validity objects, validity is determined from the points
Parameters:
points_
The points to move into this objectunit_
The units for the points, default is UNSET
function points_with_units [6/6]
inline explicit ILLIXR::data_format::points_with_units::points_with_units (
std::vector< point > & points_,
units::measurement_unit unit_=units::UNSET,
bool valid_=true
)
Construct a points_with_units from a vector of point objects
Parameters:
points_
The points to move into this objectunit_
The units for the points, default is UNSETvalid_
The validity of all points, default is true
function size
inline size_t ILLIXR::data_format::points_with_units::size () const
Get the size of the internal vector
Returns:
The number of points stored
function transform
inline void ILLIXR::data_format::points_with_units::transform (
const pose_data & pose
)
Transform (move) all points by the given pose
Parameters:
pose
The pose to apply to the points
The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR/include/illixr/data_format/point.hpp