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

FIL.BottomHatImage_AnyKernel

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void BottomHatImage_AnyKernel
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	NullableRef<FilNet.Region> inSourceRoi,
	FilNet.Pixel? inBorderColor,
	FilNet.Region inKernel,
	FilNet.Location? inKernelAnchor,
	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.
inSourceRoiFilNet.NullableRef<FilNet.Region>Range of inImage pixels to be considered in computations. Default value: ftl::NIL.
inBorderColorFilNet.Pixel?Color of the imaginary pixels outside the image boundaries. Default value: ftl::NIL.
inKernelFilNet.RegionSelects kernel shape.
inKernelAnchorFilNet.Location?A location within inKernel, defining its center. Default value: ftl::NIL.
outImageFilNet.ImageOutput image.

Description

Extracts from image small objects that are darker than surroundings. Uses user-defined kernel.

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

Examples

Bottom Hat used to remove bigger objects. 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_AnyKernel.

Function Overrides

See also