You are here: Start » FIL.NET » FIL.AverageChannels_Weighted

FIL.AverageChannels_Weighted

Creates a monochromatic image from weighted averages of the input image channels.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void AverageChannels_Weighted
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	int inWeight1,
	int inWeight2,
	int inWeight3,
	int inWeight4,
	FilNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.NullableRef<FilNet.Region>Range of pixels to be processed. Default value: ftl::NIL.
inWeight1intWeight of the first channel.
inWeight2intWeight of the second channel.
inWeight3intWeight of the third channel.
inWeight4intWeight of the fourth channel.
outImageFilNet.ImageOutput image.

Description

The operation computes the monochromatic average of the inImage color channels. Average being computed at each pixel is a weighted arithmetic mean.

Weights of the channels are determined by the parameters inWeight1, inWeight2, inWeight3, inWeight4. For images having less than four channels, it is required that weights assigned to non-existing channels equal zero.

Examples

AverageChannels_Weighted run on example image with inWeight1 = 1, inWeight2 = 0, inWeight3 = 0, inWeight4 = 0, which for a RGB image is equivalent to the extraction of the Red channel.

Hardware Acceleration

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 Non-zero weight of not existing image channel in AverageChannels_Weighted.
DomainError Region exceeds an input image in AverageChannels_Weighted.
DomainError Sum of weights equals zero in AverageChannels_Weighted.

Function Overrides

See also