DocumentDetector.detectDocument Method

Module: DocumentDetector

Definition

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

Important

Document templates must be loaded before calling this method.

detect_document(self, image: DocumentImage, detection_zone: Rectangle, document_template_subset: StringList) -> DetectedDocument

Parameters

image DocumentImage
in Source image to process

detection_zone Rectangle
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

document_template_subset StringList
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

Returns

DetectedDocument
Detected document in the image

Exceptions

DocumentException
An error has occurred during Document Library execution.
DetectedDocument detectDocument(DocumentImage image, Rectangle detectionZone, StringList documentTemplateSubset)

Parameters

image DocumentImage
in Source image to process

detectionZone Rectangle
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

documentTemplateSubset StringList
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

Returns

DetectedDocument
Detected document in the image

Exceptions

DocumentException
An error has occurred during Document Library execution.
public DetectedDocument DetectDocument(DocumentImage image, Rectangle detectionZone, StringList documentTemplateSubset)

Parameters

image DocumentImage
in Source image to process

detectionZone Rectangle
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

documentTemplateSubset StringList
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

Returns

DetectedDocument
Detected document in the image

Exceptions

DocumentException
An error has occurred during Document Library execution.
public DetectedDocument detectDocument(DocumentImage image, Rectangle detectionZone, StringList documentTemplateSubset) throws DocumentException

Parameters

image DocumentImage
in Source image to process

detectionZone Rectangle
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

documentTemplateSubset StringList
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

Returns

DetectedDocument
Detected document in the image

Exceptions

DocumentException
An error has occurred during Document Library execution.
public func detectDocument(image: DocumentImage, detectionZone: Rectangle, documentTemplateSubset: StringList) throws -> DetectedDocument

Parameters

image DocumentImage
in Source image to process

detectionZone Rectangle
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

documentTemplateSubset StringList
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

Returns

DetectedDocument
Detected document in the image

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentDetector_DetectDocument (
    ID3_DOCUMENT_DETECTOR hDocumentDetector,
    ID3_DOCUMENT_IMAGE hImage,
    ID3_DOCUMENT_RECTANGLE hDetectionZone,
    ID3_DOCUMENT_STRING_LIST hDocumentTemplateSubset,
    ID3_DETECTED_DOCUMENT hDetectedDocument)

Parameters

hDocumentDetector ID3_DOCUMENT_DETECTOR
in Handle to the DocumentDetector object.

hImage ID3_DOCUMENT_IMAGE
in Source image to process

hDetectionZone ID3_DOCUMENT_RECTANGLE
in Crop in the image where to look for document. Default is the full image. Output corners are in the full image referential.

hDocumentTemplateSubset ID3_DOCUMENT_STRING_LIST
in If not empty, will restrict the search to the specified document templates provided. If empty, searches across all loaded document templates.

hDetectedDocument ID3_DETECTED_DOCUMENT
out Detected document in the image

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.