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

FIL.BottomHatImage

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void BottomHatImage
(
	FilNet.Image inImage,
	FilNet.KernelShape inKernel,
	int inRadiusX,
	FilNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inKernelFilNet.KernelShapeSelects kernel shape.
inRadiusXint<0, INF>1Nearly half of the kernel's width (2*R+1). Default value: 1.
outImageFilNet.ImageOutput image.

Description

Extracts from image small objects that are darker than surroundings.

Is performed by running consecutively two filters. CloseImage 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=Ellipse and inRadiusX=6. 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.

Function Overrides

See also