PassportDetector Class Reference

Inheritance diagram for PassportDetector:

Public Member Functions
	PassportDetector ()
PassportDetectionResult	detect (PassportDetectionSettings settings, Bitmap image)
PassportDetectionResult	detect (PassportDetectionSettings settings, byte[] data, int width, int height)
void	destroy ()
Public Member Functions inherited from IDocumentDetector< PassportDetectionSettings, PassportDetectionResult >
U	detect (T settings, Bitmap image)
	Runs the document detection algorithm. More...
U	detect (T settings, byte[] data, int width, int height)
	Runs the document detection algorithm. More...
void	destroy ()
	Destroys this detector instance and releases resources associated with it. More...

Detailed Description

This class provides the main entry point to run Kofax's PassportDetection algorithms against a bitmap image.

Constructor & Destructor Documentation

PassportDetector

(

)

Default constructor for the PassportDetector class.

Member Function Documentation

void destroy

(

)

When using the detector directly, it is necessary to call this method to allow for clean-up. Only call this method when you are done with the detector completely, i.e. in your onDestroy method of your Activity

PassportDetectionResult detect	(	PassportDetectionSettings	settings,
		Bitmap	image
	)

Call this method to run the check detection algorithms. Note: None of the parameter values should be null.

Parameters

settings	An instance of a PassportDetectionSettings object.
image	The bitmap image with which the check detection algorithm will run against. The bitmap must be in landscape orientation with the passport in an up-right orientation (MRZ in the bottom or in the top)

Returns

PassportDetectionResult Calling this method will return a PassportDetectResult object that contains the bounds of the passport, the original image, zoom guidance, rotation guidance, horizontal guidance, and vertical guidance. A null result indicates the detector was unable to locate a passport within the image.

Implements IPassportDetector.

PassportDetectionResult detect	(	PassportDetectionSettings	settings,
		byte[]	data,
		int	width,
		int	height
	)

Call this method to run the check detection algorithms.

Parameters

settings	An instance of a PassportDetectionSettings object.
data	The image data with which the check detection algorithm will run against. The bitmap must be in landscape orientation with the passport in an up-right orientation (MRZ in the bottom or in the top)
width	The width of the image
height	The height of the image

Returns

PassportDetectResult Calling this method will return a PassportDetectResult object that contains the bounds of the passport, the original image, zoom guidance, rotation guidance, horizontal guidance, and vertical guidance. A null result indicates the detector was unable to locate a passport within the image.

Implements IPassportDetector.

---

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

• PassportDetector.java