DocumentDetector Class

Namespace: id3.Document

Definition

Detects documents in images.
class DocumentDetector
class DocumentDetector implements Finalizable
public partial class DocumentDetector
public class DocumentDetector implements AutoCloseable, Serializable
public class DocumentDetector
typedef struct id3DocumentDetector *ID3_DOCUMENT_DETECTOR;

Usage

documentDetectorInstance = DocumentDetector()
# ...

Explicit destruction

# ...
del documentDetectorInstance
final documentDetectorInstance = sdk.DocumentDetector();
// ...

Explicit destruction

// ...
documentDetectorInstance.dispose()
using (var documentDetectorInstance = new DocumentDetector())
{
   // ...
}

Explicit destruction

var documentDetectorInstance = new DocumentDetector()
// ...
documentDetectorInstance.Dispose()
try (DocumentDetector documentDetectorInstance = new DocumentDetector()) {
// ...
}

Explicit destruction

DocumentDetector documentDetectorInstance = new DocumentDetector();
// ...
documentDetectorInstance.close();
private var documentDetectorInstance: DocumentDetector? = nil
documentDetectorInstance = try DocumentDetector()
ID3_DOCUMENT_DETECTOR hDocumentDetector{};
int err = id3DocumentDetector_Initialize(&hDocumentDetector);
if (err == ID3_SUCCESS) {
    // ...
    id3DocumentDetector_Dispose(&hDocumentDetector);
}

Properties

Name

Type

Description

confidenceThreshold

int

Confidence threshold, from 0 to 100+.

documentWidthRatio

float

Ratio of the estimated width of the searched document in the image.

model

DocumentModel

Model to be used for document detection.

processingUnit

ProcessingUnit

Processing unit where to run the detection process.

threadCount

int

Number of threads to use for detection.

Methods

Name

Description

alignDocument

Aligns and crops the specified document on the specified image and returns a new DocumentImage.

detectDocument

Detects a document on a delimited area of the specified DocumentImage and returns a DetectedDocument.

detectDocumentByName

Detects a document with specified name on a delimited area of the specified DocumentImage and returns a DetectedDocument.