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

FIL.TopHatImage

Performs a morphological white top hat operation on a image using a predefined kernel.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void TopHatImage
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	NullableRef<FilNet.Region> inSourceRoi,
	FilNet.Pixel? inBorderColor,
	FilNet.KernelShape inKernel,
	int inRadiusX,
	int? inRadiusY,
	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.KernelShapeKernel shape.
inRadiusXint<0, INF>1Nearly half of the kernel's width (2*R+1). Default value: 1.
inRadiusYint?<0, INF>Nearly half of the kernel's height (2*R+1), or same as inRadiusX. Default value: ftl::NIL.
outImageFilNet.ImageOutput image.

Description

Extracts from image small objects that are brighter than surroundings.

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

Examples

Top 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 TopHatImage.

Function Overrides

See also