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

AVL.BlendImages

Computes weighted sum pixel by pixel.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void BlendImages
(
	AvlNet.Image inImage1,
	AvlNet.Image inImage2,
	float inAmount1,
	float inAmount2,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inImage1AvlNet.ImageFirst input image.
inImage2AvlNet.ImageSecond input image.
inAmount1float<-INF, INF>0.5fDefault value: 0.5f.
inAmount2float<-INF, INF>0.5fDefault value: 0.5f.
outImageAvlNet.ImageOutput image.

Description

The operation computes the weighted sum of the corresponding pixels of the input images. Note that the sum of selected weight need not to equal 1.0, but only when the sum is less or equal to 1.0 the resulting value is guaranteed to fit in the range of pixel values.

Whenever the resulting value exceeds the range of pixel values, it is clipped to the nearest proper value. 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

BlendImages performed on the sample images with inAmount1 = 0.3, inAmount2 = 0.7.

Hardware Acceleration

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

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

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

Function Overrides

See also