org.jmrtd.lds

Class IrisImageInfo

java.lang.Object

org.jmrtd.lds.IrisImageInfo

All Implemented Interfaces:

java.io.Serializable, ImageInfo, LDSElement

public class IrisImageInfo
extends java.lang.Object

Iris image header and image data based on Section 6.5.3 and Table 4 of ISO/IEC 19794-6 2005.

Version:

$Revision: 1559 $

Author:

Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	IMAGE_QUAL_HIGH_HI Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_HIGH_LO Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_LOW_HI Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_LOW_LO Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_MED_HI Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_MED_LO Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.
static int	IMAGE_QUAL_UNDEF Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

Fields inherited from interface org.jmrtd.lds.ImageInfo

JPEG_MIME_TYPE, JPEG2000_MIME_TYPE, TYPE_FINGER, TYPE_IRIS, TYPE_PORTRAIT, TYPE_SIGNATURE_OR_MARK, WSQ_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
IrisImageInfo(int imageNumber, int width, int height, java.io.InputStream imageBytes, int imageLength, int imageFormat) Constructs an iris image info.
IrisImageInfo(int imageNumber, int quality, int rotationAngle, int rotationAngleUncertainty, int width, int height, java.io.InputStream imageBytes, int imageLength, int imageFormat) Constructs an iris image info.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
byte[]	getEncoded() Encodes this image info.
int	getHeight() Gets the height of the image.
int	getImageFormat() Gets the image format.
java.io.InputStream	getImageInputStream() Gets the encoded image as an input stream.
int	getImageLength() Gets the length of the encoded image.
int	getImageNumber() Gets the image number.
java.lang.String	getMimeType() Gets the mime-type of the encoded image.
int	getQuality() Gets the quality.
long	getRecordLength() Gets the record length.
int	getRotationAngle() Gets the rotation angle.
int	getRotationAngleUncertainty() Gets the rotation angle uncertainty.
int	getType() Content type, one of ImageInfo.TYPE_PORTRAIT, ImageInfo.TYPE_FINGER, ImageInfo.TYPE_IRIS, ImageInfo.TYPE_SIGNATURE_OR_MARK.
int	getWidth() Gets the width of the image.
int	hashCode()
protected void	readImage(java.io.InputStream inputStream, long imageLength) Clients should call this method after positioning the input stream to the image bytes.
protected void	readObject(java.io.InputStream inputStream)
protected void	setHeight(int height)
protected void	setImageBytes(byte[] imageBytes)
protected void	setMimeType(java.lang.String mimeType)
protected void	setType(int type)
protected void	setWidth(int width)
java.lang.String	toString() Generates a textual representation of this object.
protected void	writeImage(java.io.OutputStream outputStream)
protected void	writeObject(java.io.OutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

IMAGE_QUAL_UNDEF

public static int IMAGE_QUAL_UNDEF

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_LOW_LO

public static int IMAGE_QUAL_LOW_LO

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_LOW_HI

public static int IMAGE_QUAL_LOW_HI

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_MED_LO

public static int IMAGE_QUAL_MED_LO

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_MED_HI

public static int IMAGE_QUAL_MED_HI

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_HIGH_LO

public static int IMAGE_QUAL_HIGH_LO

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

IMAGE_QUAL_HIGH_HI

public static int IMAGE_QUAL_HIGH_HI

Image quality, based on Table 3 in Section 5.5 of ISO 19794-6.

Constructor Detail

IrisImageInfo

public IrisImageInfo(int imageNumber,
                     int quality,
                     int rotationAngle,
                     int rotationAngleUncertainty,
                     int width,
                     int height,
                     java.io.InputStream imageBytes,
                     int imageLength,
                     int imageFormat)
              throws java.io.IOException

Constructs an iris image info.

Parameters:

imageNumber - the image number

quality - quality

rotationAngle - rotation angle

rotationAngleUncertainty - rotation angle uncertainty

width - with

height - height

imageBytes - the encoded image

imageLength - the length of the encoded image

imageFormat - the image format used for encoding

Throws:

java.io.IOException - on error reading the image input stream

IrisImageInfo

public IrisImageInfo(int imageNumber,
                     int width,
                     int height,
                     java.io.InputStream imageBytes,
                     int imageLength,
                     int imageFormat)
              throws java.io.IOException

Constructs an iris image info.

Parameters:

imageNumber - the image number

width - width

height - height

imageBytes - the encoded image

imageLength - the length of the encoded image

imageFormat - the image format used for encoding

Throws:

java.io.IOException - on error reading the image stream

Method Detail

getImageFormat

public int getImageFormat()

Gets the image format.

Returns:

the image format

getImageNumber

public int getImageNumber()

Gets the image number.

Returns:

the image number

getQuality

public int getQuality()

Gets the quality.

Returns:

the image quality

getRotationAngle

public int getRotationAngle()

Gets the rotation angle.

Returns:

the rotationAngle

getRotationAngleUncertainty

public int getRotationAngleUncertainty()

Gets the rotation angle uncertainty.

Returns:

the rotationAngleUncertainty

getRecordLength

public long getRecordLength()

Gets the record length.

Specified by:

getRecordLength in interface ImageInfo

Returns:

the record length

toString

public java.lang.String toString()

Generates a textual representation of this object.

Returns:

a textual representation of this object

See Also:

Object.toString()

readObject

protected void readObject(java.io.InputStream inputStream)
                   throws java.io.IOException

Throws:

java.io.IOException

writeObject

protected void writeObject(java.io.OutputStream out)
                    throws java.io.IOException

Throws:

java.io.IOException

getType

public int getType()

Content type, one of ImageInfo.TYPE_PORTRAIT, ImageInfo.TYPE_FINGER, ImageInfo.TYPE_IRIS, ImageInfo.TYPE_SIGNATURE_OR_MARK.

Specified by:

getType in interface ImageInfo

Returns:

content type

getMimeType

public java.lang.String getMimeType()

Gets the mime-type of the encoded image.

Specified by:

getMimeType in interface ImageInfo

Returns:

the mime-type of the encoded image

getWidth

public int getWidth()

Gets the width of the image.

Specified by:

getWidth in interface ImageInfo

Returns:

the width of the image

getHeight

public int getHeight()

Gets the height of the image.

Specified by:

getHeight in interface ImageInfo

Returns:

the height of the image

getImageLength

public int getImageLength()

Gets the length of the encoded image.

Specified by:

getImageLength in interface ImageInfo

Returns:

the length of the encoded image

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getEncoded

public byte[] getEncoded()

Encodes this image info.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the encoded image info

getImageInputStream

public java.io.InputStream getImageInputStream()

Gets the encoded image as an input stream.

Specified by:

getImageInputStream in interface ImageInfo

Returns:

an input stream containing the encoded image

readImage

protected void readImage(java.io.InputStream inputStream,
                         long imageLength)
                  throws java.io.IOException

Clients should call this method after positioning the input stream to the image bytes.

Parameters:

inputStream - input stream

imageLength - image length

Throws:

java.io.IOException - on error reading the input stream

writeImage

protected void writeImage(java.io.OutputStream outputStream)
                   throws java.io.IOException

Throws:

java.io.IOException

setMimeType

protected final void setMimeType(java.lang.String mimeType)

setType

protected final void setType(int type)

setWidth

protected final void setWidth(int width)

setHeight

protected final void setHeight(int height)

setImageBytes

protected final void setImageBytes(byte[] imageBytes)