You are here: Start » AVL.NET » Function Reference » Image » Image Point Transforms » AVL.SubtractFromImage

AVL.SubtractFromImage

Subtracts a scalar value from each pixel.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SubtractFromImage
(
	AvlNet.Image inImage,
	NullableRef<AvlNet.Region> inRoi,
	float inValue,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageAvlNet.ImageInput image.
inRoiAvlNet.NullableRef<AvlNet.Region>Range of pixels to be processed. Default value: atl::NIL.
inValuefloat50.0fValue to be subtracted. Default value: 50.0f.
outImageAvlNet.ImageOutput image.

Description

The operation decreases the brightness of the inImage by subtracting a fixed value from each of its pixels.

\forall_{i,j} \text{\textbf{OutImage} }_{i,j} = \text{\textbf{InImage} }_{i,j} - \text{\textbf{inValue} }

Whenever the resulting value exceeds the range of pixel values, it is clipped to the nearest proper value.

Examples

The SubtractFromImage performed on the sample image with inValue = 50.0.

Hardware Acceleration

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

This operation is optimized for NEON technology for pixels of types: UINT8, SINT8, UINT16, SINT16, SINT32, 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 Region exceeds an input image in SubtractFromImage.

Function Overrides

See also