NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
BiometricEvaluation::Face::ISO2005View Class Reference

A class to represent single face view and derived information. More...

#include <be_face_iso2005view.h>

Inherits BiometricEvaluation::Face::INCITSView.

Public Member Functions

 ISO2005View ()
 Construct an empty ISO2005 Face Image Data record. More...
 
 ISO2005View (const std::string &filename, const uint32_t viewNumber)
 Construct an ISO 2005 face view from the named file. More...
 
 ISO2005View (const Memory::uint8Array &buffer, const uint32_t viewNumber)
 Construct an ISO 2005 face view from a record contained in a buffer. More...
 
- Public Member Functions inherited from BiometricEvaluation::Face::INCITSView
Face::Gender getGender () const
 Obtain the gender. More...
 
Face::EyeColor getEyeColor () const
 Obtain the eye color. More...
 
Face::HairColor getHairColor () const
 Obtain the hair color. More...
 
bool propertiesConsidered () const
 Indicate whether properties are specified. More...
 
void getPropertySet (Face::PropertySet &propertySet) const
 Get the set of properties. More...
 
BiometricEvaluation::Face::Expression getExpression () const
 
void getFeaturePointSet (BiometricEvaluation::Feature::MPEGFacePointSet &featurePointSet) const
 Obtain the set of. More...
 
Face::ImageType getImageType () const
 Obtain the face image type. More...
 
Face::ImageDataType getImageDataType () const
 Obtain the face image data type. More...
 
Face::PoseAngle getPoseAngle () const
 Obtain the face pose angle. More...
 
Face::ColorSpace getColorSpace () const
 Obtain the color space. More...
 
Face::SourceType getSourceType () const
 Obtain the source type. More...
 
uint16_t getDeviceType () const
 Obtain the device type. More...
 
- Public Member Functions inherited from BiometricEvaluation::View::View
std::shared_ptr< Image::ImagegetImage () const
 Obtain the image used for the biometric view in the format contained in the record (JPEG, etc.) More...
 
Image::Size getImageSize () const
 Obtain the image size. More...
 
Image::Resolution getImageResolution () const
 Obtain the image resolution. More...
 
uint32_t getImageColorDepth () const
 Obtain the image color depth in bits-per-pixel. More...
 
Image::CompressionAlgorithm getCompressionAlgorithm () const
 Obtain the compression algorithm used on the image. More...
 
Image::Resolution getScanResolution () const
 Obtain the image scan resolution. More...
 

Protected Member Functions

void readISOHeader (BiometricEvaluation::Memory::IndexedBuffer &buf)
 Read the face image data record header from an ISO 2005 record. More...
 
- Protected Member Functions inherited from BiometricEvaluation::Face::INCITSView
 INCITSView ()
 
 INCITSView (const std::string &filename, const uint32_t viewNumber)
 Construct the common components of an INCITS face view from records contained in files. More...
 
 INCITSView (const Memory::uint8Array &buffer, const uint32_t viewNumber)
 Construct an INCITS face view from a record contained in a buffer. More...
 
Memory::uint8Array const & getFIDData () const
 Obtain a reference to the face image record data buffer. More...
 
virtual void readHeader (BiometricEvaluation::Memory::IndexedBuffer &buf, const uint32_t formatStandard)
 Read the common face image data record header from an INCITS record, excepting the format identifier and version number data items. More...
 
virtual void readFaceView (Memory::IndexedBuffer &buf)
 Read the common face representation information from an INCITS record. More...
 
- Protected Member Functions inherited from BiometricEvaluation::View::View
 View ()
 
 ~View ()
 
void setImageSize (const BiometricEvaluation::Image::Size &imageSize)
 Mutator for the image size. More...
 
void setImageColorDepth (uint32_t imageColorDepth)
 Mutator for the image color depth. More...
 
void setImageResolution (const BiometricEvaluation::Image::Resolution &imageResolution)
 Mutator for the image resolution. More...
 
void setScanResolution (const BiometricEvaluation::Image::Resolution &scanResolution)
 Mutator for the image scan resolution. More...
 
void setImageData (const BiometricEvaluation::Memory::uint8Array &imageData)
 Mutator for the image data. More...
 
void setCompressionAlgorithm (const Image::CompressionAlgorithm &ca)
 Mutator for the compression algorithm. More...
 

Static Protected Attributes

static const uint32_t BASE_SPEC_VERSION = 0x30313000
 
- Static Protected Attributes inherited from BiometricEvaluation::Face::INCITSView
static const uint32_t ISO2005_STANDARD = 1
 
static const uint32_t BASE_FORMAT_ID = 0x46414300
 

Detailed Description

A class to represent single face view and derived information.

A base Face::ISO2005View class represents an ISO 2005 face image data view.

Definition at line 33 of file be_face_iso2005view.h.

Constructor & Destructor Documentation

◆ ISO2005View() [1/3]

BiometricEvaluation::Face::ISO2005View::ISO2005View ( )

Construct an empty ISO2005 Face Image Data record.

◆ ISO2005View() [2/3]

BiometricEvaluation::Face::ISO2005View::ISO2005View ( const std::string &  filename,
const uint32_t  viewNumber 
)

Construct an ISO 2005 face view from the named file.

The entire face image data record is passed into this method, with the specific instance of the facial image that is to be extraced from the record.

Parameters
[in]filenameThe name of the file containing the complete face image data record.
[in]viewNumberThe facial information instance to read.
Exceptions
Error::DataErrorInvalid record format.
Error::FileErrorCould not open or read from file.

◆ ISO2005View() [3/3]

BiometricEvaluation::Face::ISO2005View::ISO2005View ( const Memory::uint8Array buffer,
const uint32_t  viewNumber 
)

Construct an ISO 2005 face view from a record contained in a buffer.

The entire face image data record is passed into this method, with the specific instance of the facial image that is to be extraced from the record.

Parameters
[in]bufferThe buffer containing the complete face image data record.
[in]viewNumberThe facial information instance to read.
Exceptions
Error::DataErrorInvalid record format.

Member Function Documentation

◆ readISOHeader()

void BiometricEvaluation::Face::ISO2005View::readISOHeader ( BiometricEvaluation::Memory::IndexedBuffer buf)
protected

Read the face image data record header from an ISO 2005 record.

Parameters
[in]bufThe indexed buffer containing the record data. The index of the buffer will be changed to the location after the header.
Exceptions
DataErrorThe record has invalid or missing data.

Member Data Documentation

◆ BASE_SPEC_VERSION

const uint32_t BiometricEvaluation::Face::ISO2005View::BASE_SPEC_VERSION = 0x30313000
staticprotected

Definition at line 88 of file be_face_iso2005view.h.


The documentation for this class was generated from the following file: