ImageDev

RegionalExtrema3d

Computes the regional extrema in a grayscale 3D image and marks them in a binary image.

Access to parameter description

For an introduction: This algorithm computes the regional or relative extrema in a 3D image and creates a binary image containing these extrema.

Function Syntax

This function returns outputBinaryImage. 
// Function prototype
std::shared_ptr< iolink::ImageView >
regionalExtrema3d( std::shared_ptr< iolink::ImageView > inputImage,
                   RegionalExtrema3d::ExtremaType extremaType,
                   RegionalExtrema3d::Neighborhood neighborhood,
                   std::shared_ptr< iolink::ImageView > outputBinaryImage = NULL );
This function returns outputBinaryImage. 
// Function prototype.
regional_extrema_3d( input_image,
                     extrema_type = RegionalExtrema3d.ExtremaType.MAXIMA,
                     neighborhood = RegionalExtrema3d.Neighborhood.CONNECTIVITY_26,
                     output_binary_image = None )
This function returns outputBinaryImage. 
// Function prototype.
public static IOLink.ImageView
RegionalExtrema3d( IOLink.ImageView inputImage,
                   RegionalExtrema3d.ExtremaType extremaType = ImageDev.RegionalExtrema3d.ExtremaType.MAXIMA,
                   RegionalExtrema3d.Neighborhood neighborhood = ImageDev.RegionalExtrema3d.Neighborhood.CONNECTIVITY_26,
                   IOLink.ImageView outputBinaryImage = null );

Class Syntax

Parameters

Parameter Name Description Type Supported Values Default Value
input
inputImage
The input Grayscale image. Image Grayscale nullptr
input
extremaType
The type of extrema to detect.
MAXIMA The regional maxima are extracted from the input image.
MINIMA The regional minima are extracted from the input image.
Enumeration MAXIMA
input
neighborhood
The 3D neighborhood configuration.
CONNECTIVITY_6 The structuring element is composed of voxels with a common face with the voxel of interest.
CONNECTIVITY_18 The structuring element is composed of voxels with at least one common edge.
CONNECTIVITY_26 The structuring element is a full cube.
Enumeration CONNECTIVITY_26
output
outputBinaryImage
The output binary. Its dimensions is forced to the same values as the input. Image nullptr
Parameter Name Description Type Supported Values Default Value
input
input_image
The input Grayscale image. image Grayscale None
input
extrema_type
The type of extrema to detect.
MAXIMA The regional maxima are extracted from the input image.
MINIMA The regional minima are extracted from the input image.
enumeration MAXIMA
input
neighborhood
The 3D neighborhood configuration.
CONNECTIVITY_6 The structuring element is composed of voxels with a common face with the voxel of interest.
CONNECTIVITY_18 The structuring element is composed of voxels with at least one common edge.
CONNECTIVITY_26 The structuring element is a full cube.
enumeration CONNECTIVITY_26
output
output_binary_image
The output binary. Its dimensions is forced to the same values as the input. image None
Parameter Name Description Type Supported Values Default Value
input
inputImage
The input Grayscale image. Image Grayscale null
input
extremaType
The type of extrema to detect.
MAXIMA The regional maxima are extracted from the input image.
MINIMA The regional minima are extracted from the input image.
Enumeration MAXIMA
input
neighborhood
The 3D neighborhood configuration.
CONNECTIVITY_6 The structuring element is composed of voxels with a common face with the voxel of interest.
CONNECTIVITY_18 The structuring element is composed of voxels with at least one common edge.
CONNECTIVITY_26 The structuring element is a full cube.
Enumeration CONNECTIVITY_26
output
outputBinaryImage
The output binary. Its dimensions is forced to the same values as the input. Image null

Object Examples

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

RegionalExtrema3d regionalExtrema3dAlgo;
regionalExtrema3dAlgo.setInputImage( foam );
regionalExtrema3dAlgo.setExtremaType( RegionalExtrema3d::ExtremaType::MAXIMA );
regionalExtrema3dAlgo.setNeighborhood( RegionalExtrema3d::Neighborhood::CONNECTIVITY_26 );
regionalExtrema3dAlgo.execute();

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

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

regional_extrema_3d_algo = imagedev.RegionalExtrema3d()
regional_extrema_3d_algo.input_image = foam
regional_extrema_3d_algo.extrema_type = imagedev.RegionalExtrema3d.MAXIMA
regional_extrema_3d_algo.neighborhood = imagedev.RegionalExtrema3d.CONNECTIVITY_26
regional_extrema_3d_algo.execute()

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

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

RegionalExtrema3d regionalExtrema3dAlgo = new RegionalExtrema3d
{
    inputImage = foam,
    extremaType = RegionalExtrema3d.ExtremaType.MAXIMA,
    neighborhood = RegionalExtrema3d.Neighborhood.CONNECTIVITY_26
};
regionalExtrema3dAlgo.Execute();

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

Function Examples

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

auto result = regionalExtrema3d( foam, RegionalExtrema3d::ExtremaType::MAXIMA, RegionalExtrema3d::Neighborhood::CONNECTIVITY_26 );

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

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

result = imagedev.regional_extrema_3d( foam, imagedev.RegionalExtrema3d.MAXIMA, imagedev.RegionalExtrema3d.CONNECTIVITY_26 )

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

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

IOLink.ImageView result = Processing.RegionalExtrema3d( foam, RegionalExtrema3d.ExtremaType.MAXIMA, RegionalExtrema3d.Neighborhood.CONNECTIVITY_26 );

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