Represents an ANSI/NIST variable-resolution finger image. More...

#include <be_finger_an2kview_capture.h>

Inherits BiometricEvaluation::View::AN2KViewVariableResolution.

Classes
struct	FingerSegmentPosition
	Locations of an individual finger segment in a slap. More...

Public Types
enum class	AmputatedBandaged { Amputated , Bandaged , NA }
	Enumeration of the finger amuptated or bandaged code, a reason that a capture could not be made. More...

using	FingerSegmentPosition = FingerSegmentPosition

using	FingerSegmentPositionSet = std::vector< FingerSegmentPosition >

Public Types inherited from BiometricEvaluation::View::AN2KViewVariableResolution
using	AN2KQualityMetric = AN2KQualityMetric

using	QualityMetricSet = std::vector< AN2KQualityMetric >

using	PrintPositionCoordinate = PrintPositionCoordinate

using	PrintPositionCoordinateSet = std::vector< PrintPositionCoordinate >

Public Types inherited from BiometricEvaluation::View::AN2KView
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
	AN2KViewCapture (const std::string &filename, const uint32_t recordNumber)
	Construct an AN2K finger view from a file. More...

	AN2KViewCapture (Memory::uint8Array &buf, const uint32_t recordNumber)
	Construct an AN2K finger view using from a memory buffer. More...

QualityMetricSet	extractNISTQuality (const FIELD *field)
	Extract the NQM information from an AN2K FIELD. More...

Finger::Position	getPosition () const
	Obtain the finger position. More...

PositionDescriptors	getPrintPositionDescriptors () const
	Return search position descriptors. More...

PrintPositionCoordinateSet	getPrintPositionCoordinates () const
	Obtain print position coordinates. More...

QualityMetricSet	getNISTQualityMetric () const
	Obtain the NIST quality metric for all segmented finger images. More...

QualityMetricSet	getSegmentationQualityMetric () const
	Obtain the segmentation quality metric for all segmented finger images. More...

AmputatedBandaged	getAmputatedBandaged () const

FingerSegmentPositionSet	getFingerSegmentPositionSet () const

FingerSegmentPositionSet	getAlternateFingerSegmentPositionSet () const

QualityMetricSet	getFingerprintQualityMetric () const
	Obtain metrics for fingerprint image quality score data for the image stored in this record. More...

Public Member Functions inherited from BiometricEvaluation::View::AN2KViewVariableResolution
Finger::Impression	getImpressionType () const

std::string	getSourceAgency () const

std::string	getCaptureDate () const

std::string	getComment () const
	Obtain the comment field. More...

Finger::CaptureTechnology	getCaptureTechnology () const
	Obtain capture technology used to create this image. More...

Memory::uint8Array	getUserDefinedField (const uint16_t field) const
	Obtain a user-defined field. More...

Public Member Functions inherited from BiometricEvaluation::View::AN2KView
	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...

Additional Inherited Members
Static Public Member Functions inherited from BiometricEvaluation::View::AN2KViewVariableResolution
static QualityMetricSet	extractQuality (FIELD *field, Feature::PositionType type)
	Read a Quality Metric Set from a variable resolution AN2K record. More...

static Memory::uint8Array	parseUserDefinedField (const RECORD *const record, int fieldID)
	Read raw bytes from a user-defined AN2K field. More...

static Finger::CaptureTechnology	convertCaptureTechnology (const char *str)
	Convert a friction ridge capture technology code from a string. More...

Static Public Member Functions inherited from BiometricEvaluation::View::AN2KView
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 inherited from BiometricEvaluation::View::AN2KView
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 inherited from BiometricEvaluation::View::AN2KViewVariableResolution
	AN2KViewVariableResolution (const std::string &filename, const RecordType typeID, const uint32_t recordNumber)
	Construct an AN2K finger view from a file. More...

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

Feature::FGPSet	getPositions () const
	Obtain the set of finger positions. More...

Finger::PositionDescriptors	getPositionDescriptors () const
	Obtain the position descriptors. More...

PrintPositionCoordinateSet	getPrintPositionCoordinates () const
	Obtain print position coordinates. More...

QualityMetricSet	getQualityMetric () const
	Obtain quality metrics for associated image record. More...

Protected Member Functions inherited from BiometricEvaluation::View::AN2KView
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

Represents an ANSI/NIST variable-resolution finger image.

If the complete ANSI/NIST record contains a corresponding Type-9 (finger minutiae) record, an object of this class can be used to retrieve the minutiae set(s).

Definition at line 29 of file be_finger_an2kview_capture.h.

Member Typedef Documentation

◆ FingerSegmentPosition

using BiometricEvaluation::Finger::AN2KViewCapture::FingerSegmentPosition = FingerSegmentPosition

Definition at line 70 of file be_finger_an2kview_capture.h.

◆ FingerSegmentPositionSet

using BiometricEvaluation::Finger::AN2KViewCapture::FingerSegmentPositionSet = std::vector<FingerSegmentPosition>

Definition at line 72 of file be_finger_an2kview_capture.h.

Member Enumeration Documentation

◆ AmputatedBandaged

enum class BiometricEvaluation::Finger::AN2KViewCapture::AmputatedBandaged

strong

Enumeration of the finger amuptated or bandaged code, a reason that a capture could not be made.

Enumerator
Amputated	Amputation.
Bandaged	Unable to print (e.g., bandaged)
NA	Optional field – not specified.

Definition at line 36 of file be_finger_an2kview_capture.h.

Constructor & Destructor Documentation

◆ AN2KViewCapture() [1/2]

BiometricEvaluation::Finger::AN2KViewCapture::AN2KViewCapture	(	const std::string &	filename,
		const uint32_t	recordNumber
	)

Construct an AN2K finger view from a file.

The file must contain the entire AN2K record, not just the finger image and/or minutiae records. The object is constructed based on the nth variable resolution record found.

Parameters

[in]	filename	The name of the file containing the complete ANSI/NIST record.
[in]	recordNumber	The number of variable resolution record to read from the complete AN2K record.

Exceptions

Error::ParameterError
Error::DataError
Error::FileError	An error occurred when opening or reading the file.

◆ AN2KViewCapture() [2/2]

BiometricEvaluation::Finger::AN2KViewCapture::AN2KViewCapture	(	Memory::uint8Array &	buf,
		const uint32_t	recordNumber
	)

Construct an AN2K finger view using from a memory buffer.

The buffer must contain the entire AN2K record, not just the finger image and/or minutiae records.

Member Function Documentation

◆ extractNISTQuality()

QualityMetricSet BiometricEvaluation::Finger::AN2KViewCapture::extractNISTQuality ( const FIELD * field )

Extract the NQM information from an AN2K FIELD.

Parameters

field FIELD containing properly formatted NQM data

Returns: QualityMetricSet representation of field.

Exceptions

Error::DataError Invalid format of field for NQM.

◆ getPosition()

Finger::Position BiometricEvaluation::Finger::AN2KViewCapture::getPosition ( ) const

Obtain the finger position.

An AN2K finger image record contains a single finger positions. Any minutiae record (Type-9) associated with this image will have its own set of positions.

◆ getPrintPositionDescriptors()

PositionDescriptors BiometricEvaluation::Finger::AN2KViewCapture::getPrintPositionDescriptors ( ) const

Return search position descriptors.

◆ getPrintPositionCoordinates()

PrintPositionCoordinateSet BiometricEvaluation::Finger::AN2KViewCapture::getPrintPositionCoordinates ( ) const

Obtain print position coordinates.

Returns: Set of all PrintPositionCoordinates

◆ getNISTQualityMetric()

QualityMetricSet BiometricEvaluation::Finger::AN2KViewCapture::getNISTQualityMetric ( ) const

Obtain the NIST quality metric for all segmented finger images.

Returns: QualityMetricSet containing the NIST quality metric for all segmented finger images.

Vendor ID and Product Code are undefined, as they are unused by NQM.

◆ getSegmentationQualityMetric()

QualityMetricSet BiometricEvaluation::Finger::AN2KViewCapture::getSegmentationQualityMetric ( ) const

Obtain the segmentation quality metric for all segmented finger images.

Returns: QualityMetricSet containing the segmentation quality metric for all segmented finger images.

◆ getAmputatedBandaged()

AmputatedBandaged BiometricEvaluation::Finger::AN2KViewCapture::getAmputatedBandaged ( ) const

Returns: Optional amputated or bandaged code.

◆ getFingerSegmentPositionSet()

FingerSegmentPositionSet BiometricEvaluation::Finger::AN2KViewCapture::getFingerSegmentPositionSet ( ) const

Returns: Optional set of rectangular finger segment positions for all finger segments.

◆ getAlternateFingerSegmentPositionSet()

FingerSegmentPositionSet BiometricEvaluation::Finger::AN2KViewCapture::getAlternateFingerSegmentPositionSet ( ) const

Returns: Optional set of polygonal finger segment positions for all finger segments.

◆ getFingerprintQualityMetric()

QualityMetricSet BiometricEvaluation::Finger::AN2KViewCapture::getFingerprintQualityMetric ( ) const

Obtain metrics for fingerprint image quality score data for the image stored in this record.

Returns: Fingerprint quality metrics

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

be_finger_an2kview_capture.h

Classes

Public Types

Public Member Functions

Additional Inherited Members