IrisInfo

java.lang.Object
- org.jmrtd.lds.IrisInfo

All Implemented Interfaces:

java.io.Serializable, BiometricDataBlock, LDSElement
```
public class IrisInfo
extends java.lang.Object
implements BiometricDataBlock
```
Iris record header and biometric subtype blocks based on Section 6.5.3 and Table 2 of ISO/IEC 19794-6 2005. TODO: proper enums for fields.

Version:

$Revision: 1578 $

Author:

Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CAPTURE_DEVICE_UNDEF` Constant for capture device Id, based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`IMAGEFORMAT_MONO_JPEG` Image format
`static int`	`IMAGEFORMAT_MONO_JPEG_LS` Image format
`static int`	`IMAGEFORMAT_MONO_JPEG2000` Image format
`static int`	`IMAGEFORMAT_MONO_RAW` Image format
`static int`	`IMAGEFORMAT_RGB_JPEG` Image format
`static int`	`IMAGEFORMAT_RGB_JPEG_LS` Image format
`static int`	`IMAGEFORMAT_RGB_JPEG2000` Image format
`static int`	`IMAGEFORMAT_RGB_RAW` Image format
`static int`	`INTENSITY_DEPTH_UNDEF`
`static int`	`IRBNDY_PROCESSED`
`static int`	`IRBNDY_UNDEF`
`static int`	`IROC_UNITFILL` Iris occlusion filling (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`IROCC_PROCESSED` Iris occlusion (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`IROCC_UNDEF` Iris occlusion (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`IROCC_ZEROFILL` Iris occlusion filling (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`ORIENTATION_BASE` Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`ORIENTATION_FLIPPED` Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`ORIENTATION_UNDEF` Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`SCAN_TYPE_CORRECTED` Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`SCAN_TYPE_INTERLACE_FIELD` Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`SCAN_TYPE_INTERLACE_FRAME` Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`SCAN_TYPE_PROGRESSIVE` Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`SCAN_TYPE_UNDEF` Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
`static int`	`TRANS_STD`
`static int`	`TRANS_UNDEF`

Constructor Summary

Constructors
Constructor and Description
`IrisInfo(java.io.InputStream inputStream)` Constructs an iris info from binary encoding.
`IrisInfo(int captureDeviceId, int horizontalOrientation, int verticalOrientation, int scanType, int irisOcclusion, int occlusionFilling, int boundaryExtraction, int irisDiameter, int imageFormat, int rawImageWidth, int rawImageHeight, int intensityDepth, int imageTransformation, byte[] deviceUniqueId, java.util.List<IrisBiometricSubtypeInfo> irisBiometricSubtypeInfos)` Constructs a new iris info object.
`IrisInfo(StandardBiometricHeader sbh, java.io.InputStream inputStream)` Constructs an iris info from binary encoding.
`IrisInfo(StandardBiometricHeader sbh, int captureDeviceId, int horizontalOrientation, int verticalOrientation, int scanType, int irisOcclusion, int occlusionFilling, int boundaryExtraction, int irisDiameter, int imageFormat, int rawImageWidth, int rawImageHeight, int intensityDepth, int imageTransformation, byte[] deviceUniqueId, java.util.List<IrisBiometricSubtypeInfo> irisBiometricSubtypeInfos)` Constructs a new iris info object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIrisBiometricSubtypeInfo(IrisBiometricSubtypeInfo irisBiometricSubtypeInfo)` Adds an iris biometric subtype info to this iris info.
`boolean`	`equals(java.lang.Object other)`
`int`	`getBoundaryExtraction()` Gets the boundary extraction.
`int`	`getCaptureDeviceId()` Gets the capture device id.
`byte[]`	`getDeviceUniqueId()` Gets the device unique id.
`byte[]`	`getEncoded()` Gets the encoded contents of this LDS info.
`int`	`getHorizontalOrientation()` Gets the horizontal orientation
`int`	`getImageFormat()` Gets the image format.
`int`	`getImageTransformation()` Gets the image transformation.
`int`	`getIntensityDepth()` Gets the intensity depth.
`java.util.List<IrisBiometricSubtypeInfo>`	`getIrisBiometricSubtypeInfos()` Gets the iris biometric subtype infos embedded in this iris info.
`int`	`getIrisDiameter()` Gets the iris diameter.
`int`	`getIrisOcclusion()` Gets the iris occlusion.
`int`	`getOcclusionFilling()` Gets the iris occlusing filling.
`int`	`getRawImageHeight()` Gets the raw image height.
`int`	`getRawImageWidth()` Gets the raw image width.
`int`	`getScanType()` Gets the scan type.
`StandardBiometricHeader`	`getStandardBiometricHeader()` Gets the standard biometric header of this iris info.
`int`	`getVerticalOrientation()` Gets the vertical orientation
`int`	`hashCode()`
`void`	`readObject(java.io.InputStream inputStream)` Reads this iris info from input stream.
`void`	`removeIrisBiometricSubtypeInfo(int index)` Removes an iris biometric subtype info from this iris info.
`java.lang.String`	`toString()` Generates a textual representation of this object.
`void`	`writeObject(java.io.OutputStream outputStream)` Writes this iris info to an output stream.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IMAGEFORMAT_MONO_RAW
```
public static final int IMAGEFORMAT_MONO_RAW
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_RGB_RAW
```
public static final int IMAGEFORMAT_RGB_RAW
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_MONO_JPEG
```
public static final int IMAGEFORMAT_MONO_JPEG
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_RGB_JPEG
```
public static final int IMAGEFORMAT_RGB_JPEG
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_MONO_JPEG_LS
```
public static final int IMAGEFORMAT_MONO_JPEG_LS
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_RGB_JPEG_LS
```
public static final int IMAGEFORMAT_RGB_JPEG_LS
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_MONO_JPEG2000
```
public static final int IMAGEFORMAT_MONO_JPEG2000
```
    Image format
    
    See Also:
    
    Constant Field Values
  - IMAGEFORMAT_RGB_JPEG2000
```
public static final int IMAGEFORMAT_RGB_JPEG2000
```
    Image format
    
    See Also:
    
    Constant Field Values
  - CAPTURE_DEVICE_UNDEF
```
public static final int CAPTURE_DEVICE_UNDEF
```
    Constant for capture device Id, based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_UNDEF
```
public static final int ORIENTATION_UNDEF
```
    Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_BASE
```
public static final int ORIENTATION_BASE
```
    Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_FLIPPED
```
public static final int ORIENTATION_FLIPPED
```
    Constant for horizontal and veritical orientation, based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE_UNDEF
```
public static final int SCAN_TYPE_UNDEF
```
    Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE_PROGRESSIVE
```
public static final int SCAN_TYPE_PROGRESSIVE
```
    Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE_INTERLACE_FRAME
```
public static final int SCAN_TYPE_INTERLACE_FRAME
```
    Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE_INTERLACE_FIELD
```
public static final int SCAN_TYPE_INTERLACE_FIELD
```
    Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE_CORRECTED
```
public static final int SCAN_TYPE_CORRECTED
```
    Scan type (rectilinear only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - IROCC_UNDEF
```
public static final int IROCC_UNDEF
```
    Iris occlusion (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - IROCC_PROCESSED
```
public static final int IROCC_PROCESSED
```
    Iris occlusion (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - IROCC_ZEROFILL
```
public static final int IROCC_ZEROFILL
```
    Iris occlusion filling (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - IROC_UNITFILL
```
public static final int IROC_UNITFILL
```
    Iris occlusion filling (polar only), based on Table 2 in Section 5.5 in ISO 19794-6.
    
    See Also:
    
    Constant Field Values
  - INTENSITY_DEPTH_UNDEF
```
public static final int INTENSITY_DEPTH_UNDEF
```
    See Also:
    
    Constant Field Values
  - TRANS_UNDEF
```
public static final int TRANS_UNDEF
```
    See Also:
    
    Constant Field Values
  - TRANS_STD
```
public static final int TRANS_STD
```
    See Also:
    
    Constant Field Values
  - IRBNDY_UNDEF
```
public static final int IRBNDY_UNDEF
```
    See Also:
    
    Constant Field Values
  - IRBNDY_PROCESSED
```
public static final int IRBNDY_PROCESSED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IrisInfo
```
public IrisInfo(int captureDeviceId,
                int horizontalOrientation,
                int verticalOrientation,
                int scanType,
                int irisOcclusion,
                int occlusionFilling,
                int boundaryExtraction,
                int irisDiameter,
                int imageFormat,
                int rawImageWidth,
                int rawImageHeight,
                int intensityDepth,
                int imageTransformation,
                byte[] deviceUniqueId,
                java.util.List<IrisBiometricSubtypeInfo> irisBiometricSubtypeInfos)
```
    Constructs a new iris info object.
    
    Parameters:
    
    captureDeviceId - capture device identifier assigned by vendor
    
    horizontalOrientation - horizontal orientation: ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
    
    verticalOrientation - vertical orientation: ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
    
    scanType - scan type
    
    irisOcclusion - iris occlusion (polar only)
    
    occlusionFilling - occlusion filling (polar only)
    
    boundaryExtraction - boundary extraction (polar only)
    
    irisDiameter - expected iris diameter in pixels (rectilinear only)
    
    imageFormat - image format of data blob (JPEG, raw, etc.)
    
    rawImageWidth - raw image width, pixels
    
    rawImageHeight - raw image height, pixels
    
    intensityDepth - intensity depth, bits, per color
    
    imageTransformation - transformation to polar image (polar only)
    
    deviceUniqueId - a 16 character string uniquely identifying the device or source of that data
    
    irisBiometricSubtypeInfos - the iris biometric subtype records
  - IrisInfo
```
public IrisInfo(StandardBiometricHeader sbh,
                int captureDeviceId,
                int horizontalOrientation,
                int verticalOrientation,
                int scanType,
                int irisOcclusion,
                int occlusionFilling,
                int boundaryExtraction,
                int irisDiameter,
                int imageFormat,
                int rawImageWidth,
                int rawImageHeight,
                int intensityDepth,
                int imageTransformation,
                byte[] deviceUniqueId,
                java.util.List<IrisBiometricSubtypeInfo> irisBiometricSubtypeInfos)
```
    Constructs a new iris info object.
    
    Parameters:
    
    sbh - standard biometric header to use
    
    captureDeviceId - capture device identifier assigned by vendor
    
    horizontalOrientation - horizontal orientation: ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
    
    verticalOrientation - vertical orientation: ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
    
    scanType - scan type
    
    irisOcclusion - iris occlusion (polar only)
    
    occlusionFilling - occlusion filling (polar only)
    
    boundaryExtraction - boundary extraction (polar only)
    
    irisDiameter - expected iris diameter in pixels (rectilinear only)
    
    imageFormat - image format of data blob (JPEG, raw, etc.)
    
    rawImageWidth - raw image width, pixels
    
    rawImageHeight - raw image height, pixels
    
    intensityDepth - intensity depth, bits, per color
    
    imageTransformation - transformation to polar image (polar only)
    
    deviceUniqueId - a 16 character string uniquely identifying the device or source of that data
    
    irisBiometricSubtypeInfos - the iris biometric subtype records
  - IrisInfo
```
public IrisInfo(java.io.InputStream inputStream)
         throws java.io.IOException
```
    Constructs an iris info from binary encoding.
    
    Parameters:
    
    inputStream - an input stream
    
    Throws:
    
    java.io.IOException - if reading fails
  - IrisInfo
```
public IrisInfo(StandardBiometricHeader sbh,
                java.io.InputStream inputStream)
         throws java.io.IOException
```
    Constructs an iris info from binary encoding.
    
    Parameters:
    
    sbh - standard biometric header to use
    
    inputStream - an input stream
    
    Throws:
    
    java.io.IOException - if reading fails
- Method Detail
  - readObject
```
public void readObject(java.io.InputStream inputStream)
                throws java.io.IOException
```
    Reads this iris info from input stream.
    
    Parameters:
    
    inputStream - an input stream
    
    Throws:
    
    java.io.IOException - if reading fails
  - writeObject
```
public void writeObject(java.io.OutputStream outputStream)
                 throws java.io.IOException
```
    Writes this iris info to an output stream.
    
    Parameters:
    
    outputStream - an output stream
    
    Throws:
    
    java.io.IOException - if writing fails
  - getCaptureDeviceId
```
public int getCaptureDeviceId()
```
    Gets the capture device id.
    
    Returns:
    
    the captureDeviceId
  - getHorizontalOrientation
```
public int getHorizontalOrientation()
```
    Gets the horizontal orientation
    
    Returns:
    
    the horizontalOrientation, one of ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
  - getVerticalOrientation
```
public int getVerticalOrientation()
```
    Gets the vertical orientation
    
    Returns:
    
    the verticalOrientation, one of ORIENTATION_UNDEF, ORIENTATION_BASE, or ORIENTATION_FLIPPED
  - getScanType
```
public int getScanType()
```
    Gets the scan type.
    
    Returns:
    
    the scanType, one of SCAN_TYPE_UNDEF, SCAN_TYPE_PROGRESSIVE, SCAN_TYPE_INTERLACE_FRAME, SCAN_TYPE_INTERLACE_FIELD, or SCAN_TYPE_CORRECTED
  - getIrisOcclusion
```
public int getIrisOcclusion()
```
    Gets the iris occlusion.
    
    Returns:
    
    the irisOcclusion
  - getOcclusionFilling
```
public int getOcclusionFilling()
```
    Gets the iris occlusing filling.
    
    Returns:
    
    the occlusionFilling
  - getBoundaryExtraction
```
public int getBoundaryExtraction()
```
    Gets the boundary extraction.
    
    Returns:
    
    the boundaryExtraction
  - getIrisDiameter
```
public int getIrisDiameter()
```
    Gets the iris diameter.
    
    Returns:
    
    the irisDiameter
  - getImageFormat
```
public int getImageFormat()
```
    Gets the image format.
    
    Returns:
    
    the imageFormat
  - getRawImageWidth
```
public int getRawImageWidth()
```
    Gets the raw image width.
    
    Returns:
    
    the rawImageWidth
  - getRawImageHeight
```
public int getRawImageHeight()
```
    Gets the raw image height.
    
    Returns:
    
    the rawImageHeight
  - getIntensityDepth
```
public int getIntensityDepth()
```
    Gets the intensity depth.
    
    Returns:
    
    the intensityDepth
  - getImageTransformation
```
public int getImageTransformation()
```
    Gets the image transformation.
    
    Returns:
    
    the imageTransformation
  - getDeviceUniqueId
```
public byte[] getDeviceUniqueId()
```
    Gets the device unique id.
    
    Returns:
    
    the deviceUniqueId
  - getStandardBiometricHeader
```
public StandardBiometricHeader getStandardBiometricHeader()
```
    Gets the standard biometric header of this iris info.
    
    Specified by:
    
    getStandardBiometricHeader in interface BiometricDataBlock
    
    Returns:
    
    the standard biometric header
  - toString
```
public java.lang.String toString()
```
    Generates a textual representation of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a textual representation of this object
    
    See Also:
    
    Object.toString()
  - getIrisBiometricSubtypeInfos
```
public java.util.List<IrisBiometricSubtypeInfo> getIrisBiometricSubtypeInfos()
```
    Gets the iris biometric subtype infos embedded in this iris info.
    
    Returns:
    
    iris biometric subtype infos
  - addIrisBiometricSubtypeInfo
```
public void addIrisBiometricSubtypeInfo(IrisBiometricSubtypeInfo irisBiometricSubtypeInfo)
```
    Adds an iris biometric subtype info to this iris info.
    
    Parameters:
    
    irisBiometricSubtypeInfo - an iris biometric subtype info
  - removeIrisBiometricSubtypeInfo
```
public void removeIrisBiometricSubtypeInfo(int index)
```
    Removes an iris biometric subtype info from this iris info.
    
    Parameters:
    
    index - the index of the biometric subtype info to remove
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getEncoded
```
public byte[] getEncoded()
```
    Description copied from interface: LDSElement
    
    Gets the encoded contents of this LDS info.
    
    Specified by:
    
    getEncoded in interface LDSElement
    
    Returns:
    
    a byte array containing the encoding of this LDS info

Class IrisInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IMAGEFORMAT_MONO_RAW

IMAGEFORMAT_RGB_RAW

IMAGEFORMAT_MONO_JPEG

IMAGEFORMAT_RGB_JPEG

IMAGEFORMAT_MONO_JPEG_LS

IMAGEFORMAT_RGB_JPEG_LS

IMAGEFORMAT_MONO_JPEG2000

IMAGEFORMAT_RGB_JPEG2000

CAPTURE_DEVICE_UNDEF

ORIENTATION_UNDEF

ORIENTATION_BASE

ORIENTATION_FLIPPED

SCAN_TYPE_UNDEF

SCAN_TYPE_PROGRESSIVE

SCAN_TYPE_INTERLACE_FRAME

SCAN_TYPE_INTERLACE_FIELD

SCAN_TYPE_CORRECTED

IROCC_UNDEF

IROCC_PROCESSED

IROCC_ZEROFILL

IROC_UNITFILL

INTENSITY_DEPTH_UNDEF

TRANS_UNDEF

TRANS_STD

IRBNDY_UNDEF

IRBNDY_PROCESSED

Constructor Detail

IrisInfo

IrisInfo

IrisInfo

IrisInfo

Method Detail

readObject

writeObject

getCaptureDeviceId

getHorizontalOrientation

getVerticalOrientation

getScanType

getIrisOcclusion

getOcclusionFilling

getBoundaryExtraction

getIrisDiameter

getImageFormat

getRawImageWidth

getRawImageHeight

getIntensityDepth

getImageTransformation

getDeviceUniqueId

getStandardBiometricHeader

toString

getIrisBiometricSubtypeInfos

addIrisBiometricSubtypeInfo

removeIrisBiometricSubtypeInfo

equals

hashCode

getEncoded