Pr22

Class Engine

java.lang.Object

Pr22.Engine

public class Engine
extends java.lang.Object

Data analyzer module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Engine.Information Class for storing information on an Engine.

Method Summary

Modifier and Type	Method and Description
Document	analyze(BinData data) Analyzes binary data.
Document	analyze(Page page, EngineTask task) Analyzes the image data of an already scanned Page and returns the textual and logical data according to task.
RawImage	generateLatentImage(DocImage image, java.lang.String decodingParams) Generates a decoded IPI image for visual inspection.
Engine.Information	getInfo() Returns the engine information.
Document	getRootDocument() Returns the root Document containing all data to save.
Document	readField(DocImage image, Variant readingParams) Reads character or barcode data from an image.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInfo

public Engine.Information getInfo()
                           throws General

Returns the engine information.

Returns:

The engine information.

Throws:

General

analyze

public Document analyze(Page page,
                        EngineTask task)
                 throws General

Analyzes the image data of an already scanned Page and returns the textual and logical data according to task. This method has the same role as Page.analyze(Pr22.Task.EngineTask).

Parameters:

page - A set of images to analyze.

task - Specifies data field references to analyze.

Returns:

The result data structure.

Throws:

General

analyze

public Document analyze(BinData data)
                 throws General

Analyzes binary data.

Parameters:

data - Data to analyze.

Returns:

The result data structure.

Throws:

General

generateLatentImage

public RawImage generateLatentImage(DocImage image,
                                    java.lang.String decodingParams)
                             throws General

Generates a decoded IPI image for visual inspection. This method has the same role as DocImage.generateLatentImage(java.lang.String).

Parameters:

image - Source image.

decodingParams - IPI image decoding parameters.

Returns:

Result image.

Throws:

General

readField

public Document readField(DocImage image,
                          Variant readingParams)
                   throws General

Reads character or barcode data from an image. This method has the same role as DocImage.readField(Pr22.Util.Variant).

Parameters:

image - The input image to read from.

readingParams - Reading parameters that are described in the Passport Reader reference manual.

Returns:

The result data structure.

Throws:

General

getRootDocument

public Document getRootDocument()
                         throws General

Returns the root Document containing all data to save.

Returns:

The root Document.

Throws:

General