You are here: Start » Image » Image Point Transforms » SubtractFromImage
SubtractFromImage
Header: | AVL.h |
---|---|
Namespace: | avl |
Subtracts a scalar value from each pixel.
Syntax
void avl::SubtractFromImage ( const avl::Image& inImage, atl::Optional<const avl::Region&> inRoi, float inValue, avl::Image& outImage )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inImage | const Image& | Input image | ||
inRoi | Optional<const Region&> | NIL | Range of pixels to be processed | |
inValue | float | 50.0f | Value to be subtracted | |
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 decreases the brightness of the inImage by subtracting a fixed value from each of its pixels.
Whenever the resulting value exceeds the range of pixel values, it is clipped to the nearest proper value.
Examples
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
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Region exceeds an input image in SubtractFromImage. |
See Also
- AddToImage – Adds a scalar value to each pixel.