Operator Reference
clear_surface_matching_result (Operator)
clear_surface_matching_result
— Free the memory of a surface matching result.
Signature
clear_surface_matching_result( : : SurfaceMatchingResultID : )
Description
The operator clear_surface_matching_result
frees the memory of a
surface matching result that was created by find_surface_model
or
refine_surface_model_pose
.
After calling clear_surface_matching_result
, the result can no longer
be used. The handle SurfaceMatchingResultID
becomes invalid.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
SurfaceMatchingResultID
(input_control, state is modified) surface_matching_result(-array) →
(handle)
Handle of the surface matching result.
Result
If the handle of the result is valid, the operator
clear_surface_matching_result
returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
find_surface_model
,
refine_surface_model_pose
See also
find_surface_model
,
refine_surface_model_pose
Module
3D Metrology