get_deformable_surface_matching_resultT_get_deformable_surface_matching_resultGetDeformableSurfaceMatchingResultGetDeformableSurfaceMatchingResultget_deformable_surface_matching_result (Operator)
Name
get_deformable_surface_matching_resultT_get_deformable_surface_matching_resultGetDeformableSurfaceMatchingResultGetDeformableSurfaceMatchingResultget_deformable_surface_matching_result — Get details of a result from deformable surface based matching.
Signature
Description
The operator get_deformable_surface_matching_resultget_deformable_surface_matching_resultGetDeformableSurfaceMatchingResultGetDeformableSurfaceMatchingResultget_deformable_surface_matching_result returns details about
the results of deformable surface based matching or the
deformable surface refinement.
The results are
stored in DeformableSurfaceMatchingResultDeformableSurfaceMatchingResultDeformableSurfaceMatchingResultdeformableSurfaceMatchingResultdeformable_surface_matching_result, which must have been created
by find_deformable_surface_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelfind_deformable_surface_model or
refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelrefine_deformable_surface_model.
The parameter ResultNameResultNameResultNameresultNameresult_name is used to select which result detail
shall be returned. For some result details, ResultIndexResultIndexResultIndexresultIndexresult_index
selects the index of the result detail.
ResultIndexResultIndexResultIndexresultIndexresult_index is ignored for certain values of ResultNameResultNameResultNameresultNameresult_name.
The following values are possible for ResultNameResultNameResultNameresultNameresult_name:
- 'sampled_scene'"sampled_scene""sampled_scene""sampled_scene""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_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelfind_deformable_surface_model and
refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelrefine_deformable_surface_model).
The parameter ResultIndexResultIndexResultIndexresultIndexresult_index is ignored.
- 'rigid_pose'"rigid_pose""rigid_pose""rigid_pose""rigid_pose":
If DeformableSurfaceMatchingResultDeformableSurfaceMatchingResultDeformableSurfaceMatchingResultdeformableSurfaceMatchingResultdeformable_surface_matching_result was created by
find_deformable_surface_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelfind_deformable_surface_model, a rigid pose is returned
that approximates the deformable matching result.
The parameter ResultIndexResultIndexResultIndexresultIndexresult_index is ignored.
This parameter is not available if
DeformableSurfaceMatchingResultDeformableSurfaceMatchingResultDeformableSurfaceMatchingResultdeformableSurfaceMatchingResultdeformable_surface_matching_result was
created by refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelrefine_deformable_surface_model.
- 'reference_point_x'"reference_point_x""reference_point_x""reference_point_x""reference_point_x":
-
- 'reference_point_y'"reference_point_y""reference_point_y""reference_point_y""reference_point_y":
-
- 'reference_point_z'"reference_point_z""reference_point_z""reference_point_z""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_pointadd_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePointadd_deformable_surface_model_reference_point.
The indices of the reference points to be returned are passed in
ResultIndexResultIndexResultIndexresultIndexresult_index.
If 'all'"all""all""all""all" is passed in ResultIndexResultIndexResultIndexresultIndexresult_index, the position
of all reference points is returned.
- 'deformed_model'"deformed_model""deformed_model""deformed_model""deformed_model":
Returns a deformed variant of the 3D object model that was originally
passed to create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelcreate_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 parameter ResultIndexResultIndexResultIndexresultIndexresult_index is ignored.
- 'deformed_sampled_model'"deformed_sampled_model""deformed_sampled_model""deformed_sampled_model""deformed_sampled_model":
Returns a deformed variant of the 3D object model that was sampled
by create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelcreate_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 in
create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelcreate_deformable_surface_model.
The original, undeformed sampled model can be obtained with
get_deformable_surface_model_paramget_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParamget_deformable_surface_model_param.
The parameter ResultIndexResultIndexResultIndexresultIndexresult_index is ignored.
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
DeformableSurfaceMatchingResultDeformableSurfaceMatchingResultDeformableSurfaceMatchingResultdeformableSurfaceMatchingResultdeformable_surface_matching_result (input_control) deformable_surface_matching_result → HDeformableSurfaceMatchingResult, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the deformable
surface matching result.
ResultNameResultNameResultNameresultNameresult_name (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Name of the result property.
Default:
'sampled_scene'
"sampled_scene"
"sampled_scene"
"sampled_scene"
"sampled_scene"
List of values:
'deformed_model'"deformed_model""deformed_model""deformed_model""deformed_model", 'deformed_sampled_model'"deformed_sampled_model""deformed_sampled_model""deformed_sampled_model""deformed_sampled_model", 'reference_point_x'"reference_point_x""reference_point_x""reference_point_x""reference_point_x", 'reference_point_y'"reference_point_y""reference_point_y""reference_point_y""reference_point_y", 'reference_point_z'"reference_point_z""reference_point_z""reference_point_z""reference_point_z", 'rigid_pose'"rigid_pose""rigid_pose""rigid_pose""rigid_pose", 'sampled_scene'"sampled_scene""sampled_scene""sampled_scene""sampled_scene"
ResultIndexResultIndexResultIndexresultIndexresult_index (input_control) integer(-array) → HTupleMaybeSequence[Union[int, str]]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Index of the result property.
Default:
0
Suggested values:
0, 1, 2, 3, 'all'"all""all""all""all"
Restriction:
ResultIndex >= 0
ResultValueResultValueResultValueresultValueresult_value (output_control) integer(-array) → HTupleSequence[HTupleElementType]HTupleHtuple (integer / string / real / handle) (int / long / string / double / HHandle) (Hlong / HString / double / HHandle) (Hlong / char* / double / handle)
Value of the result property.
Result
If the handle of the result is valid, the operator
get_deformable_surface_matching_resultget_deformable_surface_matching_resultGetDeformableSurfaceMatchingResultGetDeformableSurfaceMatchingResultget_deformable_surface_matching_result returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
find_deformable_surface_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelfind_deformable_surface_model,
refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelrefine_deformable_surface_model
Possible Successors
clear_deformable_surface_modelclear_deformable_surface_modelClearDeformableSurfaceModelClearDeformableSurfaceModelclear_deformable_surface_model
See also
find_deformable_surface_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelfind_deformable_surface_model,
refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelrefine_deformable_surface_model,
read_deformable_surface_modelread_deformable_surface_modelReadDeformableSurfaceModelReadDeformableSurfaceModelread_deformable_surface_model,
write_deformable_surface_modelwrite_deformable_surface_modelWriteDeformableSurfaceModelWriteDeformableSurfaceModelwrite_deformable_surface_model,
clear_deformable_surface_modelclear_deformable_surface_modelClearDeformableSurfaceModelClearDeformableSurfaceModelclear_deformable_surface_model
Module
3D Metrology