Start » Filter Reference » Image » Image Conversions » AverageChannels_121
Basic| Module: | FoundationLite |
|---|
Creates a monochromatic image by averaging the input image channels.
Applications
| Name | Type | Description | |
|---|---|---|---|
 |
inImage | Image | Input image |
|
inRoi | Region* | Range of pixels to be processed |
 |
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
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_121. |
| DomainError | Not supported inImage pixel format in AverageChannels_121. Supported formats: 3xUInt8, 3xInt8, 3xUInt16, 3xInt16, 3xInt32, 3xReal. |
Complexity Level
This filter is available on Basic Complexity Level.
See Also
- AverageChannels_Weighted – Creates a monochromatic image from weighted averages of the input image channels.
- AverageChannels – Creates a monochromatic image by averaging the input image channels.