get_bar_code_object — Access iconic objects that were created during the search or decoding of
bar code symbols.
With the operator
get_bar_code_object, iconic objects created
during the last call of the operator
find_bar_code can be accessed.
Besides the name of the object (
ObjectName), the bar code model
BarCodeHandle) must be passed to
In addition, in
CandidateHandle an index to a single decoded
symbol or a single symbol candidate must be passed. Alternatively,
CandidateHandle can be set to 'all' and then all
objects of the decoded symbols or symbol candidates are returned.
Depending on the option selected in
the following objects are returned:
The regions of successfully decoded symbols are returned. When
choosing 'all' as
CandidateHandle, the regions
of all decoded symbols are retrieved. The order of the returned
objects is the same as in
The regions of potential bar codes are returned. If there is a
total of n decoded symbols out of a total of m candidates then
CandidateHandle can be chosen between 0 and (m-1). With
CandidateHandle between 0 and (n-1) the original
segmented region of the respective decoded symbol is retrieved.
CandidateHandle between n and (m-1) the region
of the potential or undecodable symbol is returned. In addition,
CandidateHandle can be set to 'all' to retrieve
all candidate regions at the same time.
XLD contours representing the particular detected bars in the
scanlines applied on the candidate regions are returned. Note that
the scanlines can be only be returned if the bar code was decoded
'persistence' mode (see
set_bar_code_param for further details).
'scanlines_all' represents all scanlines that
find_bar_code could potentially create in order to decode a bar
'scanlines_valid' represents only those scanlines that
could be successfully decoded. The number of scanlines that has to
be valid can be adjusted with
set_bar_code_param with the
There will be no 'scanlines_valid'
if the symbol was not decoded. For stacked bar codes (e.g.
'GS1 DataBar Stacked' and 'GS1 DataBar Expanded
Stacked') this rule applies similarly, but on a per-symbol-row basis
rather then per-symbol.
the scanlines and edges which were used for the merged scanlines
(see 'merge_scanlines' in
get_bar_code_object returns each scanline as separate XLD
contour. Please note that the XLD contours returned by
'scanlines_all', 'scanlines_valid' and
'scanlines_merged_edges' are meant
for visualization purposes and hence consist of many XLD points.
Double lines are used between edges that the bar
code reader recognized as bar, whereas single lines are used for white
spaces. Additional information about each scanline can be obtained
get_bar_code_result with the parameter 'status'.
The '_plain' variants 'scanlines_all_plain' and 'scanlines_valid_plain' return the described scanlines in a plain format. Every edge found is returned as a point of an XLD contour. For every scanline a new XLD contour is created. Scanlines for which no edges could be found are omitted.
Objects that are created as intermediate results during the detection or evaluation of bar codes.
Handle of the bar code model.
→(string / integer)
Indicating the bar code results respectively candidates for which the data is required.
Default value: 'all'
Suggested values: 0, 1, 2, 'all'
Name of the iconic object to return.
Default value: 'candidate_regions'
List of values: 'candidate_regions', 'scanlines_all', 'scanlines_all_plain', 'scanlines_merged_edges', 'scanlines_valid', 'scanlines_valid_plain', 'symbol_regions'
get_bar_code_object returns the value 2 (H_MSG_TRUE)
if the given parameters are correct and the requested objects are
available for the last symbol search.
Otherwise, an exception will be raised.