be_image.h File Reference

#include <cstdint>
#include <iostream>
#include <vector>
#include <be_framework_enumeration.h>
#include <be_memory_autoarray.h>

Go to the source code of this file.

Classes
struct	BiometricEvaluation::Image::Coordinate
	A structure to contain a two-dimensional coordinate without a specified origin. More...
struct	BiometricEvaluation::Image::Size
	A structure to represent the size of an image, in pixels. More...
struct	BiometricEvaluation::Image::Resolution
	A structure to represent the resolution of an image. More...
struct	BiometricEvaluation::Image::ROI
	A structure to represent a region of interest (ROI), which is a bounding box and a set of coordinates. More...

Namespaces
namespace	BiometricEvaluation
	This software was developed at the National Institute of Standards and Technology (NIST) by employees of the Federal Government in the course of their official duties.
namespace	BiometricEvaluation::Image
	Basic information relating to images.

Typedefs
using	BiometricEvaluation::Image::Coordinate = Coordinate
using	BiometricEvaluation::Image::CoordinateSet = std::vector< Image::Coordinate >
using	BiometricEvaluation::Image::Size = Size
using	BiometricEvaluation::Image::Resolution = Resolution
using	BiometricEvaluation::Image::ROI = ROI

Enumerations
enum class	BiometricEvaluation::Image::CompressionAlgorithm {   BiometricEvaluation::Image::None = 0 , BiometricEvaluation::Image::Facsimile = 1 , BiometricEvaluation::Image::WSQ20 = 2 , BiometricEvaluation::Image::JPEGB = 3 ,   BiometricEvaluation::Image::JPEGL = 4 , BiometricEvaluation::Image::JP2 = 5 , BiometricEvaluation::Image::JP2L = 6 , BiometricEvaluation::Image::PNG = 7 ,   BiometricEvaluation::Image::NetPBM = 8 , BiometricEvaluation::Image::BMP = 9 , BiometricEvaluation::Image::TIFF = 10 }
	Image compression algorithms. More...
enum class	BiometricEvaluation::Image::PixelFormat { BiometricEvaluation::Image::MonoWhite = 0 , BiometricEvaluation::Image::MonoBlack = 1 , BiometricEvaluation::Image::Gray8 = 2 , BiometricEvaluation::Image::RGB24 = 3 }
	Image pixel formats. More...

Functions
std::string	BiometricEvaluation::Image::to_string (const Coordinate &c)
	Convert Coordinate to std::string. More...
std::ostream &	BiometricEvaluation::Image::operator<< (std::ostream &, const Coordinate &)
bool	BiometricEvaluation::Image::operator== (const Coordinate &lhs, const Coordinate &rhs)
bool	BiometricEvaluation::Image::operator!= (const Coordinate &lhs, const Coordinate &rhs)
std::string	BiometricEvaluation::Image::to_string (const CoordinateSet &coordinates)
	Convert CoordinateSet to std::string. More...
std::ostream &	BiometricEvaluation::Image::operator<< (std::ostream &stream, const CoordinateSet &coordinates)
	Output stream overload for CoordinateSet. More...
std::string	BiometricEvaluation::Image::to_string (const Size &s)
	Convert Size to std::string. More...
std::ostream &	BiometricEvaluation::Image::operator<< (std::ostream &, const Size &)
bool	BiometricEvaluation::Image::operator== (const Size &lhs, const Size &rhs)
bool	BiometricEvaluation::Image::operator!= (const Size &lhs, const Size &rhs)
std::string	BiometricEvaluation::Image::to_string (const Resolution &r)
	Convert Resolution to std::string. More...
std::ostream &	BiometricEvaluation::Image::operator<< (std::ostream &, const Resolution &)
bool	BiometricEvaluation::Image::operator== (const Resolution &lhs, const Resolution &rhs)
bool	BiometricEvaluation::Image::operator!= (const Resolution &lhs, const Resolution &rhs)
float	BiometricEvaluation::Image::distance (const Coordinate &p1, const Coordinate &p2)
	Calculate the distance between two points. More...
BiometricEvaluation::Memory::uint8Array	BiometricEvaluation::Image::removeComponents (const BiometricEvaluation::Memory::uint8Array &rawData, const uint8_t bitDepth, const std::vector< bool > &components)
	Remove components from a decompressed image's raw byte representation. More...
std::string	BiometricEvaluation::Image::to_string (const ROI &r)
	Convert ROI to std::string. More...
std::ostream &	BiometricEvaluation::Image::operator<< (std::ostream &, const ROI &)
bool	BiometricEvaluation::Image::operator== (const ROI &lhs, const ROI &rhs)
bool	BiometricEvaluation::Image::operator!= (const ROI &lhs, const ROI &rhs)
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::Image::CompressionAlgorithm, BE_Image_CompressionAlgorithm_EnumToStringMap)
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::Image::PixelFormat, BE_Image_PixelFormat_EnumToStringMap)
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::Image::Resolution::Units, BE_Image_Resolution_Units_EnumToStringMap)

Variables
const double	BiometricEvaluation::Image::CentimetersPerInch = 2.54
	Number of centimeters in one inch. More...
const double	BiometricEvaluation::Image::MillimetersPerInch = CentimetersPerInch * 10
	Number of millimeters in one inch. More...

Function Documentation

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [1/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::Image::CompressionAlgorithm	,
		BE_Image_CompressionAlgorithm_EnumToStringMap
	)

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [2/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::Image::PixelFormat	,
		BE_Image_PixelFormat_EnumToStringMap
	)

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [3/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::Image::Resolution::Units	,
		BE_Image_Resolution_Units_EnumToStringMap
	)