Back to FabImage Library website

You are here: Start » Function Reference » Image Combinators » MultiplyImages_OfArray

MultiplyImages_OfArray


Header:FIL.h
Namespace:fil

Multiplies images of an array pixel by pixel.

Syntax

C++
C#
 
void fil::MultiplyImages_OfArray
(
	const ftl::Array<fil::Image>& inImageArray,
	ftl::Optional<const fil::Region&> inRoi,
	float inScale,
	fil::Image& outImage
)

Parameters

Name Type Default Description
inImageArray const Array<Image>&
inRoi Optional<const Region&> NIL Range of pixels to be processed
inScale float 1.0f
outImage Image& Output image

Description

Array version of MultiplyImages.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT16, REAL, SINT8(for inScale=1).

This operation is optimized for SSE41 technology for pixels of type: UINT16.

This operation is optimized for AVX2 technology for pixels of types: UINT8, UINT16, SINT16, REAL, SINT8(for inScale=1).

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Image formats are not the same in MultiplyImages.
DomainError Image sizes are not equal in MultiplyImages.
DomainError Region exceeds an input image in MultiplyImages.

See Also