Pr22.Imaging

Class DocImage

java.lang.Object

Pr22.Imaging.DocImage

public class DocImage
extends java.lang.Object

Scanned document image data.

Field Summary

Fields

Modifier and Type	Field and Description
Variant	image Low level data of the image.
Light	light The illumination used at image scanning.

Method Summary

Modifier and Type	Method and Description
DocImage	docView() Returns a rotated and cropped image.
RawImage	generateLatentImage(java.lang.String decodingParams) Generates a decoded IPI image for visual inspection.
RawImage	getImage() Returns the RawImage object.
Document	readField(Variant readingParams) Reads character or barcode data from the image.
java.awt.image.BufferedImage	toImage() Returns the image as a BufferedImage.
Page	toPage() Converts image to Page object.

Methods inherited from class java.lang.Object

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

Field Detail

light

public final Light light

The illumination used at image scanning.

image

public Variant image

Low level data of the image.

Method Detail

toImage

public java.awt.image.BufferedImage toImage()
                                     throws General,
                                            java.io.IOException

Returns the image as a BufferedImage.

Returns:

BufferedImage image object.

Throws:

General

java.io.IOException

getImage

public RawImage getImage()
                  throws General

Returns the RawImage object.

Returns:

The RawImage object.

Throws:

General

docView

public DocImage docView()
                 throws General

Returns a rotated and cropped image. For top-bottom orientation, the Page.analyze(Pr22.Task.EngineTask) method must be called before.

Returns:

A DocImage object.

Throws:

General

toPage

public Page toPage()
            throws General

Converts image to Page object.

Returns:

The Page object.

Throws:

General

generateLatentImage

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

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

Parameters:

decodingParams - IPI image decoding parameters.

Returns:

Result image.

Throws:

General

readField

public Document readField(Variant readingParams)
                   throws General

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

Parameters:

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

Returns:

The result data structure.

Throws:

General