Celartem::ExportUtils::TIFFExportParam Struct Reference

#include <pxl_imageexport.h>

List of all members.

Public Types
enum	Compression { none = 0, zip = 1, lzw = 2, jpeg = 3 }
enum	Config { embedThumbnail = 1, pyramidEncoding = 2, binalizeOutput = 4, useImagesAsLayers = 8 }
Public Member Functions
	TIFFExportParam (Compression inCompression=none, size_t inTileWidth=0, size_t inTileHeight=0, size_t inFlags=0, Endian inEndian=endianHost)
Public Attributes
Compression	compression
	The compression scheme.
size_t	tileWidth
	The width of each tile.
size_t	tileHeight
	The height of each tile.
size_t	flags
	Any combination of Config enumeration values.
Endian	endian
	Endian used in the TIFF file.
double	binalizationThreshold
size_t	jpegQuality
bool	jpegUseYCbCr

---

Detailed Description

TIFFExportParam structure is used with exportAsTIFF function and it customizes the parameter for encoding TIFF files. Before using this structure, you should zero-clear the whole instance to prevent some errors due to lack of the initialization.

See also:

exportAsTIFF

Exporting Images, TIFF Image File Format

Definition at line 347 of file pxl_imageexport.h.

---

Member Enumeration Documentation

enum Celartem::ExportUtils::TIFFExportParam::Compression

This enumeration defines the compression schemes.

Enumerator:

none	No compression.
zip	ZIP compression.
lzw	LZW compression.
jpeg	JPEG compression.

Definition at line 352 of file pxl_imageexport.h.

enum Celartem::ExportUtils::TIFFExportParam::Config

This enumeration values define the options for TIFF encoder.

Enumerator:

embedThumbnail	Includes a thumbnail version.
pyramidEncoding	Use pyramid encoding.
binalizeOutput	Binalize the output.
useImagesAsLayers	Use the input image array as layers of the same image pyramid. The first image is the largest image and each trailing image should be smaller than the previous. The most preferable is 1x, 1/2x, 1/4x, 1/8x, ...

Definition at line 383 of file pxl_imageexport.h.

---

Constructor & Destructor Documentation

Celartem::ExportUtils::TIFFExportParam::TIFFExportParam	(	Compression	inCompression = none,
		size_t	inTileWidth = 0,
		size_t	inTileHeight = 0,
		size_t	inFlags = 0,
		Endian	inEndian = endianHost
	)			[inline]

This constructor initializes the structure.

Parameters:

	inCompression	The compression scheme. This is one of Compression enumeration values.
	inTileWidth	The width of each tile. If 0 is specified, the encoder automatically determine the tile size. If the value is equal to the image width, the encoder encodes the image as strip oriented image.
	inTileHeight	The height of each tile. If 0 is specified, the encoder automatically determine the tile size.
	inFlags	Any combination of Config enumeration values.
	inEndian	The endianness of the output TIFF file. It is one of Endian enumeration values.

Definition at line 447 of file pxl_imageexport.h.

---

Member Data Documentation

Compression Celartem::ExportUtils::TIFFExportParam::compression

The compression scheme.

The compression scheme. This is one of Compression enumeration values.

Definition at line 364 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::TIFFExportParam::tileWidth

The width of each tile.

The width of each tile. If 0 is specified, the encoder automatically determine the tile size. If the value is equal to the image width, the encoder encodes the image as strip oriented image.

Definition at line 372 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::TIFFExportParam::tileHeight

The height of each tile.

The height of each tile. If 0 is specified, the encoder automatically determine the tile size.

Definition at line 378 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::TIFFExportParam::flags

Any combination of Config enumeration values.

Any combination of Config enumeration values.

Definition at line 399 of file pxl_imageexport.h.

Endian Celartem::ExportUtils::TIFFExportParam::endian

Endian used in the TIFF file.

The endianness of the output TIFF file. It is one of Endian enumeration values.

Definition at line 405 of file pxl_imageexport.h.

double Celartem::ExportUtils::TIFFExportParam::binalizationThreshold

Binalization threshold in [0.0 1.0].
This value is used only if binalizeOutput is specified to flag field.

Definition at line 412 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::TIFFExportParam::jpegQuality

For JPEG compression, you can specify the quality in 0-100.
The defaukt is 80.

Definition at line 418 of file pxl_imageexport.h.

bool Celartem::ExportUtils::TIFFExportParam::jpegUseYCbCr

For JPEG compression, whether to use YCbCr color model to reduce the JPEG size; this realizes almost same size to normal YCbCr JPEG.
The default is true.

Definition at line 426 of file pxl_imageexport.h.

---

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

• pxl_imageexport.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:32 2008.