Back to Adaptive Vision Library website

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

SmoothImage_Mean_AnyKernel


Header: AVL.h
Namespace: avl
Module: FoundationPro

Smooths an image by averaging pixels within an arbitrary kernel.

Syntax

C++
C#
 
void avl::SmoothImage_Mean_AnyKernel
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	atl::Optional<const avl::Region&> inSourceRoi,
	atl::Optional<avl::Pixel> inBorderColor,
	const avl::Region& inKernel,
	atl::Optional<const avl::Location&> inKernelAnchor,
	avl::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:

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

See Also

  • SmoothImage_Mean – Smooths an image by averaging pixels within a rectangular kernel.