BilateralFilter3d

Applies a three-dimensional edge-preserving smoothing filter.

Access to parameter description

For an introduction to image filters: see Images Filtering.

This algorithm is an edge-preserving smoothing filter. The intensity value at each voxel in an image is replaced by a weighted average of intensity values from nearby voxels. Crucially, the weights depend on the distance in color space from the considered voxel.
It preserves sharp edges by systematically excluding voxels across discontinuities from consideration:

$O(i,j,k)=\frac{1}{K(i,j,k)}\sum_{l=-\frac{n_x}{2}}^{\frac{n_x}{2}}\sum_{m=-\frac{n_y}{2}}^{\frac{n_y}{2}} \sum_{n=-\frac{n_z}{2}}^{\frac{n_z}{2}} e^{_\frac{(I(i,j,k)-I(l,m,n))^2}{h^2}} I(l,m,n)$
Where

$h$ is a weighting similarity factor and

$K$ is a local normalisation factor given by:

$K(i,j,k)=\sum_{l=-\frac{n_x}{2}}^{\frac{n_x}{2}}\sum_{m=-\frac{n_y}{2}}^{\frac{n_y}{2}} \sum_{n=-\frac{n_z}{2}}^{\frac{n_z}{2}} e^{_\frac{(I(i,j,k)-I(l,m,n))^2}{h^2}}$
The greater

$h$ is, the stronger the blur.

A filter mode parameter that allows this algorithm to switch to the SUSAN filter (Smallest Univalue Segment Assimilating Nucleus).
The SUSAN filter reproduces bilateral filter behavior simply by excluding the central voxel from computation. This filter gives better results in the case of impulse noise.

Reference:
C.Tomasi, R.Manduchi. "Bilateral Filtering for Gray and Color Images". Sixth International Conference on Computer Vision (IEEE Cat. No.98CH36271), Bombay, India, pp. 839-846, 1998.

See also

See related example

PoreAnalysis

Function Syntax

This function returns outputImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
bilateralFilter3d( std::shared_ptr< iolink::ImageView > inputImage,
                   int32_t kernelSizeX,
                   int32_t kernelSizeY,
                   int32_t kernelSizeZ,
                   double similarity,
                   BilateralFilter3d::FilterMode filterMode,
                   std::shared_ptr< iolink::ImageView > outputImage = NULL );

This function returns outputImage.

// Function prototype.
bilateral_filter_3d( input_image,
                     kernel_size_x = 3,
                     kernel_size_y = 3,
                     kernel_size_z = 3,
                     similarity = 20,
                     filter_mode = BilateralFilter3d.FilterMode.BILATERAL,
                     output_image = None )

This function returns outputImage.

// Function prototype.
public static IOLink.ImageView
BilateralFilter3d( IOLink.ImageView inputImage,
                   Int32 kernelSizeX = 3,
                   Int32 kernelSizeY = 3,
                   Int32 kernelSizeZ = 3,
                   double similarity = 20,
                   BilateralFilter3d.FilterMode filterMode = ImageDev.BilateralFilter3d.FilterMode.BILATERAL,
                   IOLink.ImageView outputImage = null );

Class Syntax

// Command constructor.
BilateralFilter3d();

/// 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 kernelSizeX parameter.
/// The horizontal kernel size in voxels (odd value).
int32_t kernelSizeX() const;
/// Sets the kernelSizeX parameter.
/// The horizontal kernel size in voxels (odd value).
void setKernelSizeX( const int32_t& kernelSizeX );

/// Gets the kernelSizeY parameter.
/// The vertical kernel size in voxels (odd value).
int32_t kernelSizeY() const;
/// Sets the kernelSizeY parameter.
/// The vertical kernel size in voxels (odd value).
void setKernelSizeY( const int32_t& kernelSizeY );

/// Gets the kernelSizeZ parameter.
/// The depth kernel size in voxels (odd value).
int32_t kernelSizeZ() const;
/// Sets the kernelSizeZ parameter.
/// The depth kernel size in voxels (odd value).
void setKernelSizeZ( const int32_t& kernelSizeZ );

/// Gets the similarity parameter.
/// The weighting similarity factor (must be a positive value).
double similarity() const;
/// Sets the similarity parameter.
/// The weighting similarity factor (must be a positive value).
void setSimilarity( const double& similarity );

/// Gets the filterMode parameter.
/// The way to consider the central pixel.
BilateralFilter3d::FilterMode filterMode() const;
/// Sets the filterMode parameter.
/// The way to consider the central pixel.
void setFilterMode( const BilateralFilter3d::FilterMode& filterMode );

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


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

# Property of the inputImage parameter.
BilateralFilter3d.input_image
# Property of the kernelSizeX parameter.
BilateralFilter3d.kernel_size_x
# Property of the kernelSizeY parameter.
BilateralFilter3d.kernel_size_y
# Property of the kernelSizeZ parameter.
BilateralFilter3d.kernel_size_z
# Property of the similarity parameter.
BilateralFilter3d.similarity
# Property of the filterMode parameter.
BilateralFilter3d.filter_mode
# Property of the outputImage parameter.
BilateralFilter3d.output_image

// Method to launch the command.
execute()

// Command constructor.
BilateralFilter3d()

// Property of the inputImage parameter.
BilateralFilter3d.inputImage
// Property of the kernelSizeX parameter.
BilateralFilter3d.kernelSizeX
// Property of the kernelSizeY parameter.
BilateralFilter3d.kernelSizeY
// Property of the kernelSizeZ parameter.
BilateralFilter3d.kernelSizeZ
// Property of the similarity parameter.
BilateralFilter3d.similarity
// Property of the filterMode parameter.
BilateralFilter3d.filterMode
// Property of the outputImage parameter.
BilateralFilter3d.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

kernelSizeX

The horizontal kernel size in voxels (odd value).

Int32

[3, 100]

kernelSizeY

The vertical kernel size in voxels (odd value).

Int32

[3, 100]

kernelSizeZ

The depth kernel size in voxels (odd value).

Int32

[3, 100]

similarity

The weighting similarity factor (must be a positive value).

Float64

filterMode

The way to consider the central pixel.

BILATERAL	This mode corresponds to the standard bilateral filter (uses the central point).
SUSAN	This mode corresponds to the SUSAN filter (does not use the central point).

Enumeration

BILATERAL

outputImage

The output image. Its dimensions, type, and calibration are forced to the same values as the input.

Image

nullptr

Object Examples

auto foam = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "foam.vip" );

BilateralFilter3d bilateralFilter3dAlgo;
bilateralFilter3dAlgo.setInputImage( foam );
bilateralFilter3dAlgo.setKernelSizeX( 3 );
bilateralFilter3dAlgo.setKernelSizeY( 3 );
bilateralFilter3dAlgo.setKernelSizeZ( 3 );
bilateralFilter3dAlgo.setSimilarity( 20.0 );
bilateralFilter3dAlgo.setFilterMode( BilateralFilter3d::FilterMode::BILATERAL );
bilateralFilter3dAlgo.execute();

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

foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

bilateral_filter_3d_algo = imagedev.BilateralFilter3d()
bilateral_filter_3d_algo.input_image = foam
bilateral_filter_3d_algo.kernel_size_x = 3
bilateral_filter_3d_algo.kernel_size_y = 3
bilateral_filter_3d_algo.kernel_size_z = 3
bilateral_filter_3d_algo.similarity = 20.0
bilateral_filter_3d_algo.filter_mode = imagedev.BilateralFilter3d.BILATERAL
bilateral_filter_3d_algo.execute()

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

ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

BilateralFilter3d bilateralFilter3dAlgo = new BilateralFilter3d
{
    inputImage = foam,
    kernelSizeX = 3,
    kernelSizeY = 3,
    kernelSizeZ = 3,
    similarity = 20.0,
    filterMode = BilateralFilter3d.FilterMode.BILATERAL
};
bilateralFilter3dAlgo.Execute();

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

Function Examples

auto foam = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "foam.vip" );

auto result = bilateralFilter3d( foam, 3, 3, 3, 20.0, BilateralFilter3d::FilterMode::BILATERAL );

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

foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

result = imagedev.bilateral_filter_3d( foam, 3, 3, 3, 20.0, imagedev.BilateralFilter3d.BILATERAL )

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

ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

IOLink.ImageView result = Processing.BilateralFilter3d( foam, 3, 3, 3, 20.0, BilateralFilter3d.FilterMode.BILATERAL );

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

BilateralFilter3d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax