Back to FabImage Library website

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

AverageImages_OfArray


Header: FIL.h
Namespace: fil
Module: FoundationLite

Averages images from an array pixel by pixel.

Syntax

C++
C#
 
void fil::AverageImages_OfArray
(
	const ftl::Array<fil::Image>& inImages,
	ftl::Optional<const fil::Region&> inRoi,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImages const Array<Image>&
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Output value outImage Image& Output image

Description

Array version of AverageImages.

Errors

List of possible exceptions:

Error type Description
DomainError Empty array of images in AverageImages_OfArray.
DomainError Image dimensions are not equal in AverageImages_OfArray.
DomainError Image formats are not the same in AverageImages_OfArray.
DomainError Not supported image type in AverageImages_OfArray.
DomainError Region exceeds an input image in AverageImages_OfArray.

See Also