Back to Adaptive Vision Studio website

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

SmoothImage_Quantile


Module: FoundationLite

Replaces each pixel with a quantile of pixels within a kernel.

Applications

Edge-preserving noise removal (but slow).
Name Type Range Description
inImage Image Input image
inRoi Region* Range of outImage pixels being written
inSourceRoi Region* Range of inImage pixels being read
inQuantile Real 0.0 - 1.0 The quantile to be calculated for a neighbourhood of each pixel
inKernel SmoothImageMedianKernel
inRadiusX Integer 0 - Nearly half of the kernel's width (2*R+1)
inRadiusY Integer* 0 - Nearly half of the kernel's height (2*R+1), or same as inRadiusX
outImage Image Output image

Requirements

For input inImage only pixel formats are supported: uint8.

Read more about pixel formats in Image documentation.

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_Quantile.
DomainError Not supported pixel format in SmoothImage_Quantile.
DomainError Region exceeds an input image in SmoothImage_Quantile.
DomainError Source roi exceeds an input image in SmoothImage_Quantile.
DomainError Not supported inImage pixel format in SmoothImage_Quantile.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of SmoothImage filter group.