set_offset_templateT_set_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template (Operator)

Name

set_offset_templateT_set_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template — Gray value offset for template.

Warning

set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template is obsolete and is only provided for reasons of backward compatibility. New applications should use the shape-based or NCC-based operators instead.

Signature

set_offset_template( : : TemplateID, GrayOffset : )

Description

set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template adds a gray value offset to the template to eliminate gray value changes in the image. The parameter GrayOffsetGrayOffsetGrayOffsetgrayOffsetgray_offset specifies a difference relative to the gray values of the pattern when it was created with create_templatecreate_templateCreateTemplateCreateTemplatecreate_template (not relative to the last call of set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template). The values of GrayOffsetGrayOffsetGrayOffsetgrayOffsetgray_offset has to be chosen according to the gray values of the image: A brighter image results in a positive value, a darker image results in a negative value. set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template has to be called each time the gray values of the image changes. The gray values can be measured in a reference area using intensityintensityIntensityIntensityintensity or min_max_graymin_max_grayMinMaxGrayMinMaxGraymin_max_gray

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:

TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

TemplateIDTemplateIDTemplateIDtemplateIDtemplate_id (input_control, state is modified) template → (handle)

Template number.

GrayOffsetGrayOffsetGrayOffsetgrayOffsetgray_offset (input_control) number → (integer)

Offset of gray values.

Default: 0

Suggested values: -10, -5, -2, -1, 0, 1, 2, 5, 10

Value range: -255 ≤ GrayOffset GrayOffset GrayOffset grayOffset gray_offset ≤ 255

Minimum increment: 1

Recommended increment: 1

Result

If the parameter values are correct, the operator set_offset_templateset_offset_templateSetOffsetTemplateSetOffsetTemplateset_offset_template returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

create_templatecreate_templateCreateTemplateCreateTemplatecreate_template, adapt_templateadapt_templateAdaptTemplateAdaptTemplateadapt_template, read_templateread_templateReadTemplateReadTemplateread_template

Possible Successors

best_matchbest_matchBestMatchBestMatchbest_match, best_match_mgbest_match_mgBestMatchMgBestMatchMgbest_match_mg, best_match_rotbest_match_rotBestMatchRotBestMatchRotbest_match_rot, fast_matchfast_matchFastMatchFastMatchfast_match, fast_match_mgfast_match_mgFastMatchMgFastMatchMgfast_match_mg

Module

Matching

Operators