Back to Aurora Vision Library website

You are here: Start » Function Reference » Image » Image Point Transforms » SquareImage

SquareImage


Header: AVL.h
Namespace: avl
Module: FoundationLite

Raises pixel values to the second power pixel by pixel.

Syntax

C++
C#
 
void avl::SquareImage
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& 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 inImage and outImage

Read more about In-place Computation.

Description

The operation increases the brightness of an image by squaring each pixel value. Whenever the resulting value exceeds the range of pixel values, it is clipped to the nearest proper value. Note that the absolute change of pixel brightness is usually very big.

Examples

The SquareImage performed on the sample image.

Hardware Acceleration

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

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Region exceeds an input image in SquareImage.

See Also

  • SquareRootImage – Transforms pixel values to their square roots pixel by pixel.