Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Local Transforms » ErodeImage_AnyKernel

ErodeImage_AnyKernel


Header: FIL.h
Namespace: fil
Module: FoundationPro

Replaces each pixel with the minimum of pixels within an arbitrary kernel.

Syntax

C++
C#
 
void fil::ErodeImage_AnyKernel
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<const fil::Region&> inSourceRoi,
	ftl::Optional<fil::Pixel> inBorderColor,
	const fil::Region& inKernel,
	ftl::Optional<const fil::Location&> inKernelAnchor,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value
 inImage const Image& Input image
Input value
 inRoi Optional<const Region&> NIL Range of outImage pixels to be computed
Input value
 inSourceRoi Optional<const Region&> NIL Range of inImage pixels to be considered in computations
Input value
 inBorderColor Optional<Pixel> NIL Color of the imaginary pixels outside the image boundaries
Input value
 inKernel const Region& Kernel shape (any)
Input value
 inKernelAnchor Optional<const Location&> NIL A location within inKernel, defining its center
Output value
 outImage Image& Output image

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.

This operation supports processing on OpenCL compatible device (when inRoi=NIL, inSourceRoi=NIL, inBorderColor=NIL).

Errors

List of possible exceptions:

Error type Description
DomainError Empty kernel on input in ErodeImage_AnyKernel.
DomainError Region exceeds an input image in ErodeImage_AnyKernel.