Start » Filter Reference » Image » Image Pixel Statistics » ImageAverageHSx

ImageAverageHSx


Module: FoundationLite

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

Name Type Range Description
Input value
inRgbImage Image
Input value
inRoi Region* Range of pixels to be processed
Input value
inColorModel HSxColorModel Selected color model
Input value
inMinSaturation Integer* 0 - 255
Output value
outHAverage Integer Output hue average
Output value
outSAverage Integer Output saturation average
Output value
outBAverage Integer 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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

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.

Complexity Level

This filter is available on Advanced Complexity Level.