set_bar_code_param_specificT_set_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecific (Operator)

Name

set_bar_code_param_specificT_set_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecific — Set selected parameters of the bar code model for selected bar code types

Signature

Description

The operator set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecific is used to set or change the different parameters of a bar code model for selected bar code types in order to adapt to special properties of the bar codes. Contrary to set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamSetBarCodeParam, only parameters for selected bar code types will be changed with set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecific. This is useful when searching different code types within one image (see section Autodiscrimination in find_bar_codefind_bar_codeFindBarCodeFindBarCodeFindBarCode).

The current configuration of the bar code model for a specified bar code type can be queried with get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificGetBarCodeParamSpecific.

The following generic parameters can be set for specific bar code types:

'num_scanlines'"num_scanlines""num_scanlines""num_scanlines""num_scanlines":

Maximal number of scanlines used during the scanning of a (candidate) bar code.

Typical values: [0, 5, 10, 20 ...]

Default: 0

'min_identical_scanlines'"min_identical_scanlines""min_identical_scanlines""min_identical_scanlines""min_identical_scanlines":

Minimal number of decoded scanlines which return identical data to read the bar code successfully.

Typical values: [0, 2, 3, ...]

Default:

Barcode Type	min_identical_scanlines
2/5 Industrial	2
2/5 Interleaved	2
all others	0

'stop_after_result_num'"stop_after_result_num""stop_after_result_num""stop_after_result_num""stop_after_result_num":

Number of successfully decoded bar codes of the given code type after which the decoding will stop.

Typical values: [0, 1, 2, ...]

Default: 0

'orientation'"orientation""orientation""orientation""orientation":

Expected bar code orientation.

Typical values: [-90.0 ... 90.0]

Default: 0.0

'orientation_tol'"orientation_tol""orientation_tol""orientation_tol""orientation_tol":

Orientation tolerance.

Typical values: [0.0 ... 90.0]

Default: 90.0

'quiet_zone'"quiet_zone""quiet_zone""quiet_zone""quiet_zone":

Enforces the verification of quiet zones of a bar code symbol.

Typical values: 'false'"false""false""false""false", 'true'"true""true""true""true", 1, 2, 3, 4, 5

Default: 'false'"false""false""false""false"

'start_stop_tolerance'"start_stop_tolerance""start_stop_tolerance""start_stop_tolerance""start_stop_tolerance":

Start/stop search criteria tolerance. Currently this is implemented only for Code 128 and GS1-128.

List of values: ['high'"high""high""high""high", 'low'"low""low""low""low"]

Default: 'high'"high""high""high""high"

'check_char'"check_char""check_char""check_char""check_char":

Handling of an optional check character.

List of values: ['absent'"absent""absent""absent""absent", 'present'"present""present""present""present", 'preserved'"preserved""preserved""preserved""preserved"]

Default: 'absent'"absent""absent""absent""absent"

'composite_code'"composite_code""composite_code""composite_code""composite_code":

Find and decode a composite component.

List of values: ['none'"none""none""none""none", 'CC-A/B'"CC-A/B""CC-A/B""CC-A/B""CC-A/B"]

Default: 'none'"none""none""none""none"

'upce_encodation'"upce_encodation""upce_encodation""upce_encodation""upce_encodation":

Output format for UPC-E bar codes.

List of values: ['ucc-12'"ucc-12""ucc-12""ucc-12""ucc-12", 'zero-suppressed'"zero-suppressed""zero-suppressed""zero-suppressed""zero-suppressed"]

Default: 'ucc-12'"ucc-12""ucc-12""ucc-12""ucc-12"

'min_code_length'"min_code_length""min_code_length""min_code_length""min_code_length":

Minimal number of decoded characters.

Default:

Barcode Type	min_code_length
2/5 Industrial	3
2/5 Interleaved	3
all others	0

Further details on these parameters can be found with the description of the operator set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamSetBarCodeParam.

It is possible to supply multivalue tuples for CodeTypesCodeTypesCodeTypesCodeTypescodeTypes, GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. The n-th entry of one multivalue tuple corresponds to the n-th entry of the other multivalue tuple. The following combinations are allowed:

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:

• BarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandle

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

Parameters

Result

The operator set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecific returns the value 2 (H_MSG_TRUE) if the given parameters are correct. Otherwise, an exception will be raised.

Possible Predecessors

create_bar_code_modelcreate_bar_code_modelCreateBarCodeModelCreateBarCodeModelCreateBarCodeModel

Possible Successors

find_bar_codefind_bar_codeFindBarCodeFindBarCodeFindBarCode

Alternatives

set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamSetBarCodeParam

Module

Bar Code