Class WeChatQRCode

Namespace

OpenCvSharp

Assembly

OpenCvSharp.dll

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.

public class WeChatQRCode : DisposableCvObject, IDisposable, ICvPtrHolder

Inheritance

object

DisposableObject

DisposableCvObject

WeChatQRCode

Implements

IDisposable

ICvPtrHolder

Inherited Members

DisposableCvObject.ptr

DisposableCvObject.DisposeUnmanaged()

DisposableCvObject.CvPtr

DisposableObject.DataHandle

DisposableObject.IsDisposed

DisposableObject.IsEnabledDispose

DisposableObject.AllocatedMemory

DisposableObject.AllocatedMemorySize

DisposableObject.Dispose()

DisposableObject.Dispose(bool)

DisposableObject.AllocGCHandle(object)

DisposableObject.AllocMemory(int)

DisposableObject.NotifyMemoryPressure(long)

DisposableObject.ThrowIfDisposed()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Create(string, string, string, string)

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

public static WeChatQRCode Create(string detectorPrototxtPath, string detectorCaffeModelPath, string superResolutionPrototxtPath, string superResolutionCaffeModelPath)

Parameters

detectorPrototxtPath string

prototxt file path for the detector

detectorCaffeModelPath string

caffe model file path for the detector

superResolutionPrototxtPath string

prototxt file path for the super resolution model

superResolutionCaffeModelPath string

caffe file path for the super resolution model

Returns

WeChatQRCode

Exceptions

ArgumentException

DetectAndDecode(InputArray, out Mat[], out string[])

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

public void DetectAndDecode(InputArray inputImage, out Mat[] bbox, out string[] results)

Parameters

inputImage InputArray

supports grayscale or color(BGR) image.

bbox Mat[]

optional output array of vertices of the found QR code quadrangle.Will be empty if not found.

results string[]

list of decoded string.

DisposeManaged()

Releases managed resources

protected override void DisposeManaged()