ClassesClassesClassesClasses | | | | Operators

get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResult (Operator)

Name

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

Signature

get_surface_matching_result( : : SurfaceMatchingResultID, ResultName, ResultIndex : ResultValue)

Herror get_surface_matching_result(const Hlong SurfaceMatchingResultID, const char* ResultName, const Hlong ResultIndex, Hlong* ResultValue)

Herror T_get_surface_matching_result(const Htuple SurfaceMatchingResultID, const Htuple ResultName, const Htuple ResultIndex, Htuple* ResultValue)

Herror get_surface_matching_result(const HTuple& SurfaceMatchingResultID, const HTuple& ResultName, const HTuple& ResultIndex, Hlong* ResultValue)

Herror get_surface_matching_result(const HTuple& SurfaceMatchingResultID, const HTuple& ResultName, const HTuple& ResultIndex, HTuple* ResultValue)

HTuple HSurfaceMatchingResult::GetSurfaceMatchingResult(const HTuple& ResultName, const HTuple& ResultIndex) const

void GetSurfaceMatchingResult(const HTuple& SurfaceMatchingResultID, const HTuple& ResultName, const HTuple& ResultIndex, HTuple* ResultValue)

HTuple HSurfaceMatchingResult::GetSurfaceMatchingResult(const HTuple& ResultName, Hlong ResultIndex) const

HTuple HSurfaceMatchingResult::GetSurfaceMatchingResult(const HString& ResultName, Hlong ResultIndex) const

HTuple HSurfaceMatchingResult::GetSurfaceMatchingResult(const char* ResultName, Hlong ResultIndex) const

void HOperatorSetX.GetSurfaceMatchingResult(
[in] VARIANT SurfaceMatchingResultID, [in] VARIANT ResultName, [in] VARIANT ResultIndex, [out] VARIANT* ResultValue)

VARIANT HSurfaceMatchingResultX.GetSurfaceMatchingResult(
[in] VARIANT ResultName, [in] Hlong ResultIndex)

static void HOperatorSet.GetSurfaceMatchingResult(HTuple surfaceMatchingResultID, HTuple resultName, HTuple resultIndex, out HTuple resultValue)

HTuple HSurfaceMatchingResult.GetSurfaceMatchingResult(HTuple resultName, int resultIndex)

HTuple HSurfaceMatchingResult.GetSurfaceMatchingResult(string resultName, int resultIndex)

Description

The operator get_surface_matching_resultget_surface_matching_resultGetSurfaceMatchingResultget_surface_matching_resultGetSurfaceMatchingResultGetSurfaceMatchingResult returns details about the results of surface based matching or the surface pose refinement. The results are stored in SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID, which must have been created by find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel or refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose.

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

The following values are possible for ResultNameResultNameResultNameResultNameResultNameresultName:

'sampled_scene'"sampled_scene""sampled_scene""sampled_scene""sampled_scene""sampled_scene":

If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel, 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_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel). The parameter ResultIndexResultIndexResultIndexResultIndexResultIndexresultIndex is ignored. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dclear_object_model_3dClearObjectModel3dClearObjectModel3d. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose, an empty 3D object model is returned.

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

If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel 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_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel). The parameter ResultIndexResultIndexResultIndexResultIndexResultIndexresultIndex 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_3dClearObjectModel3dclear_object_model_3dClearObjectModel3dClearObjectModel3d. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose, a 3D object model with no content is returned.

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

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

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

If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel, 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_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel for details about the score. In ResultIndexResultIndexResultIndexResultIndexResultIndexresultIndex the index of the result must be specified. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose, 0 is returned.

'score_refined'"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_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel for details about this score. In ResultIndexResultIndexResultIndexResultIndexResultIndexresultIndex the index of the result must be specified. If SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID was created by find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel and dense pose refinement was disabled, 0 is returned.

Parallelization

Parameters

SurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDSurfaceMatchingResultIDsurfaceMatchingResultID (input_control)  surface_matching_result HSurfaceMatchingResult, HTupleHTupleHSurfaceMatchingResult, HTupleHSurfaceMatchingResultX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the surface matching result.

ResultNameResultNameResultNameResultNameResultNameresultName (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the result property.

Default value: 'pose' "pose" "pose" "pose" "pose" "pose"

List of values: 'key_points'"key_points""key_points""key_points""key_points""key_points", 'pose'"pose""pose""pose""pose""pose", 'sampled_scene'"sampled_scene""sampled_scene""sampled_scene""sampled_scene""sampled_scene", 'score_refined'"score_refined""score_refined""score_refined""score_refined""score_refined", 'score_unrefined'"score_unrefined""score_unrefined""score_unrefined""score_unrefined""score_unrefined"

ResultIndexResultIndexResultIndexResultIndexResultIndexresultIndex (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Index of the matching result, starting with 0.

Default value: 0

Suggested values: 0, 1, 2, 3

Restriction: ResultIndex >= 0

ResultValueResultValueResultValueResultValueResultValueresultValue (output_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer / string / real) (int / long / string / double) (Hlong / HString / double) (Hlong / char* / double) (Hlong / BSTR / double) (Hlong / char* / double)

Value of the result property.

Result

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

Possible Predecessors

find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose

Possible Successors

clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel

See also

find_surface_modelfind_surface_modelFindSurfaceModelfind_surface_modelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose, read_surface_modelread_surface_modelReadSurfaceModelread_surface_modelReadSurfaceModelReadSurfaceModel, write_surface_modelwrite_surface_modelWriteSurfaceModelwrite_surface_modelWriteSurfaceModelWriteSurfaceModel, clear_surface_modelclear_surface_modelClearSurfaceModelclear_surface_modelClearSurfaceModelClearSurfaceModel

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators