OpenCVForUnity.DnnModule.TextDetectionModel_DB Class Reference

This class represents high-level API for text detection DL networks compatible with DB model. More...

Public Member Functions
	TextDetectionModel_DB (Net network)
	Create text detection algorithm from deep learning network.
	TextDetectionModel_DB (string model)
	Create text detection model from network represented in one of the supported formats. An order of model and config arguments does not matter.
	TextDetectionModel_DB (string model, string config)
	Create text detection model from network represented in one of the supported formats. An order of model and config arguments does not matter.
float	getBinaryThreshold ()
int	getMaxCandidates ()
float	getPolygonThreshold ()
double	getUnclipRatio ()
TextDetectionModel_DB	setBinaryThreshold (float binaryThreshold)
TextDetectionModel_DB	setMaxCandidates (int maxCandidates)
TextDetectionModel_DB	setPolygonThreshold (float polygonThreshold)
TextDetectionModel_DB	setUnclipRatio (double unclipRatio)
Public Member Functions inherited from OpenCVForUnity.DnnModule.TextDetectionModel
void	detect (Mat frame, List< MatOfPoint > detections)
void	detect (Mat frame, List< MatOfPoint > detections, MatOfFloat confidences)
	Performs detection.
void	detectTextRectangles (Mat frame, MatOfRotatedRect detections)
void	detectTextRectangles (Mat frame, MatOfRotatedRect detections, MatOfFloat confidences)
	Performs detection.
Public Member Functions inherited from OpenCVForUnity.DnnModule.Model
	Model (Net network)
	Create model from deep learning network.
	Model (string model)
	Create model from deep learning network represented in one of the supported formats. An order of model and config arguments does not matter.
	Model (string model, string config)
	Create model from deep learning network represented in one of the supported formats. An order of model and config arguments does not matter.
Model	enableWinograd (bool useWinograd)
IntPtr	getNativeObjAddr ()
void	predict (Mat frame, List< Mat > outs)
	Given the input frame, create input blob, run net and return the output blobs.
Model	setInputCrop (bool crop)
	Set flag crop for frame.
Model	setInputMean (in Vec4d mean)
	Set mean value for frame.
Model	setInputMean (in(double v0, double v1, double v2, double v3) mean)
	Set mean value for frame.
Model	setInputMean (Scalar mean)
	Set mean value for frame.
void	setInputParams ()
	Set preprocessing parameters for frame.
void	setInputParams (double scale)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in Vec2d size)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in Vec2d size, in Vec4d mean)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in Vec2d size, in Vec4d mean, bool swapRB)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in Vec2d size, in Vec4d mean, bool swapRB, bool crop)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in(double width, double height) size)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in(double width, double height) size, in(double v0, double v1, double v2, double v3) mean)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in(double width, double height) size, in(double v0, double v1, double v2, double v3) mean, bool swapRB)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, in(double width, double height) size, in(double v0, double v1, double v2, double v3) mean, bool swapRB, bool crop)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, Size size)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, Size size, Scalar mean)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, Size size, Scalar mean, bool swapRB)
	Set preprocessing parameters for frame.
void	setInputParams (double scale, Size size, Scalar mean, bool swapRB, bool crop)
	Set preprocessing parameters for frame.
Model	setInputScale (in Vec4d scale)
	Set scalefactor value for frame.
Model	setInputScale (in(double v0, double v1, double v2, double v3) scale)
	Set scalefactor value for frame.
Model	setInputScale (Scalar scale)
	Set scalefactor value for frame.
Model	setInputSize (in Vec2d size)
	Set input size for frame.
Model	setInputSize (in(double width, double height) size)
	Set input size for frame.
Model	setInputSize (int width, int height)
Model	setInputSize (Size size)
	Set input size for frame.
Model	setInputSwapRB (bool swapRB)
	Set flag swapRB for frame.
Model	setOutputNames (List< string > outNames)
	Set output names for frame.
Model	setPreferableBackend (int backendId)
Model	setPreferableTarget (int targetId)
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static new TextDetectionModel_DB	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DnnModule.TextDetectionModel
static new TextDetectionModel	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DnnModule.Model
static Model	__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.DnnModule.TextDetectionModel
Protected Member Functions inherited from OpenCVForUnity.DnnModule.Model
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.DnnModule.TextDetectionModel
Package Functions inherited from OpenCVForUnity.DnnModule.Model
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

This class represents high-level API for text detection DL networks compatible with DB model.

Related publications: [liao2020real] Paper: https://arxiv.org/abs/1911.08947 For more information about the hyper-parameters setting, please refer to https://github.com/MhLiao/DB

Configurable parameters:

• (float) binaryThreshold - The threshold of the binary map. It is usually set to 0.3.
• (float) polygonThreshold - The threshold of text polygons. It is usually set to 0.5, 0.6, and 0.7. Default is 0.5f
• (double) unclipRatio - The unclip ratio of the detected text region, which determines the output size. It is usually set to 2.0.
• (int) maxCandidates - The max number of the output results.

Constructor & Destructor Documentation

TextDetectionModel_DB() [1/3]

OpenCVForUnity.DnnModule.TextDetectionModel_DB.TextDetectionModel_DB

(

Net

network

)

Create text detection algorithm from deep learning network.

Parameters

network

Net object.

TextDetectionModel_DB() [2/3]

OpenCVForUnity.DnnModule.TextDetectionModel_DB.TextDetectionModel_DB	(	string	model,
		string	config )

Create text detection model from network represented in one of the supported formats. An order of model and config arguments does not matter.

Parameters

model	Binary file contains trained weights.
config	Text file contains network configuration.

TextDetectionModel_DB() [3/3]

OpenCVForUnity.DnnModule.TextDetectionModel_DB.TextDetectionModel_DB

(

string

model

)

Create text detection model from network represented in one of the supported formats. An order of model and config arguments does not matter.

Parameters

model	Binary file contains trained weights.
config	Text file contains network configuration.

Member Function Documentation

__fromPtr__()

static new TextDetectionModel_DB OpenCVForUnity.DnnModule.TextDetectionModel_DB.__fromPtr__ ( IntPtr addr )

static

Dispose()

override void OpenCVForUnity.DnnModule.TextDetectionModel_DB.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DnnModule.TextDetectionModel.

getBinaryThreshold()

float OpenCVForUnity.DnnModule.TextDetectionModel_DB.getBinaryThreshold

(

)

getMaxCandidates()

int OpenCVForUnity.DnnModule.TextDetectionModel_DB.getMaxCandidates

(

)

getPolygonThreshold()

float OpenCVForUnity.DnnModule.TextDetectionModel_DB.getPolygonThreshold

(

)

getUnclipRatio()

double OpenCVForUnity.DnnModule.TextDetectionModel_DB.getUnclipRatio

(

)

setBinaryThreshold()

TextDetectionModel_DB OpenCVForUnity.DnnModule.TextDetectionModel_DB.setBinaryThreshold

(

float

binaryThreshold

)

setMaxCandidates()

TextDetectionModel_DB OpenCVForUnity.DnnModule.TextDetectionModel_DB.setMaxCandidates

(

int

maxCandidates

)

setPolygonThreshold()

TextDetectionModel_DB OpenCVForUnity.DnnModule.TextDetectionModel_DB.setPolygonThreshold

(

float

polygonThreshold

)

setUnclipRatio()

TextDetectionModel_DB OpenCVForUnity.DnnModule.TextDetectionModel_DB.setUnclipRatio

(

double

unclipRatio

)

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/dnn/TextDetectionModel_DB.cs