Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Local Transforms » SmoothImage_Median

SmoothImage_Median

Basic

Module: FoundationLite

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

Applications

Edge-preserving noise removal (but slow).
Name Type Range Description
Input value inImage Image Input image
Input value inRoi Region* Range of outImage pixels being written
Input value inSourceRoi Region* Range of inImage pixels being read
Input value inKernel SmoothImageMedianKernel
Input value inRadiusX Integer 0 - Nearly half of the kernel's width (2*R+1)
Input value inRadiusY Integer* 0 - Nearly half of the kernel's height (2*R+1), or same as inRadiusX
Output value 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 inRadiusX and inRadiusY inputs.
  • For small kernels consider switching to SmoothImage_Median_Mask to achieve higher performance.

Examples

SmoothImage_Median performed on a sample image with inRadiusX = 4, inRadiusY = Nil.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Not supported kernel in SmoothImage_Median.
DomainError Not supported pixel format in SmoothImage_Median.
DomainError Region exceeds an input image in SmoothImage_Median.
DomainError Source roi exceeds an input image in SmoothImage_Median.
DomainError Not supported inImage pixel format in SmoothImage_Median. Supported formats: UInt8.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of SmoothImage filter group.