image_saturation

file.image_saturation(p0: float) → int

Desaturate color when saving an image to disk or printer.

Desaturating images is especially useful when saving images to a format which will be played back on a television monitor as fully saturated colors have a tendency to “bleed”. 1.0 is the default and is used if not specified.

Args:

p0:

‘sat_value’ A value from 0 (black and white) to 1 (full color saturation)

Examples:

ensight.file.image_format("sgi_rgb")
ensight.file.image_saturation(0.8)
ensight.file.image_file("/tmp/test_image")
ensight.file.save_image()

Returns:

zero on success, non-zero on error