IDS peak ICV v1.6.0
Loading...
Searching...
No Matches
CoordinateSystem Class Reference

Public Member Functions

 CoordinateSystem ()
 Initializes a new instance of the CoordinateSystem.
 
 CoordinateSystem (PointF origin, VectorF xAxis, VectorF yAxis, VectorF zAxis)
 Initializes a new instance of the CoordinateSystem class with specified coordinates.
 
override string ToString ()
 Converts the CoordinateSystem to a string representation.
 
bool Equals (CoordinateSystem? other)
 Compares the coordinate systems by value.
 
override bool Equals (object? obj)
 Compares the coordinate systems by value.
 
override int GetHashCode ()
 Generates a hash code from the classes properties.
 

Properties

PointF Origin [get]
 Gets the location of the coordinate system origin.
 
VectorF XAxis [get]
 Gets the vector that describes the x-axis of the coordinate system.
 
VectorF YAxis [get]
 Gets the vector that describes the y-axis of the coordinate system.
 
VectorF ZAxis [get]
 Gets the vector that describes the z-axis of the coordinate system.
 

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.

Since
IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ CoordinateSystem() [1/2]

CoordinateSystem ( )
inline

Initializes a new instance of the CoordinateSystem.

Since
IDSImaging.Peak.ICV 1.3

◆ CoordinateSystem() [2/2]

CoordinateSystem ( PointF origin,
VectorF xAxis,
VectorF yAxis,
VectorF zAxis )
inline

Initializes a new instance of the CoordinateSystem class with specified coordinates.

Parameters
originThe location of the coordinate system origin.
xAxisThe vector that describes the x-axis of the coordinate system.
yAxisThe vector that describes the y-axis of the coordinate system.
zAxisThe vector that describes the z-axis of the coordinate system.
Since
IDSImaging.Peak.ICV 1.3

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( CoordinateSystem? other)
inline

Compares the coordinate systems by value.

Since
IDSImaging.Peak.ICV 1.3

◆ Equals() [2/2]

override bool Equals ( object? obj)
inline

Compares the coordinate systems by value.

Since
IDSImaging.Peak.ICV 1.3

◆ GetHashCode()

override int GetHashCode ( )
inline

Generates a hash code from the classes properties.

Since
IDSImaging.Peak.ICV 1.3

◆ ToString()

override string ToString ( )
inline

Converts the CoordinateSystem to a string representation.

Returns
A string representing the coordinate system.
Since
IDSImaging.Peak.ICV 1.3

Property Documentation

◆ Origin

PointF Origin
get

Gets the location of the coordinate system origin.

Since
IDSImaging.Peak.ICV 1.3

◆ XAxis

VectorF XAxis
get

Gets 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.

Since
IDSImaging.Peak.ICV 1.3

◆ YAxis

VectorF YAxis
get

Gets 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.

Since
IDSImaging.Peak.ICV 1.3

◆ ZAxis

VectorF ZAxis
get

Gets 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.

Since
IDSImaging.Peak.ICV 1.3