Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Local Transforms » OpenImage_Mask

OpenImage_Mask


Header: FIL.h
Namespace: fil
Module: FoundationLite

Removes small bright structures from an image (or fills in dark ones) by applying consecutive erosion and dilation.

Applications: E.g. removal of the "salt" component of salt-and-pepper noise.

Syntax

C++
C#
 
void fil::OpenImage_Mask
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<fil::Pixel> inBorderColor,
	fil::MorphologyKernel::Type inKernel,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Region&> NIL Range of outImage pixels to be computed
Input value inBorderColor Optional<Pixel> NIL Color of the imaginary pixels outside the image boundaries
Input value inKernel MorphologyKernel::Type Kernel shape
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 is optimized for SSE2 technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).

This operation is optimized for NEON technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).

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 OpenImage_Mask.
DomainError Unsupported kernel shape in OpenImage_Mask.