WsqImageEncoder Class Reference

Converts image type ImageType::WSQ. More...

#include <ImageEncoder.h>

Collaboration diagram for WsqImageEncoder:

Public Member Functions
	WsqImageEncoder ()
	Construct a new WSQ Image Encoder object.
void	Accept (ImageEncoderVisitor &visitor) const final
	Allow visitor to visit concrete type of encoder.
void	SetBitrate (float bitrate)
	Set the bitrate for WSQ compression.
float	GetBitrate () const
	Provides WSQ image bitrate.
std::vector< uint8_t >	Encode (const RawImage &raw) const final
	Saves given RawImage as formatted image.

Static Public Member Functions
static std::shared_ptr< ImageEncoder >	Create (ImageType type)
	Create concrete default encoder for given type.

Detailed Description

Converts image type ImageType::WSQ.

Member Function Documentation

Accept()

void Accept ( ImageEncoderVisitor & visitor ) const

inlinefinalvirtual

Allow visitor to visit concrete type of encoder.

Parameters

visitor

ImageEncoderVisitor to call

Implements ImageEncoder.

Create()

std::shared_ptr< ImageEncoder > Create ( ImageType type )

inlinestaticinherited

Create concrete default encoder for given type.

Parameters

type

ImageType

Exceptions

EnrollmentException

when image type is unknown

Returns

ImageEncoder

References ImageType::BMP, ImageType::IRAW, ImageType::JPG, ImageType::JPG2000, ImageType::PNG, ImageType::TIFF, ImageException::UNKNOWN_IMAGE, ImageType::WEBP, and ImageType::WSQ.

Referenced by Image::Decode(), and ImageFileSaver::Save().

Here is the caller graph for this function:

Encode()

std::vector< uint8_t > Encode ( const RawImage & raw ) const

inlinefinalvirtualinherited

Saves given RawImage as formatted image.

Parameters

raw

RawImage

Returns

encoded image

Exceptions

ImageException	when it is not possible to encode image
InvalidImageArgumentException	when image is empty

Implements ImageEncoder.

GetBitrate()

float GetBitrate ( ) const

inline

Provides WSQ image bitrate.

Returns

average bits per pixel in the WSQ image

SetBitrate()

void SetBitrate ( float bitrate )

inline

Set the bitrate for WSQ compression.

Defines the bitrate for the WSQ compression algorithm. Note that there is no universal correlation between bitrate and compression ratio as it depends on the image content. The bitrate is defined as the average bits per pixel in the compressed image.

Parameters

bitrate

Valid range is <0.1,5.0>. The default value is 1.25, which corresponds approximately to a 1:10 compression ratio for a standard fingerprint image.

Exceptions

EnrollmentInvalidArgumentException

if the bitrate is not in the valid range <0.1,5.0>.

---

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

• Image/ImageEncoder.h