RTC6 boards
Doc. Rev. 1.0.21 en-US
10 RTC6 Commands
449
Ctrl Command get_z_distance
Function Returns the focus length value l for the specified point within the 3D Image Field.
Restriction If the Option “3D” has not been enabled or if no 3D correction table has been assigned
(see select_cor_table), then get_z_distance returns 0 and otherwise has no effect.
Call
ZDistance = get_z_distance( X, Y, Z )
Parameters
X
Absolute coordinates of the point (x|y|z) in the 3D Image Field. In bits.
As a signed 32-bit value.
Allowed value range: [–524,288…+524,287].
Out-of-range values are clipped to the boundary values.
Y
Like
X
(analogously).
Z
Like
X
(analogously).
Result Focus length value. [–524,288…+524,287].
As a signed 32-bit value.
Comments • get_z_distance is only needed for re-calibrating the z axis in a 3-axis scan system, see
Section ”Checking the z axis Calibration”, page 170.
• The focus length value l:
– Has no dimension
– Corresponds to the focus length difference between the specified point (x|y|z) and
the point (0|0|0)
– Can be positive or negative
• With the RTC6,
ZDistance
is always in 20-bit range [–524,288…+524,287]:
– In RTC4 Compatibility Mode
– In RTC5 Compatibility Mode
– In RTC6 Standard Mode
Important: If you do not use load_z_table_20b or load_z_table_no_20b, you must
divide
ZDistance
by 16 and insert the result into the parabolic function
z
out
= A + Bl + Cl
2
.
• get_z_distance 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 get_z_distance has no effect and returns 0
(get_last_error return code
RTC6_BUSY
).
• get_z_distance is not executed and returns 0
(get_last_error return code
RTC6_BUSY
), if:
– the BUSY list execution status is set
– the INTERNAL-BUSY list execution status is set
• get_z_distance is even executed, if:
– a list has been paused by set_wait (
PAUSED list execution status s
et)
• For 3D Image Field calibration, see Chapter ”3D Commands”, page 238.
RTC4RTC6 Unchanged functionality.
In RTC4 Compatibility Mode, the RTC6 multiplies the values specified for
X
,
Y
and
Z
by 16.
The allowed value range decreases accordingly.
RTC5RTC6 Unchanged functionality.
In RTC5 Compatibility Mode, the RTC6 multiplies the value specified for
Z
by 16.
The allowed value range decreases accordingly.
Version info Available as of DLL 600, OUT 600, RBF 600.
References load_z_table, load_z_table_no, load_z_table_20b, load_z_table_no_20b