Start » Filter Reference » Image » Image Point Transforms » SubtractFromImage

SubtractFromImage

Advanced

Module: FoundationLite

Subtracts a scalar value from each pixel.

Name Type Description
Input value
 inImage Image Input image
Input value
 inRoi Region* Range of pixels to be processed
Input value
 inValue Real Value to be subtracted
Output value
 outImage Image Output 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.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

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

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • AddToImage – Adds a scalar value to each pixel.