Skip to content

set_planar_uncalib_deformable_model_metricset_planar_uncalib_deformable_model_metricSetPlanarUncalibDeformableModelMetricSetPlanarUncalibDeformableModelMetricset_planar_uncalib_deformable_model_metricT_set_planar_uncalib_deformable_model_metric🔗

Short description🔗

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

Signature🔗

set_planar_uncalib_deformable_model_metric( image Image, deformable_model ModelID, hom_mat2d HomMat2D, string Metric )set_planar_uncalib_deformable_model_metric( Image : : ModelID, HomMat2D, Metric : )void SetPlanarUncalibDeformableModelMetric( const HObject& Image, const HTuple& ModelID, const HTuple& HomMat2D, const HTuple& Metric )static void HOperatorSet.SetPlanarUncalibDeformableModelMetric( HObject image, HTuple modelID, HTuple homMat2D, HTuple metric )def set_planar_uncalib_deformable_model_metric( image: HObject, model_id: HHandle, hom_mat_2d: Sequence[float], metric: str ) -> None

Herror T_set_planar_uncalib_deformable_model_metric( const Hobject Image, const Htuple ModelID, const Htuple HomMat2D, const Htuple Metric )

void HDeformableModel::SetPlanarUncalibDeformableModelMetric( const HImage& Image, const HHomMat2D& HomMat2D, const HString& Metric ) const

void HDeformableModel::SetPlanarUncalibDeformableModelMetric( const HImage& Image, const HHomMat2D& HomMat2D, const char* Metric ) const

void HDeformableModel::SetPlanarUncalibDeformableModelMetric( const HImage& Image, const HHomMat2D& HomMat2D, const wchar_t* Metric ) const (Windows only)

void HImage::SetPlanarUncalibDeformableModelMetric( const HDeformableModel& ModelID, const HHomMat2D& HomMat2D, const HString& Metric ) const

void HImage::SetPlanarUncalibDeformableModelMetric( const HDeformableModel& ModelID, const HHomMat2D& HomMat2D, const char* Metric ) const

void HImage::SetPlanarUncalibDeformableModelMetric( const HDeformableModel& ModelID, const HHomMat2D& HomMat2D, const wchar_t* Metric ) const (Windows only)

void HDeformableModel.SetPlanarUncalibDeformableModelMetric( HImage image, HHomMat2D homMat2D, string metric )

void HImage.SetPlanarUncalibDeformableModelMetric( HDeformableModel modelID, HHomMat2D homMat2D, string metric )

Description🔗

set_planar_uncalib_deformable_model_metricSetPlanarUncalibDeformableModelMetric changes the value of the parameter Metricmetricmetric that was selected during the creation of the deformable model ModelIDmodelIDmodel_id 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 Imageimageimage. For this, the model contours are mapped to the respective position where the object appears in the Imageimageimage using HomMat2DhomMat2Dhom_mat_2d, which can be obtained by a previous call to find_planar_uncalib_deformable_modelFindPlanarUncalibDeformableModel.

The parameter Metricmetricmetric then determines the conditions under which the model is recognized later in the search image. If Metricmetricmetric \(=\) '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 Metricmetricmetric \(=\) '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_uncalib_deformable_modelFindPlanarUncalibDeformableModel will increase slightly in this case.

It must be ensured that the object contours in the Imageimageimage 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 Imageimageimage 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 Imageimageimage, 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 Metricmetricmetric to '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 (HomMat2DhomMat2Dhom_mat_2d) 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 Metricmetricmetric can be changed, e.g., to 'use_polarity'"use_polarity". This leads to a faster and more robust recognition in the following images.

Attention🔗

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

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🔗

Imageimageimage (input_object) singlechannelimage → object (byte / uint2)object (byte / uint2)HObject (byte / uint2)HImage (byte / uint2)HObject (byte / uint2)Hobject (byte / uint2)

Input image used for the determination of the polarity.

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

Handle of the model.

HomMat2DhomMat2Dhom_mat_2d (input_control) hom_mat2d → (real)(real)HTuple (double)HHomMat2D, HTuple (double)Sequence[float]Htuple (double)

Transformation matrix.

Metricmetricmetric (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Match metric.

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

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_planar_uncalib_deformable_model_xldCreatePlanarUncalibDeformableModelXld, find_planar_uncalib_deformable_modelFindPlanarUncalibDeformableModel

Possible successors

find_planar_uncalib_deformable_modelFindPlanarUncalibDeformableModel

See also

create_planar_uncalib_deformable_model_xldCreatePlanarUncalibDeformableModelXld

Module🔗

Matching