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

#include <nfiq2_fingerprintimagedata.hpp>

Public Member Functions
	FingerprintImageData ()
	Default constructor. More...

	FingerprintImageData (uint32_t imageWidth, uint32_t imageHeight, uint8_t fingerCode, uint16_t imageDPI)
	Constructor that does not store image data. More...

	FingerprintImageData (const uint8_t *pData, uint32_t dataSize, uint32_t imageWidth, uint32_t imageHeight, uint8_t fingerCode, uint16_t imageDPI)
	Constructor storing image data. More...

	FingerprintImageData (const FingerprintImageData &otherData)
	Copy constructor. More...

virtual	~FingerprintImageData ()
	Destructor. More...

NFIQ2::FingerprintImageData	removeWhiteFrameAroundFingerprint () const
	Remove near-white lines around the image. More...

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

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

	Data (const Data &otherData)
	Copy constructor. More...

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

virtual	~Data ()
	Destructor. More...

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

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

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

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

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

Public Attributes
uint32_t	m_ImageWidth
	Width of the fingerprint image (in pixels) More...

uint32_t	m_ImageHeight
	Height of the fingerprint image (in pixels) More...

uint8_t	m_FingerCode
	ISO finger code of the fingerprint in the image. More...

int16_t	m_ImageDPI
	Dots per inch of the fingerprint image. More...

Detailed Description

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

Definition at line 26 of file nfiq2_fingerprintimagedata.hpp.

Constructor & Destructor Documentation

◆ FingerprintImageData() [1/4]

NFIQ2::FingerprintImageData::FingerprintImageData ( )

Default constructor.

◆ FingerprintImageData() [2/4]

NFIQ2::FingerprintImageData::FingerprintImageData	(	uint32_t	imageWidth,
		uint32_t	imageHeight,
		uint8_t	fingerCode,
		uint16_t	imageDPI
	)

Constructor that does not store image data.

Parameters

imageWidth	Width of the image in pixels.
imageHeight	Height of the image in pixels.
fingerCode	Finger position of the fingerprint in the image.
imageDPI	Resolution of the image in pixels per inch.

◆ FingerprintImageData() [3/4]

NFIQ2::FingerprintImageData::FingerprintImageData	(	const uint8_t *	pData,
		uint32_t	dataSize,
		uint32_t	imageWidth,
		uint32_t	imageHeight,
		uint8_t	fingerCode,
		uint16_t	imageDPI
	)

Constructor storing image data.

Parameters

pData	Pointer to decompressed 8 bit-per-pixel grayscale image data, canonically encoded as per ISO/IEC 19794-4:2005.
dataSize	Size of the buffer pointed to by `pData`.
imageWidth	Width of the image in pixels.
imageHeight	Height of the image in pixels.
fingerCode	Finger position of the fingerprint in the image.
imageDPI	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

◆ removeWhiteFrameAroundFingerprint()

NFIQ2::FingerprintImageData NFIQ2::FingerprintImageData::removeWhiteFrameAroundFingerprint ( ) const

Remove near-white lines around the image.

Returns: Cropped fingerprint image.

Exceptions

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

Member Data Documentation

◆ m_ImageWidth

uint32_t NFIQ2::FingerprintImageData::m_ImageWidth

Width of the fingerprint image (in pixels)

Definition at line 77 of file nfiq2_fingerprintimagedata.hpp.

◆ m_ImageHeight

uint32_t NFIQ2::FingerprintImageData::m_ImageHeight

Height of the fingerprint image (in pixels)

Definition at line 79 of file nfiq2_fingerprintimagedata.hpp.

◆ m_FingerCode

uint8_t NFIQ2::FingerprintImageData::m_FingerCode

ISO finger code of the fingerprint in the image.

Definition at line 81 of file nfiq2_fingerprintimagedata.hpp.

◆ m_ImageDPI

int16_t NFIQ2::FingerprintImageData::m_ImageDPI

Dots per inch of the fingerprint image.

Definition at line 83 of file nfiq2_fingerprintimagedata.hpp.

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

nfiq2_fingerprintimagedata.hpp

Public Member Functions

Public Attributes