IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
MedianFilter Class Reference

Public Member Functions

Image Process (Image image)
 Applies the median filter to the specified image.
 

Data Fields

uint KernelSize = 3
 

Detailed Description

Class for applying a median filter to an image.

The median filter is a non-linear, spatial filter used to reduce impulsive noise in images. It replaces each pixel with the median value of the pixels in its local neighborhood, defined by the specified kernel size. The kernel size corresponds to a square neighborhood (size x size grid) around each pixel, where the median is calculated.

This process preserves edges better than linear smoothing filters while effectively removing salt-and-pepper noise and small image artifacts. A larger kernel removes more noise but also reduces image detail.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 31 of file MedianFilter.cs.

Member Function Documentation

◆ Process()

Image Process ( Image image)
inline

Applies the median filter to the specified image.

Supported pixel formats
  • Mono8
  • Mono10
  • Mono12
  • Mono16
  • RGB8
  • RGBa8
  • BGR8
  • BGRa8
  • Coord3D_C32f
  • Coord3D_ABC32f

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Note: Processes the entire image, ignoring any specified image region.

Parameters
imageThe image to process.
Returns
The filtered image.
Exceptions
IcvNotSupportedExceptionThe pixel format is unsupported.
IcvNotPossibleExceptionThe kernel size must be an odd numbe greater than 1.
IcvOutOfRangeExceptionThe kernel size exceeds the image dimensions.
Since
IDSImaging.Peak.ICV 1.3

Definition at line 83 of file MedianFilter.cs.

Field Documentation

◆ KernelSize

uint KernelSize = 3

Default kernel size is 3 (3 × 3 neighborhood).

The size of the kernel must be an odd number greater than 1 and smaller than the image size. The kernel size defines the size of the neighborhood (in a size × size grid) used to calculate the median for each pixel.

A larger kernel removes more noise but also reduces image detail.

Since
IDSImaging.Peak.ICV 1.3

Definition at line 52 of file MedianFilter.cs.