Despeckle3d

Smooths a three-dimensional image by replacing any aberrant voxel values by their neighbors mean value.

Access to parameter description

For an introduction to image filters: see Images Filtering.

For each voxel of the input image, mean

$\mu$ and standard deviation

$\sigma$ values of a rectangular neighbor window are computed.
The output image value is then given by:

$O(i,j,k)=\left\{\begin{array}{ll} \mu(i,j,k) & ~ \mbox{if} ~ \lambda \times |I(i,j,k)-\mu(i,j,k)| > \sigma(i,j,k)\\ I(i,j,k) & ~ \mbox{otherwise} \end{array}\right.$
Where

$\lambda$ is a user-defined threshold factor on the distance of the current voxel gray level to the mean of its neighbors, relative to their standard deviation.
The greater

$\lambda$ is, the stronger the blur.

This filter gives good results in the case of impulse noise.

See also

Function Syntax

This function returns outputImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
despeckle3d( std::shared_ptr< iolink::ImageView > inputImage,
             int32_t kernelSizeX,
             int32_t kernelSizeY,
             int32_t kernelSizeZ,
             double thresholdFactor,
             std::shared_ptr< iolink::ImageView > outputImage = NULL );

This function returns outputImage.

// Function prototype.
despeckle_3d( input_image,
              kernel_size_x = 3,
              kernel_size_y = 3,
              kernel_size_z = 3,
              threshold_factor = 1,
              output_image = None )

This function returns outputImage.

// Function prototype.
public static IOLink.ImageView
Despeckle3d( IOLink.ImageView inputImage,
             Int32 kernelSizeX = 3,
             Int32 kernelSizeY = 3,
             Int32 kernelSizeZ = 3,
             double thresholdFactor = 1,
             IOLink.ImageView outputImage = null );

Class Syntax

// Command constructor.
Despeckle3d();

/// 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 thresholdFactor parameter.
/// The standard deviation threshold factor (must be a positive value).
double thresholdFactor() const;
/// Sets the thresholdFactor parameter.
/// The standard deviation threshold factor (must be a positive value).
void setThresholdFactor( const double& thresholdFactor );

/// 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.
Despeckle3d.input_image
# Property of the kernelSizeX parameter.
Despeckle3d.kernel_size_x
# Property of the kernelSizeY parameter.
Despeckle3d.kernel_size_y
# Property of the kernelSizeZ parameter.
Despeckle3d.kernel_size_z
# Property of the thresholdFactor parameter.
Despeckle3d.threshold_factor
# Property of the outputImage parameter.
Despeckle3d.output_image

// Method to launch the command.
execute()

// Command constructor.
Despeckle3d()

// Property of the inputImage parameter.
Despeckle3d.inputImage
// Property of the kernelSizeX parameter.
Despeckle3d.kernelSizeX
// Property of the kernelSizeY parameter.
Despeckle3d.kernelSizeY
// Property of the kernelSizeZ parameter.
Despeckle3d.kernelSizeZ
// Property of the thresholdFactor parameter.
Despeckle3d.thresholdFactor
// Property of the outputImage parameter.
Despeckle3d.outputImage

// Method to launch the command.
Execute()

Parameters

	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]	3
kernelSizeY	The vertical kernel size in voxels (odd value).	Int32	[3, 100]	3
kernelSizeZ	The depth kernel size in voxels (odd value).	Int32	[3, 100]	3
thresholdFactor	The standard deviation threshold factor (must be a positive value).	Float64	>0	1
outputImage	The output image. Its dimensions, type, and calibration are forced to the same values as the input.	Image		nullptr

Description	Type	Supported Values	Default Value
input_image	The input image.	image	Binary, Label, Grayscale or Multispectral	None
kernel_size_x	The horizontal kernel size in voxels (odd value).	int32	[3, 100]	3
kernel_size_y	The vertical kernel size in voxels (odd value).	int32	[3, 100]	3
kernel_size_z	The depth kernel size in voxels (odd value).	int32	[3, 100]	3
threshold_factor	The standard deviation threshold factor (must be a positive value).	float64	>0	1
output_image	The output image. Its dimensions, type, and calibration are forced to the same values as the input.	image		None

Description	Type	Supported Values	Default Value
inputImage	The input image.	Image	Binary, Label, Grayscale or Multispectral	null
kernelSizeX	The horizontal kernel size in voxels (odd value).	Int32	[3, 100]	3
kernelSizeY	The vertical kernel size in voxels (odd value).	Int32	[3, 100]	3
kernelSizeZ	The depth kernel size in voxels (odd value).	Int32	[3, 100]	3
thresholdFactor	The standard deviation threshold factor (must be a positive value).	Float64	>0	1
outputImage	The output image. Its dimensions, type, and calibration are forced to the same values as the input.	Image		null

Object Examples

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

Despeckle3d despeckle3dAlgo;
despeckle3dAlgo.setInputImage( foam );
despeckle3dAlgo.setKernelSizeX( 3 );
despeckle3dAlgo.setKernelSizeY( 3 );
despeckle3dAlgo.setKernelSizeZ( 3 );
despeckle3dAlgo.setThresholdFactor( 1.0 );
despeckle3dAlgo.execute();

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

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

despeckle_3d_algo = imagedev.Despeckle3d()
despeckle_3d_algo.input_image = foam
despeckle_3d_algo.kernel_size_x = 3
despeckle_3d_algo.kernel_size_y = 3
despeckle_3d_algo.kernel_size_z = 3
despeckle_3d_algo.threshold_factor = 1.0
despeckle_3d_algo.execute()

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

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

Despeckle3d despeckle3dAlgo = new Despeckle3d
{
    inputImage = foam,
    kernelSizeX = 3,
    kernelSizeY = 3,
    kernelSizeZ = 3,
    thresholdFactor = 1.0
};
despeckle3dAlgo.Execute();

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

Function Examples

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

auto result = despeckle3d( foam, 3, 3, 3, 1.0 );

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

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

result = imagedev.despeckle_3d( foam, 3, 3, 3, 1.0 )

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

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

IOLink.ImageView result = Processing.Despeckle3d( foam, 3, 3, 3, 1.0 );

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

Despeckle3d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax