CoordinateSystem Class Reference

#include <peak_icv/types/geometry/peak_icv_coordinate_system.hpp>

Inheritance diagram for CoordinateSystem:

Collaboration diagram for CoordinateSystem:

Public Member Functions
	CoordinateSystem ()=default
	CoordinateSystem constructor.
	CoordinateSystem (peak::common::PointF origin, peak::common::VectorF xAxis, peak::common::VectorF yAxis, peak::common::VectorF zAxis)
	CoordinateSystem constructor from origin, xAxis, yAxis and zAxis.
peak::common::PointF	GetOrigin () const
	Returns the location of the coordinate system origin.
peak::common::VectorF	GetXAxis () const
	Returns the vector that describes the x-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.
peak::common::VectorF	GetYAxis () const
	Returns the vector that describes the y-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.
peak::common::VectorF	GetZAxis () const
	Returns the vector that describes the z-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.
bool	operator== (const CoordinateSystem &rhs) const

Detailed Description

Represents the coordinate system of a calibration view projected into the image plane. The coordinate system is represented by its origin and three vectors, each corresponding to one of the three coordinate axes (X, Y and Z). These vectors describe the directions of the respective axes projected from 3D into 2D space. Their lengths are determined by twice the distance between neighboring markers on the calibration plate.

Warning

This function is still in development and not released.

Definition at line 42 of file peak_icv_coordinate_system.hpp.

Constructor & Destructor Documentation

CoordinateSystem() [1/2]

CoordinateSystem ( )

default

CoordinateSystem constructor.

Warning

This function is still in development and not released.

CoordinateSystem() [2/2]

CoordinateSystem ( peak::common::PointF origin, peak::common::VectorF xAxis, peak::common::VectorF yAxis, peak::common::VectorF zAxis )

inline

CoordinateSystem constructor from origin, xAxis, yAxis and zAxis.

Parameters

origin	location of the coordinate system origin
xAxis	vector that describes the x-axis of the coordinate system
yAxis	vector that describes the y-axis of the coordinate system
zAxis	vector that describes the z-axis of the coordinate system

Warning

This function is still in development and not released.

Definition at line 62 of file peak_icv_coordinate_system.hpp.

Member Function Documentation

GetOrigin()

peak::common::PointF GetOrigin ( ) const

inline

Returns the location of the coordinate system origin.

Warning

This function is still in development and not released.

Definition at line 75 of file peak_icv_coordinate_system.hpp.

GetXAxis()

peak::common::VectorF GetXAxis ( ) const

inline

Returns the vector that describes the x-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.

Warning

This function is still in development and not released.

Definition at line 86 of file peak_icv_coordinate_system.hpp.

GetYAxis()

peak::common::VectorF GetYAxis ( ) const

inline

Returns the vector that describes the y-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.

Warning

This function is still in development and not released.

Definition at line 97 of file peak_icv_coordinate_system.hpp.

GetZAxis()

peak::common::VectorF GetZAxis ( ) const

inline

Returns the vector that describes the z-axis of the coordinate system. Its length is determined by twice the distance between neighboring markers on the calibration plate.

Warning

This function is still in development and not released.

Definition at line 108 of file peak_icv_coordinate_system.hpp.

operator==()

bool operator== ( const CoordinateSystem & rhs ) const

inline

Definition at line 113 of file peak_icv_coordinate_system.hpp.