MultiplyImage

Multiplies each pixel by a scalar value.

void fil::MultiplyImage
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	float inValue,
	fil::Image& outImage
)

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inValue	float	2.0f	Multiplier
outImage	Image&		Output image

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

The operation increases the brightness of an image by multiplying each of its pixels by a fixed value.

$\forall_{i,j} \text{\textbf{OutImage} }_{i,j} = \text{\textbf{InImage} }_{i,j} \cdot \text{\textbf{inValue} }$

Whenever the resulting value exceeds the range of pixel values, it is clipped to the nearest proper value.

The MultiplyImage performed on the sample image with inValue = 2.0.

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

This operation supports automatic parallelization for multicore and multiprocessor systems.

List of possible exceptions:

Error type	Description
DomainError	Region exceeds an input image in MultiplyImage.