You are here: Start » FIL.NET » Function Reference » Image » Image Pixel Statistics » FIL.ImageAverageHSx

FIL.ImageAverageHSx

Computes the average of the HSV, HSL or HSI image pixel values.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void ImageAverageHSx
(
	FilNet.Image inRgbImage,
	FilNet.HSxColorModel inColorModel,
	out int outHAverage,
	out int outSAverage,
	out int outBAverage
)

Parameters

Name Type Range Default Description
inRgbImageFilNet.Image
inColorModelFilNet.HSxColorModelSelected color model.
outHAverageintOutput hue average.
outSAverageintOutput saturation average.
outBAverageintOutput brightness average.

Description

The filter finds average values of the HSV, HSL or HSI color space image from the RGB image inRgbImage within specific region inRoi.

The calculations take into account only these pixels which have saturation a greater than inMinSaturation.

Filter returns average values of a hue, saturation and brightness.

Errors

List of possible exceptions:

Error type Description
DomainError Region exceeds an input image in ImageAverageHSx.
DomainError Not supported inRgbImage pixel format in ImageAverageHSx. Supported formats: 3xUInt8.

Function Overrides

See also