Back to FabImage Library website

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

ImageAverageHSx


Header: FIL.h
Namespace: fil
Module: FoundationLite

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

Syntax

C++
C#
 
void fil::ImageAverageHSx
(
	const fil::Image& inRgbImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::HSxColorModel::Type inColorModel,
	ftl::Optional<int> inMinSaturation,
	int& outHAverage,
	int& outSAverage,
	int& outBAverage
)

Parameters

Name Type Range Default Description
Input value inRgbImage const Image&
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inColorModel HSxColorModel::Type Selected color model
Input value inMinSaturation Optional<int> 0 - 255 0
Output value outHAverage int& Output hue average
Output value outSAverage int& Output saturation average
Output value outBAverage int& Output brightness average

Requirements

For input inRgbImage only pixel formats are supported: 3⨯uint8.

Read more about pixel formats in Image documentation.

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.