create_local_deformable_modelCreateLocalDeformableModelCreateLocalDeformableModelcreate_local_deformable_modelT_create_local_deformable_model🔗

Short description🔗

create_local_deformable_modelCreateLocalDeformableModelCreateLocalDeformableModelcreate_local_deformable_modelT_create_local_deformable_model — Creates a deformable model for local, deformable matching.

Signature🔗

create_local_deformable_model( image Template, integer NumLevels, angle.rad AngleStart, angle.rad AngleExtent, angle.rad AngleStep, number ScaleRMin, number ScaleRMax, number ScaleRStep, number ScaleCMin, number ScaleCMax, number ScaleCStep, string Optimization, string Metric, number Contrast, number MinContrast, string GenParamName, integer GenParamValue, out deformable_model ModelID )

Description🔗

The operator create_local_deformable_modelCreateLocalDeformableModel prepares a template, which is passed in the image Templatetemplatetemplate, as a deformable model used for local deformable matching. The ROI of the model is passed as the domain of Templatetemplatetemplate.

The local deformable matching can be used to detect an object that is distorted by a local deformation, estimate the deformation, and rectify the image area where the object is found. For a distinction from further matching methods we refer to the “Solution Guide I” chapter ‘2D Matching’.

As described in create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel, the origin (reference point) of the model is defined as the center of gravity of the domain (region) of the model image Templatetemplatetemplate. Further, the axis-aligned enclosing rectangle of the domain of the Templatetemplatetemplate is used to determine the area of the search image that is rectified in calls of find_local_deformable_modelFindLocalDeformableModel.

For further explanation on the parameters used for the creation of a local deformable model we refer to the description of create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel. Note, that the parameters of the actual deformation are set with the call of find_local_deformable_modelFindLocalDeformableModel.

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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

Templatetemplatetemplate (input_object) (multichannel-)image → object (byte / uint2)HObject (byte / uint2)HImage (byte / uint2)HObject (byte / uint2)Hobject (byte / uint2)

Input image whose domain will be used to create the model.

NumLevelsnumLevelsnum_levels (input_control) integer → (integer / string)HTuple (Hlong / HString)HTuple (int / long / string)Union[int, str]Htuple (Hlong / char*)

Maximum number of pyramid levels.

Default: 'auto'"auto"
List of values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 'auto'

AngleStartangleStartangle_start (input_control) angle.rad-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

This parameter is not used.

Default: [][]

AngleExtentangleExtentangle_extent (input_control) angle.rad-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

This parameter is not used.

Default: [][]

AngleStepangleStepangle_step (input_control) angle.rad → (real / string)HTuple (double / HString)HTuple (double / string)Union[float, str]Htuple (double / char*)

Step length of the angles (resolution).

Default: 'auto'"auto"
Suggested values: 'auto', 0.0175, 0.0349, 0.0524, 0.0698, 0.0873
Restriction: AngleStep > 0 && AngleStep <= pi/16

ScaleRMinscaleRMinscale_rmin (input_control) number → (real)HTuple (double)HTuple (double)floatHtuple (double)

Minimum scale of the pattern in row direction.

Default: 1.01.0
Suggested values: 0.5, 0.6, 0.7, 0.8, 0.9, 1.00.5, 0.6, 0.7, 0.8, 0.9, 1.0
Restriction: ScaleRMin > 0

ScaleRMaxscaleRMaxscale_rmax (input_control) number-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

This parameter is not used.

Default: [][]

ScaleRStepscaleRStepscale_rstep (input_control) number → (real / string)HTuple (double / HString)HTuple (double / string)Union[float, str]Htuple (double / char*)

Scale step length (resolution) in row direction.

Default: 'auto'"auto"
Suggested values: 'auto', 0.01, 0.02, 0.05, 0.1, 0.15, 0.2
Restriction: ScaleRStep >= 0

ScaleCMinscaleCMinscale_cmin (input_control) number → (real)HTuple (double)HTuple (double)floatHtuple (double)

Minimum scale of the pattern in column direction.

Default: 1.01.0
Suggested values: 0.5, 0.6, 0.7, 0.8, 0.9, 1.00.5, 0.6, 0.7, 0.8, 0.9, 1.0
Restriction: ScaleCMin > 0

ScaleCMaxscaleCMaxscale_cmax (input_control) number-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

This parameter is not used.

Default: [][]

ScaleCStepscaleCStepscale_cstep (input_control) number → (real / string)HTuple (double / HString)HTuple (double / string)Union[float, str]Htuple (double / char*)

Scale step length (resolution) in column direction.

Default: 'auto'"auto"
Suggested values: 'auto', 0.01, 0.02, 0.05, 0.1, 0.15, 0.2
Restriction: ScaleCStep >= 0

Optimizationoptimizationoptimization (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Kind of optimization used for generating the model.

Default: 'none'"none"
List of values: 'auto', 'none', 'point_reduction_high', 'point_reduction_low', 'point_reduction_medium'

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

Match metric.

Default: 'use_polarity'"use_polarity"
List of values: 'ignore_color_polarity', 'ignore_global_polarity', 'ignore_local_polarity', 'ignore_part_polarity', 'use_polarity'

Contrastcontrastcontrast (input_control) number-array → (integer / string)HTuple (Hlong / HString)HTuple (int / long / string)Sequence[Union[int, str]]Htuple (Hlong / char*)

Thresholds or hysteresis thresholds for the contrast of the object in the template image.

Default: 'auto'"auto"
Suggested values: 'auto', 10, 20, 30, 40, 60, 80, 100, 120, 140, 160

MinContrastminContrastmin_contrast (input_control) number → (integer / string)HTuple (Hlong / HString)HTuple (int / long / string)Union[int, str]Htuple (Hlong / char*)

Minimum contrast of the objects in the search images.

Default: 'auto'"auto"
Suggested values: 'auto', 1, 2, 3, 5, 7, 10, 20, 30, 40"auto", 1, 2, 3, 5, 7, 10, 20, 30, 40
Restriction: MinContrast < Contrast

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

The generic parameter names.

Default: [][]
List of values: [], 'min_size', 'part_size'[], "min_size", "part_size"

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

Values of the generic parameters.

Default: [][]
List of values: [], 'big', 'medium', 'small'[], "big", "medium", "small"

ModelIDmodelIDmodel_id (output_control) deformable_model → (handle)HTuple (HHandle)HDeformableModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the model.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

determine_deformable_model_paramsDetermineDeformableModelParams

Possible successors

set_deformable_model_originSetDeformableModelOrigin, set_deformable_model_paramSetDeformableModelParam, get_deformable_model_contoursGetDeformableModelContours, find_local_deformable_modelFindLocalDeformableModel, get_deformable_model_paramsGetDeformableModelParams, write_deformable_modelWriteDeformableModel, clear_deformable_modelClearDeformableModel

Alternatives

read_deformable_modelReadDeformableModel

Module🔗

Matching