You are here: Start » AVL.NET » AVL.ImageAverage
Computes the average of the image pixel values.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void ImageAverage ( AvlNet.Image inImage, NullableRef<AvlNet.Region> inRoi, out AvlNet.Pixel outAverageColor, out float outAverageValue )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | AvlNet.Image | Input image. | |||
inRoi | AvlNet.NullableRef<AvlNet.Region> | Range of pixels to be processed. Default value: atl::NIL. | |||
outAverageColor | AvlNet.Pixel | Average of each channel. | |||
outAverageValue | float | Average of the entire image. |
Description
The function calculates average of pixel values in the inImage.
Average values of pixels calculated for each channel are returned in outAverageColor, while calculated for the region of interest - in outAverageValue. If region of interest isn't specified, average is calculated for the entire image.
Examples
Remarks
Minimal image size requirement
The input image shouldn't be empty.
Minimal region of interest size requirement
The input region of interest shouldn't be empty.
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 | Empty image on input in ImageAverage. |
DomainError | Empty region of interest on input in ImageAverage. |
Function Overrides
- ImageAverage(Image, Pixel)
- ImageAverage(Image, Pixel, Single)
- ImageAverage(Image, NullableRef<Region>, Pixel)