Public Member Functions
	BarcodeDetector ()
	Initialize the BarcodeDetector.

	BarcodeDetector (string prototxt_path, string model_path)
	Initialize the BarcodeDetector.

bool	decodeWithType (Mat img, Mat points, List< string > decoded_info, List< string > decoded_type)
	Decodes barcode in image once it's found by the detect() method.

bool	detectAndDecodeWithType (Mat img, List< string > decoded_info, List< string > decoded_type)
	Both detects and decodes barcode.

bool	detectAndDecodeWithType (Mat img, List< string > decoded_info, List< string > decoded_type, Mat points)
	Both detects and decodes barcode.

void	getDetectorScales (MatOfFloat sizes)
	Returns detector box filter sizes.

double	getDownsamplingThreshold ()
	Get detector downsampling threshold.

double	getGradientThreshold ()
	Get detector gradient magnitude threshold.

BarcodeDetector	setDetectorScales (MatOfFloat sizes)
	Set detector box filter sizes.

BarcodeDetector	setDownsamplingThreshold (double thresh)
	Set detector downsampling threshold.

BarcodeDetector	setGradientThreshold (double thresh)
	Set detector gradient magnitude threshold.

Public Member Functions inherited from OpenCVForUnity.ObjdetectModule.GraphicalCodeDetector
string	decode (Mat img, Mat points)
	Decodes graphical code in image once it's found by the detect() method.

string	decode (Mat img, Mat points, Mat straight_code)
	Decodes graphical code in image once it's found by the detect() method.

bool	decodeMulti (Mat img, Mat points, List< string > decoded_info)
	Decodes graphical codes in image once it's found by the detect() method.

bool	decodeMulti (Mat img, Mat points, List< string > decoded_info, List< Mat > straight_code)
	Decodes graphical codes in image once it's found by the detect() method.

bool	detect (Mat img, Mat points)
	Detects graphical code in image and returns the quadrangle containing the code.

string	detectAndDecode (Mat img)
	Both detects and decodes graphical code.

string	detectAndDecode (Mat img, Mat points)
	Both detects and decodes graphical code.

string	detectAndDecode (Mat img, Mat points, Mat straight_code)
	Both detects and decodes graphical code.

bool	detectAndDecodeMulti (Mat img, List< string > decoded_info)
	Both detects and decodes graphical codes.

bool	detectAndDecodeMulti (Mat img, List< string > decoded_info, Mat points)
	Both detects and decodes graphical codes.

bool	detectAndDecodeMulti (Mat img, List< string > decoded_info, Mat points, List< Mat > straight_code)
	Both detects and decodes graphical codes.

bool	detectMulti (Mat img, Mat points)
	Detects graphical codes in image and returns the vector of the quadrangles containing the codes.

IntPtr	getNativeObjAddr ()

Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()

void	ThrowIfDisposed ()

Static Public Member Functions
static new BarcodeDetector	__fromPtr__ (IntPtr addr)

Static Public Member Functions inherited from OpenCVForUnity.ObjdetectModule.GraphicalCodeDetector
static GraphicalCodeDetector	__fromPtr__ (IntPtr addr)

Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.ObjdetectModule.GraphicalCodeDetector
override void	Dispose (bool disposing)

Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()

	DisposableOpenCVObject (bool isEnabledDispose)

	DisposableOpenCVObject (IntPtr ptr)

	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)

Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()

	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Functions inherited from OpenCVForUnity.ObjdetectModule.GraphicalCodeDetector
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed `[get, protected set]`

bool	IsEnabledDispose `[get, set]`

Constructor & Destructor Documentation

◆ BarcodeDetector() [1/2]

OpenCVForUnity.ObjdetectModule.BarcodeDetector.BarcodeDetector ( )

Initialize the BarcodeDetector.

◆ BarcodeDetector() [2/2]

OpenCVForUnity.ObjdetectModule.BarcodeDetector.BarcodeDetector	(	string	prototxt_path,
		string	model_path )

Initialize the BarcodeDetector.

Parameters allow to load optional Super Resolution DNN model for better quality.

Parameters

prototxt_path	prototxt file path for the super resolution model
model_path	model file path for the super resolution model

Member Function Documentation

◆ fromPtr()

static new BarcodeDetector OpenCVForUnity.ObjdetectModule.BarcodeDetector.__fromPtr__ ( IntPtr addr )

static

◆ decodeWithType()

bool OpenCVForUnity.ObjdetectModule.BarcodeDetector.decodeWithType	(	Mat	img,
		Mat	points,
		List< string >	decoded_info,
		List< string >	decoded_type )

Decodes barcode in image once it's found by the detect() method.

Parameters

img	grayscale or color (BGR) image containing bar code.
points	vector of rotated rectangle vertices found by detect() method (or some other algorithm). For N detected barcodes, the dimensions of this array should be [N][4]. Order of four points in vector<Point2f> is bottomLeft, topLeft, topRight, bottomRight.
decoded_info	UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
decoded_type	vector strings, specifies the type of these barcodes

Returns: true if at least one valid barcode have been found

◆ detectAndDecodeWithType() [1/2]

bool OpenCVForUnity.ObjdetectModule.BarcodeDetector.detectAndDecodeWithType	(	Mat	img,
		List< string >	decoded_info,
		List< string >	decoded_type )

Both detects and decodes barcode.

Parameters

img	grayscale or color (BGR) image containing barcode.
decoded_info	UTF8-encoded output vector of string(s) or empty vector of string if the codes cannot be decoded.
decoded_type	vector of strings, specifies the type of these barcodes
points	optional output vector of vertices of the found barcode rectangle. Will be empty if not found.

Returns: true if at least one valid barcode have been found

◆ detectAndDecodeWithType() [2/2]

bool OpenCVForUnity.ObjdetectModule.BarcodeDetector.detectAndDecodeWithType	(	Mat	img,
		List< string >	decoded_info,
		List< string >	decoded_type,
		Mat	points )

Both detects and decodes barcode.

Parameters

img	grayscale or color (BGR) image containing barcode.
decoded_info	UTF8-encoded output vector of string(s) or empty vector of string if the codes cannot be decoded.
decoded_type	vector of strings, specifies the type of these barcodes
points	optional output vector of vertices of the found barcode rectangle. Will be empty if not found.

Returns: true if at least one valid barcode have been found

◆ Dispose()

override void OpenCVForUnity.ObjdetectModule.BarcodeDetector.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableObject.

◆ getDetectorScales()

void OpenCVForUnity.ObjdetectModule.BarcodeDetector.getDetectorScales ( MatOfFloat sizes )

Returns detector box filter sizes.

Parameters

sizes output parameter for returning the sizes.

◆ getDownsamplingThreshold()

double OpenCVForUnity.ObjdetectModule.BarcodeDetector.getDownsamplingThreshold ( )

Get detector downsampling threshold.

Returns: detector downsampling threshold

◆ getGradientThreshold()

double OpenCVForUnity.ObjdetectModule.BarcodeDetector.getGradientThreshold ( )

Get detector gradient magnitude threshold.

Returns: detector gradient magnitude threshold.

◆ setDetectorScales()

BarcodeDetector OpenCVForUnity.ObjdetectModule.BarcodeDetector.setDetectorScales ( MatOfFloat sizes )

Set detector box filter sizes.

Adjusts the value and the number of box filters used in the detect step. The filter sizes directly correlate with the expected line widths for a barcode. Corresponds to expected barcode distance. If the downsampling limit is increased, filter sizes need to be adjusted in an inversely proportional way.

Parameters

sizes box filter sizes, relative to minimum dimension of the image (default [0.01, 0.03, 0.06, 0.08])

◆ setDownsamplingThreshold()

BarcodeDetector OpenCVForUnity.ObjdetectModule.BarcodeDetector.setDownsamplingThreshold ( double thresh )

Set detector downsampling threshold.

By default, the detect method resizes the input image to this limit if the smallest image size is is greater than the threshold. Increasing this value can improve detection accuracy and the number of results at the expense of performance. Correlates with detector scales. Setting this to a large value will disable downsampling.

Parameters

thresh downsampling limit to apply (default 512)

setDetectorScales

◆ setGradientThreshold()

BarcodeDetector OpenCVForUnity.ObjdetectModule.BarcodeDetector.setGradientThreshold ( double thresh )

Set detector gradient magnitude threshold.

Sets the coherence threshold for detected bounding boxes. Increasing this value will generate a closer fitted bounding box width and can reduce false-positives. Values between 16 and 1024 generally work, while too high of a value will remove valid detections.

Parameters

thresh gradient magnitude threshold (default 64).

The documentation for this class was generated from the following file:

OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/objdetect/BarcodeDetector.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ BarcodeDetector() [1/2]

◆ BarcodeDetector() [2/2]

Member Function Documentation

◆ __fromPtr__()

◆ decodeWithType()

◆ detectAndDecodeWithType() [1/2]

◆ detectAndDecodeWithType() [2/2]

◆ Dispose()

◆ getDetectorScales()

◆ getDownsamplingThreshold()

◆ getGradientThreshold()

◆ setDetectorScales()

◆ setDownsamplingThreshold()

◆ setGradientThreshold()

◆ fromPtr()