OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode Class Reference

WeChat QRCode includes two CNN-based models: A object detection model and a super resolution model. Object detection model is applied to detect QRCode with the bounding box. super resolution model is applied to zoom in QRCode when it is small. More...

Public Member Functions
	WeChatQRCode ()
	Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).
	WeChatQRCode (string detector_prototxt_path)
	Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).
	WeChatQRCode (string detector_prototxt_path, string detector_caffe_model_path)
	Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).
	WeChatQRCode (string detector_prototxt_path, string detector_caffe_model_path, string super_resolution_prototxt_path)
	Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).
	WeChatQRCode (string detector_prototxt_path, string detector_caffe_model_path, string super_resolution_prototxt_path, string super_resolution_caffe_model_path)
	Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).
List< string >	detectAndDecode (Mat img)
	Both detects and decodes QR code. To simplify the usage, there is a only API: detectAndDecode.
List< string >	detectAndDecode (Mat img, List< Mat > points)
	Both detects and decodes QR code. To simplify the usage, there is a only API: detectAndDecode.
IntPtr	getNativeObjAddr ()
float	getScaleFactor ()
void	setScaleFactor (float _scalingFactor)
	set scale factor QR code detector use neural network to detect QR. Before running the neural network, the input image is pre-processed by scaling. By default, the input image is scaled to an image with an area of 160000 pixels. The scale factor allows to use custom scale the input image: width = scaleFactor*width height = scaleFactor*width
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static WeChatQRCode	__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.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 Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

WeChat QRCode includes two CNN-based models: A object detection model and a super resolution model. Object detection model is applied to detect QRCode with the bounding box. super resolution model is applied to zoom in QRCode when it is small.

Constructor & Destructor Documentation

WeChatQRCode() [1/5]

OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.WeChatQRCode	(	string	detector_prototxt_path,
		string	detector_caffe_model_path,
		string	super_resolution_prototxt_path,
		string	super_resolution_caffe_model_path )

Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).

Parameters

detector_prototxt_path	prototxt file path for the detector
detector_caffe_model_path	caffe model file path for the detector
super_resolution_prototxt_path	prototxt file path for the super resolution model
super_resolution_caffe_model_path	caffe file path for the super resolution model

WeChatQRCode() [2/5]

OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.WeChatQRCode	(	string	detector_prototxt_path,
		string	detector_caffe_model_path,
		string	super_resolution_prototxt_path )

Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).

Parameters

detector_prototxt_path	prototxt file path for the detector
detector_caffe_model_path	caffe model file path for the detector
super_resolution_prototxt_path	prototxt file path for the super resolution model
super_resolution_caffe_model_path	caffe file path for the super resolution model

WeChatQRCode() [3/5]

OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.WeChatQRCode	(	string	detector_prototxt_path,
		string	detector_caffe_model_path )

Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).

Parameters

detector_prototxt_path	prototxt file path for the detector
detector_caffe_model_path	caffe model file path for the detector
super_resolution_prototxt_path	prototxt file path for the super resolution model
super_resolution_caffe_model_path	caffe file path for the super resolution model

WeChatQRCode() [4/5]

OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.WeChatQRCode

(

string

detector_prototxt_path

)

Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).

Parameters

detector_prototxt_path	prototxt file path for the detector
detector_caffe_model_path	caffe model file path for the detector
super_resolution_prototxt_path	prototxt file path for the super resolution model
super_resolution_caffe_model_path	caffe file path for the super resolution model

WeChatQRCode() [5/5]

OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.WeChatQRCode

(

)

Initialize the WeChatQRCode. It includes two models, which are packaged with caffe format. Therefore, there are prototxt and caffe models (In total, four paramenters).

Parameters

detector_prototxt_path	prototxt file path for the detector
detector_caffe_model_path	caffe model file path for the detector
super_resolution_prototxt_path	prototxt file path for the super resolution model
super_resolution_caffe_model_path	caffe file path for the super resolution model

Member Function Documentation

__fromPtr__()

static WeChatQRCode OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.__fromPtr__ ( IntPtr addr )

static

detectAndDecode() [1/2]

List< string > OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.detectAndDecode

(

Mat

img

)

Both detects and decodes QR code. To simplify the usage, there is a only API: detectAndDecode.

Parameters

img	supports grayscale or color (BGR) image.
points	optional output array of vertices of the found QR code quadrangle. Will be empty if not found.

Returns

list of decoded string.

detectAndDecode() [2/2]

List< string > OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.detectAndDecode	(	Mat	img,
		List< Mat >	points )

Both detects and decodes QR code. To simplify the usage, there is a only API: detectAndDecode.

Parameters

img	supports grayscale or color (BGR) image.
points	optional output array of vertices of the found QR code quadrangle. Will be empty if not found.

Returns

list of decoded string.

Dispose()

override void OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableOpenCVObject.

getNativeObjAddr()

IntPtr OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.getNativeObjAddr

(

)

getScaleFactor()

float OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.getScaleFactor

(

)

setScaleFactor()

void OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode.setScaleFactor

(

float

_scalingFactor

)

set scale factor QR code detector use neural network to detect QR. Before running the neural network, the input image is pre-processed by scaling. By default, the input image is scaled to an image with an area of 160000 pixels. The scale factor allows to use custom scale the input image: width = scaleFactor*width height = scaleFactor*width

scaleFactor valuse must be > 0 and <= 1, otherwise the scaleFactor value is set to -1 and use default scaled to an image with an area of 160000 pixels.

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv_contrib/wechat_qrcode/WeChatQRCode.cs