ImageDev

ErosionDisk3d

Performs a three-dimensional erosion using a structuring element matching with an oriented disk.

Access to parameter description

For an introduction: The erosion disk normal is oriented in the direction given by ($\theta$, $\varphi$) in spherical coordinates as often used in mathematics (azimuthal angle, $\theta$ and polar angle, $\varphi$). This direction is described with the following formula: $$V=\left[\begin{array}{c}; v_x\\ v_y\\ v_z\end{array}\right] = \left[\begin{array}{c}; \sin(\varphi)\cos(\theta)\\ \sin(\varphi)\sin(\theta)\\ \cos(\varphi)\end{array}\right]$$ This direction can be illustrated on the unit sphere:

<b> Figure 1.</b> Azimuthal and polar angles on the unit sphere
Figure 1. Azimuthal and polar angles on the unit sphere


See also

Function Syntax

This function returns outputImage.
// Function prototype
std::shared_ptr< iolink::ImageView > erosionDisk3d( std::shared_ptr< iolink::ImageView > inputImage, double thetaAngle, double phiAngle, uint32_t kernelRadius, std::shared_ptr< iolink::ImageView > outputImage = NULL );
This function returns outputImage.
// Function prototype.
erosion_disk_3d( input_image,
                 theta_angle = 0,
                 phi_angle = 0,
                 kernel_radius = 3,
                 output_image = None )
This function returns outputImage.
// Function prototype.
public static IOLink.ImageView
ErosionDisk3d( IOLink.ImageView inputImage,
               double thetaAngle = 0,
               double phiAngle = 0,
               UInt32 kernelRadius = 3,
               IOLink.ImageView outputImage = null );

Class Syntax

Parameters

Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. The image type can be integer or float. Image Binary, Label, Grayscale or Multispectral nullptr
input
thetaAngle
The azimuthal angle in degrees. Float64 Any value 0
input
phiAngle
The polar angle in degrees. Float64 Any value 0
input
kernelRadius
The length of the disk radius in voxels. UInt32 >=1 3
output
outputImage
The output image. Its dimensions and type are forced to the same values as the input image. Image nullptr
Parameter Name Description Type Supported Values Default Value
input
input_image
The input image. The image type can be integer or float. image Binary, Label, Grayscale or Multispectral None
input
theta_angle
The azimuthal angle in degrees. float64 Any value 0
input
phi_angle
The polar angle in degrees. float64 Any value 0
input
kernel_radius
The length of the disk radius in voxels. uint32 >=1 3
output
output_image
The output image. Its dimensions and type are forced to the same values as the input image. image None
Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. The image type can be integer or float. Image Binary, Label, Grayscale or Multispectral null
input
thetaAngle
The azimuthal angle in degrees. Float64 Any value 0
input
phiAngle
The polar angle in degrees. Float64 Any value 0
input
kernelRadius
The length of the disk radius in voxels. UInt32 >=1 3
output
outputImage
The output image. Its dimensions and type are forced to the same values as the input image. Image null

Object Examples

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

ErosionDisk3d erosionDisk3dAlgo;
erosionDisk3dAlgo.setInputImage( foam );
erosionDisk3dAlgo.setThetaAngle( 0 );
erosionDisk3dAlgo.setPhiAngle( 0 );
erosionDisk3dAlgo.setKernelRadius( 3 );
erosionDisk3dAlgo.execute();

std::cout << "outputImage:" << erosionDisk3dAlgo.outputImage()->toString();
foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

erosion_disk_3d_algo = imagedev.ErosionDisk3d()
erosion_disk_3d_algo.input_image = foam
erosion_disk_3d_algo.theta_angle = 0
erosion_disk_3d_algo.phi_angle = 0
erosion_disk_3d_algo.kernel_radius = 3
erosion_disk_3d_algo.execute()

print( "output_image:", str( erosion_disk_3d_algo.output_image ) )
ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

ErosionDisk3d erosionDisk3dAlgo = new ErosionDisk3d
{
    inputImage = foam,
    thetaAngle = 0,
    phiAngle = 0,
    kernelRadius = 3
};
erosionDisk3dAlgo.Execute();

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

Function Examples

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

auto result = erosionDisk3d( foam, 0, 0, 3 );

std::cout << "outputImage:" << result->toString();
foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

result = imagedev.erosion_disk_3d( foam, 0, 0, 3 )

print( "output_image:", str( result ) )
ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

IOLink.ImageView result = Processing.ErosionDisk3d( foam, 0, 0, 3 );

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