Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Conversions » AverageChannels

AverageChannels


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a monochromatic image by averaging the input image channels.

Syntax

C++
C#
 
void fil::AverageChannels
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::Image& outImage
)

Parameters

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

Description

The operation computes the monochromatic average of inImage color channels. Average being computed at each pixel is a standard arithmetic mean.

Examples

AverageChannels run on example image.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of type: 3xUINT8.

This operation is optimized for SSSE3 technology for pixels of types: 2xUINT8, 4xUINT8.

This operation is optimized for AVX2 technology for pixels of types: 2xUINT8, 3xUINT8, 4xUINT8.

This operation is optimized for NEON technology for pixels of type: UINT8.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

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

See Also