set_bar_code_param_specificT_set_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific (Operator)
Name
set_bar_code_param_specificT_set_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific — Set selected parameters of the bar code model for selected bar code types
Signature
void SetBarCodeParamSpecific(const HTuple& BarCodeHandle, const HTuple& CodeTypes, const HTuple& GenParamName, const HTuple& GenParamValue)
void HBarCode::SetBarCodeParamSpecific(const HTuple& CodeTypes, const HTuple& GenParamName, const HTuple& GenParamValue) const
void HBarCode::SetBarCodeParamSpecific(const HString& CodeTypes, const HString& GenParamName, const HTuple& GenParamValue) const
void HBarCode::SetBarCodeParamSpecific(const char* CodeTypes, const char* GenParamName, const HTuple& GenParamValue) const
void HBarCode::SetBarCodeParamSpecific(const wchar_t* CodeTypes, const wchar_t* GenParamName, const HTuple& GenParamValue) const
(Windows only)
Description
The operator set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific 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_paramSetBarCodeParamSetBarCodeParamSetBarCodeParamset_bar_code_param, only parameters for selected bar
code types will be changed with set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific.
This is useful when searching different code types within one image (see
section Autodiscrimination in find_bar_codefind_bar_codeFindBarCodeFindBarCodeFindBarCodefind_bar_code).
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_specificGetBarCodeParamSpecificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific.
The following generic parameters can be set for specific bar code types:
- 'num_scanlines'"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""min_identical_scanlines":
-
Minimal number of decoded scanlines which return
identical data to read the bar code successfully.
Typical values: [0, 2, 3,
...]
Default:
|
Bar code 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""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""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_tol":
-
Orientation tolerance.
Typical values: [0.0 ... 90.0]
Default: 90.0
- 'quiet_zone'"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""false", 'true'"true""true""true""true""true", 1,
2, 3, 4,
5
Default: 'false'"false""false""false""false""false"
- 'start_stop_tolerance'"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""high", 'low'"low""low""low""low""low"]
Default: 'high'"high""high""high""high""high"
- 'check_char'"check_char""check_char""check_char""check_char""check_char":
-
Handling of an optional check character.
List of values: ['absent'"absent""absent""absent""absent""absent", 'present'"present""present""present""present""present",
'preserved'"preserved""preserved""preserved""preserved""preserved"]
Default: 'absent'"absent""absent""absent""absent""absent"
- 'composite_code'"composite_code""composite_code""composite_code""composite_code""composite_code":
-
Find and decode a composite component.
List of values: ['none'"none""none""none""none""none", 'CC-A/B'"CC-A/B""CC-A/B""CC-A/B""CC-A/B""CC-A/B"]
Default: 'none'"none""none""none""none""none"
- 'upce_encodation'"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""ucc-12", 'zero-suppressed'"zero-suppressed""zero-suppressed""zero-suppressed""zero-suppressed""zero-suppressed"]
Default: 'ucc-12'"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""min_code_length":
-
Minimal number of decoded characters.
Default:
|
Bar code 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_paramSetBarCodeParamSetBarCodeParamSetBarCodeParamset_bar_code_param.
It is possible to supply multivalue tuples for CodeTypesCodeTypesCodeTypesCodeTypescodeTypescode_types,
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. 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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
BarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandlebar_code_handle (input_control, state is modified) barcode → HBarCode, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the bar code model.
CodeTypesCodeTypesCodeTypesCodeTypescodeTypescode_types (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the bar code types for which parameters
should be set.
Default value:
'EAN-13'
"EAN-13"
"EAN-13"
"EAN-13"
"EAN-13"
"EAN-13"
List of values: '2/5 Industrial'"2/5 Industrial""2/5 Industrial""2/5 Industrial""2/5 Industrial""2/5 Industrial", '2/5 Interleaved'"2/5 Interleaved""2/5 Interleaved""2/5 Interleaved""2/5 Interleaved""2/5 Interleaved", 'Codabar'"Codabar""Codabar""Codabar""Codabar""Codabar", 'Code 128'"Code 128""Code 128""Code 128""Code 128""Code 128", 'Code 39'"Code 39""Code 39""Code 39""Code 39""Code 39", 'Code 93'"Code 93""Code 93""Code 93""Code 93""Code 93", 'EAN-13 Add-On 2'"EAN-13 Add-On 2""EAN-13 Add-On 2""EAN-13 Add-On 2""EAN-13 Add-On 2""EAN-13 Add-On 2", 'EAN-13 Add-On 5'"EAN-13 Add-On 5""EAN-13 Add-On 5""EAN-13 Add-On 5""EAN-13 Add-On 5""EAN-13 Add-On 5", 'EAN-13'"EAN-13""EAN-13""EAN-13""EAN-13""EAN-13", 'EAN-8 Add-On 2'"EAN-8 Add-On 2""EAN-8 Add-On 2""EAN-8 Add-On 2""EAN-8 Add-On 2""EAN-8 Add-On 2", 'EAN-8 Add-On 5'"EAN-8 Add-On 5""EAN-8 Add-On 5""EAN-8 Add-On 5""EAN-8 Add-On 5""EAN-8 Add-On 5", 'EAN-8'"EAN-8""EAN-8""EAN-8""EAN-8""EAN-8", 'GS1 DataBar Expanded Stacked'"GS1 DataBar Expanded Stacked""GS1 DataBar Expanded Stacked""GS1 DataBar Expanded Stacked""GS1 DataBar Expanded Stacked""GS1 DataBar Expanded Stacked", 'GS1 DataBar Expanded'"GS1 DataBar Expanded""GS1 DataBar Expanded""GS1 DataBar Expanded""GS1 DataBar Expanded""GS1 DataBar Expanded", 'GS1 DataBar Limited'"GS1 DataBar Limited""GS1 DataBar Limited""GS1 DataBar Limited""GS1 DataBar Limited""GS1 DataBar Limited", 'GS1 DataBar Omnidir'"GS1 DataBar Omnidir""GS1 DataBar Omnidir""GS1 DataBar Omnidir""GS1 DataBar Omnidir""GS1 DataBar Omnidir", 'GS1 DataBar Stacked Omnidir'"GS1 DataBar Stacked Omnidir""GS1 DataBar Stacked Omnidir""GS1 DataBar Stacked Omnidir""GS1 DataBar Stacked Omnidir""GS1 DataBar Stacked Omnidir", 'GS1 DataBar Stacked'"GS1 DataBar Stacked""GS1 DataBar Stacked""GS1 DataBar Stacked""GS1 DataBar Stacked""GS1 DataBar Stacked", 'GS1 DataBar Truncated'"GS1 DataBar Truncated""GS1 DataBar Truncated""GS1 DataBar Truncated""GS1 DataBar Truncated""GS1 DataBar Truncated", 'GS1-128'"GS1-128""GS1-128""GS1-128""GS1-128""GS1-128", 'MSI'"MSI""MSI""MSI""MSI""MSI", 'PharmaCode'"PharmaCode""PharmaCode""PharmaCode""PharmaCode""PharmaCode", 'UPC-A Add-On 2'"UPC-A Add-On 2""UPC-A Add-On 2""UPC-A Add-On 2""UPC-A Add-On 2""UPC-A Add-On 2", 'UPC-A Add-On 5'"UPC-A Add-On 5""UPC-A Add-On 5""UPC-A Add-On 5""UPC-A Add-On 5""UPC-A Add-On 5", 'UPC-A'"UPC-A""UPC-A""UPC-A""UPC-A""UPC-A", 'UPC-E Add-On 2'"UPC-E Add-On 2""UPC-E Add-On 2""UPC-E Add-On 2""UPC-E Add-On 2""UPC-E Add-On 2", 'UPC-E Add-On 5'"UPC-E Add-On 5""UPC-E Add-On 5""UPC-E Add-On 5""UPC-E Add-On 5""UPC-E Add-On 5", 'UPC-E'"UPC-E""UPC-E""UPC-E""UPC-E""UPC-E"
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters that shall be
adjusted for finding and decoding bar codes.
Default value:
'check_char'
"check_char"
"check_char"
"check_char"
"check_char"
"check_char"
List of values: 'check_char'"check_char""check_char""check_char""check_char""check_char", 'composite_code'"composite_code""composite_code""composite_code""composite_code""composite_code", 'min_code_length'"min_code_length""min_code_length""min_code_length""min_code_length""min_code_length", 'min_identical_scanlines'"min_identical_scanlines""min_identical_scanlines""min_identical_scanlines""min_identical_scanlines""min_identical_scanlines", 'num_scanlines'"num_scanlines""num_scanlines""num_scanlines""num_scanlines""num_scanlines", 'orientation'"orientation""orientation""orientation""orientation""orientation", 'orientation_tol'"orientation_tol""orientation_tol""orientation_tol""orientation_tol""orientation_tol", 'quiet_zone'"quiet_zone""quiet_zone""quiet_zone""quiet_zone""quiet_zone", 'start_stop_tolerance'"start_stop_tolerance""start_stop_tolerance""start_stop_tolerance""start_stop_tolerance""start_stop_tolerance", 'stop_after_result_num'"stop_after_result_num""stop_after_result_num""stop_after_result_num""stop_after_result_num""stop_after_result_num"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.name-array → HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Values of the generic parameters that are
adjusted for finding and decoding bar codes.
Default value:
'absent'
"absent"
"absent"
"absent"
"absent"
"absent"
Suggested values: 0, 1, 2, 4, 45, 90, 'true'"true""true""true""true""true", 'false'"false""false""false""false""false", 'present'"present""present""present""present""present", 'absent'"absent""absent""absent""absent""absent", 'none'"none""none""none""none""none", 'CC-A/B'"CC-A/B""CC-A/B""CC-A/B""CC-A/B""CC-A/B", 'high'"high""high""high""high""high", 'low'"low""low""low""low""low"
Result
The operator set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific 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_modelCreateBarCodeModelCreateBarCodeModelCreateBarCodeModelcreate_bar_code_model
Possible Successors
find_bar_codefind_bar_codeFindBarCodeFindBarCodeFindBarCodefind_bar_code
Alternatives
set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamSetBarCodeParamset_bar_code_param
Module
Bar Code