Start » Filter Reference » Image » Image IO » SaveImageToTiff_Asynchronous
Basic| Module: | FoundationLite |
|---|
Saves an image to a TIFF file in the background thread.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inThreadQueueSize | Integer | 1 -  |
Number of incoming frames that can be buffered before the thread is able to process them |
|
inImage | Image | An image to be saved | |
|
inFile | File | Path to a file | |
|
inCompressionScheme | TiffImageCompressionScheme* | Compression scheme | |
|
inJpegQuality | Integer* | 0 - 100 | Quality (0-100) - used only for JPEG compression scheme |
|
inIgnoreErrors | Bool | If false the error will be reported as soon as the filter instance is again executed | |
Requirements
For input inImage only pixel formats are supported: uint8, uint16, real, int32.
Read more about pixel formats in Image documentation.
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
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_Asynchronous. |
| DomainError | inJpegQuality set in SaveImageToTiff_Asynchronous is valid only with inCompressionScheme set as JPEG. |
| DomainError | Path name cannot be empty in SaveImageToTiff_Asynchronous. |
| DomainError | Not supported inImage pixel format in SaveImageToTiff_Asynchronous. 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.