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

AddImages_OfLoop

Header:	FIL.h
Namespace:	fil

Adds images appearing in consecutive iterations pixel by pixel.

Syntax

void fil::AddImages_OfLoop
(
	AddImages_OfLoopState& ioState,
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	float inScale,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
ioState	AddImages_OfLoopState&		Object used to maintain state of the function.
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inScale	float	1.0f
outImage	Image&		Output image

In-place Processing

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

Description

Loop version of AddImages.

Hardware Acceleration

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

This operation is optimized for SSE41 technology for pixels of types: UINT16(for inScale!=1).

This operation is optimized for AVX2 technology for pixels of types: UINT8, SINT16, UINT16, 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 AddImages.
DomainError	Image sizes are not equal in AddImages.
DomainError	Region exceeds an input image in AddImages.