Back to Adaptive Vision Library website

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

SaveImageToTiff_Asynchronous


Saves an image to a TIFF file in the background thread.

Syntax

void avl::SaveImageToTiff_Asynchronous
(
	SaveImageState& ioState,
	const avl::Image& inImage,
	const atl::File& inFile,
	atl::Optional<avl::TiffImageCompressionScheme::Type> inCompressionScheme,
	atl::Optional<int> inJpegQuality
)

Parameters

Name Type Range Default Description
ioState SaveImageState& Object used to maintain state of the function.
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 (0-100) - used only for JPEG compression scheme

Remarks

This filter is executed in the background thread. Execution errors may be reported with a delay or ignored. Stopping of the program may be delayed, because of waiting for background work to complete.

Errors

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

See Also