get_deformable_surface_matching_result🔗
Short description🔗
get_deformable_surface_matching_result — Get details of a result from deformable surface based matching.
Signature🔗
get_deformable_surface_matching_result( deformable_surface_matching_result DeformableSurfaceMatchingResult, string ResultName, integer ResultIndex, out integer ResultValue )
Description🔗
The operator get_deformable_surface_matching_result returns details about
the results of deformable surface based matching or the
deformable surface refinement.
The results are
stored in DeformableSurfaceMatchingResult, which must have been created
by find_deformable_surface_model or
refine_deformable_surface_model.
The parameter ResultName is used to select which result detail
shall be returned. For some result details, ResultIndex
selects the index of the result detail.
ResultIndex is ignored for certain values of ResultName.
The following values are possible for ResultName:
-
'sampled_scene': A 3D object model handle is returned that contains the sampled scene points that were used in the matching or refinement. This is helpful for tuning the sampling distance of the scene (see parameter RelSamplingDistance of operators
find_deformable_surface_modelandrefine_deformable_surface_model). The parameterResultIndexis ignored. -
'rigid_pose': If
DeformableSurfaceMatchingResultwas created byfind_deformable_surface_model, a rigid pose is returned that approximates the deformable matching result. The parameterResultIndexis ignored. This parameter is not available ifDeformableSurfaceMatchingResultwas created byrefine_deformable_surface_model. -
'reference_point_x':
-
'reference_point_y':
-
'reference_point_z': Returns the x-, y- or z-coordinates of a transformed reference point. The reference point must have been added to the deformable surface model using the operator
add_deformable_surface_model_reference_point. The indices of the reference points to be returned are passed inResultIndex. If 'all' is passed inResultIndex, the position of all reference points is returned. -
'deformed_model': Returns a deformed variant of the 3D object model that was originally passed to
create_deformable_surface_model. The 3D object model is deformed with the reconstructed deformation. Triangles, polygons and extended attributes contained in the original 3D object model are maintained. The parameterResultIndexis ignored. -
'deformed_sampled_model': Returns a deformed variant of the 3D object model that was sampled by
create_deformable_surface_model. The returned 3D object model has the same number of points as the original, undeformed sampled model, and the points are in the same order. Details about the sampling are described increate_deformable_surface_model. The original, undeformed sampled model can be obtained withget_deformable_surface_model_param. The parameterResultIndexis ignored.
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🔗
DeformableSurfaceMatchingResult (input_control) deformable_surface_matching_result → (handle)
Handle of the deformable surface matching result.
ResultName (input_control) string(-array) → (string)
Name of the result property.
Default: 'sampled_scene'
List of values: 'deformed_model', 'deformed_sampled_model', 'reference_point_x', 'reference_point_y', 'reference_point_z', 'rigid_pose', 'sampled_scene'
ResultIndex (input_control) integer(-array) → (integer / string)
Index of the result property.
Default: 0
Suggested values: 0, 1, 2, 3, 'all'
Restriction: ResultIndex >= 0
ResultValue (output_control) integer(-array) → (integer / string / real / handle)
Value of the result property.
Result🔗
If the handle of the result is valid, the operator
get_deformable_surface_matching_result returns the value 2 (H_MSG_TRUE).
If necessary an exception is raised.
Combinations with other operators🔗
Combinations
Possible predecessors
find_deformable_surface_model, refine_deformable_surface_model
Possible successors
clear_deformable_surface_model
See also
find_deformable_surface_model, refine_deformable_surface_model, read_deformable_surface_model, write_deformable_surface_model, clear_deformable_surface_model
Module🔗
3D Metrology