Back to Adaptive Vision Library website

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

SaveImageToTiff


Saves an image to a TIFF file.

Syntax

C++
C#
 
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)

Errors

Error type Description
DomainError Path name cannot be empty in SaveImageToTiff.
DomainError inCompressionScheme must be set to JPEG to use inJpegQuality in SaveImageToTiff.