HALCON Reference Manual 10.0.2
Table of Contents / 3D Matching / Surface-Based ClassesClassesClasses | | | Operators

get_surface_model_paramget_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParam (Operator)

Name

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

Signature

get_surface_model_param( : : SurfaceModelID, ParamName : ParamValue)

Herror get_surface_model_param(const Hlong SurfaceModelID, const char* ParamName, double* ParamValue)

Herror T_get_surface_model_param(const Htuple SurfaceModelID, const Htuple ParamName, Htuple* ParamValue)

Herror get_surface_model_param(const HTuple& SurfaceModelID, const HTuple& ParamName, double* ParamValue)

Herror get_surface_model_param(const HTuple& SurfaceModelID, const HTuple& ParamName, HTuple* ParamValue)

HTuple HSurfaceModel::GetSurfaceModelParam(const HTuple& ParamName) const

void HOperatorSetX.GetSurfaceModelParam(
[in] VARIANT SurfaceModelID, [in] VARIANT ParamName, [out] VARIANT* ParamValue)

VARIANT HSurfaceModelX.GetSurfaceModelParam([in] VARIANT ParamName)

static void HOperatorSet.GetSurfaceModelParam(HTuple surfaceModelID, HTuple paramName, out HTuple paramValue)

HTuple HSurfaceModel.GetSurfaceModelParam(HTuple paramName)

HTuple HSurfaceModel.GetSurfaceModelParam(string paramName)

Description

The operator get_surface_model_paramget_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParam returns parameters and properties of the surface model SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID. The surface model must have been created by create_surface_modelcreate_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel or read_surface_modelread_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModel. The names of the desired properties are passed in the generic parameter ParamNameParamNameParamNameParamNameparamName, the corresponding values are returned in ParamValueParamValueParamValueParamValueparamValue.

The following values are possible for ParamNameParamNameParamNameParamNameparamName:

'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 ObjectModel3DID 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_3dclear_object_model_3dClearObjectModel3dClearObjectModel3d 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 ObjectModel3DID 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_3dclear_object_model_3dClearObjectModel3dClearObjectModel3d to avoid memory leaks.

Parallelization

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control)  surface_model → HSurfaceModel, HTupleHSurfaceModel, HTupleHSurfaceModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Handle of the surface model.

ParamNameParamNameParamNameParamNameparamName (input_control)  attribute.name(-array) → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Name of the parameter.

Default value: 'diameter' "diameter" "diameter" "diameter" "diameter"

List of values: 'diameter'"diameter""diameter""diameter""diameter", 'center'"center""center""center""center", 'bounding_box1'"bounding_box1""bounding_box1""bounding_box1""bounding_box1", 'sampled_model'"sampled_model""sampled_model""sampled_model""sampled_model", 'sampled_pose_refinement'"sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement"

ParamValueParamValueParamValueParamValueparamValue (output_control)  attribute.value(-array) → HTupleHTupleVARIANTHtuple (real / string / integer) (double / string / int / long) (double / char* / Hlong) (double / BSTR / Hlong) (double / char* / Hlong)

Value of the parameter.

Result

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

Possible Predecessors

create_surface_modelcreate_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel, read_surface_modelread_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModel

Possible Successors

find_surface_modelfind_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPose, write_surface_modelwrite_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModel

See also

create_surface_modelcreate_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModel

Module

3D Metrology

Table of Contents / 3D Matching / Surface-Based ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH