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

CloseImage_Mask

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

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

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

Syntax

void fil::CloseImage_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
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of outImage pixels to be computed
inBorderColor	Optional<Pixel>	NIL	Color of the imaginary pixels outside the image boundaries
inKernel	MorphologyKernel::Type		Selects kernel shape
outImage	Image&		Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

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