Back to Aurora Vision Library Lite website

You are here: Start » Image » Image Combinators » MaximumImage

MaximumImage


Header: AVL.h
Namespace: avl

Creates an image from the higher pixel values of each corresponding pair.

Syntax

void avl::MaximumImage
(
	const avl::Image& inImage1,
	const avl::Image& inImage2,
	atl::Optional<const avl::Region&> inRoi,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage1 const Image& First input image
Input value inImage2 const Image& Second input image
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Output value outImage Image& Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage1 and outImage, inImage2 and outImage

Read more about In-place Computation.

Description

The operation computes the maximum of two images. Each outImage pixel is equal to the brighter 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

MaximumImage performed on the sample images.

Hardware Acceleration

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

This operation is optimized for SSE4.1 technology for pixels of types: SINT8, UINT16, SINT32.

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

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

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Image formats are not the same in MaximumImage.
DomainError Image sizes are not equal in MaximumImage.
DomainError Region exceeds an input image in MaximumImage.

See Also

  • MinimumImage – Creates an image from the lower pixel values of each corresponding pair.