get_deformable_model_paramsT_get_deformable_model_paramsGetDeformableModelParamsGetDeformableModelParams (Operator)

Name

get_deformable_model_paramsT_get_deformable_model_paramsGetDeformableModelParamsGetDeformableModelParams — Return the parameters of a deformable model.

Signature

Description

The operator get_deformable_model_paramsget_deformable_model_paramsGetDeformableModelParamsGetDeformableModelParamsGetDeformableModelParams allows to query parameters of the deformable model. The names of the desired parameters are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue.

The following parameters can be queried:

'cam_param'"cam_param""cam_param""cam_param""cam_param":

Internal parameters of the camera that is used for the calibrated case.

'cam_param_rect'"cam_param_rect""cam_param_rect""cam_param_rect""cam_param_rect":

Rectified internal parameters of the camera that is used for the calibrated case.

'reference_pose'"reference_pose""reference_pose""reference_pose""reference_pose":

Reference position and orientation of the calibrated deformable model. The returned pose describes the model plane that the user provided.

'model_pose'"model_pose""model_pose""model_pose""model_pose":

Reference position and orientation of the deformable model. The returned pose describes the pose of the internally used 3D metric model that was used for model generation.

'angle_start'"angle_start""angle_start""angle_start""angle_start":

The smallest rotation angle of the model.

'angle_extent'"angle_extent""angle_extent""angle_extent""angle_extent":

The extent of the rotation angle of the model.

'angle_step'"angle_step""angle_step""angle_step""angle_step":

The angle step length of the model.

'scale_r_min'"scale_r_min""scale_r_min""scale_r_min""scale_r_min":

The minimum scale of the pattern in row direction.

'scale_r_max'"scale_r_max""scale_r_max""scale_r_max""scale_r_max":

The maximum scale of the pattern in row direction.

'scale_r_step'"scale_r_step""scale_r_step""scale_r_step""scale_r_step":

The scale step of the pattern in row direction.

'scale_c_min'"scale_c_min""scale_c_min""scale_c_min""scale_c_min":

The minimum scale of the pattern in column direction.

'scale_c_max'"scale_c_max""scale_c_max""scale_c_max""scale_c_max":

The maximum scale of the pattern in column direction.

'scale_c_step'"scale_c_step""scale_c_step""scale_c_step""scale_c_step":

The scale step of the pattern in column direction.

'num_levels'"num_levels""num_levels""num_levels""num_levels":

User-specified number of pyramid levels.

'optimization'"optimization""optimization""optimization""optimization":

Kind of optimization by reducing the number of model points.

'min_size'"min_size""min_size""min_size""min_size":

Minimum size of the deformable model edge.

'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast":

Minimum contrast of the objects in the search images.

'metric'"metric""metric""metric""metric":

Match metric.

'model_row'"model_row""model_row""model_row""model_row":

Row coordinate of origin in the radial undistorted model image.

'model_col'"model_col""model_col""model_col""model_col":

Column coordinate of origin in the radial undistorted model image.

'model_type'"model_type""model_type""model_type""model_type":

The type of the model: 'planar_uncalib', 'planar_calib' or 'local'.

'created_from_xld'"created_from_xld""created_from_xld""created_from_xld""created_from_xld":

Was the model created from XLD or from an image: 'created_from_xld' or 'created_from_image'.

'get_deformable_model_contours_coord_system'"get_deformable_model_contours_coord_system""get_deformable_model_contours_coord_system""get_deformable_model_contours_coord_system""get_deformable_model_contours_coord_system":

Coordinate system ('image'"image""image""image""image" or 'world'"world""world""world""world") in which contours are returned when calling the operator get_deformable_model_contoursget_deformable_model_contoursGetDeformableModelContoursGetDeformableModelContoursGetDeformableModelContours.

A detailed description of the parameters can be looked up with the operator create_planar_uncalib_deformable_modelcreate_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModel and create_planar_calib_deformable_modelcreate_planar_calib_deformable_modelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModel or with the operator get_deformable_model_contoursget_deformable_model_contoursGetDeformableModelContoursGetDeformableModelContoursGetDeformableModelContours.

Note that although the parameter ContrastContrastContrastContrastcontrast can be determined automatically during the model creation, its value cannot be queried using get_deformable_model_paramsget_deformable_model_paramsGetDeformableModelParamsGetDeformableModelParamsGetDeformableModelParams. Instead, the operator determine_deformable_model_paramsdetermine_deformable_model_paramsDetermineDeformableModelParamsDetermineDeformableModelParamsDetermineDeformableModelParams should be used to retrieve its value.

It is possible to query the values of several parameters with a single operator call by passing a tuple containing the names of all desired parameters to GenParamNameGenParamNameGenParamNameGenParamNamegenParamName. As a result a tuple of the same length with the corresponding values is returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. Note that this is solely possible for parameters that return only a single value.

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

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

Possible Predecessors

create_planar_uncalib_deformable_modelcreate_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModel, create_planar_calib_deformable_modelcreate_planar_calib_deformable_modelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModel, create_local_deformable_modelcreate_local_deformable_modelCreateLocalDeformableModelCreateLocalDeformableModelCreateLocalDeformableModel

Possible Successors

find_planar_uncalib_deformable_modelfind_planar_uncalib_deformable_modelFindPlanarUncalibDeformableModelFindPlanarUncalibDeformableModelFindPlanarUncalibDeformableModel, find_planar_calib_deformable_modelfind_planar_calib_deformable_modelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModel

See also

set_deformable_model_paramset_deformable_model_paramSetDeformableModelParamSetDeformableModelParamSetDeformableModelParam

Module

Matching