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

AverageImages_OfLoop

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Averages images appearing in consecutive iterations pixel by pixel.

Syntax

void fil::AverageImages_OfLoop
(
	AverageImages_OfLoopState& ioState,
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<fil::Image&> outImage
)

Parameters

Name	Type	Default	Description
ioState	AverageImages_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
outImage	Optional<Image&>		Output image

In-place Processing

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

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outImage.

Description

Loop version of AverageImages.

Errors

List of possible exceptions:

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