ImageSaveParams Class Documentation

classImageSaveParams

Namespace:datalogics_interface

Detailed Description

The parameters include the file type (such as PNG or JPG), compression, image quality, and gray scale.

Constructor & Destructor Documentation

ImageSaveParams

ImageSaveParams()

Default constructor. All options are initialised to defaults.

~ImageSaveParams

~ImageSaveParams()

Member Function Documentation

get_compression

CompressionCodeget_compression()

Returns:

The compression code currently set. The default is CompressionCode.Default.

Gets the type of compression to be used in saving the image to a file.

get_disable_alpha_channel_generation

boolget_disable_alpha_channel_generation()

Returns:

true if alpha channel generation is disabled, false otherwise.

When false, RGB image data with a Mask will be combined as RGBA + Alpha Channel output (32-bit). When true, the Mask is not combined and the output is RGB (24-bit). This is only valid for TIFF and PNG output formats.

get_halftone_gray_images

boolget_halftone_gray_images()

Returns:

true if halftone conversion is enabled, false otherwise.

When true, converts 8bpc grayscale images to 1bpc (B/W) images using a 45 degree line screen set for 106lpi at 600dpi. Note this can only be set to true for an image of ColorSpace of DeviceGray.

get_jpeg_quality

intget_jpeg_quality()

Returns:

The JPEG quality value (0-100). The default is 0.

Gets the quality of a JPEG output image.

get_monochrome_threshold

unsigned charget_monochrome_threshold()

Returns:

The monochrome threshold value (0-255). The default is 128.

Note: this is only valid for TIF Images using G3 or G4 compression and HalftoneGrayImages must be set to false.

get_raise_exception_if_not_usable_color

boolget_raise_exception_if_not_usable_color()

Returns:

true if an exception will be raised for unsupported color formats, false otherwise.

When true, an exception will be raised if the image being saved is not in a format this graphic form can save natively. When false, the image will be automatically converted into a form that can be saved natively (generally DeviceRGB using the sRGB profile).

get_reverse_gray

boolget_reverse_gray()

Returns:

true if the grayscale output will be reversed, false otherwise.

Note this is only valid for an image with a DeviceGray Colorspace.

get_tiff_black_is_one

boolget_tiff_black_is_one()

Returns:

true if the TIFF image is photometrically reversed, false otherwise.

Note this is only valid for a 1-bit TIFF image with a DeviceGray Colorspace.

get_tiff_byte_order

TIFFByteOrderget_tiff_byte_order()

Returns:

The current TIFF byte order setting.

This is only valid for TIFF output.

get_tiff_cmyk_alpha

boolget_tiff_cmyk_alpha()

Returns:

true if CMYK + Alpha channel TIFF output is enabled, false otherwise.

Note: This is only valid for CMYK image data which has a Soft Mask; the output will be 40-bit.

get_write_separation_colors_to_tiff

boolget_write_separation_colors_to_tiff()

Returns:

true if separation colors are written to TIFF, false if converted to sRGB.

When false, separation colors will be converted to their alternate color space and rendered as RGB. When true, separation colors are output using the TIFF Photoshop tag.

set_compression

voidset_compression(CompressionCodecode)

Parameters

code: CompressionCode

Returns:

The compression code currently set. The default is CompressionCode.Default.

Gets the type of compression to be used in saving the image to a file.

set_disable_alpha_channel_generation

voidset_disable_alpha_channel_generation(booldisable)

Parameters

disable: bool

Returns:

true if alpha channel generation is disabled, false otherwise.

When false, RGB image data with a Mask will be combined as RGBA + Alpha Channel output (32-bit). When true, the Mask is not combined and the output is RGB (24-bit). This is only valid for TIFF and PNG output formats.

set_halftone_gray_images

voidset_halftone_gray_images(boolhalftone)

Parameters

halftone: bool

Returns:

true if halftone conversion is enabled, false otherwise.

When true, converts 8bpc grayscale images to 1bpc (B/W) images using a 45 degree line screen set for 106lpi at 600dpi. Note this can only be set to true for an image of ColorSpace of DeviceGray.

set_jpeg_quality

voidset_jpeg_quality(intquality)

Parameters

quality: int

Returns:

The JPEG quality value (0-100). The default is 0.

Gets the quality of a JPEG output image.

set_monochrome_threshold

voidset_monochrome_threshold(unsigned charthreshold)

Parameters

threshold: unsigned char

Returns:

The monochrome threshold value (0-255). The default is 128.

Note: this is only valid for TIF Images using G3 or G4 compression and HalftoneGrayImages must be set to false.

set_raise_exception_if_not_usable_color

voidset_raise_exception_if_not_usable_color(boolraise)

Parameters

raise: bool

Returns:

true if an exception will be raised for unsupported color formats, false otherwise.

When true, an exception will be raised if the image being saved is not in a format this graphic form can save natively. When false, the image will be automatically converted into a form that can be saved natively (generally DeviceRGB using the sRGB profile).

set_reverse_gray

voidset_reverse_gray(boolreverse)

Parameters

reverse: bool

Returns:

true if the grayscale output will be reversed, false otherwise.

Note this is only valid for an image with a DeviceGray Colorspace.

set_tiff_black_is_one

voidset_tiff_black_is_one(boolblack_is_one)

Parameters

black_is_one: bool

Returns:

true if the TIFF image is photometrically reversed, false otherwise.

Note this is only valid for a 1-bit TIFF image with a DeviceGray Colorspace.

set_tiff_byte_order

voidset_tiff_byte_order(TIFFByteOrderorder)

Parameters

order: TIFFByteOrder

Returns:

The current TIFF byte order setting.

This is only valid for TIFF output.

set_tiff_cmyk_alpha

voidset_tiff_cmyk_alpha(boolcmyk_alpha)

Parameters

cmyk_alpha: bool

Returns:

true if CMYK + Alpha channel TIFF output is enabled, false otherwise.

Note: This is only valid for CMYK image data which has a Soft Mask; the output will be 40-bit.

set_write_separation_colors_to_tiff

voidset_write_separation_colors_to_tiff(boolwrite)

Parameters

write: bool

Returns:

true if separation colors are written to TIFF, false if converted to sRGB.

When false, separation colors will be converted to their alternate color space and rendered as RGB. When true, separation colors are output using the TIFF Photoshop tag.