SelectiveErosion3d

Erodes objects of a three-dimensional binary image conditionally to a local constraint.

Access to parameter description

For an introduction:

section Mathematical Morphology
section Introduction To Erosion

This algorithm can be applied only on binary images. It is performed iteratively and at each step a foreground voxel is transformed into a background voxel if the number of background voxels in its 26-neighborhood is greater than or equal to a specified threshold.
Using a threshold of 1 amounts to applying a standard morphological erosion.

This operator is smoother than a standard erosion, and softens the appearance of the structuring element in the filtered image.

See also

Function Syntax

This function returns outputBinaryImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
selectiveErosion3d( std::shared_ptr< iolink::ImageView > inputBinaryImage,
                    uint32_t numberOfIterations,
                    uint32_t threshold,
                    std::shared_ptr< iolink::ImageView > outputBinaryImage = NULL );

This function returns outputBinaryImage.

// Function prototype.
selective_erosion_3d( input_binary_image,
                      number_of_iterations = 3,
                      threshold = 14,
                      output_binary_image = None )

This function returns outputBinaryImage.

// Function prototype.
public static IOLink.ImageView
SelectiveErosion3d( IOLink.ImageView inputBinaryImage,
                    UInt32 numberOfIterations = 3,
                    UInt32 threshold = 14,
                    IOLink.ImageView outputBinaryImage = null );

Class Syntax

// Command constructor.
SelectiveErosion3d();

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

/// Gets the numberOfIterations parameter.
/// The number of iterations.
uint32_t numberOfIterations() const;
/// Sets the numberOfIterations parameter.
/// The number of iterations.
void setNumberOfIterations( const uint32_t& numberOfIterations );

/// Gets the threshold parameter.
/// The minimum number of background neighbors that is required to transform a foreground voxel into a background one.
uint32_t threshold() const;
/// Sets the threshold parameter.
/// The minimum number of background neighbors that is required to transform a foreground voxel into a background one.
void setThreshold( const uint32_t& threshold );

/// Gets the outputBinaryImage parameter.
/// The binary output image. Its size and type are forced to the same values as the input.
std::shared_ptr< iolink::ImageView > outputBinaryImage() const;
/// Sets the outputBinaryImage parameter.
/// The binary output image. Its size and type are forced to the same values as the input.
void setOutputBinaryImage( std::shared_ptr< iolink::ImageView > outputBinaryImage );


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

# Property of the inputBinaryImage parameter.
SelectiveErosion3d.input_binary_image
# Property of the numberOfIterations parameter.
SelectiveErosion3d.number_of_iterations
# Property of the threshold parameter.
SelectiveErosion3d.threshold
# Property of the outputBinaryImage parameter.
SelectiveErosion3d.output_binary_image

// Method to launch the command.
execute()

// Command constructor.
SelectiveErosion3d()

// Property of the inputBinaryImage parameter.
SelectiveErosion3d.inputBinaryImage
// Property of the numberOfIterations parameter.
SelectiveErosion3d.numberOfIterations
// Property of the threshold parameter.
SelectiveErosion3d.threshold
// Property of the outputBinaryImage parameter.
SelectiveErosion3d.outputBinaryImage

// Method to launch the command.
Execute()

Parameters

	Description	Type	Supported Values	Default Value
inputBinaryImage	The binary input image.	Image	Binary	nullptr
numberOfIterations	The number of iterations.	UInt32	>=1	3
threshold	The minimum number of background neighbors that is required to transform a foreground voxel into a background one.	UInt32	[1, 26]	14
outputBinaryImage	The binary output image. Its size and type are forced to the same values as the input.	Image		nullptr

Description	Type	Supported Values	Default Value
input_binary_image	The binary input image.	image	Binary	None
number_of_iterations	The number of iterations.	uint32	>=1	3
threshold	The minimum number of background neighbors that is required to transform a foreground voxel into a background one.	uint32	[1, 26]	14
output_binary_image	The binary output image. Its size and type are forced to the same values as the input.	image		None

Description	Type	Supported Values	Default Value
inputBinaryImage	The binary input image.	Image	Binary	null
numberOfIterations	The number of iterations.	UInt32	>=1	3
threshold	The minimum number of background neighbors that is required to transform a foreground voxel into a background one.	UInt32	[1, 26]	14
outputBinaryImage	The binary output image. Its size and type are forced to the same values as the input.	Image		null

Object Examples

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

SelectiveErosion3d selectiveErosion3dAlgo;
selectiveErosion3dAlgo.setInputBinaryImage( foam_sep );
selectiveErosion3dAlgo.setNumberOfIterations( 3 );
selectiveErosion3dAlgo.setThreshold( 14 );
selectiveErosion3dAlgo.execute();

std::cout << "outputBinaryImage:" << selectiveErosion3dAlgo.outputBinaryImage()->toString();

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

selective_erosion_3d_algo = imagedev.SelectiveErosion3d()
selective_erosion_3d_algo.input_binary_image = foam_sep
selective_erosion_3d_algo.number_of_iterations = 3
selective_erosion_3d_algo.threshold = 14
selective_erosion_3d_algo.execute()

print( "output_binary_image:", str( selective_erosion_3d_algo.output_binary_image ) )

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

SelectiveErosion3d selectiveErosion3dAlgo = new SelectiveErosion3d
{
    inputBinaryImage = foam_sep,
    numberOfIterations = 3,
    threshold = 14
};
selectiveErosion3dAlgo.Execute();

Console.WriteLine( "outputBinaryImage:" + selectiveErosion3dAlgo.outputBinaryImage.ToString() );

Function Examples

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

auto result = selectiveErosion3d( foam_sep, 3, 14 );

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

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

result = imagedev.selective_erosion_3d( foam_sep, 3, 14 )

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

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

IOLink.ImageView result = Processing.SelectiveErosion3d( foam_sep, 3, 14 );

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

SelectiveErosion3d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax