ILBarcodeDetector Interface Reference

This interface provide functionalities of barcode detection and quality verification. More...

Inheritance diagram for ILBarcodeDetector:

Public Member Functions
LPVErrorCode	Detect (ILImage *img, ILRegion *region, ILBarcodeResults **results)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Properties
BOOL	AllowDup [get, set]
	Whether duplicated symbols are allowed in multi-detection. By default, it's False, means for the duplicated barcode of the same decoded contents, only report the first one.
BOOL	CheckSum [get, set]
	Whether decode will verify the check digit. By default, it's True.
int	MaxCount [get, set]
	The maximum of barcode results to find. The detection stops if it meets the setting maximum.
LPVBarcodeType	Type [get, set]
	The barcode symbologies for detection, it could be the combination of multiple symbologies.
BOOL	VerifyQuality [get, set]
	Whether to do the barcode quality verification during detection. By default, it's False.

Detailed Description

This interface provide functionalities of barcode detection and quality verification.

Most popular 1D(linear) and 2D barcode symbologies are supported, see LPVBarcodeType for detailed list. The verification follows ISO-15416 standard for 1D codes, and ISO-15415 for 2D codes.

To use this interface, you should create a LBarcodeDetector object.

Example Code

C++

ILBarcodeDetectorPtr barcodeDetector = LBarcodeDetector::Create();
barcodeDetector->Type = LPVBarcodeType::LPVBarcodeAll1D; // detect all types of 1D barcode
barcodeDetector->VerifyQuality = VARIANT_TRUE; // do quality verification during detection
barcodeDetector->MaxCount = 3;
LPVErrorCode err = barcodeDetector->Detect(img, roi, &codeResults);
if (err != LPVErrorCode::LPVNoError) return;

C#

LBarcodeDetector barcodeDetector = new LBarcodeDetector();
barcodeDetector.Type = LPVBarcodeType.LPVBarcodeAll1D; // detect all types of 1D barcode
barcodeDetector.VerifyQuality = true; // do quality verification during detection
barcodeDetector.MaxCount = 3;
LPVErrorCode err = barcodeDetector.Detect(img, (LRegion)roi, out codeResults);
if (err != LPVErrorCode.LPVNoError) return;

COM

ILBarcodeDetectorPtr barcodeDetector = LBarcodeDetector::Create();
// or, ILBarcodeDetectorPtr barcodeDetector(__uuidof(LBarcodeDetector)), for absence of built-in Create functions (before 2.2.0)
barcodeDetector->Type = LPVBarcodeType::LPVBarcodeAll1D; // detect all types of 1D barcode
barcodeDetector->VerifyQuality = VARIANT_TRUE; // do quality verification during detection
barcodeDetector->MaxCount = 3;
LPVErrorCode err = barcodeDetector->Detect(img, roi, &codeResults);
if (err != LPVErrorCode::LPVNoError) return;

Note: This interface is currently not available on Linux / MacOS platform.

Member Function Documentation

Detect()

LPVErrorCode Detect	(	ILImage *	img,
		ILRegion *	region,
		ILBarcodeResults **	results
	)

Detect barcode(and do quality verification) using the input image and the provided region.

Parameters

[in]	img	The input image
[in]	region	The input region, to limit the region of detection.
[out]	results	Return the barcode results.

Return values

error

Return error code if anything is wrong.