Back to Adaptive Vision Library Lite website

You are here: Start » Image Local Transforms » SmoothImage_Median

SmoothImage_Median


Replaces each pixel with the median of pixels within a kernel.

Syntax

void avl::SmoothImage_Median
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	atl::Optional<const avl::Region&> inSourceRoi,
	avl::SmoothImageMedianKernel::Type inKernel,
	int inRadius,
	avl::Image& outImage
)

Parameters

Name Type Range Default Description
inImage const Image& Input image
inRoi Optional<const Region&> NIL Range of outImage pixels being written
inSourceRoi Optional<const Region&> NIL Range of inImage pixels being read
inKernel SmoothImageMedianKernel::Type
inRadius int 0 - 1 Nearly half of the kernel's size (2*R+1)
outImage Image& Output image

Requirements

For input inImage only pixel formats are supported: uint8.

Read more about pixel formats in Image documentation.

Hints

  • Define the kernel size by setting the inRadius input.

Examples

SmoothImage_Median performed on a sample image with inRadius = 4.

Errors

Error type Description
DomainError inRoi exceeds image dimensions in SmoothImage_Median.
DomainError inSourceRoi exceeds image dimensions in SmoothImage_Median.
DomainError Not supported pixel format in SmoothImage_Median.
DomainError Not supported kernel in SmoothImage_Median.