ClassesClasses | | Operators

set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParam (Operator)

Name

set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParam — Set parameters and properties of a surface model.

Signature

set_surface_model_param( : : SurfaceModelID, GenParamName, GenParamValue : )

Herror set_surface_model_param(const Hlong SurfaceModelID, const char* GenParamName, double GenParamValue)

Herror T_set_surface_model_param(const Htuple SurfaceModelID, const Htuple GenParamName, const Htuple GenParamValue)

void SetSurfaceModelParam(const HTuple& SurfaceModelID, const HTuple& GenParamName, const HTuple& GenParamValue)

void HSurfaceModel::SetSurfaceModelParam(const HString& GenParamName, const HTuple& GenParamValue) const

void HSurfaceModel::SetSurfaceModelParam(const HString& GenParamName, double GenParamValue) const

void HSurfaceModel::SetSurfaceModelParam(const char* GenParamName, double GenParamValue) const

static void HOperatorSet.SetSurfaceModelParam(HTuple surfaceModelID, HTuple genParamName, HTuple genParamValue)

void HSurfaceModel.SetSurfaceModelParam(string genParamName, HTuple genParamValue)

void HSurfaceModel.SetSurfaceModelParam(string genParamName, double genParamValue)

Description

The operator set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParam sets 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 passed in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue.

The following values are possible for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName:

'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":

Sets 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 are used by the operators find_surface_model_imagefind_surface_model_imageFindSurfaceModelImageFindSurfaceModelImageFindSurfaceModelImage and refine_surface_model_pose_imagerefine_surface_model_pose_imageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImage, which use the images corresponding to the camera for the 3D pose refinement. Cameras must be added in increasing order.

'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":

Sets 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). The pose defaults to the zero-pose [0,0,0,0,0,0,0] when adding a new camera with 'camera_parameter'"camera_parameter""camera_parameter""camera_parameter""camera_parameter". This usually means that camera and 3D sensor have the same point of origin.

'clear_cameras'"clear_cameras""clear_cameras""clear_cameras""clear_cameras":

Removes all previously set cameras from the surface model.

Execution Information

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control)  surface_model HSurfaceModel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the surface model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the parameter.

Default value: 'camera_parameter' "camera_parameter" "camera_parameter" "camera_parameter" "camera_parameter"

List of values: 'camera_parameter'"camera_parameter""camera_parameter""camera_parameter""camera_parameter", 'camera_pose'"camera_pose""camera_pose""camera_pose""camera_pose", 'clear_cameras'"clear_cameras""clear_cameras""clear_cameras""clear_cameras"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  attribute.value(-array) HTupleHTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Value of the parameter.

Result

set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParam 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, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParam

Possible Successors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModel, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPose, write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel, find_surface_model_imagefind_surface_model_imageFindSurfaceModelImageFindSurfaceModelImageFindSurfaceModelImage, refine_surface_model_pose_imagerefine_surface_model_pose_imageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImage

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParam

Module

3D Metrology


ClassesClasses | | Operators