set_surface_model_paramT_set_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamset_surface_model_param (Operator)

Name

set_surface_model_paramT_set_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamset_surface_model_param — Set parameters and properties of a surface model.

Signature

set_surface_model_param( : : SurfaceModelID, GenParamName, 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

void HSurfaceModel::SetSurfaceModelParam(const wchar_t* GenParamName, double GenParamValue) const   (Windows only)

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

void HSurfaceModel.SetSurfaceModelParam(string genParamName, HTuple genParamValue)

void HSurfaceModel.SetSurfaceModelParam(string genParamName, double genParamValue)

def set_surface_model_param(surface_model_id: HHandle, gen_param_name: str, gen_param_value: MaybeSequence[Union[str, float, int]]) -> None

Description

The operator set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParamset_surface_model_param sets parameters and properties of the surface model SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id. The surface model must have been created by create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModelcreate_surface_model or read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModelread_surface_model. The names of the desired properties are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

The possible values for GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name are listed below.

Attention

Note that in some cases, if this operator encounters an error condition while modifying the surface model, such as an out-of-memory error, the model might be left in an inconsistent, partly changed state. In such cases, it is recommended to clear the surface model and to no longer use it.

This does not apply to error codes due to invalid parameters, which are checked before performing any model modification.

Also note that setting some of the options requires re-generation of internal data structures and can take as long as the original create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModelcreate_surface_model.

Execution Information

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id (input_control, state is modified)  surface_model HSurfaceModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the parameter.

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

List of values: 'camera_parameter'"camera_parameter""camera_parameter""camera_parameter""camera_parameter""camera_parameter", 'camera_pose'"camera_pose""camera_pose""camera_pose""camera_pose""camera_pose", 'clear_cameras'"clear_cameras""clear_cameras""clear_cameras""clear_cameras""clear_cameras", 'pose_restriction_allowed_axis_direction'"pose_restriction_allowed_axis_direction""pose_restriction_allowed_axis_direction""pose_restriction_allowed_axis_direction""pose_restriction_allowed_axis_direction""pose_restriction_allowed_axis_direction", 'pose_restriction_allowed_axis_origin'"pose_restriction_allowed_axis_origin""pose_restriction_allowed_axis_origin""pose_restriction_allowed_axis_origin""pose_restriction_allowed_axis_origin""pose_restriction_allowed_axis_origin", 'pose_restriction_filter_final_poses_only'"pose_restriction_filter_final_poses_only""pose_restriction_filter_final_poses_only""pose_restriction_filter_final_poses_only""pose_restriction_filter_final_poses_only""pose_restriction_filter_final_poses_only", 'pose_restriction_max_angle_diff'"pose_restriction_max_angle_diff""pose_restriction_max_angle_diff""pose_restriction_max_angle_diff""pose_restriction_max_angle_diff""pose_restriction_max_angle_diff", 'pose_restriction_reference_pose'"pose_restriction_reference_pose""pose_restriction_reference_pose""pose_restriction_reference_pose""pose_restriction_reference_pose""pose_restriction_reference_pose", 'self_similar_poses'"self_similar_poses""self_similar_poses""self_similar_poses""self_similar_poses""self_similar_poses", 'symmetry_axis_direction'"symmetry_axis_direction""symmetry_axis_direction""symmetry_axis_direction""symmetry_axis_direction""symmetry_axis_direction", 'symmetry_axis_origin'"symmetry_axis_origin""symmetry_axis_origin""symmetry_axis_origin""symmetry_axis_origin""symmetry_axis_origin", 'symmetry_poses'"symmetry_poses""symmetry_poses""symmetry_poses""symmetry_poses""symmetry_poses"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value(-array) HTupleMaybeSequence[Union[str, float, int]]HTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Value of the parameter.

Suggested values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false", [], [0,0,0,0,0,0,0], [0,0,1]

Result

set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamSetSurfaceModelParamset_surface_model_param returns TRUE if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModelcreate_surface_model, read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModelread_surface_model, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParamget_surface_model_param

Possible Successors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelFindSurfaceModelfind_surface_model, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose, write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModelwrite_surface_model, find_surface_model_imagefind_surface_model_imageFindSurfaceModelImageFindSurfaceModelImageFindSurfaceModelImagefind_surface_model_image, refine_surface_model_pose_imagerefine_surface_model_pose_imageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImagerefine_surface_model_pose_image

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModelcreate_surface_model, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParamget_surface_model_param

Module

3D Metrology