decode_bar_code_rectangle2 T_decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2 (Operator)
Name
decode_bar_code_rectangle2 T_decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2
— Decode bar code symbols within a rectangle.
Signature
void DecodeBarCodeRectangle2 (const HObject& Image , const HTuple& BarCodeHandle , const HTuple& CodeType , const HTuple& Row , const HTuple& Column , const HTuple& Phi , const HTuple& Length1 , const HTuple& Length2 , HTuple* DecodedDataStrings )
HTuple HBarCode ::DecodeBarCodeRectangle2 (const HImage& Image , const HTuple& CodeType , const HTuple& Row , const HTuple& Column , const HTuple& Phi , const HTuple& Length1 , const HTuple& Length2 ) const
HString HBarCode ::DecodeBarCodeRectangle2 (const HImage& Image , const HString& CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
HString HBarCode ::DecodeBarCodeRectangle2 (const HImage& Image , const char* CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
HString HBarCode ::DecodeBarCodeRectangle2 (const HImage& Image , const wchar_t* CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
(Windows only)
HTuple HImage ::DecodeBarCodeRectangle2 (const HBarCode& BarCodeHandle , const HTuple& CodeType , const HTuple& Row , const HTuple& Column , const HTuple& Phi , const HTuple& Length1 , const HTuple& Length2 ) const
HString HImage ::DecodeBarCodeRectangle2 (const HBarCode& BarCodeHandle , const HString& CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
HString HImage ::DecodeBarCodeRectangle2 (const HBarCode& BarCodeHandle , const char* CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
HString HImage ::DecodeBarCodeRectangle2 (const HBarCode& BarCodeHandle , const wchar_t* CodeType , double Row , double Column , double Phi , double Length1 , double Length2 ) const
(Windows only)
static void HOperatorSet .DecodeBarCodeRectangle2 (HObject image , HTuple barCodeHandle , HTuple codeType , HTuple row , HTuple column , HTuple phi , HTuple length1 , HTuple length2 , out HTuple decodedDataStrings )
HTuple HBarCode .DecodeBarCodeRectangle2 (HImage image , HTuple codeType , HTuple row , HTuple column , HTuple phi , HTuple length1 , HTuple length2 )
string HBarCode .DecodeBarCodeRectangle2 (HImage image , string codeType , double row , double column , double phi , double length1 , double length2 )
HTuple HImage .DecodeBarCodeRectangle2 (HBarCode barCodeHandle , HTuple codeType , HTuple row , HTuple column , HTuple phi , HTuple length1 , HTuple length2 )
string HImage .DecodeBarCodeRectangle2 (HBarCode barCodeHandle , string codeType , double row , double column , double phi , double length1 , double length2 )
Description
The operator decode_bar_code_rectangle2 decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2
uses the bar code
model specified by BarCodeHandle BarCodeHandle BarCodeHandle BarCodeHandle barCodeHandle
to decode a bar code at
a given position within the image Image Image Image Image image
.
BarCodeHandle BarCodeHandle BarCodeHandle BarCodeHandle barCodeHandle
must be created with
create_bar_code_model create_bar_code_model CreateBarCodeModel CreateBarCodeModel CreateBarCodeModel
, its parameters can be set with
set_bar_code_param set_bar_code_param SetBarCodeParam SetBarCodeParam SetBarCodeParam
. The position of the bar code is given
as an arbitrarily oriented rectangle. Contrary to
find_bar_code find_bar_code FindBarCode FindBarCode FindBarCode
, where the decoding is preceded by a time
consuming search for candidate regions,
decode_bar_code_rectangle2 decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2
scans the provided region directly
for bar codes. The rectangular region is defined by the parameters
Row Row Row Row row
and Column Column Column Column column
for the center, Phi Phi Phi Phi phi
for
the orientation and Length1 Length1 Length1 Length1 length1
and Length2 Length2 Length2 Length2 length2
for the
half edge lengths (see gen_rectangle2 gen_rectangle2 GenRectangle2 GenRectangle2 GenRectangle2
). The angle Phi Phi Phi Phi phi
also determines the reading direction and is defined as the angle
between the reading direction of the bar code and the horizontal
image axis. The angle is positive in counter clockwise direction and
is given in radians as in gen_rectangle2 gen_rectangle2 GenRectangle2 GenRectangle2 GenRectangle2
. Note that the angle
unit deviates from the conventions in get_bar_code_result get_bar_code_result GetBarCodeResult GetBarCodeResult GetBarCodeResult
and
set_bar_code_param set_bar_code_param SetBarCodeParam SetBarCodeParam SetBarCodeParam
where angles are given in degrees.
Phi Phi Phi Phi phi
can be in the range of
[
].
The reading direction is perpendicular to the bars of the bar code.
Bar codes with a reading direction
are also returned.
Multiple regions for decoding can be given by supplying tuples for
Row Row Row Row row
, Column Column Column Column column
, Phi Phi Phi Phi phi
, Length1 Length1 Length1 Length1 length1
and
Length2 Length2 Length2 Length2 length2
.
The rectangle should cover completely the bar code and the quiet zones.
Regions that are too big will be decoded, if there is no disturbing
pattern within these regions and the height (Length2 Length2 Length2 Length2 length2
) is
small enough such that scanlines can be placed sufficiently dense.
Rectangles that are too short in reading direction (Length1 Length1 Length1 Length1 length1
)
cannot be decoded.
decode_bar_code_rectangle2 decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2
can be used if the position of
the bar code is already known in advance. For example, the candidate
regions found by find_bar_code find_bar_code FindBarCode FindBarCode FindBarCode
and get_bar_code_object get_bar_code_object GetBarCodeObject GetBarCodeObject GetBarCodeObject
could be reused with a different code type (see the following example).
Multiple bar code types can be specified for CodeType CodeType CodeType CodeType codeType
. See
section Autodiscrimination for find_bar_code find_bar_code FindBarCode FindBarCode FindBarCode
.
Further aspects of the actual decoding are explained with the operator
find_bar_code find_bar_code FindBarCode FindBarCode FindBarCode
.
Execution Information
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on internal data level.
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
Image Image Image Image image
(input_object) singlechannelimage →
object HImage HImage Hobject (byte / uint2)
Input image.
BarCodeHandle BarCodeHandle BarCodeHandle BarCodeHandle barCodeHandle
(input_control, state is modified) barcode →
HBarCode , HTuple HTuple Htuple (handle) (IntPtr ) (HHandle ) (handle )
Handle of the bar code model.
CodeType CodeType CodeType CodeType codeType
(input_control) string(-array) →
HTuple HTuple Htuple (string) (string ) (HString ) (char* )
Type of the searched bar code.
Default value:
'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" , 'auto' "auto" "auto" "auto" "auto"
Row Row Row Row row
(input_control) rectangle2.center.y(-array) →
HTuple HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Row index of the center.
Default value: 50.0
Column Column Column Column column
(input_control) rectangle2.center.x(-array) →
HTuple HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column index of the center.
Default value: 100.0
Phi Phi Phi Phi phi
(input_control) rectangle2.angle.rad(-array) →
HTuple HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Orientation of rectangle in radians.
Default value: 0.0
Suggested values: 0.0, 0.785398, 1.570796, 3.1415926
Length1 Length1 Length1 Length1 length1
(input_control) rectangle2.hwidth(-array) →
HTuple HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Half of the length of the rectangle along the reading
direction of the bar code.
Default value: 200.0
Length2 Length2 Length2 Length2 length2
(input_control) rectangle2.hheight(-array) →
HTuple HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Half of the length of the rectangle perpendicular to
the reading direction of the bar code.
Default value: 100.0
DecodedDataStrings DecodedDataStrings DecodedDataStrings DecodedDataStrings decodedDataStrings
(output_control) string(-array) →
HTuple HTuple Htuple (string) (string ) (HString ) (char* )
Data strings of all successfully decoded bar codes.
Example (HDevelop)
read_image (Image, 'barcode/ean13/ean1301.png')
create_bar_code_model ([], [], BHandle)
find_bar_code (Image, SymReg, BHandle, '2/5 Industrial', Dec)
if (|Dec| == 0)
* A 2/5 Industrial code wasn't found. Try decoding an EAN-13 code.
get_bar_code_object (CandReg, BHandle, 'all', 'candidate_regions')
smallest_rectangle2 (CandReg, R, C, Phi, L1, L2)
decode_bar_code_rectangle2 (Image, BHandle, 'EAN-13', R, C, Phi, \
L1, L2, Dec)
endif
Result
The operator decode_bar_code_rectangle2 decode_bar_code_rectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2 DecodeBarCodeRectangle2
returns the value 2 (H_MSG_TRUE)
if the given parameters are correct.
Otherwise, an exception will be raised.
Possible Predecessors
create_bar_code_model create_bar_code_model CreateBarCodeModel CreateBarCodeModel CreateBarCodeModel
,
set_bar_code_param set_bar_code_param SetBarCodeParam SetBarCodeParam SetBarCodeParam
,
smallest_rectangle2 smallest_rectangle2 SmallestRectangle2 SmallestRectangle2 SmallestRectangle2
Possible Successors
get_bar_code_result get_bar_code_result GetBarCodeResult GetBarCodeResult GetBarCodeResult
,
get_bar_code_object get_bar_code_object GetBarCodeObject GetBarCodeObject GetBarCodeObject
,
clear_bar_code_model clear_bar_code_model ClearBarCodeModel ClearBarCodeModel ClearBarCodeModel
Alternatives
find_bar_code find_bar_code FindBarCode FindBarCode FindBarCode
See also
gen_rectangle2 gen_rectangle2 GenRectangle2 GenRectangle2 GenRectangle2
Module
Bar Code