Package org.jmrtd.lds.iso19794

Class IrisInfo

    • 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

    • 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,
                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,
                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​(InputStream inputStream)
         throws IOException
        Constructs an iris info from binary encoding.
        Parameters:
        inputStream - an input stream
        Throws:
        IOException - if reading fails

    • Method Detail

      • getCaptureDeviceId

        public int getCaptureDeviceId()
        Returns the capture device identifier.
        Returns:
        the capture device identifier

      • getIrisOcclusion

        public int getIrisOcclusion()
        Returns the iris occlusion.
        Returns:
        the irisOcclusion

      • getOcclusionFilling

        public int getOcclusionFilling()
        Returns the iris occlusing filling.
        Returns:
        the occlusionFilling

      • getBoundaryExtraction

        public int getBoundaryExtraction()
        Returns the boundary extraction.
        Returns:
        the boundaryExtraction

      • getIrisDiameter

        public int getIrisDiameter()
        Returns the iris diameter.
        Returns:
        the irisDiameter

      • getImageFormat

        public int getImageFormat()
        Returns the image format.
        Returns:
        the imageFormat

      • getRawImageWidth

        public int getRawImageWidth()
        Returns the raw image width.
        Returns:
        the rawImageWidth

      • getRawImageHeight

        public int getRawImageHeight()
        Returns the raw image height.
        Returns:
        the rawImageHeight

      • getIntensityDepth

        public int getIntensityDepth()
        Returns the intensity depth.
        Returns:
        the intensityDepth

      • getImageTransformation

        public int getImageTransformation()
        Returns the image transformation.
        Returns:
        the imageTransformation

      • getDeviceUniqueId

        public byte[] getDeviceUniqueId()
        Returns the device unique id.
        Returns:
        the deviceUniqueId

      • toString

        public String toString()
        Generates a textual representation of this object.
        Overrides:
        toString in class Object
        Returns:
        a textual representation of this object
        See Also:
        Object.toString()

      • getIrisBiometricSubtypeInfos

        public List<IrisBiometricSubtypeInfo> getIrisBiometricSubtypeInfos()
        Returns 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