CoordinateSystem Class Reference

Public Member Functions
None	__init__ (self, Point origin, Point x_axis, Point y_axis, Point z_axis)
	Creates a coordinate system.
Point	origin (self)
	Origin of the coordinate system.
Point	x_axis (self)
	X-axis vector of the coordinate system.
Point	y_axis (self)
	Y-axis vector of the coordinate system.
Point	z_axis (self)
	Z-axis vector of the coordinate system.
bool	__eq__ (self, object other)
	Check if two coordinate systems are equal.
bool	__ne__ (self, object other)
	Check if two coordinate systems are not equal.
str	__repr__ (self)
	Get a string representation of the CoordinateSystem.

Protected Attributes
Point	_origin = origin
Point	_x_axis = x_axis
Point	_y_axis = y_axis
Point	_z_axis = z_axis

Detailed Description

Represents the coordinate system of a calibration view that was projected into the 2D 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.

Since

ids_peak_icv 1.1

Definition at line 7 of file coordinate_system.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Point	origin,
		Point	x_axis,
		Point	y_axis,
		Point	z_axis )

Creates a coordinate system.

Parameters

origin	origin coordinate
x_axis	x_axis coordinate
y_axis	y_axis coordinate
z_axis	z_axis coordinate

Exceptions

NotSupportedException

if the given arguments are not points.

Since

ids_peak_icv 1.1

Definition at line 20 of file coordinate_system.py.

Member Function Documentation

__eq__()

bool __eq__	(		self,
		object	other )

Check if two coordinate systems are equal.

Parameters

other

Another CoordinateSystem object

Returns

True if coordinate systems are equal, False otherwise

Since

ids_peak_icv 1.1

Definition at line 83 of file coordinate_system.py.

__ne__()

bool __ne__	(		self,
		object	other )

Check if two coordinate systems are not equal.

Parameters

other

Another CoordinateSystem object

Returns

True if coordinate systems are not equal, False otherwise

Since

ids_peak_icv 1.1

Definition at line 100 of file coordinate_system.py.

__repr__()

str __repr__

(

self

)

Get a string representation of the CoordinateSystem.

Returns

String representation of the CoordinateSystem

Since

ids_peak_icv 1.1

Definition at line 113 of file coordinate_system.py.

origin()

Point origin

(

self

)

Origin of the coordinate system.

Since

ids_peak_icv 1.1

Definition at line 44 of file coordinate_system.py.

x_axis()

Point x_axis

(

self

)

X-axis vector of the coordinate system.

Since

ids_peak_icv 1.1

Definition at line 54 of file coordinate_system.py.

y_axis()

Point y_axis

(

self

)

Y-axis vector of the coordinate system.

Since

ids_peak_icv 1.1

Definition at line 64 of file coordinate_system.py.

z_axis()

Point z_axis

(

self

)

Z-axis vector of the coordinate system.

Since

ids_peak_icv 1.1

Definition at line 74 of file coordinate_system.py.

Field Documentation

_origin

Point _origin = origin

protected

Definition at line 38 of file coordinate_system.py.

_x_axis

Point _x_axis = x_axis

protected

Definition at line 39 of file coordinate_system.py.

_y_axis

Point _y_axis = y_axis

protected

Definition at line 40 of file coordinate_system.py.

_z_axis

Point _z_axis = z_axis

protected

Definition at line 41 of file coordinate_system.py.