get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParam (Operator)

Name

get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParam — Return the parameters and properties of a surface model.

Signature

Description

The operator get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParam returns parameters and properties of the surface model SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID. The surface model must have been created by create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel or read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel. The names of the desired properties are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue.

The following values are possible for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName:

'diameter'"diameter""diameter""diameter""diameter":

Diameter of the model point cloud. The diameter is the length of the diagonal of the axis-parallel bounding box (see parameter 'bounding_box1'"bounding_box1""bounding_box1""bounding_box1""bounding_box1").

'center'"center""center""center""center":

Center point of the model. The center point is the center of the axis-parallel bounding box (see parameter 'bounding_box1'"bounding_box1""bounding_box1""bounding_box1""bounding_box1").

'bounding_box1'"bounding_box1""bounding_box1""bounding_box1""bounding_box1":

Smallest enclosing axis-parallel cuboid (min_x, min_y, min_z, max_x, max_y, max_z).

'sampled_model'"sampled_model""sampled_model""sampled_model""sampled_model":

The 3D points sampled from the model for matching. This returns an ObjectModel3D that contains all points sampled from the model surface for matching. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d to avoid memory leaks.

'sampled_pose_refinement'"sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement":

The 3D model points subsampled from the model for the pose refinement. This returns an ObjectModel3D that contains all points sampled from the model surface for pose refinement. The returned ObjectModel3D handle must be freed with clear_object_model_3dclear_object_model_3dClearObjectModel3dClearObjectModel3dClearObjectModel3d to avoid memory leaks.

'3d_edges_trained'"3d_edges_trained""3d_edges_trained""3d_edges_trained""3d_edges_trained":

Returns if the surface model was prepared for edge-supported surface-based matching, i.e., if the parameter 'train_3d_edges'"train_3d_edges""train_3d_edges""train_3d_edges""train_3d_edges" was enabled in create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel. The returned value is either 'true'"true""true""true""true" or 'false'"false""false""false""false".

'camera_parameter'"camera_parameter""camera_parameter""camera_parameter""camera_parameter":

'camera_parameter X'"camera_parameter X""camera_parameter X""camera_parameter X""camera_parameter X":

Returns the camera parameters for camera number X, where X is a zero-based index for the cameras. If not given, X defaults zero (first camera). The camera parameters must previously have been set by set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParam.

'camera_pose'"camera_pose""camera_pose""camera_pose""camera_pose":

'camera_pose X'"camera_pose X""camera_pose X""camera_pose X""camera_pose X":

Returns the camera pose for camera number X, where X is a zero-based index for the cameras. If not given, X defaults zero (first camera).

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

get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParam returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel, read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel

Possible Successors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose, write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel, set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParam

Module

3D Metrology