LocalDensityMap2d

Measures the local density of a two-dimensional binary image within a binary mask.

Access to parameter description

This algorithm computes the density using a region formed by the intersection of a mask image and a user-defined kernel.

Pixels are assigned the percentage of pixels with a value of 1 inside this region. These values are expressed in the interval [0, 100].
Pixels outside of the mask are assigned the value -1.

Image borders are mirrored to ensure full kernel processing for pixels at the image boundary. The output image type is float.

Function Syntax

This function returns outputImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
localDensityMap2d( std::shared_ptr< iolink::ImageView > inputBinaryImage,
                   std::shared_ptr< iolink::ImageView > inputMaskImage,
                   iolink::Vector2i32 kernelSize,
                   std::shared_ptr< iolink::ImageView > outputImage = NULL );

This function returns outputImage.

// Function prototype.
local_density_map_2d( input_binary_image,
                      input_mask_image,
                      kernel_size = [3, 3],
                      output_image = None )

This function returns outputImage.

// Function prototype.
public static IOLink.ImageView
LocalDensityMap2d( IOLink.ImageView inputBinaryImage,
                   IOLink.ImageView inputMaskImage,
                   int[] kernelSize = null,
                   IOLink.ImageView outputImage = null );

Class Syntax

// Command constructor.
LocalDensityMap2d();

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

/// Gets the inputMaskImage parameter.
/// The binary mask image. This image must have same dimensions and type as the main input image.
std::shared_ptr< iolink::ImageView > inputMaskImage() const;
/// Sets the inputMaskImage parameter.
/// The binary mask image. This image must have same dimensions and type as the main input image.
void setInputMaskImage( std::shared_ptr< iolink::ImageView > inputMaskImage );

/// Gets the kernelSize parameter.
/// The side size in pixels of the square kernel.
iolink::Vector2i32 kernelSize() const;
/// Sets the kernelSize parameter.
/// The side size in pixels of the square kernel.
void setKernelSize( const iolink::Vector2i32& kernelSize );

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


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

# Property of the inputBinaryImage parameter.
LocalDensityMap2d.input_binary_image
# Property of the inputMaskImage parameter.
LocalDensityMap2d.input_mask_image
# Property of the kernelSize parameter.
LocalDensityMap2d.kernel_size
# Property of the outputImage parameter.
LocalDensityMap2d.output_image

// Method to launch the command.
execute()

// Command constructor.
LocalDensityMap2d()

// Property of the inputBinaryImage parameter.
LocalDensityMap2d.inputBinaryImage
// Property of the inputMaskImage parameter.
LocalDensityMap2d.inputMaskImage
// Property of the kernelSize parameter.
LocalDensityMap2d.kernelSize
// Property of the outputImage parameter.
LocalDensityMap2d.outputImage

// Method to launch the command.
Execute()

Parameters

Class Name	LocalDensityMap2d

	Description	Type	Supported Values	Default Value
inputBinaryImage	The input binary image.	Image	Binary	nullptr
inputMaskImage	The binary mask image. This image must have same dimensions and type as the main input image.	Image	Binary	nullptr
kernelSize	The side size in pixels of the square kernel.	Vector2i32	>0	{3, 3}
outputImage	The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point.	Image		nullptr

Object Examples

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

LocalDensityMap2d localDensityMap2dAlgo;
localDensityMap2dAlgo.setInputBinaryImage( polystyrene_sep );
localDensityMap2dAlgo.setInputMaskImage( polystyrene_sep );
localDensityMap2dAlgo.setKernelSize( {3, 3} );
localDensityMap2dAlgo.execute();

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

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

local_density_map_2d_algo = imagedev.LocalDensityMap2d()
local_density_map_2d_algo.input_binary_image = polystyrene_sep
local_density_map_2d_algo.input_mask_image = polystyrene_sep
local_density_map_2d_algo.kernel_size = [3, 3]
local_density_map_2d_algo.execute()

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

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

LocalDensityMap2d localDensityMap2dAlgo = new LocalDensityMap2d
{
    inputBinaryImage = polystyrene_sep,
    inputMaskImage = polystyrene_sep,
    kernelSize = new int[]{3, 3}
};
localDensityMap2dAlgo.Execute();

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

Function Examples

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

auto result = localDensityMap2d( polystyrene_sep, polystyrene_sep, {3, 3} );

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

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

result = imagedev.local_density_map_2d( polystyrene_sep, polystyrene_sep, [3, 3] )

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

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

IOLink.ImageView result = Processing.LocalDensityMap2d( polystyrene_sep, polystyrene_sep, new int[]{3, 3} );

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

LocalDensityMap2d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax