BiometricEvaluation::View::View Class Reference

A class to represent single biometric element view. More...

#include <be_view_view.h>

Inherited by BiometricEvaluation::Face::INCITSView, BiometricEvaluation::Finger::INCITSView, BiometricEvaluation::Iris::INCITSView, and BiometricEvaluation::View::AN2KView.

Public Member Functions
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...

Protected Member Functions
	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 element view.

Included in a view is the biometric image and any derived information, such as minutiae points.

Definition at line 31 of file be_view_view.h.

Constructor & Destructor Documentation

View()

BiometricEvaluation::View::View::View ( )

protected

~View()

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

protected

Member Function Documentation

getImage()

std::shared_ptr< Image::Image > BiometricEvaluation::View::View::getImage

(

)

const

Obtain the image used for the biometric view in the format contained in the record (JPEG, etc.)

Not all views will have an image, however the derived information, such as minutiae, may be present.

Returns

The image data.

getImageSize()

Image::Size BiometricEvaluation::View::View::getImageSize

(

)

const

Obtain the image size.

This value is as present in the biometric record, and not in the image data itself. Normally, this value and the actual image size must be equal, but applications can check for inconsistencies. In the case of raw images, however, the value obtained with this method must be accepted as correct.

Returns

The image size.

getImageResolution()

Image::Resolution BiometricEvaluation::View::View::getImageResolution

(

)

const

Obtain the image resolution.

Image resolution is taken from the biometric record, and not from the image data.

Returns

The scan resolution.

Note

In some cases, the resolution may be the components of the pixel ratio, and applications must check the Image::Resolution::Units field for value NA.

getImageColorDepth()

uint32_t BiometricEvaluation::View::View::getImageColorDepth

(

)

const

Obtain the image color depth in bits-per-pixel.

This value is as present in the biometric record, and not in the image data itself. Normally, this value and the actual image depth must be equal, but applications can check for inconsistencies. In the case of raw images, however, the value obtained with this method must be accepted as correct.

Returns

The image depth.

getCompressionAlgorithm()

Image::CompressionAlgorithm BiometricEvaluation::View::View::getCompressionAlgorithm

(

)

const

Obtain the compression algorithm used on the image.

This value is as present in the biometric record, and not obtained from the image data itself.

Returns

The compression algorithm.

getScanResolution()

Image::Resolution BiometricEvaluation::View::View::getScanResolution

(

)

const

Obtain the image scan resolution.

This value is as present in the biometric record, and not in the image data itself. Normally, this value and the actual image resolution must be equal, but applications can check for inconsistencies.

Returns

The scan resolution.

Note

In some cases, the resolution may be the components of the pixel ratio, and applications must check the Image::Resolution::Units field for value NA.

setImageSize()

void BiometricEvaluation::View::View::setImageSize ( const BiometricEvaluation::Image::Size &  imageSize )

protected

Mutator for the image size.

Parameters

[in]

imageSize

The image size object.

setImageColorDepth()

void BiometricEvaluation::View::View::setImageColorDepth ( uint32_t  imageColorDepth )

protected

Mutator for the image color depth.

Parameters

[in]

imageColorDepth

The image color depth.

setImageResolution()

void BiometricEvaluation::View::View::setImageResolution ( const BiometricEvaluation::Image::Resolution &  imageResolution )

protected

Mutator for the image resolution.

Parameters

[in]

imageResolution

The image resolution object.

setScanResolution()

void BiometricEvaluation::View::View::setScanResolution ( const BiometricEvaluation::Image::Resolution &  scanResolution )

protected

Mutator for the image scan resolution.

Parameters

[in]

scanResolution

The image scan resolution object.

setImageData()

void BiometricEvaluation::View::View::setImageData ( const BiometricEvaluation::Memory::uint8Array &  imageData )

protected

Mutator for the image data.

Parameters

[in]

imageData

The image data object.

setCompressionAlgorithm()

void BiometricEvaluation::View::View::setCompressionAlgorithm ( const Image::CompressionAlgorithm &  ca )

protected

Mutator for the compression algorithm.

---

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

• be_view_view.h