IDS peak ICV v1.4.0
Loading...
Searching...
No Matches
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

Constructor & Destructor Documentation

◆ __init__()

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

Creates a coordinate system.

Parameters
originorigin coordinate
x_axisx_axis coordinate
y_axisy_axis coordinate
z_axisz_axis coordinate
Exceptions
NotSupportedExceptionif the given arguments are not points.
Since
ids_peak_icv 1.1

Member Function Documentation

◆ __eq__()

bool __eq__ ( self,
object other )

Check if two coordinate systems are equal.

Parameters
otherAnother CoordinateSystem object
Returns
True if coordinate systems are equal, False otherwise
Since
ids_peak_icv 1.1

◆ __ne__()

bool __ne__ ( self,
object other )

Check if two coordinate systems are not equal.

Parameters
otherAnother CoordinateSystem object
Returns
True if coordinate systems are not equal, False otherwise
Since
ids_peak_icv 1.1

◆ __repr__()

str __repr__ ( self)

Get a string representation of the CoordinateSystem.

Returns
String representation of the CoordinateSystem
Since
ids_peak_icv 1.1

◆ origin()

Point origin ( self)

Origin of the coordinate system.

Since
ids_peak_icv 1.1

◆ x_axis()

Point x_axis ( self)

X-axis vector of the coordinate system.

Since
ids_peak_icv 1.1

◆ y_axis()

Point y_axis ( self)

Y-axis vector of the coordinate system.

Since
ids_peak_icv 1.1

◆ z_axis()

Point z_axis ( self)

Z-axis vector of the coordinate system.

Since
ids_peak_icv 1.1

Field Documentation

◆ _origin

Point _origin = origin
protected

◆ _x_axis

Point _x_axis = x_axis
protected

◆ _y_axis

Point _y_axis = y_axis
protected

◆ _z_axis

Point _z_axis = z_axis
protected