You are here: Start » FIL.NET » Function Reference » Image » Image Conversions » FIL.AddChannels
FIL.AddChannels
Creates a monochromatic image by summing the values of the input image channels.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
public static void AddChannels ( FilNet.Image inImage, NullableRef<FilNet.Region> inRoi, FilNet.Image outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inImage | FilNet.Image | Input image. | ||
| inRoi | FilNet.NullableRef<FilNet.Region> | Range of pixels to be processed. Default value: ftl::NIL. | ||
 | outImage | FilNet.Image | output mono image. |
Description
This operation sums values of the given inImage image channels to obtain a monochromatic image.
Examples
 |
|
|
Image with one channel on the input of the filter (on the left) doesn't affect the image - see the image on the right. |
|
 |
|
|
Input RGB image (on the left) converted to single-channel image (on the right) with pixel values obtained from summing values of input image channels. For example, if a pixel from input image in each R, G and B channel has values {255, 0, 0}, corresponding pixel in the output image will have value {255} (because 255 + 0 + 0 = 255). |
|
Hardware Acceleration
This operation is optimized for AVX2 technology for pixels of types: 2xUINT8, 3xUINT8, 4xUINT8, 2xUINT16, 3xUINT16, 4xUINT16.
This operation is optimized for SSSE3 technology for pixels of types: 2xUINT8, 3xUINT8, 4xUINT8, 2xUINT16, 3xUINT16, 4xUINT16.
This operation supports automatic parallelization for multicore and multiprocessor systems.
Hardware acceleration settings may be manipulated with Settings class.
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Region exceeds an input image in AddChannels. |
