Back to FabImage Library website

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

SaveImageToTiff


Header: FIL.h
Namespace: fil
Module: FoundationLite

Saves an image to a TIFF file.

Syntax

C++
C#
 
void fil::SaveImageToTiff
(
	const fil::Image& inImage,
	const ftl::File& inFile,
	ftl::Optional<fil::TiffImageCompressionScheme::Type> inCompressionScheme,
	ftl::Optional<int> inJpegQuality,
	bool inIgnoreErrors
)

Parameters

Name Type Range Default Description
Input value inImage const Image& An image to be saved
Input value inFile const File& Path to a file
Input value inCompressionScheme Optional<TiffImageCompressionScheme::Type> NIL Compression scheme
Input value inJpegQuality Optional<int> 0 - 100 NIL Quality - used only for JPEG compression scheme
Input value 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 in SaveImageToTiff.
DomainError inJpegQuality set in SaveImageToTiff is valid only with inCompressionScheme set as JPEG.
DomainError Path name cannot be empty in SaveImageToTiff.
DomainError Not supported inImage pixel format in SaveImageToTiff. Supported formats: UInt8, UInt16, Real, Int32.