Back to Aurora Vision Studio website

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

SaveImageToTiff


Module: FoundationLite

Saves an image to a TIFF file.

Name Type Range Description
Input value inImage Image An image to be saved
Input value inFile File Path to a file
Input value inCompressionScheme TiffImageCompressionScheme* Compression scheme
Input value inJpegQuality Integer* 0 - 100 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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

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.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of SaveImage filter group.