MeanFilter2d

Computes, for each pixel of a two-dimensional image, the mean value of its neighborhood.

Access to parameter description

For an introduction:

section Images Filtering.
section First Order Statistics Filters.

This algorithm replaces each pixel of the output image by the mean value of its neighborhood in the input image. The mean operator is given by:

$mean=m=\sum_{n}n\cdot p(n)$ The shape of the neighborhood can be:

A square with a half side length defined by the kernelRadius parameter,
A disk with a radius defined by the kernelRadius parameter.

See also

Function Syntax

This function returns outputImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
meanFilter2d( std::shared_ptr< iolink::ImageView > inputImage,
              MeanFilter2d::KernelShape kernelShape,
              uint32_t kernelRadius,
              std::shared_ptr< iolink::ImageView > outputImage = NULL );

This function returns outputImage.

// Function prototype.
mean_filter_2d( input_image,
                kernel_shape = MeanFilter2d.KernelShape.DISK,
                kernel_radius = 3,
                output_image = None )

This function returns outputImage.

// Function prototype.
public static IOLink.ImageView
MeanFilter2d( IOLink.ImageView inputImage,
              MeanFilter2d.KernelShape kernelShape = ImageDev.MeanFilter2d.KernelShape.DISK,
              UInt32 kernelRadius = 3,
              IOLink.ImageView outputImage = null );

Class Syntax

// Command constructor.
MeanFilter2d();

/// Gets the inputImage parameter.
/// The input image.
std::shared_ptr< iolink::ImageView > inputImage() const;
/// Sets the inputImage parameter.
/// The input image.
void setInputImage( std::shared_ptr< iolink::ImageView > inputImage );

/// Gets the kernelShape parameter.
/// The shape of the window defining the neighborhood.
MeanFilter2d::KernelShape kernelShape() const;
/// Sets the kernelShape parameter.
/// The shape of the window defining the neighborhood.
void setKernelShape( const MeanFilter2d::KernelShape& kernelShape );

/// Gets the kernelRadius parameter.
/// The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter.
uint32_t kernelRadius() const;
/// Sets the kernelRadius parameter.
/// The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter.
void setKernelRadius( const uint32_t& kernelRadius );

/// Gets the outputImage parameter.
/// The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point.
std::shared_ptr< iolink::ImageView > outputImage() const;
/// Sets the outputImage parameter.
/// The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point.
void setOutputImage( std::shared_ptr< iolink::ImageView > outputImage );


// Method to launch the command.
void execute();

# Property of the inputImage parameter.
MeanFilter2d.input_image
# Property of the kernelShape parameter.
MeanFilter2d.kernel_shape
# Property of the kernelRadius parameter.
MeanFilter2d.kernel_radius
# Property of the outputImage parameter.
MeanFilter2d.output_image

// Method to launch the command.
execute()

// Command constructor.
MeanFilter2d()

// Property of the inputImage parameter.
MeanFilter2d.inputImage
// Property of the kernelShape parameter.
MeanFilter2d.kernelShape
// Property of the kernelRadius parameter.
MeanFilter2d.kernelRadius
// Property of the outputImage parameter.
MeanFilter2d.outputImage

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

inputImage

The input image.

Image

Binary, Label, Grayscale or Multispectral

nullptr

kernelRadius

The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter.

UInt32

>=1

kernelShape

The shape of the window defining the neighborhood.

SQUARE	The sliding window is a square.
DISK	The sliding window is a disk.

Enumeration

DISK

outputImage

The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point.

Image

nullptr

Object Examples

std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

MeanFilter2d meanFilter2dAlgo;
meanFilter2dAlgo.setInputImage( polystyrene );
meanFilter2dAlgo.setKernelShape( MeanFilter2d::KernelShape::SQUARE );
meanFilter2dAlgo.setKernelRadius( 3 );
meanFilter2dAlgo.execute();

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

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

mean_filter_2d_algo = imagedev.MeanFilter2d()
mean_filter_2d_algo.input_image = polystyrene
mean_filter_2d_algo.kernel_shape = imagedev.MeanFilter2d.SQUARE
mean_filter_2d_algo.kernel_radius = 3
mean_filter_2d_algo.execute()

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

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

MeanFilter2d meanFilter2dAlgo = new MeanFilter2d
{
    inputImage = polystyrene,
    kernelShape = MeanFilter2d.KernelShape.SQUARE,
    kernelRadius = 3
};
meanFilter2dAlgo.Execute();

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

Function Examples

std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

auto result = meanFilter2d( polystyrene, MeanFilter2d::KernelShape::SQUARE, 3 );

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

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

result = imagedev.mean_filter_2d( polystyrene, imagedev.MeanFilter2d.SQUARE, 3 )

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

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

IOLink.ImageView result = Processing.MeanFilter2d( polystyrene, MeanFilter2d.KernelShape.SQUARE, 3 );

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

MeanFilter2d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax