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

#include <be_view_an2kview.h>

Inherits BiometricEvaluation::View::View.

Inherited by BiometricEvaluation::Finger::AN2KView, and BiometricEvaluation::View::AN2KViewVariableResolution.

Public Types
enum class	RecordType : uint16_t { Type_1 = 1 , Type_2 = 2 , Type_3 = 3 , Type_4 = 4 , Type_5 = 5 , Type_6 = 6 , Type_7 = 7 , Type_8 = 8 , Type_9 = 9 , Type_10 = 10 , Type_11 = 11 , Type_12 = 12 , Type_13 = 13 , Type_14 = 14 , Type_15 = 15 , Type_16 = 16 , Type_17 = 17 , Type_99 = 99 }
	The type of AN2K record. More...

enum class	DeviceMonitoringMode { Controlled , Assisted , Observed , Unattended , Unknown , NA }
	The level of human monitoring for the image capture device. More...

Public Member Functions
	AN2KView (const std::string filename, const RecordType typeID, const uint32_t recordNumber)
	Construct an AN2K view from a file. More...

	AN2KView (Memory::uint8Array &buf, const RecordType typeID, const uint32_t recordNumber)
	Construct an AN2K view from a buffer. More...

	~AN2KView ()

std::vector< Finger::AN2KMinutiaeDataRecord >	getMinutiaeDataRecordSet () const
	Obtain the set of minutiae records. More...

RecordType	getRecordType () const
	Obtain the ANSI-NIST record type. More...

Public Member Functions inherited from BiometricEvaluation::View::View
std::shared_ptr< Image::Image >	getImage () 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...

Static Public Member Functions
static DeviceMonitoringMode	convertDeviceMonitoringMode (const char *dmm)
	Convert a device monitoring mode indicator from an AN2K record. More...

static Image::CompressionAlgorithm	convertCompressionAlgorithm (const uint16_t recordType, const unsigned char *an2kValue)
	Convert a compression algorithm indicator from an AN2K finger image record. More...

Static Public Attributes
static const double	MinimumScanResolutionPPMM
	Constants to define the minimum resolution used for fingerprint images in an AN2k record. More...

static const double	HalfMinimumScanResolutionPPMM

static const int	FixedResolutionBitDepth = 8
	The defined bit-depth for fixed-resolution images. More...

Protected Member Functions
Memory::AutoBuffer< ANSI_NIST >	getAN2K () const
	Obtain the complete ANSI/NIST record set. More...

RECORD *	getAN2KRecord () const
	Obtain a pointer to the single ANSI/NIST 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...

Detailed Description

A class to represent single biometric view and derived information.

This abstraction represents the image and derived information taken from an ANSI/NIST record.

For these types of records, the image resolution and scan resolution are identical. For compressed images, applications can compare the image resolution and size taken from the Type-3/4/5/6 record to that returned by the Image object directly.

Definition at line 51 of file be_view_an2kview.h.

Member Enumeration Documentation

◆ RecordType

enum class BiometricEvaluation::View::AN2KView::RecordType : uint16_t

strong

The type of AN2K record.

Enumerator
Type_1
Type_2
Type_3
Type_4
Type_5
Type_6
Type_7
Type_8
Type_9
Type_10
Type_11
Type_12
Type_13
Type_14
Type_15
Type_16
Type_17
Type_99

Definition at line 54 of file be_view_an2kview.h.

◆ DeviceMonitoringMode

enum class BiometricEvaluation::View::AN2KView::DeviceMonitoringMode

strong

The level of human monitoring for the image capture device.

Enumerator
Controlled	Operator physically controls the subject to acquire biometric sample.
Assisted	Person available to provide assistance to the subject submitting the biometric.
Observed	Person present to observe the operation of the device but provides no assistance.
Unattended	No one present to observe or provide assistance.
Unknown	No information is known.
NA	Optional field – not specified.

Definition at line 81 of file be_view_an2kview.h.

Constructor & Destructor Documentation

◆ AN2KView() [1/2]

BiometricEvaluation::View::AN2KView::AN2KView	(	const std::string	filename,
		const RecordType	typeID,
		const uint32_t	recordNumber
	)

Construct an AN2K view from a file.

The file must contain the entire AN2K record, not just the image and other view-related records.

◆ AN2KView() [2/2]

BiometricEvaluation::View::AN2KView::AN2KView	(	Memory::uint8Array &	buf,
		const RecordType	typeID,
		const uint32_t	recordNumber
	)

Construct an AN2K view from a buffer.

The buffer must contain the entire AN2K record, not just the image and other view-related records.

◆ ~AN2KView()

BiometricEvaluation::View::AN2KView::~AN2KView ( )

Member Function Documentation

◆ convertDeviceMonitoringMode()

static DeviceMonitoringMode BiometricEvaluation::View::AN2KView::convertDeviceMonitoringMode ( const char * dmm )

static

Convert a device monitoring mode indicator from an AN2K record.

Parameters

dmm	Item value for device monitoring mode from an AN2K record.

Returns: DeviceMonitoringMode representation of dmm.

Exceptions

Error::DataError Invalid format of dmm.

◆ convertCompressionAlgorithm()

static Image::CompressionAlgorithm BiometricEvaluation::View::AN2KView::convertCompressionAlgorithm	(	const uint16_t	recordType,
		const unsigned char *	an2kValue
	)

static

Convert a compression algorithm indicator from an AN2K finger image record.

Parameters

recordType	The AN2K record type as an integer, allowing the value taken directly from the AN2K record or a RecordType::Kind to be passed in.
an2kValue	Compression type data as read from an AN2K record.

Returns: The compression algorithm.

Exceptions

Error::DataError	Invalid compression algorithm for record type.
Error::ParameterError	Invalid record type.

◆ getMinutiaeDataRecordSet()

std::vector< Finger::AN2KMinutiaeDataRecord > BiometricEvaluation::View::AN2KView::getMinutiaeDataRecordSet ( ) const

Obtain the set of minutiae records.

Each AN2KViewVariableResolution may have more than one associated Type-9 record and each Type-9 record may have more than one minutiae format.

Returns: A vector of minutiae data records.

◆ getRecordType()

RecordType BiometricEvaluation::View::AN2KView::getRecordType ( ) const

Obtain the ANSI-NIST record type.

Returns: The type of record used to construct this object.

◆ getAN2K()

Memory::AutoBuffer< ANSI_NIST > BiometricEvaluation::View::AN2KView::getAN2K ( ) const

protected

Obtain the complete ANSI/NIST record set.

◆ getAN2KRecord()

RECORD * BiometricEvaluation::View::AN2KView::getAN2KRecord ( ) const

protected

Obtain a pointer to the single ANSI/NIST record.

Child classes use this method to obtain a pointer to the specific ANSI/NIST record that was searched for by this class object.

Member Data Documentation

◆ MinimumScanResolutionPPMM

const double BiometricEvaluation::View::AN2KView::MinimumScanResolutionPPMM

static

Constants to define the minimum resolution used for fingerprint images in an AN2k record.

Definition at line 159 of file be_view_an2kview.h.

◆ HalfMinimumScanResolutionPPMM

const double BiometricEvaluation::View::AN2KView::HalfMinimumScanResolutionPPMM

static

Definition at line 160 of file be_view_an2kview.h.

◆ FixedResolutionBitDepth

const int BiometricEvaluation::View::AN2KView::FixedResolutionBitDepth = 8

static

The defined bit-depth for fixed-resolution images.

Definition at line 166 of file be_view_an2kview.h.

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

be_view_an2kview.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ RecordType

◆ DeviceMonitoringMode

Constructor & Destructor Documentation

◆ AN2KView() [1/2]

◆ AN2KView() [2/2]

◆ ~AN2KView()

Member Function Documentation

◆ convertDeviceMonitoringMode()

◆ convertCompressionAlgorithm()

◆ getMinutiaeDataRecordSet()

◆ getRecordType()

◆ getAN2K()

◆ getAN2KRecord()

Member Data Documentation

◆ MinimumScanResolutionPPMM

◆ HalfMinimumScanResolutionPPMM

◆ FixedResolutionBitDepth