RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
550
Ctrl Command transform
Function performs a backward transformation of individual position values.
Call
TransformErrorCode = transform( &Sig1, &Sig2, Ptr, Code )
Parameters
+
Returned para-
meter values
Sig1,
Sig2
Parameters: to-be-transformed position values as pointers to signed 32-bit
values.
Returned parameter values: transformed position values as signed 32-bit
values (the input values will be overwritten).
Parameters
Ptr
Pointer (in C and C++ data type ULONG_PTR, i.e. an unsigned 32-bit or 64-bit
value) to the area of PC main memory to which the correction and
transformation settings for backward transformation were previously
transferred via upload_transform.
Code
This parameter (an unsigned 32-bit value) controls aspects of the backward
transformation, particularly which partial transformations to perform: If a
partial transformation is not to be performed, then its corresponding bit
(#2…#5) should be set to 1.
The parameter’s meaning is similar to that of get_transform (
Sig
1
corresponds to
Ptr1
and
Sig
2
to
Ptr2
).
If bit #0 = 0, then both supplied position values (
Sig1
and
Sig2
) will be
backward transformed as XY coordinates:
Bit #1 = 0: The value supplied via
Sig1
will be backward transformed as the X
coordinate and the value supplied via
Sig2
as the Y coordinate.
= 1: The value supplied via
Sig1
will be backward transformed as the Y
coordinate and the value supplied via
Sig2
as the X coordinate.
Bit #2 = 0: The gain/offset correction of automatic self-calibration will be backward
transformed.
Bit #3 = 0: The image field correction will be backward transformed.
Bit #4 = 0: The offset of the defined coordinate transformation will be backward
transformed.
Bit #5 = 0: The total matrix of the defined coordinate transformation will be backward
transformed.
Bits #6..#31 reserved
If bit #0 = 1, then one of the two supplied position values (specifiable as Sig
1
or Sig
2
) will be backward transformed as the Z coordinate:
Bit #1 = 0: The value supplied via
Sig1
will be backward transformed as the Z
coordinate (
Sig2
remains unchanged).
= 1: The value supplied via
Sig2
will be backward transformed as the Z
coordinate (
Sig1
remains unchanged).
Bit #2 = 0: The offset to the focal length defined via set_defocus or set_defocus_list
will be backward transformed.
Bit #3 = 0: The ABC correction will be backward transformed.
Bit #4 = 0: The offset to the Z coordinate defined via set_offset_xyz or
set_offset_xyz_list will be backward transformed.
Bits #5..#31 reserved
Result error code as an unsigned 32-bit value:
Value Description
0 Success.
1
Ptr
= NULL (no memory area specified)
2 No valid data at
Ptr
(upload_transform did not execute)
3 Erroneous data at
Ptr
(a corresponding error indication has been stored via upload_transform)
4 Z-axis inversion not possible