Back to FabImage Library website

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

ConvertToMultichannel


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates a multichannel image from a monochromatic one by replicating its channel.

Syntax

C++
C#
 
void fil::ConvertToMultichannel
(
	const fil::Image& inMonoImage,
	ftl::Optional<const fil::Region&> inRoi,
	int inNewDepth,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value
 inMonoImage const Image&
Input value
 inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value
 inNewDepth int 1 - 4 3
Output value
 outImage Image& Output image

Description

The operation computes multichannel image equivalent to monochromatic inMonoImage. The number of channels in the resulting image is determined by the inNewDepth parameter. Each of the channels in outImage will be equal to the only channel of the inMonoImage.

Note that the operation does not alter the appearance of the image in the IDE.

Hardware Acceleration

This operation is optimized for SSSE3 technology for pixels of types: 3xUINT8, 3xSINT8, 3xUINT16, 3xSINT16, 3xSINT32, 3xREAL.

This operation is optimized for NEON technology for pixels of types: 3xUINT8, 3xSINT8, 3xUINT16, 3xSINT16, 3xSINT32, 3xREAL.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Not a monochromatic input in ConvertToMultichannel.
DomainError Region exceeds an input image in ConvertToMultichannel.