Back to FabImage Library website

You are here: Start » Function Reference » Region » Region Morphology » BottomHatRegion

BottomHatRegion


Header: FIL.h
Namespace: fil
Module: FoundationBasic

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

Syntax

C++
C#
 
void fil::BottomHatRegion
(
	const fil::Region& inRegion,
	fil::KernelShape::Type inKernel,
	int inRadiusX,
	ftl::Optional<int> inRadiusY,
	fil::Region& outRegion
)

Parameters

Name Type Range Default Description
Input value
 inRegion const Region& Input region
Input value
 inKernel KernelShape::Type Kernel shape (predefined)
Input value
 inRadiusX int 0 - 1 Nearly half of the kernel's width (2*R+1)
Input value
 inRadiusY Optional<int> 0 - NIL Nearly half of the kernel's height (2*R+1), or same as inRadiusX
Output value
 outRegion Region& Output region

Errors

List of possible exceptions:

Error type Description
DomainError Unsupported kernel in BottomHatRegion.