Back to FabImage Library website

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

SelectChannel


Header: FIL.h
Namespace: fil
Module: FoundationLite

Creates an image from a single channel of the input image.

Syntax

C++
C#
 
void fil::SelectChannel
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	int inChannelIndex,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inChannelIndex int 0 - 3
Output value outImage Image& Output image

Description

The operation extracts the selected color channel of inImage.

Examples

An example image used as inImage.

The resulting outImage when inChannelIndex = 0.

The resulting outImage when inChannelIndex = 1.

The resulting outImage when inChannelIndex = 2.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Channel index out of range in SelectChannel.
DomainError Region exceeds an input image in SelectChannel.

See Also

  • SplitChannels – Creates several monochromatic images from individual channels of the input image.