A structure to represent the resolution of an image. More...

#include <be_image.h>

Public Types
enum class	Units { NA = 0 , PPI = 1 , PPMM = 2 , PPCM = 3 }
	Possible representations of the units in a Resolution struct. More...

Public Member Functions
	Resolution (const double xRes=0.0, const double yRes=0.0, const Units units=Units::PPI)
	Create a Resolution struct. More...

Resolution	toUnits (const Units &units) const
	Obtain alternate representations of this resolution. More...

Public Attributes
double	xRes
	Resolution along the X-axis. More...

double	yRes
	Resolution along the Y-axis. More...

Units	units
	Units in which xRes and yRes are represented. More...

Detailed Description

A structure to represent the resolution of an image.

Definition at line 206 of file be_image.h.

Member Enumeration Documentation

◆ Units

enum class BiometricEvaluation::Image::Resolution::Units

strong

Possible representations of the units in a Resolution struct.

Enumerator
NA	Not-applicable: unknown, or otherwise.
PPI	Pixels per inch.
PPMM	Pixels per millimeter.
PPCM	Pixels per centimeter.

Definition at line 212 of file be_image.h.

Constructor & Destructor Documentation

◆ Resolution()

BiometricEvaluation::Image::Resolution::Resolution	(	const double	xRes = `0.0`,
		const double	yRes = `0.0`,
		const Units	units = `Units::PPI`
	)

Create a Resolution struct.

Parameters

[in]	xRes	Resolution along the X-axis
[in]	yRes	Resolution along the Y-axis
[in]	units	Units in which xRes and yRes are represented

Member Function Documentation

◆ toUnits()

Resolution BiometricEvaluation::Image::Resolution::toUnits ( const Units & units ) const

Obtain alternate representations of this resolution.

Parameters

units The units to which this resolution is converted.

Returns: This resolution, in units units.

Exceptions

BE::Error::StrategyError Units are not defined for either the source or destination resolution.

Member Data Documentation

◆ xRes

double BiometricEvaluation::Image::Resolution::xRes

Resolution along the X-axis.

Definition at line 240 of file be_image.h.

◆ yRes

double BiometricEvaluation::Image::Resolution::yRes

Resolution along the Y-axis.

Definition at line 242 of file be_image.h.

◆ units

Units BiometricEvaluation::Image::Resolution::units

Units in which xRes and yRes are represented.

Definition at line 244 of file be_image.h.

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

be_image.h

Public Types

Public Member Functions

Public Attributes