ImageDev

CudaMedianFilter2d

Applies a median operator, which is a non-linear smoothing filter, on a two-dimensional image. The calculations are performed on the GPU.

Access to parameter description

This command is experimental, his signature may be modified between now and his final version.

 For an introduction to image filters: section Images Filtering.

This algorithm uses morphological operators to set the pixel value to the median for the defined neighborhood. This filter is particularly effective for removing speckle noise and salt and pepper noise (impulsive noise) without affecting edges.
The median filter usually works well with images containing non-Gaussian noise and/or very small artifacts. It does not cause blurring to the same extent as the Box Filter, but takes longer to execute.

The gray levels of all pixels of the considered neighborhood are sorted from the smallest value to the largest one. The central pixel in the sort is then the median value (the value for which there are as many lower gray levels as higher ones). The process can be iterated.

Considering the array: $$ \begin{bmatrix} 12 & 17 & 15 \\ 20 & 14 & 16 \\ 18 & 19 & 14 \end{bmatrix} $$ The sorted gray level values are: [12 14 14 15 16 17 18 19 20]. The median value is 16, and it is assigned to the output pixel.

See also

Function Syntax

This function returns outputImage. 
// Function prototype
std::shared_ptr< iolink::ImageView >
cudaMedianFilter2d( std::shared_ptr< iolink::ImageView > inputImage,
                    uint32_t kernelRadius,
                    CudaMedianFilter2d::TilingMode tilingMode,
                    iolink::Vector2u32 tileSize,
                    CudaContext::Ptr cudaContext,
                    std::shared_ptr< iolink::ImageView > outputImage = nullptr );
This function returns outputImage. 
// Function prototype.
cuda_median_filter_2d(input_image: idt.ImageType,
                      kernel_radius: int = 3,
                      tiling_mode: CudaMedianFilter2d.TilingMode = CudaMedianFilter2d.TilingMode.NONE,
                      tile_size: Iterable[int] = [1024, 1024],
                      cuda_context: Union[CudaContext, None] = None,
                      output_image: idt.ImageType = None) -> idt.ImageType
This function returns outputImage. 
// Function prototype.
public static IOLink.ImageView
CudaMedianFilter2d( IOLink.ImageView inputImage,
                    UInt32 kernelRadius = 3,
                    CudaMedianFilter2d.TilingMode tilingMode = ImageDev.CudaMedianFilter2d.TilingMode.NONE,
                    uint[] tileSize = null,
                    Data.CudaContext cudaContext = null,
                    IOLink.ImageView outputImage = null );

Class Syntax

Parameters

Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. Image Binary, Label, Grayscale or Multispectral nullptr
input
kernelRadius
The half size of the structuring element. A square structuring element always has an odd side length (3x3, 5x5, etc.) which is defined by twice the kernel radius + 1. UInt32 [1, 6] 3
input
tilingMode
The way to manage the GPU memory.
NONE The entire input image is transferred to the GPU memory. If the total input, intermediate and output data size exceed the GPU memory, the computation will fail.
USER_DEFINED The input image is processed by tiles of a predefined size.
Enumeration NONE
input
tileSize
The tile width and height in pixels. This parameter is used only in USER_DEFINED tiling mode. Vector2u32 >=1 {1024, 1024}
input
cudaContext
CUDA context information. CudaContext nullptr
output
outputImage
The output image. Its dimensions and type are forced to the same values as the input. Image nullptr
Parameter Name Description Type Supported Values Default Value
input
input_image
The input image. image Binary, Label, Grayscale or Multispectral None
input
kernel_radius
The half size of the structuring element. A square structuring element always has an odd side length (3x3, 5x5, etc.) which is defined by twice the kernel radius + 1. uint32 [1, 6] 3
input
tiling_mode
The way to manage the GPU memory.
NONE The entire input image is transferred to the GPU memory. If the total input, intermediate and output data size exceed the GPU memory, the computation will fail.
USER_DEFINED The input image is processed by tiles of a predefined size.
enumeration NONE
input
tile_size
The tile width and height in pixels. This parameter is used only in USER_DEFINED tiling mode. vector2u32 >=1 [1024, 1024]
input
cuda_context
CUDA context information. cuda_context None
output
output_image
The output image. Its dimensions and type are forced to the same values as the input. image None
Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. Image Binary, Label, Grayscale or Multispectral null
input
kernelRadius
The half size of the structuring element. A square structuring element always has an odd side length (3x3, 5x5, etc.) which is defined by twice the kernel radius + 1. UInt32 [1, 6] 3
input
tilingMode
The way to manage the GPU memory.
NONE The entire input image is transferred to the GPU memory. If the total input, intermediate and output data size exceed the GPU memory, the computation will fail.
USER_DEFINED The input image is processed by tiles of a predefined size.
Enumeration NONE
input
tileSize
The tile width and height in pixels. This parameter is used only in USER_DEFINED tiling mode. Vector2u32 >=1 {1024, 1024}
input
cudaContext
CUDA context information. CudaContext null
output
outputImage
The output image. Its dimensions and type are forced to the same values as the input. Image null

Object Examples

auto polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

CudaMedianFilter2d cudaMedianFilter2dAlgo;
cudaMedianFilter2dAlgo.setInputImage( polystyrene );
cudaMedianFilter2dAlgo.setKernelRadius( 3 );
cudaMedianFilter2dAlgo.setTilingMode( CudaMedianFilter2d::TilingMode::NONE );
cudaMedianFilter2dAlgo.setTileSize( {264, 264} );
cudaMedianFilter2dAlgo.setCudaContext( nullptr );
cudaMedianFilter2dAlgo.setOutputImage( iolink::ImageViewFactory::allocate( iolink::VectorXu64( { 1, 1 } ), iolink::DataTypeId::UINT8 ) );
cudaMedianFilter2dAlgo.execute();

std::cout << "outputImage:" << cudaMedianFilter2dAlgo.outputImage()->toString();

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

cuda_median_filter_2d_algo = imagedev.CudaMedianFilter2d()
cuda_median_filter_2d_algo.input_image = polystyrene
cuda_median_filter_2d_algo.kernel_radius = 3
cuda_median_filter_2d_algo.tiling_mode = imagedev.CudaMedianFilter2d.NONE
cuda_median_filter_2d_algo.tile_size = [264, 264]
cuda_median_filter_2d_algo.cuda_context = None
cuda_median_filter_2d_algo.execute()

print("output_image:", str(cuda_median_filter_2d_algo.output_image))

ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

CudaMedianFilter2d cudaMedianFilter2dAlgo = new CudaMedianFilter2d
{
    inputImage = polystyrene,
    kernelRadius = 3,
    tilingMode = CudaMedianFilter2d.TilingMode.NONE,
    tileSize = new uint[]{264, 264},
    cudaContext = null
};
cudaMedianFilter2dAlgo.Execute();

Console.WriteLine( "outputImage:" + cudaMedianFilter2dAlgo.outputImage.ToString() );

Function Examples

auto polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

auto result = cudaMedianFilter2d( polystyrene, 3, CudaMedianFilter2d::TilingMode::NONE, {264, 264}, nullptr , iolink::ImageViewFactory::allocate( iolink::VectorXu64( { 1, 1 } ), iolink::DataTypeId::UINT8 ));

std::cout << "outputImage:" << result->toString();

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

result = imagedev.cuda_median_filter_2d(polystyrene, 3, imagedev.CudaMedianFilter2d.NONE, [264, 264], None)

print("output_image:", str(result))

ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

IOLink.ImageView result = Processing.CudaMedianFilter2d( polystyrene, 3, CudaMedianFilter2d.TilingMode.NONE, new uint[]{264, 264}, null );

Console.WriteLine( "outputImage:" + result.ToString() );