You are here: Start » Function Reference » Image » Image Point Transforms » ResaturateImage

ResaturateImage

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Sets pixels below the low value to minimum, above the high value to maximum, and interpolates the rest.

Syntax

void fil::ResaturateImage
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	float inLowValue,
	float inHighValue,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inLowValue	float	64.0f	The value that will be changed to minimum (usually 0)
inHighValue	float	192.0f	The value that will be changed to maximum (usually 255)
outImage	Image&		Output image

Requirements

For input inImage only pixel formats are supported: int8, uint8, int16, uint16, int32.

Read more about pixel formats in Image documentation.

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT16.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	Region exceeds an input image in ResaturateImage.
DomainError	Not supported inImage pixel format in ResaturateImage. Supported formats: Int8, UInt8, Int16, UInt16, Int32.