set_planar_calib_deformable_model_metricT_set_planar_calib_deformable_model_metricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetric (Operator)


set_planar_calib_deformable_model_metricT_set_planar_calib_deformable_model_metricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetric — Set the metric of a planar calibrated deformable model that was created from XLD contours.


set_planar_calib_deformable_model_metric(Image : : ModelID, Pose, Metric : )

Herror T_set_planar_calib_deformable_model_metric(const Hobject Image, const Htuple ModelID, const Htuple Pose, const Htuple Metric)

void SetPlanarCalibDeformableModelMetric(const HObject& Image, const HTuple& ModelID, const HTuple& Pose, const HTuple& Metric)

void HDeformableModel::SetPlanarCalibDeformableModelMetric(const HImage& Image, const HPose& Pose, const HString& Metric) const

void HDeformableModel::SetPlanarCalibDeformableModelMetric(const HImage& Image, const HPose& Pose, const char* Metric) const

void HDeformableModel::SetPlanarCalibDeformableModelMetric(const HImage& Image, const HPose& Pose, const wchar_t* Metric) const   (Windows only)

void HImage::SetPlanarCalibDeformableModelMetric(const HDeformableModel& ModelID, const HPose& Pose, const HString& Metric) const

void HImage::SetPlanarCalibDeformableModelMetric(const HDeformableModel& ModelID, const HPose& Pose, const char* Metric) const

void HImage::SetPlanarCalibDeformableModelMetric(const HDeformableModel& ModelID, const HPose& Pose, const wchar_t* Metric) const   (Windows only)

static void HOperatorSet.SetPlanarCalibDeformableModelMetric(HObject image, HTuple modelID, HTuple pose, HTuple metric)

void HDeformableModel.SetPlanarCalibDeformableModelMetric(HImage image, HPose pose, string metric)

void HImage.SetPlanarCalibDeformableModelMetric(HDeformableModel modelID, HPose pose, string metric)


set_planar_calib_deformable_model_metricset_planar_calib_deformable_model_metricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetric changes the value of the parameter MetricMetricMetricMetricmetric that was selected during the creation of the deformable model ModelIDModelIDModelIDModelIDmodelID from XLD contours. Because no information about the polarity of the model contours is available for XLD contours, the polarity is determined based on a representative ImageImageImageImageimage. For this, the model contours are mapped to the respective position where the object appears in the ImageImageImageImageimage using PosePosePosePosepose, which can be obtained by a previous call to find_planar_calib_deformable_modelfind_planar_calib_deformable_modelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModel.

The parameter MetricMetricMetricMetricmetric then determines the conditions under which the model is recognized later in the search image. If MetricMetricMetricMetricmetric = 'use_polarity'"use_polarity""use_polarity""use_polarity""use_polarity", the object in the image and the model must have the same contrast. If, e.g., the model is a bright object on a dark background, the object is found only if it is also brighter than the background. If MetricMetricMetricMetricmetric = 'ignore_global_polarity'"ignore_global_polarity""ignore_global_polarity""ignore_global_polarity""ignore_global_polarity", the object is found in the image also if the contrast reverses globally. In the above example, the object hence is also found if it is darker than the background. The runtime of find_planar_calib_deformable_modelfind_planar_calib_deformable_modelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModel will increase slightly in this case.

It must be ensured that the object contours in the ImageImageImageImageimage have the same (or inverse) polarity as the object contours in the image in which the object must be searched later. Especially, the object must not be occluded in the ImageImageImageImageimage and the background must be either brighter than the object or darker. Otherwise, the determined polarity of the model contour will not represent the polarity of the object contour during the search. Note that only the polarity of the contours is determined, not their contrast. Note also that the polarity is determined from a single-channel image, only. If a multi-channel image is passed in ImageImageImageImageimage, only the first channel will be used (and no error message will be returned).

A typical proceeding is to read the XLD contours from file. Since these XLD contours do not provide polarity information, the model must be created from the XLD contours by setting the parameter MetricMetricMetricMetricmetric to 'ignore_local_polarity'"ignore_local_polarity""ignore_local_polarity""ignore_local_polarity""ignore_local_polarity". Then, in a first search image the model is recognized. The transformation that maps the model contours to the position of the object in the search image PosePosePosePosepose can be determined from the matching result. To verify the match interactively, the model contours can be mapped to this position. If the matching result is correct, the value of the parameter MetricMetricMetricMetricmetric can be changed, e.g., to 'use_polarity'"use_polarity""use_polarity""use_polarity""use_polarity". This leads to a faster and more robust recognition in the following images.


set_planar_calib_deformable_model_metricset_planar_calib_deformable_model_metricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetricSetPlanarCalibDeformableModelMetric can only be used with deformable models that were created from XLD contours.

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.


ImageImageImageImageimage (input_object)  singlechannelimage objectHImageHImageHobject (byte / uint2)

Input image used for the determination of the polarity.

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified)  deformable_model HDeformableModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

PosePosePosePosepose (input_control)  pose HPose, HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Pose of the model in the image.

Number of elements: 7

MetricMetricMetricMetricmetric (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Match metric.

Default value: 'use_polarity' "use_polarity" "use_polarity" "use_polarity" "use_polarity"

List of values: 'ignore_global_polarity'"ignore_global_polarity""ignore_global_polarity""ignore_global_polarity""ignore_global_polarity", 'use_polarity'"use_polarity""use_polarity""use_polarity""use_polarity"


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

Possible Predecessors

create_planar_calib_deformable_model_xldcreate_planar_calib_deformable_model_xldCreatePlanarCalibDeformableModelXldCreatePlanarCalibDeformableModelXldCreatePlanarCalibDeformableModelXld, find_planar_calib_deformable_modelfind_planar_calib_deformable_modelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModelFindPlanarCalibDeformableModel

Possible Successors


See also