Start » Filter Reference » Image » Image Conversions » AverageChannels

AverageChannels

Basic

Module: FoundationLite

Creates a monochromatic image by averaging the input image channels.

Name Type Description
Input value
 inImage Image Input image
Input value
 inRoi Region* 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

Description of usage of this filter can be found in examples and tutorial: Rubber Ring, Rubber Ring (Simple).

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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

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

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of AverageChannels filter group.

See Also