get_disp_object_model_3d_info🔗
Short description🔗
get_disp_object_model_3d_info — Get the depth or the index of a displayed 3D object model.
Signature🔗
get_disp_object_model_3d_info( window WindowHandle, integer Row, integer Column, string Information, out integer Value )
Description🔗
get_disp_object_model_3d_info returns information on the
3D object models that have been displayed with disp_object_model_3d
in the window WindowHandle. The requested information at the
positions (Row, Column) is returned in Value.
The following values can be queried via Information:
-
'object_index' The indices of the 3D object models that have been displayed at the positions (
Row,Column). If no 3D object model was displayed at this position, \(-1\) is returned. In order to retrieve this information,disp_object_model_3dmust have been called with the generic parameter 'object_index_persistence' set to 'true'. -
'depth' The depth (i.e. the Z coordinate in the camera coordinate system) at the positions (
Row,Column). If no 3D object model was displayed at one of these positions, \(-1.0\) is returned for this position. In order to retrieve this information,disp_object_model_3dmust have been called with the generic parameter 'depth_persistence' set to 'true'.
The window coordinates Row, Column must be provided in
respect to the current image part. Thereby they are understood in
edge centered subpixel accurate coordinates,
see Transformations / 2D Transformations.
Given the current image part
(row1,column1,row2,column2,
in the HALCON standard coordinate system), the upper left corner corresponds
to the coordinates (row1 - 0.5, column1 - 0.5).
Accordingly, the bottom right corner corresponds to the coordinates
(row2 - 0.5, column2 - 0.5).
Use get_mposition_sub_pix or get_mbutton_sub_pix to obtain
these coordinates directly.
In case the window coordinates correspond to values outside the current
image part, the operator behavior is undefined.
Execution information🔗
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Automatically parallelized on internal data level.
Parameters🔗
WindowHandle (input_control) window → (handle)
Window handle.
Row (input_control) integer(-array) → (real / integer)
Row coordinates.
Column (input_control) integer(-array) → (real / integer)
Column coordinates.
Information (input_control) string(-array) → (string)
Information.
Default: 'depth'
List of values: 'depth', 'object_index'
Value (output_control) integer(-array) → (integer / real)
Indices or the depth of the objects at (Row,Column).
Result🔗
get_disp_object_model_3d_info returns 2 (H_MSG_TRUE) if all parameters are
correct.
Combinations with other operators🔗
Combinations
Possible predecessors
disp_object_model_3d, get_mbutton, get_mbutton_sub_pix, get_mposition, get_mposition_sub_pix
See also
Module🔗
3D Metrology