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

SmoothImage_Mean_AnyKernel

Header:	FIL.h
Namespace:	fil
Module:	FoundationPro

Smooths an image by averaging pixels within an arbitrary kernel.

Applications: Usually used for computing features related to local image "windows" having non-standard shape.

Syntax

void fil::SmoothImage_Mean_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
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of outImage pixels to be computed
inSourceRoi	Optional<const Region&>	NIL	Range of inImage pixels to be considered in computations
inBorderColor	Optional<Pixel>	NIL	Color of the imaginary pixels outside the image boundaries
inKernel	const Region&		Kernel shape (any)
inKernelAnchor	Optional<const Location&>	NIL	A location within inKernel, defining its center
outImage	Image&		Output image

Hints

Define the kernel shape by setting the inKernel input.
Define the kernel center point by setting the inKernelAnchor input. If you leave it NIL, the mass center will be used.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions: