FaceImageInfo (JMRTD 0.5.6 API)

java.lang.Object
- org.jmrtd.lds.AbstractImageInfo
- - org.jmrtd.lds.iso19794.FaceImageInfo

All Implemented Interfaces:

Serializable, ImageInfo, LDSElement
```
public class FaceImageInfo
extends AbstractImageInfo
```
Data structure for storing facial image data. This represents a facial record data block as specified in Section 5.5, 5.6, and 5.7 of ISO/IEC FCD 19794-5 (2004-03-22, AKA Annex D). A facial record data block contains a single facial image.

Version:

$Revision: 1613 $

Author:

Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FaceImageInfo.Expression` Expression code based on Section 5.5.7 of ISO 19794-5.
`static class`	`FaceImageInfo.EyeColor` Eye color code based on Section 5.5.4 of ISO 19794-5.
`static class`	`FaceImageInfo.FaceImageType` Face image type code based on Section 5.7.1 of ISO 19794-5.
`static class`	`FaceImageInfo.FeaturePoint` Feature points as described in Section 5.6.3 of ISO/IEC FCD 19794-5.
`static class`	`FaceImageInfo.Features` Feature flags meaning based on Section 5.5.6 of ISO 19794-5.
`static class`	`FaceImageInfo.HairColor` Hair color code based on Section 5.5.5 of ISO 19794-5.
`static class`	`FaceImageInfo.ImageColorSpace` Color space code based on Section 5.7.4 of ISO 19794-5.
`static class`	`FaceImageInfo.ImageDataType` Image data type code based on Section 5.7.2 of ISO 19794-5.
`static class`	`FaceImageInfo.SourceType` Source type based on Section 5.7.6 of ISO 19794-5.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`EXPRESSION_EYES_LOOKING_AWAY`
`static short`	`EXPRESSION_FROWNING`
`static short`	`EXPRESSION_NEUTRAL`
`static short`	`EXPRESSION_RAISED_EYEBROWS`
`static short`	`EXPRESSION_SMILE_CLOSED`
`static short`	`EXPRESSION_SMILE_OPEN`
`static short`	`EXPRESSION_SQUINTING`
`static short`	`EXPRESSION_UNSPECIFIED`
`static int`	`EYE_COLOR_BLACK`
`static int`	`EYE_COLOR_BLUE`
`static int`	`EYE_COLOR_BROWN`
`static int`	`EYE_COLOR_GRAY`
`static int`	`EYE_COLOR_GREEN`
`static int`	`EYE_COLOR_MULTI_COLORED`
`static int`	`EYE_COLOR_PINK`
`static int`	`EYE_COLOR_UNKNOWN`
`static int`	`EYE_COLOR_UNSPECIFIED`
`static int`	`FACE_IMAGE_TYPE_BASIC`
`static int`	`FACE_IMAGE_TYPE_FULL_FRONTAL`
`static int`	`FACE_IMAGE_TYPE_TOKEN_FRONTAL`
`static int`	`HAIR_COLOR_BALD`
`static int`	`HAIR_COLOR_BLACK`
`static int`	`HAIR_COLOR_BLONDE`
`static int`	`HAIR_COLOR_BLUE`
`static int`	`HAIR_COLOR_BROWN`
`static int`	`HAIR_COLOR_GRAY`
`static int`	`HAIR_COLOR_GREEN`
`static int`	`HAIR_COLOR_RED`
`static int`	`HAIR_COLOR_UNKNOWN`
`static int`	`HAIR_COLOR_UNSPECIFIED`
`static int`	`HAIR_COLOR_WHITE`
`static int`	`IMAGE_COLOR_SPACE_GRAY8`
`static int`	`IMAGE_COLOR_SPACE_OTHER`
`static int`	`IMAGE_COLOR_SPACE_RGB24`
`static int`	`IMAGE_COLOR_SPACE_UNSPECIFIED`
`static int`	`IMAGE_COLOR_SPACE_YUV422`
`static int`	`IMAGE_DATA_TYPE_JPEG`
`static int`	`IMAGE_DATA_TYPE_JPEG2000`
`static int`	`SOURCE_TYPE_STATIC_PHOTO_DIGITAL_CAM`
`static int`	`SOURCE_TYPE_STATIC_PHOTO_SCANNER`
`static int`	`SOURCE_TYPE_STATIC_PHOTO_UNKNOWN_SOURCE`
`static int`	`SOURCE_TYPE_UNKNOWN`
`static int`	`SOURCE_TYPE_UNSPECIFIED`
`static int`	`SOURCE_TYPE_VIDEO_FRAME_ANALOG_CAM`
`static int`	`SOURCE_TYPE_VIDEO_FRAME_DIGITAL_CAM`
`static int`	`SOURCE_TYPE_VIDEO_FRAME_UNKNOWN_SOURCE`

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
`FaceImageInfo(net.sf.scuba.data.Gender gender, FaceImageInfo.EyeColor eyeColor, int featureMask, int hairColor, int expression, int[] poseAngle, int[] poseAngleUncertainty, int faceImageType, int colorSpace, int sourceType, int deviceType, int quality, FaceImageInfo.FeaturePoint[] featurePoints, int width, int height, InputStream imageInputStream, int imageLength, int imageDataType)` Constructs a new face information data structure instance.
`FaceImageInfo(InputStream inputStream)` Constructs a new face information structure from binary encoding.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getColorSpace()` Gets the image color space (rgb, grayscale, etc).
`int`	`getDeviceType()` Gets the device type.
`int`	`getExpression()` Gets the expression (neutral, smiling, eyebrow raised, etc).
`FaceImageInfo.EyeColor`	`getEyeColor()` Gets the eye color (black, blue, brown, etc).
`int`	`getFaceImageType()` Gets the face image type (full frontal, token frontal, etc).
`int`	`getFeatureMask()` Gets the feature mask.
`FaceImageInfo.FeaturePoint[]`	`getFeaturePoints()` Gets the available feature points of this face.
`net.sf.scuba.data.Gender`	`getGender()` Gets the gender (male, female, etc).
`int`	`getHairColor()` Gets the hair color (bald, black, blonde, etc).
`int`	`getImageDataType()` Gets the image data type.
`int[]`	`getPoseAngle()` Gets the pose angle as an integer array of length 3, containing yaw, pitch, and roll angle in encoded form.
`int[]`	`getPoseAngleUncertainty()` Gets the pose angle uncertainty as an integer array of length 3, containing yaw, pitch, and roll angle uncertainty.
`int`	`getQuality()` Gets the quality as unsigned integer.
`long`	`getRecordLength()` Gets the record length.
`int`	`getSourceType()` Gets the source type (camera, scanner, etc).
`protected void`	`readObject(InputStream inputStream)`
`String`	`toString()` Generates a textual representation of this object.
`void`	`writeObject(OutputStream outputStream)` Writes this face image info to output stream.

Methods inherited from class org.jmrtd.lds.AbstractImageInfo
equals, getEncoded, getHeight, getImageInputStream, getImageLength, getMimeType, getType, getWidth, hashCode, readImage, setHeight, setImageBytes, setMimeType, setType, setWidth, writeImage

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

- Field Detail
  - EYE_COLOR_UNSPECIFIED
```
public static final int EYE_COLOR_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_BLACK
```
public static final int EYE_COLOR_BLACK
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_BLUE
```
public static final int EYE_COLOR_BLUE
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_BROWN
```
public static final int EYE_COLOR_BROWN
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_GRAY
```
public static final int EYE_COLOR_GRAY
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_GREEN
```
public static final int EYE_COLOR_GREEN
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_MULTI_COLORED
```
public static final int EYE_COLOR_MULTI_COLORED
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_PINK
```
public static final int EYE_COLOR_PINK
```
    See Also:
    
    Constant Field Values
  - EYE_COLOR_UNKNOWN
```
public static final int EYE_COLOR_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_UNSPECIFIED
```
public static final int HAIR_COLOR_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_BALD
```
public static final int HAIR_COLOR_BALD
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_BLACK
```
public static final int HAIR_COLOR_BLACK
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_BLONDE
```
public static final int HAIR_COLOR_BLONDE
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_BROWN
```
public static final int HAIR_COLOR_BROWN
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_GRAY
```
public static final int HAIR_COLOR_GRAY
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_WHITE
```
public static final int HAIR_COLOR_WHITE
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_RED
```
public static final int HAIR_COLOR_RED
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_GREEN
```
public static final int HAIR_COLOR_GREEN
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_BLUE
```
public static final int HAIR_COLOR_BLUE
```
    See Also:
    
    Constant Field Values
  - HAIR_COLOR_UNKNOWN
```
public static final int HAIR_COLOR_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_UNSPECIFIED
```
public static final short EXPRESSION_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_NEUTRAL
```
public static final short EXPRESSION_NEUTRAL
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_SMILE_CLOSED
```
public static final short EXPRESSION_SMILE_CLOSED
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_SMILE_OPEN
```
public static final short EXPRESSION_SMILE_OPEN
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_RAISED_EYEBROWS
```
public static final short EXPRESSION_RAISED_EYEBROWS
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_EYES_LOOKING_AWAY
```
public static final short EXPRESSION_EYES_LOOKING_AWAY
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_SQUINTING
```
public static final short EXPRESSION_SQUINTING
```
    See Also:
    
    Constant Field Values
  - EXPRESSION_FROWNING
```
public static final short EXPRESSION_FROWNING
```
    See Also:
    
    Constant Field Values
  - FACE_IMAGE_TYPE_BASIC
```
public static final int FACE_IMAGE_TYPE_BASIC
```
    See Also:
    
    Constant Field Values
  - FACE_IMAGE_TYPE_FULL_FRONTAL
```
public static final int FACE_IMAGE_TYPE_FULL_FRONTAL
```
    See Also:
    
    Constant Field Values
  - FACE_IMAGE_TYPE_TOKEN_FRONTAL
```
public static final int FACE_IMAGE_TYPE_TOKEN_FRONTAL
```
    See Also:
    
    Constant Field Values
  - IMAGE_DATA_TYPE_JPEG
```
public static final int IMAGE_DATA_TYPE_JPEG
```
    See Also:
    
    Constant Field Values
  - IMAGE_DATA_TYPE_JPEG2000
```
public static final int IMAGE_DATA_TYPE_JPEG2000
```
    See Also:
    
    Constant Field Values
  - IMAGE_COLOR_SPACE_UNSPECIFIED
```
public static final int IMAGE_COLOR_SPACE_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - IMAGE_COLOR_SPACE_RGB24
```
public static final int IMAGE_COLOR_SPACE_RGB24
```
    See Also:
    
    Constant Field Values
  - IMAGE_COLOR_SPACE_YUV422
```
public static final int IMAGE_COLOR_SPACE_YUV422
```
    See Also:
    
    Constant Field Values
  - IMAGE_COLOR_SPACE_GRAY8
```
public static final int IMAGE_COLOR_SPACE_GRAY8
```
    See Also:
    
    Constant Field Values
  - IMAGE_COLOR_SPACE_OTHER
```
public static final int IMAGE_COLOR_SPACE_OTHER
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_UNSPECIFIED
```
public static final int SOURCE_TYPE_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_STATIC_PHOTO_UNKNOWN_SOURCE
```
public static final int SOURCE_TYPE_STATIC_PHOTO_UNKNOWN_SOURCE
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_STATIC_PHOTO_DIGITAL_CAM
```
public static final int SOURCE_TYPE_STATIC_PHOTO_DIGITAL_CAM
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_STATIC_PHOTO_SCANNER
```
public static final int SOURCE_TYPE_STATIC_PHOTO_SCANNER
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_VIDEO_FRAME_UNKNOWN_SOURCE
```
public static final int SOURCE_TYPE_VIDEO_FRAME_UNKNOWN_SOURCE
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_VIDEO_FRAME_ANALOG_CAM
```
public static final int SOURCE_TYPE_VIDEO_FRAME_ANALOG_CAM
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_VIDEO_FRAME_DIGITAL_CAM
```
public static final int SOURCE_TYPE_VIDEO_FRAME_DIGITAL_CAM
```
    See Also:
    
    Constant Field Values
  - SOURCE_TYPE_UNKNOWN
```
public static final int SOURCE_TYPE_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FaceImageInfo
```
public FaceImageInfo(net.sf.scuba.data.Gender gender,
                     FaceImageInfo.EyeColor eyeColor,
                     int featureMask,
                     int hairColor,
                     int expression,
                     int[] poseAngle,
                     int[] poseAngleUncertainty,
                     int faceImageType,
                     int colorSpace,
                     int sourceType,
                     int deviceType,
                     int quality,
                     FaceImageInfo.FeaturePoint[] featurePoints,
                     int width,
                     int height,
                     InputStream imageInputStream,
                     int imageLength,
                     int imageDataType)
              throws IOException
```
    Constructs a new face information data structure instance.
    
    Parameters:
    
    gender - gender
    
    eyeColor - eye color
    
    featureMask - feature mask (least significant 3 bytes)
    
    hairColor - hair color
    
    expression - expression
    
    poseAngle - (encoded) pose angle
    
    poseAngleUncertainty - pose angle uncertainty
    
    faceImageType - face image type
    
    colorSpace - color space
    
    sourceType - source type
    
    deviceType - capture device type (unspecified is 0x00)
    
    quality - quality
    
    featurePoints - feature points
    
    width - width
    
    height - height
    
    imageInputStream - encoded image bytes
    
    imageLength - length of encoded image
    
    imageDataType - either IMAGE_DATA_TYPE_JPEG or IMAGE_DATA_TYPE_JPEG2000
    
    Throws:
    
    IOException - on error reading input
  - FaceImageInfo
```
public FaceImageInfo(InputStream inputStream)
              throws IOException
```
    Constructs a new face information structure from binary encoding.
    
    Parameters:
    
    inputStream - an input stream
    
    Throws:
    
    IOException - if input cannot be read
- Method Detail
  - readObject
```
protected void readObject(InputStream inputStream)
                   throws IOException
```
    Specified by:
    
    readObject in class AbstractImageInfo
    
    Throws:
    
    IOException
  - writeObject
```
public void writeObject(OutputStream outputStream)
                 throws IOException
```
    Writes this face image info to output stream.
    
    Specified by:
    
    writeObject in class AbstractImageInfo
    
    Parameters:
    
    outputStream - an output stream
    
    Throws:
    
    IOException - if writing fails
  - getRecordLength
```
public long getRecordLength()
```
    Gets the record length.
    
    Specified by:
    
    getRecordLength in interface ImageInfo
    
    Specified by:
    
    getRecordLength in class AbstractImageInfo
    
    Returns:
    
    the record length
  - getFeaturePoints
```
public FaceImageInfo.FeaturePoint[] getFeaturePoints()
```
    Gets the available feature points of this face.
    
    Returns:
    
    feature points
  - getExpression
```
public int getExpression()
```
    Gets the expression (neutral, smiling, eyebrow raised, etc).
    
    Returns:
    
    expression
  - getEyeColor
```
public FaceImageInfo.EyeColor getEyeColor()
```
    Gets the eye color (black, blue, brown, etc).
    
    Returns:
    
    eye color
  - getGender
```
public net.sf.scuba.data.Gender getGender()
```
    Gets the gender (male, female, etc).
    
    Returns:
    
    gender
  - getHairColor
```
public int getHairColor()
```
    Gets the hair color (bald, black, blonde, etc).
    
    Returns:
    
    hair color
  - getFaceImageType
```
public int getFaceImageType()
```
    Gets the face image type (full frontal, token frontal, etc).
    
    Returns:
    
    face image type
  - getFeatureMask
```
public int getFeatureMask()
```
    Gets the feature mask.
    
    Returns:
    
    feature mask
  - getQuality
```
public int getQuality()
```
    Gets the quality as unsigned integer.
    
    Returns:
    
    quality
  - getSourceType
```
public int getSourceType()
```
    Gets the source type (camera, scanner, etc).
    
    Returns:
    
    source type
  - getImageDataType
```
public int getImageDataType()
```
    Gets the image data type.
    
    Returns:
    
    image data type
  - getColorSpace
```
public int getColorSpace()
```
    Gets the image color space (rgb, grayscale, etc).
    
    Returns:
    
    image color space
  - getDeviceType
```
public int getDeviceType()
```
    Gets the device type.
    
    Returns:
    
    device type
  - getPoseAngle
```
public int[] getPoseAngle()
```
    Gets the pose angle as an integer array of length 3, containing yaw, pitch, and roll angle in encoded form.
    
    Returns:
    
    an integer array of length 3
  - getPoseAngleUncertainty
```
public int[] getPoseAngleUncertainty()
```
    Gets the pose angle uncertainty as an integer array of length 3, containing yaw, pitch, and roll angle uncertainty.
    
    Returns:
    
    an integer array of length 3
  - toString
```
public String toString()
```
    Generates a textual representation of this object.
    
    Overrides:
    
    toString in class AbstractImageInfo
    
    Returns:
    
    a textual representation of this object
    
    See Also:
    
    Object.toString()

Class FaceImageInfo

Nested Class Summary

Field Summary

Fields inherited from interface org.jmrtd.lds.ImageInfo

Constructor Summary

Method Summary

Methods inherited from class org.jmrtd.lds.AbstractImageInfo

Methods inherited from class java.lang.Object

Field Detail

EYE_COLOR_UNSPECIFIED

EYE_COLOR_BLACK

EYE_COLOR_BLUE

EYE_COLOR_BROWN

EYE_COLOR_GRAY

EYE_COLOR_GREEN

EYE_COLOR_MULTI_COLORED

EYE_COLOR_PINK

EYE_COLOR_UNKNOWN

HAIR_COLOR_UNSPECIFIED

HAIR_COLOR_BALD

HAIR_COLOR_BLACK

HAIR_COLOR_BLONDE

HAIR_COLOR_BROWN

HAIR_COLOR_GRAY

HAIR_COLOR_WHITE

HAIR_COLOR_RED

HAIR_COLOR_GREEN

HAIR_COLOR_BLUE

HAIR_COLOR_UNKNOWN

EXPRESSION_UNSPECIFIED

EXPRESSION_NEUTRAL

EXPRESSION_SMILE_CLOSED

EXPRESSION_SMILE_OPEN

EXPRESSION_RAISED_EYEBROWS

EXPRESSION_EYES_LOOKING_AWAY

EXPRESSION_SQUINTING

EXPRESSION_FROWNING

FACE_IMAGE_TYPE_BASIC

FACE_IMAGE_TYPE_FULL_FRONTAL

FACE_IMAGE_TYPE_TOKEN_FRONTAL

IMAGE_DATA_TYPE_JPEG

IMAGE_DATA_TYPE_JPEG2000

IMAGE_COLOR_SPACE_UNSPECIFIED

IMAGE_COLOR_SPACE_RGB24

IMAGE_COLOR_SPACE_YUV422

IMAGE_COLOR_SPACE_GRAY8

IMAGE_COLOR_SPACE_OTHER

SOURCE_TYPE_UNSPECIFIED

SOURCE_TYPE_STATIC_PHOTO_UNKNOWN_SOURCE

SOURCE_TYPE_STATIC_PHOTO_DIGITAL_CAM

SOURCE_TYPE_STATIC_PHOTO_SCANNER

SOURCE_TYPE_VIDEO_FRAME_UNKNOWN_SOURCE

SOURCE_TYPE_VIDEO_FRAME_ANALOG_CAM

SOURCE_TYPE_VIDEO_FRAME_DIGITAL_CAM

SOURCE_TYPE_UNKNOWN

Constructor Detail

FaceImageInfo

FaceImageInfo

Method Detail

readObject

writeObject

getRecordLength

getFeaturePoints

getExpression

getEyeColor

getGender

getHairColor

getFaceImageType

getFeatureMask

getQuality

getSourceType

getImageDataType

getColorSpace

getDeviceType

getPoseAngle

getPoseAngleUncertainty

toString