You are here: Start » AVL.NET » Function Reference » Image » Image Combinators » AVL.AverageImages

AVL.AverageImages

Averages two images pixel by pixel.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void AverageImages
(
	AvlNet.Image inImage1,
	AvlNet.Image inImage2,
	NullableRef<AvlNet.Region> inRoi,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inImage1AvlNet.ImageFirst input image.
inImage2AvlNet.ImageSecond input image.
inRoiAvlNet.NullableRef<AvlNet.Region>Range of pixels to be processed. Default value: atl::NIL.
outImageAvlNet.ImageOutput image.

Description

The operation computes the average of two images. Each outImage pixel is equal to the average of the corresponding pixels of the input images.

In multichannel (color) images each pixel channel is processed separately.

The operation requires that the images being processed have equal format and dimensions, otherwise an error with appropriate description occurs. To obtain an image of desired dimensions one can use ResizeImage or CropImage filter. To alter the pixel type of an image one can use ConvertPixelType filter. ConvertToMultichannel and AverageChannels filters allow to alter the number of image channels.

Examples

AverageImages performed on the sample images.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT16, UINT16, REAL.

This operation is optimized for AVX2 technology for pixels of types: UINT8, SINT16, UINT16, REAL.

This operation is optimized for NEON technology for pixels of types: UINT8, SINT8, UINT16, SINT16, SINT32.

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 Image formats are not the same in AverageImages.
DomainError Image sizes are not equal in AverageImages.
DomainError Region exceeds an input image in AverageImages.

Function Overrides

See also