Back to FabImage Library website

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

ClipPixels


Header: FIL.h
Namespace: fil
Module: FoundationLite

Sets pixels below the low value to the low value and above the high value to the high value.

Syntax

C++
C#
 
void fil::ClipPixels
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<float> inLowValue,
	ftl::Optional<float> inHighValue,
	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
Input value inLowValue Optional<float> 64.0f The lower threshold for the image pixel values
Input value inHighValue Optional<float> 192.0f The higher threshold for the image pixel values
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.

Hardware Acceleration

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 ClipPixels.
DomainError The low value cannot be higher than the high value in ClipPixels.