Operator Reference

HALCON Operator Reference / Identification / Bar Code
ClassesClasses | | Operators

get_bar_code_param_specificT_get_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific (Operator)

get_bar_code_param_specificT_get_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific — Get parameters that are used by the bar code reader when processing a specific bar code type.

Signature

get_bar_code_param_specific( : : BarCodeHandle, CodeTypes, GenParamName : GenParamValue)

Herror T_get_bar_code_param_specific(const Htuple BarCodeHandle, const Htuple CodeTypes, const Htuple GenParamName, Htuple* GenParamValue)

void GetBarCodeParamSpecific(const HTuple& BarCodeHandle, const HTuple& CodeTypes, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HBarCode::GetBarCodeParamSpecific(const HTuple& CodeTypes, const HTuple& GenParamName) const

HTuple HBarCode::GetBarCodeParamSpecific(const HString& CodeTypes, const HString& GenParamName) const

HTuple HBarCode::GetBarCodeParamSpecific(const char* CodeTypes, const char* GenParamName) const

HTuple HBarCode::GetBarCodeParamSpecific(const wchar_t* CodeTypes, const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetBarCodeParamSpecific(HTuple barCodeHandle, HTuple codeTypes, HTuple genParamName, out HTuple genParamValue)

HTuple HBarCode.GetBarCodeParamSpecific(HTuple codeTypes, HTuple genParamName)

HTuple HBarCode.GetBarCodeParamSpecific(string codeTypes, string genParamName)

def get_bar_code_param_specific(bar_code_handle: HHandle, code_types: MaybeSequence[str], gen_param_name: MaybeSequence[str]) -> Sequence[Union[float, int, str]]

def get_bar_code_param_specific_s(bar_code_handle: HHandle, code_types: MaybeSequence[str], gen_param_name: MaybeSequence[str]) -> Union[float, int, str]

Description

The operator get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific allows to query parameters of a bar code model, which are of relevance for a successful search and decoding of a respective class of bar codes. Contrary to get_bar_code_paramget_bar_code_paramGetBarCodeParamGetBarCodeParamget_bar_code_param, get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific allows a bar code type specific query for the following parameters. This is useful when searching different code types in one image. The bar code types are specified in CodeTypesCodeTypesCodeTypescodeTypescode_types. The names of the desired parameters are passed in the generic parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and the corresponding values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. All of these parameters can be set and changed selectively with the operator set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific or for all bar code types with the operator set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamset_bar_code_param. Which parameters are set specifically can be determined at runtime with the operator query_bar_code_paramsquery_bar_code_paramsQueryBarCodeParamsQueryBarCodeParamsquery_bar_code_params. These parameters cannot be read with get_bar_code_paramget_bar_code_paramGetBarCodeParamGetBarCodeParamget_bar_code_param, but must be read with get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_bar_code_param_specific.

The following parameters can be queried:

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

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

'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.

'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. 0 is the default where the reader tries to decode all candidates.

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

Accepted orientation of the decoded bar codes.

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

Tolerance of the accepted orientation.

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

Quiet zone verification mode.

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

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

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

Handling of an optional check character.

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

Presence and type of a 2D composite code appended to the bar code.

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

Minimal number of decoded characters.

'max_code_length'"max_code_length""max_code_length""max_code_length""max_code_length":

Maximum number of decoded characters.

Further details on the above parameters can be found with the description of set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamset_bar_code_param operator.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

BarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandlebar_code_handle (input_control)  barcode → HBarCode, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the bar code model.

CodeTypesCodeTypesCodeTypescodeTypescode_types (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the bar code types for which parameters should be queried.

Default: '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 Interleaved'"2/5 Interleaved""2/5 Interleaved""2/5 Interleaved""2/5 Interleaved", 'Codabar'"Codabar""Codabar""Codabar""Codabar", 'Code 128'"Code 128""Code 128""Code 128""Code 128", 'Code 39'"Code 39""Code 39""Code 39""Code 39", '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 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-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'"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'"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 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'"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-128'"GS1-128""GS1-128""GS1-128""GS1-128", 'MSI'"MSI""MSI""MSI""MSI", '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 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-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'"UPC-E""UPC-E""UPC-E""UPC-E"

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters that are to be queried for the bar code model.

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

List of values: 'check_char'"check_char""check_char""check_char""check_char", 'composite_code'"composite_code""composite_code""composite_code""composite_code", 'max_code_length'"max_code_length""max_code_length""max_code_length""max_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", 'num_scanlines'"num_scanlines""num_scanlines""num_scanlines""num_scanlines", 'orientation'"orientation""orientation""orientation""orientation", 'orientation_tol'"orientation_tol""orientation_tol""orientation_tol""orientation_tol", '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", 'stop_after_result_num'"stop_after_result_num""stop_after_result_num""stop_after_result_num""stop_after_result_num"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_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.

Result

The operator get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecificget_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_modelCreateBarCodeModelCreateBarCodeModelcreate_bar_code_model, set_bar_code_paramset_bar_code_paramSetBarCodeParamSetBarCodeParamset_bar_code_param, set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecificset_bar_code_param_specific

Alternatives

get_bar_code_paramget_bar_code_paramGetBarCodeParamGetBarCodeParamget_bar_code_param

Module

Bar Code

ClassesClasses | | Operators