You are here: Start » Function Reference » Image IO » SaveImageToTiff

SaveImageToTiff

Header:	AVL.h
Namespace:	avl

Saves an image to a TIFF file.

Syntax

void avl::SaveImageToTiff
(
	const avl::Image& inImage,
	const atl::File& inFile,
	atl::Optional<avl::TiffImageCompressionScheme::Type> inCompressionScheme,
	atl::Optional<int> inJpegQuality,
	bool inIgnoreErrors
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			An image to be saved
inFile	const File&			Path to a file
inCompressionScheme	Optional<TiffImageCompressionScheme::Type>		NIL	Compression scheme
inJpegQuality	Optional<int>	0 - 100	NIL	Quality - used only for JPEG compression scheme
inIgnoreErrors	bool			Switches to re-trying and canceling in case of errors (e.g. when the disk is full)

Requirements

For input inImage only pixel formats are supported: uint8, uint16, real, int32.

Read more about pixel formats in Image documentation.

Errors

List of possible exceptions:

Error type	Description
DomainError	Compression is not supported for 32-bit pixel type.
DomainError	inJpegQuality set in SaveImageToTiff is valid only with inCompressionScheme set as JPEG.
DomainError	Path name cannot be empty in SaveImageToTiff.