You are here: Start » FIL.NET » Function Reference » Image » Image Local Transforms » FIL.BottomHatImage_Mask

FIL.BottomHatImage_Mask

Performs a morphological black top hat (bottom hat) operation on a image using a predefined mask.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void BottomHatImage_Mask
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	FilNet.Pixel? inBorderColor,
	FilNet.MorphologyKernel inKernel,
	FilNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.NullableRef<FilNet.Region>Range of outImage pixels to be computed. Default value: ftl::NIL.
inBorderColorFilNet.Pixel?Color of the imaginary pixels outside the image boundaries. Default value: ftl::NIL.
inKernelFilNet.MorphologyKernelSelects kernel shape.
outImageFilNet.ImageOutput image.

Description

Extracts from image small objects that are darker than surroundings. Uses predefined mask.

Is performed by running consecutively two filters. CloseImage_Mask to get the image without small objects and SubtractFromImage to remove everything but them.

Examples

Bottom Hat used to remove bigger objects. Used parameters inKernel=Box5x5. Source image on the left and result on the right.

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.

Hardware acceleration settings may be manipulated with Settings class.

Errors

List of possible exceptions:

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

Function Overrides

See also