Skip to content

set_deformable_model_paramSetDeformableModelParamSetDeformableModelParamset_deformable_model_paramT_set_deformable_model_param🔗

Short description🔗

set_deformable_model_paramSetDeformableModelParamSetDeformableModelParamset_deformable_model_paramT_set_deformable_model_param — Set selected parameters of the deformable model.

Signature🔗

set_deformable_model_param( deformable_model ModelID, attribute.name GenParamName, attribute.value GenParamValue )void SetDeformableModelParam( const HTuple& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetDeformableModelParam( HTuple modelID, HTuple genParamName, HTuple genParamValue )def set_deformable_model_param( model_id: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[float, int, str]] ) -> None

Herror T_set_deformable_model_param( const Htuple ModelID, const Htuple GenParamName, const Htuple GenParamValue )

void HDeformableModel::SetDeformableModelParam( const HTuple& GenParamName, const HTuple& GenParamValue ) const

void HDeformableModel.SetDeformableModelParam( HTuple genParamName, HTuple genParamValue )

Description🔗

The operator set_deformable_model_paramSetDeformableModelParam sets the selected parameters GenParamNamegenParamNamegen_param_name in the deformable model ModelIDmodelIDmodel_id. The following parameters can be modified:

'min_contrast'"min_contrast"

Sets the minimum contrast of the object in the search images for the deformable model ModelIDmodelIDmodel_id. Thereby, the value of 'min_contrast'"min_contrast" that was originally set, e.g., with create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel, is overwritten for the deformable model ModelIDmodelIDmodel_id. Note that if the deformable model ModelIDmodelIDmodel_id was read from file and if this file should be changed as well, the deformable model ModelIDmodelIDmodel_id must again be written to file after the execution of the operator set_deformable_model_paramSetDeformableModelParam.

'get_deformable_model_contours_coord_system'"get_deformable_model_contours_coord_system"

Sets the coordinate system in which the contours are returned when calling the operator get_deformable_model_contoursGetDeformableModelContours. If 'world'"world" is passed, the contours are returned in the world coordinate system in metric units. Note that this is only possible for the calibrated case. If 'image'"image" is passed, the contours are returned in the image coordinate system in pixel units. In the calibrated case this system corresponds to the rectified image coordinate system. The rectified image coordinate system is the coordinate system of an image one would obtain by change_radial_distortion_imageChangeRadialDistortionImage when using the rectified camera parameters. The rectified camera parameters can be queried by get_deformable_model_paramsGetDeformableModelParams. If the model was created by create_planar_calib_deformable_model_xldCreatePlanarCalibDeformableModelXld the value of 'get_deformable_model_contours_coord_system'"get_deformable_model_contours_coord_system" is 'world'"world" by default. In all other cases it is 'image'"image" by default.

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

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🔗

ModelIDmodelIDmodel_id (input_control, state is modified) deformable_model → (handle)HTuple (HHandle)HDeformableModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Parameter names.

List of values: 'get_deformable_model_contours_coord_system', 'min_contrast'"get_deformable_model_contours_coord_system", "min_contrast"

GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (real / integer / string)HTuple (double / Hlong / HString)HTuple (double / int / long / string)Sequence[Union[float, int, str]]Htuple (double / Hlong / char*)

Parameter values.

Suggested values: 5, 6, 7, 8, 9, 10, 'image', 'world'5, 6, 7, 8, 9, 10, "image", "world"

Result🔗

If the parameters are valid, the operator set_deformable_model_paramSetDeformableModelParam returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel, create_planar_calib_deformable_modelCreatePlanarCalibDeformableModel, create_local_deformable_modelCreateLocalDeformableModel, read_deformable_modelReadDeformableModel

Possible successors

find_planar_uncalib_deformable_modelFindPlanarUncalibDeformableModel, find_planar_calib_deformable_modelFindPlanarCalibDeformableModel

See also

get_deformable_model_contoursGetDeformableModelContours, get_deformable_model_paramsGetDeformableModelParams

Module🔗

Matching