ImageDev

EnergyFilter2d

Computes, for each pixel of a two-dimensional image, the energy value of its neighborhood.

Access to parameter description

For an introduction: This algorithm replaces each pixel of the output image by the energy value of its neighborhood in the input image. The energy operator is given by: $$ energy=\sum_{n}p(n)^2 $$ The shape of the neighborhood can be: See also

Function Syntax

This function returns outputImage. 
// Function prototype
std::shared_ptr< iolink::ImageView >
energyFilter2d( std::shared_ptr< iolink::ImageView > inputImage,
                EnergyFilter2d::KernelShape kernelShape,
                uint32_t kernelRadius,
                std::shared_ptr< iolink::ImageView > outputImage = NULL );
This function returns outputImage. 
// Function prototype.
energy_filter_2d( input_image,
                  kernel_shape = EnergyFilter2d.KernelShape.DISK,
                  kernel_radius = 3,
                  output_image = None )
This function returns outputImage. 
// Function prototype.
public static IOLink.ImageView
EnergyFilter2d( IOLink.ImageView inputImage,
                EnergyFilter2d.KernelShape kernelShape = ImageDev.EnergyFilter2d.KernelShape.DISK,
                UInt32 kernelRadius = 3,
                IOLink.ImageView outputImage = null );

Class Syntax

Parameters

Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. Image Binary, Label, Grayscale or Multispectral nullptr
input
kernelRadius
The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter. UInt32 >=1 3
input
kernelShape
The shape of the window defining the neighborhood.
SQUARE The sliding window is a square.
DISK The sliding window is a disk.
Enumeration DISK
output
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
Parameter Name Description Type Supported Values Default Value
input
input_image
The input image. image Binary, Label, Grayscale or Multispectral None
input
kernel_radius
The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter. uint32 >=1 3
input
kernel_shape
The shape of the window defining the neighborhood.
SQUARE The sliding window is a square.
DISK The sliding window is a disk.
enumeration DISK
output
output_image
The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point. image None
Parameter Name Description Type Supported Values Default Value
input
inputImage
The input image. Image Binary, Label, Grayscale or Multispectral null
input
kernelRadius
The kernel half side length or radius, in pixels. In case of a square, a value N produces a square window of 2N+1 pixels side length. In case of a disk, a value N produces a disk with a 2N+1 pixels diameter. UInt32 >=1 3
input
kernelShape
The shape of the window defining the neighborhood.
SQUARE The sliding window is a square.
DISK The sliding window is a disk.
Enumeration DISK
output
outputImage
The output image. Its dimensions are forced to the same values as the input. Its data type is forced to floating point. Image null

Object Examples

std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

EnergyFilter2d energyFilter2dAlgo;
energyFilter2dAlgo.setInputImage( polystyrene );
energyFilter2dAlgo.setKernelShape( EnergyFilter2d::KernelShape::SQUARE );
energyFilter2dAlgo.setKernelRadius( 3 );
energyFilter2dAlgo.execute();

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

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

energy_filter_2d_algo = imagedev.EnergyFilter2d()
energy_filter_2d_algo.input_image = polystyrene
energy_filter_2d_algo.kernel_shape = imagedev.EnergyFilter2d.SQUARE
energy_filter_2d_algo.kernel_radius = 3
energy_filter_2d_algo.execute()

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

ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

EnergyFilter2d energyFilter2dAlgo = new EnergyFilter2d
{
    inputImage = polystyrene,
    kernelShape = EnergyFilter2d.KernelShape.SQUARE,
    kernelRadius = 3
};
energyFilter2dAlgo.Execute();

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

Function Examples

std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

auto result = energyFilter2d( polystyrene, EnergyFilter2d::KernelShape::SQUARE, 3 );

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

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

result = imagedev.energy_filter_2d( polystyrene, imagedev.EnergyFilter2d.SQUARE, 3 )

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

ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

IOLink.ImageView result = Processing.EnergyFilter2d( polystyrene, EnergyFilter2d.KernelShape.SQUARE, 3 );

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