get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam (Operator)

Name

get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam — Get one or several parameters that describe the bar code model.

Signature

Description

The operator get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam 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.

The names of the desired parameters are passed in the generic parameter GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames and the corresponding values are returned in GenParamValuesGenParamValuesGenParamValuesGenParamValuesGenParamValuesgenParamValues. All of these parameters can be set and changed at any time with the operator set_bar_code_paramset_bar_code_paramSetBarCodeParamset_bar_code_paramSetBarCodeParamSetBarCodeParam.

Parameters that have been set bar code type specific by set_bar_code_param_specificset_bar_code_param_specificSetBarCodeParamSpecificset_bar_code_param_specificSetBarCodeParamSpecificSetBarCodeParamSpecific or by automatic parameter training cannot be read with get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam, but must be read with get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecific. All parameters listed with the operator get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecific can always be set specific. Which parameters are actually set specificially can be determined at runtime with the operator query_bar_code_paramsquery_bar_code_paramsQueryBarCodeParamsquery_bar_code_paramsQueryBarCodeParamsQueryBarCodeParams.

The following parameters can be queried - ordered by different categories:

Size of the bar code elements:

'element_size_min'"element_size_min""element_size_min""element_size_min""element_size_min""element_size_min":

Minimal size of the bar code elements.

'element_size_max'"element_size_max""element_size_max""element_size_max""element_size_max""element_size_max":

Maximal size of the bar code elements.

'element_size_variable'"element_size_variable""element_size_variable""element_size_variable""element_size_variable""element_size_variable":

Specifies, if the element size varies across a single bar code.

'element_height_min'"element_height_min""element_height_min""element_height_min""element_height_min""element_height_min":

Minimal height of the bar code.

Scaning settings:

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

Maximal number of scans per (candidate) bar code.

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

Minimal number of successfully decoded scanlines, which return identical data for a bar code, that is needed to consider a bar code as being successfully decoded.

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

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

Accepted orientation of the decoded bar codes.

'orientation_tol'"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":

Quiet zone verification mode.

'slanted'"slanted""slanted""slanted""slanted""slanted":

Slanted codes processing mode.

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

Start/Stop search criteria tolerance.

Appearance of the bar code in the image:

'meas_thresh'"meas_thresh""meas_thresh""meas_thresh""meas_thresh""meas_thresh":

Relative threshold for the detection of edges in the bar code region.

'meas_thresh_abs'"meas_thresh_abs""meas_thresh_abs""meas_thresh_abs""meas_thresh_abs""meas_thresh_abs":

Absolute threshold for the detection of edges in the bar code region.

'max_diff_orient'"max_diff_orient""max_diff_orient""max_diff_orient""max_diff_orient""max_diff_orient":

Maximal difference in the orientation of edges in a bar code region. The difference in oriented angles, given in degree, refers to neighboring pixels.

Bar code specific values:

'check_char'"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""composite_code":

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

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

Output format for UPC-E bar codes.

Miscellaneous:

'timeout'"timeout""timeout""timeout""timeout""timeout":

Interrupt of find_bar_codefind_bar_codeFindBarCodefind_bar_codeFindBarCodeFindBarCode in case of a timeout.

'persistence'"persistence""persistence""persistence""persistence""persistence":

Persistence mode of the bar code model.

'train'"train""train""train""train""train":

Returns the names of the trained parameters. The returned tuple can be passed as GenParamNamesGenParamNamesGenParamNamesGenParamNamesGenParamNamesgenParamNames to a further call to get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam to get the values of the trained parameters.

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

Attention

A bar code model BarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandleBarCodeHandlebarCodeHandle cannot be shared between two or more user's threads. Different bar code models can be used independently and safely in different threads.

Parallelization

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

Parameters

Result

The operator get_bar_code_paramget_bar_code_paramGetBarCodeParamget_bar_code_paramGetBarCodeParamGetBarCodeParam 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_modelCreateBarCodeModelcreate_bar_code_modelCreateBarCodeModelCreateBarCodeModel, set_bar_code_paramset_bar_code_paramSetBarCodeParamset_bar_code_paramSetBarCodeParamSetBarCodeParam

Possible Successors

set_bar_code_paramset_bar_code_paramSetBarCodeParamset_bar_code_paramSetBarCodeParamSetBarCodeParam

Alternatives

get_bar_code_param_specificget_bar_code_param_specificGetBarCodeParamSpecificget_bar_code_param_specificGetBarCodeParamSpecificGetBarCodeParamSpecific

Module

Bar Code