Binary data representing a decompressed fingerprint image, canonically encoded as per ISO/IEC 39794-4:2019. More...

#include <nfiq2_fingerprintimagedata.hpp>

Public Member Functions
	FingerprintImageData ()
	Default constructor.

	FingerprintImageData (uint32_t width, uint32_t height, uint8_t fingerCode, uint16_t ppi)
	Constructor that does not store image data.

	FingerprintImageData (const uint8_t *pData, uint32_t dataSize, uint32_t width, uint32_t height, uint8_t fingerCode, uint16_t ppi)
	Constructor storing image data.

	FingerprintImageData (const FingerprintImageData &otherData)
	Copy constructor.

virtual	~FingerprintImageData ()
	Destructor.

NFIQ2::FingerprintImageData	copyRemovingNearWhiteFrame () const
	Obtain a copy of the image with near-white lines surrounding the fingerprint removed.

Public Member Functions inherited from NFIQ2::Data
	Data ()
	Default Data constructor.

	Data (const uint8_t *pData, uint32_t dataSize)
	Constructor with available pointer to data.

	Data (const Data &otherData)
	Copy constructor.

	Data (const std::basic_string< uint8_t > &otherData)
	Constructor with string-based data.

virtual	~Data ()
	Destructor.

void	readFromFile (const std::string &filename)
	Reads the content from the a file into this object.

void	writeToFile (const std::string &filename) const
	Writes the content to a file.

std::string	toHexString () const
	Generates a string in hexadecimal format of the buffer.

void	fromBase64String (const std::string &base64String)
	Imports data from a Base64 encoded string.

std::string	toBase64String () const
	Generates a string in Base64 format of the buffer.

Public Attributes
uint32_t	width { 0 }
	Width of the fingerprint image in pixels.

uint32_t	height { 0 }
	Height of the fingerprint image in pixels.

uint8_t	fingerCode { 0 }
	ISO finger code of the fingerprint in the image.

uint16_t	ppi { Resolution500PPI }
	Pixels per inch of the fingerprint image.

Static Public Attributes
static const uint16_t	Resolution500PPI { 500 }
	500 PPI resolution.

Detailed Description

Binary data representing a decompressed fingerprint image, canonically encoded as per ISO/IEC 39794-4:2019.

Definition at line 22 of file nfiq2_fingerprintimagedata.hpp.

Constructor & Destructor Documentation

◆ FingerprintImageData() [1/4]

NFIQ2::FingerprintImageData::FingerprintImageData ( )

Default constructor.

◆ FingerprintImageData() [2/4]

NFIQ2::FingerprintImageData::FingerprintImageData	(	uint32_t	width,
		uint32_t	height,
		uint8_t	fingerCode,
		uint16_t	ppi )

Constructor that does not store image data.

Parameters

width	Width of the image in pixels.
height	Height of the image in pixels.
fingerCode	Finger position of the fingerprint in the image.
ppi	Resolution of the image in pixels per inch.

◆ FingerprintImageData() [3/4]

NFIQ2::FingerprintImageData::FingerprintImageData	(	const uint8_t *	pData,
		uint32_t	dataSize,
		uint32_t	width,
		uint32_t	height,
		uint8_t	fingerCode,
		uint16_t	ppi )

Constructor storing image data.

Parameters

pData	Pointer to decompressed 8 bit-per-pixel grayscale image data, canonically encoded as per ISO/IEC 39794-4:2019.
dataSize	Size of the buffer pointed to by `pData`.
width	Width of the image in pixels.
height	Height of the image in pixels.
fingerCode	Finger position of the fingerprint in the image.
ppi	Resolution of the image in pixels per inch.

◆ FingerprintImageData() [4/4]

NFIQ2::FingerprintImageData::FingerprintImageData ( const FingerprintImageData & otherData )

Copy constructor.

◆ ~FingerprintImageData()

virtual NFIQ2::FingerprintImageData::~FingerprintImageData ( )

virtual

Destructor.

Member Function Documentation

◆ copyRemovingNearWhiteFrame()

NFIQ2::FingerprintImageData NFIQ2::FingerprintImageData::copyRemovingNearWhiteFrame ( ) const

Obtain a copy of the image with near-white lines surrounding the fingerprint removed.

Returns: Cropped fingerprint image.

Exceptions

NFIQ2::Exception Error performing the crop, or the image is too small to be processed after cropping.

Member Data Documentation

◆ Resolution500PPI

const uint16_t NFIQ2::FingerprintImageData::Resolution500PPI { 500 }

static

500 PPI resolution.

Definition at line 25 of file nfiq2_fingerprintimagedata.hpp.

◆ width

uint32_t NFIQ2::FingerprintImageData::width { 0 }

Width of the fingerprint image in pixels.

Definition at line 74 of file nfiq2_fingerprintimagedata.hpp.

◆ height

uint32_t NFIQ2::FingerprintImageData::height { 0 }

Height of the fingerprint image in pixels.

Definition at line 76 of file nfiq2_fingerprintimagedata.hpp.

◆ fingerCode

uint8_t NFIQ2::FingerprintImageData::fingerCode { 0 }

ISO finger code of the fingerprint in the image.

Definition at line 78 of file nfiq2_fingerprintimagedata.hpp.

◆ ppi

uint16_t NFIQ2::FingerprintImageData::ppi { Resolution500PPI }

Pixels per inch of the fingerprint image.

Definition at line 80 of file nfiq2_fingerprintimagedata.hpp.

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

nfiq2_fingerprintimagedata.hpp

Public Member Functions

Public Attributes

Static Public Attributes