get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResult (Operator)

Name

get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResult — Get details of a result from surface based matching.

Signature

Description

The operator get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResultGetSurfaceMatchingResult returns details about the results of surface based matching or the surface pose refinement. The results are stored in SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID, which must have been created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel or refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose.

The parameter ResultNameResultNameResultNameResultNameresultName is used to select which result detail shall be returned. If details about one of the results shall be retrieved, ResultIndexResultIndexResultIndexResultIndexresultIndex selects the result index, where 0 selects the first result. ResultIndexResultIndexResultIndexResultIndexresultIndex is ignored for certain values of ResultNameResultNameResultNameResultNameresultName.

The following values are possible for ResultNameResultNameResultNameResultNameresultName if SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel or find_surface_model_imagefind_surface_model_imageFindSurfaceModelImageFindSurfaceModelImageFindSurfaceModelImage:

'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 approximate matching step. This is helpful for tuning the sampling distance for the matching (see parameter RelSamplingDistance of operator find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel). The parameter ResultIndexResultIndexResultIndexResultIndexresultIndex is ignored. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d.

'key_points'"key_points""key_points""key_points""key_points":

A 3D object model handle is returned that contains all points from the 3D scene that were used as key points in the matching process. This is helpful for tuning the sampling distance and key point rate for the matching (see parameter KeyPointFraction of operator find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel). The parameter ResultIndexResultIndexResultIndexResultIndexresultIndex is ignored. At least 10 key points should be on the object of interest for stable results. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d.

'score_unrefined'"score_unrefined""score_unrefined""score_unrefined""score_unrefined":

The score of the result before the dense pose refinement is returned. If the sparse pose refinement was disabled, this is the score of the approximate matching. Otherwise the score of the sparse pose refinement is returned. See find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel for details about the score. In ResultIndexResultIndexResultIndexResultIndexresultIndex the index of the result must be specified. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose, 0 is returned.

'sampled_3d_edges'"sampled_3d_edges""sampled_3d_edges""sampled_3d_edges""sampled_3d_edges":

If the surface model was trained with 'train_3d_edges'"train_3d_edges""train_3d_edges""train_3d_edges""train_3d_edges" enabled, a 3D object model handle is returned that contains the sampled 3D edge points that were used in the approximate matching step and in the sparse refinement step. The parameter ResultIndexResultIndexResultIndexResultIndexresultIndex is ignored. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d.

The following values are always possible for ResultNameResultNameResultNameResultNameresultName, regardless the operator SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created with:

'pose'"pose""pose""pose""pose":

Returns the pose of the matching or refinement result. In ResultIndexResultIndexResultIndexResultIndexresultIndex the index of the result must be specified.

'score_refined'"score_refined""score_refined""score_refined""score_refined":

Returns the score of the result after the dense pose refinement. See find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel for details about this score. In ResultIndexResultIndexResultIndexResultIndexresultIndex the index of the result must be specified. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel and dense pose refinement was disabled, 0 is returned.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

If the handle of the result is valid, the operator get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResultGetSurfaceMatchingResult returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose

Possible Successors

clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel

See also

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose, read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel, write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel, clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel

Module

3D Metrology