MrzScanner

API for machine readable zone scanning. More...

Public Member Functions
None	__init__ (self, *, Optional[MrzScannerConfiguration] configuration=None)
	Initialize the MRZ scanner.
MrzScannerResult	run (self, *, ImageRef image)
	Recognize the MRZ in the given image.
None	clear_result (self)
	Clears the accumulated results.

Detailed Description

API for machine readable zone scanning.

Required licence feature(s): MrzScanner.

Constructor & Destructor Documentation

__init__()

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

Initialize the MRZ scanner.

Parameters

configuration

The configuration to use for the scanner.

Member Function Documentation

clear_result()

None clear_result

(

self

)

Clears the accumulated results.

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

run()

MrzScannerResult run	(		self,
		*	,
		ImageRef	image )

Recognize the MRZ in the given image.

Parameters

image

The image to recognize.

Returns

The recognition result.

---

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

• api/mrz/mrz_scanner.py