Back to FabImage Library website

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

SquareRootImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Transforms pixel values to their square roots pixel by pixel.

Syntax

C++
C#
 
void fil::SquareRootImage
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::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

Requirements

For input inImage only pixel formats are supported: uint8, uint16.

Read more about pixel formats in Image documentation.

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 decreases the brightness of an image by transforming each pixel value to its square root.

Examples

The SquareRootImage performed on the sample image.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of type: UINT8.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Not an unsigned-valued image in SquareRootImage.
DomainError Region exceeds an input image in SquareRootImage.
DomainError Not supported inImage pixel format in SquareRootImage. Supported formats: UInt8, UInt16.

See Also

  • SquareImage – Raises pixel values to the second power pixel by pixel.