Back to FabImage Library website

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

AverageChannels_121


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a monochromatic image by averaging the input image channels.

Applications: Conversion to mono which is more consistent with human perception (our eyes are more sensitive to green).

Syntax

C++
C#
 
void fil::AverageChannels_121
(
	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

Requirements

For input inImage only pixel formats are supported: 3⨯uint8, 3⨯int8, 3⨯uint16, 3⨯int16, 3⨯int32, 3⨯real.

Read more about pixel formats in Image documentation.

Description

The operation computes the monochromatic average of inImage color channels. Average being computed at each pixel is a mean with weight (1, 2, 1).

Hardware Acceleration

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

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

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

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_121.
DomainError Not supported inImage pixel format in AverageChannels_121. Supported formats: 3xUInt8, 3xInt8, 3xUInt16, 3xInt16, 3xInt32, 3xReal.

See Also

  • AverageChannels – Creates a monochromatic image by averaging the input image channels.