DocumentScanner

API for document detection and scanning. More...

Public Member Functions
None	__init__ (self, *, Optional[DocumentScannerConfiguration] configuration=None)
	Initialize the document detector.
DocumentDetectionResult	run (self, *, ImageRef image)
	Detect the document contour in the given image.
DocumentScanningResult	scan (self, *, ImageRef image)
	Detect the document contour in the given image and crop it.
None	clear_result (self)
	Clears the accumulated results.

Detailed Description

API for document detection and scanning.

Required licence feature(s): DocumentScanner.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*	,
		Optional[DocumentScannerConfiguration]	configuration = None )

Initialize the document detector.

Parameters

configuration

The configuration for the document detector.

Member Function Documentation

clear_result()

None clear_result

(

self

)

Clears the accumulated results.

Should be called after a document has been detected to the customers satisfaction to prevent a poisoned cache.

run()

DocumentDetectionResult run	(		self,
		*	,
		ImageRef	image )

Detect the document contour in the given image.

Parameters

image

The image to detect the document contour in.

Returns

The detection result.

scan()

DocumentScanningResult scan	(		self,
		*	,
		ImageRef	image )

Detect the document contour in the given image and crop it.

Parameters

image

The image to detect the document contour in.

Returns

The scanning result.

---

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

• api/document_scanner/document_scanner.py