TiffImageEncoder Class Reference

Converts image type ImageType::TIFF. More...

#include <ImageEncoder.h>

Collaboration diagram for TiffImageEncoder:

Public Types
enum	Compression : uint16_t {   NONE = 1 , CCITTRLE = 2 , CCITTFAX3 = 3 , CCITT_T4 = CCITTFAX3 ,   CCITTFAX4 = 4 , CCITT_T6 = CCITTFAX4 , LZW = 5 , JPEG = 7 ,   NEXT = 32766 , CCITTRLEW = 32771 , PACKBITS = 32773 , THUNDERSCAN = 32809 ,   IT8CTPAD = 32895 , IT8LW = 32896 , IT8MP = 32897 , IT8BL = 32898 ,   PIXARFILM = 32908 , PIXARLOG = 32909 , DEFLATE = 32946 , ADOBE_DEFLATE = 8 ,   DCS = 32947 , SGILOG = 34676 , SGILOG24 = 34677 , JP2000 = 34712 }
	Compression supported for tiff images. More...

Public Member Functions
	TiffImageEncoder ()
	Construct a new Tiff Image Encoder object.
void	SetCompression (Compression compression)
	Set compression level.
Compression	GetCompression () const
	Provides compression.
void	Accept (ImageEncoderVisitor &visitor) const final
	Allow visitor to visit concrete type of encoder.
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::TIFF.

Member Enumeration Documentation

Compression

enum Compression : uint16_t

Compression supported for tiff images.

See https://www.awaresystems.be/imaging/tiff/tifftags/compression.html.

Enumerator
NONE	No compression.
CCITTRLE	CCITT RLE.
CCITTFAX3	CCITT FAX3.
CCITT_T4	CCITT T4.
CCITTFAX4	CCITT FAX4.
CCITT_T6	CCITT T6.
LZW	LZW.
JPEG	JPEG.
NEXT	NEXT.
CCITTRLEW	CCITT RLE W.
PACKBITS	PACKBITS.
THUNDERSCAN	THUNDERSCAN.
IT8CTPAD	IT8 CTPAD.
IT8LW	IT8 LW.
IT8MP	IT8 MP.
IT8BL	IT8 BL.
PIXARFILM	PIXAR FILM.
PIXARLOG	PIXAR LOG.
DEFLATE	DEFLATE.
ADOBE_DEFLATE	ADOBE DEFLATE.
DCS	DCS.
SGILOG	SGI LOG.
SGILOG24	SGI LOG24.
JP2000	JP2000.

Constructor & Destructor Documentation

TiffImageEncoder()

TiffImageEncoder ( )

inline

Construct a new Tiff Image Encoder object.

Default compression is Compression::NONE.

References NONE.

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.

GetCompression()

Compression GetCompression ( ) const

inline

Provides compression.

Returns

compression

SetCompression()

void SetCompression ( Compression compression )

inline

Set compression level.

Parameters

compression

Compression to use in encoding

Exceptions

EnrollmentInvalidArgumentException

when compression is unknown

---

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

• Image/ImageEncoder.h