Back to Aurora Vision Library website

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


Header: AVL.h
Namespace: avl
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.


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


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


  • 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.


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.