RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
295
innovators for industry
Ctrl Command get_z_distance
Function
returns the focus length value
l
for the specified point within the working volume.
Restriction
If the 3D option has not been enabled or if no 3D correction table has been assigned (see
), then the command returns 0 and otherwise has no effect.
Call
ZDistance = get_z_distance( X, Y, Z )
Parameters
X, Y, Z
absolute coordinates of the point
(x|y|z)
in the working volume in
bits
as
signed 32-bit values; allowed range:
• for
X
and
Y
: [–524288 … 524287]
• for
Z
: [–32768 … 32767]
Out-of-range values will be edge-clipped.
Result
focus length value as a signed 32-bit value [–32768 … 32767]
Comments
• This command is only needed for re-calibrating the Z-axis in a 3-axis scan system (see
). The (unit-free) focus length value
l
corresponds to the focus length differ-
ence between the specified point
(x|y|z)
and the point
(0|0|0)
. The focus length value
can be positive or negative.
• The command first performs a (virtual) jump to the point
(x|y|z)
and then returns the
focus length value.
• If a list is currently executed, then the command has no effect and will return 0
(
return code:
RTC5_BUSY
).
• The command has no effect and will return 0 (
return code
:
RTC5_BUSY
)
if the board’s BUSY status is currently set (list is being processed or has been halted via
) or the board’s INTERNAL-BUSY status is currently set. In contrast, the
command is normally executed when a list has been paused via
PAUSED
status set).
• For 3D image field calibration, see
"3D Marking Commands", page 172
RTC
®
4
RTC
®
5 unchanged functionality (except for the extended range of
X
and
Y
values).
In RTC
®
4 compatibility mode, the RTC
®
5 multiplies the specified
X
and
Y
coordinate values
by 16 (the permissible range of values is correspondingly reduced to [–32768 … 32767]).
The value range for Z coordinates is identical for the RTC
®
5 and RTC
®
4.
References