DijkstraShortestPath2d

Finds the shortest path through an image, considering the image intensities as weights.

Access to parameter description

This algorithm is used to find the shortest path through an image using local maxima or minima and represent it in a binary image.

The path can be searched either from the left to the right side (X axis mode), or from the top to the bottom (Y axis mode) of the input image.
In dark intensity mode the path must minimize the sum of the traveled intensities, while in bright mode it must maximize this sum.
A binary input image has to be set to guide the path inside this mask.

See also

Function Syntax

This function returns outputBinaryImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
dijkstraShortestPath2d( std::shared_ptr< iolink::ImageView > inputGrayImage,
                        std::shared_ptr< iolink::ImageView > inputMaskImage,
                        DijkstraShortestPath2d::Axis axis,
                        DijkstraShortestPath2d::IntensityMode intensityMode,
                        std::shared_ptr< iolink::ImageView > outputBinaryImage = NULL );

This function returns outputBinaryImage.

// Function prototype.
dijkstra_shortest_path_2d( input_gray_image,
                           input_mask_image,
                           axis = DijkstraShortestPath2d.Axis.X_AXIS,
                           intensity_mode = DijkstraShortestPath2d.IntensityMode.BRIGHT,
                           output_binary_image = None )

This function returns outputBinaryImage.

// Function prototype.
public static IOLink.ImageView
DijkstraShortestPath2d( IOLink.ImageView inputGrayImage,
                        IOLink.ImageView inputMaskImage,
                        DijkstraShortestPath2d.Axis axis = ImageDev.DijkstraShortestPath2d.Axis.X_AXIS,
                        DijkstraShortestPath2d.IntensityMode intensityMode = ImageDev.DijkstraShortestPath2d.IntensityMode.BRIGHT,
                        IOLink.ImageView outputBinaryImage = null );

Class Syntax

// Command constructor.
DijkstraShortestPath2d();

/// Gets the inputGrayImage parameter.
/// The grayscale input image.
std::shared_ptr< iolink::ImageView > inputGrayImage() const;
/// Sets the inputGrayImage parameter.
/// The grayscale input image.
void setInputGrayImage( std::shared_ptr< iolink::ImageView > inputGrayImage );

/// Gets the inputMaskImage parameter.
/// The binary input image for the mask.
std::shared_ptr< iolink::ImageView > inputMaskImage() const;
/// Sets the inputMaskImage parameter.
/// The binary input image for the mask.
void setInputMaskImage( std::shared_ptr< iolink::ImageView > inputMaskImage );

/// Gets the axis parameter.
/// The direction of the searched path.
DijkstraShortestPath2d::Axis axis() const;
/// Sets the axis parameter.
/// The direction of the searched path.
void setAxis( const DijkstraShortestPath2d::Axis& axis );

/// Gets the intensityMode parameter.
/// The type of enclosed objects.
DijkstraShortestPath2d::IntensityMode intensityMode() const;
/// Sets the intensityMode parameter.
/// The type of enclosed objects.
void setIntensityMode( const DijkstraShortestPath2d::IntensityMode& intensityMode );

/// Gets the outputBinaryImage parameter.
/// The binary output image.
std::shared_ptr< iolink::ImageView > outputBinaryImage() const;
/// Sets the outputBinaryImage parameter.
/// The binary output image.
void setOutputBinaryImage( std::shared_ptr< iolink::ImageView > outputBinaryImage );


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

# Property of the inputGrayImage parameter.
DijkstraShortestPath2d.input_gray_image
# Property of the inputMaskImage parameter.
DijkstraShortestPath2d.input_mask_image
# Property of the axis parameter.
DijkstraShortestPath2d.axis
# Property of the intensityMode parameter.
DijkstraShortestPath2d.intensity_mode
# Property of the outputBinaryImage parameter.
DijkstraShortestPath2d.output_binary_image

// Method to launch the command.
execute()

// Command constructor.
DijkstraShortestPath2d()

// Property of the inputGrayImage parameter.
DijkstraShortestPath2d.inputGrayImage
// Property of the inputMaskImage parameter.
DijkstraShortestPath2d.inputMaskImage
// Property of the axis parameter.
DijkstraShortestPath2d.axis
// Property of the intensityMode parameter.
DijkstraShortestPath2d.intensityMode
// Property of the outputBinaryImage parameter.
DijkstraShortestPath2d.outputBinaryImage

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

inputGrayImage

The grayscale input image.

Image

Binary, Label or Grayscale

nullptr

inputMaskImage

The binary input image for the mask.

Image

Binary

nullptr

axis

The direction of the searched path.

X_AXIS	The shortest path is searched through the X axis.
Y_AXIS	The shortest path is searched through the Y axis.

Enumeration

X_AXIS

intensityMode

The type of enclosed objects.

BRIGHT	The shortest path is searched through the intensity maxima pixels.
DARK	The shortest path is searched through the intensity minima pixels.

Enumeration

BRIGHT

outputBinaryImage

The binary output image.

Image

nullptr

Object Examples

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

DijkstraShortestPath2d dijkstraShortestPath2dAlgo;
dijkstraShortestPath2dAlgo.setInputGrayImage( polystyrene );
dijkstraShortestPath2dAlgo.setInputMaskImage( polystyrene_sep );
dijkstraShortestPath2dAlgo.setAxis( DijkstraShortestPath2d::Axis::X_AXIS );
dijkstraShortestPath2dAlgo.setIntensityMode( DijkstraShortestPath2d::IntensityMode::BRIGHT );
dijkstraShortestPath2dAlgo.execute();

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

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))
polystyrene_sep = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep.vip"))

dijkstra_shortest_path_2d_algo = imagedev.DijkstraShortestPath2d()
dijkstra_shortest_path_2d_algo.input_gray_image = polystyrene
dijkstra_shortest_path_2d_algo.input_mask_image = polystyrene_sep
dijkstra_shortest_path_2d_algo.axis = imagedev.DijkstraShortestPath2d.X_AXIS
dijkstra_shortest_path_2d_algo.intensity_mode = imagedev.DijkstraShortestPath2d.BRIGHT
dijkstra_shortest_path_2d_algo.execute()

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

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

DijkstraShortestPath2d dijkstraShortestPath2dAlgo = new DijkstraShortestPath2d
{
    inputGrayImage = polystyrene,
    inputMaskImage = polystyrene_sep,
    axis = DijkstraShortestPath2d.Axis.X_AXIS,
    intensityMode = DijkstraShortestPath2d.IntensityMode.BRIGHT
};
dijkstraShortestPath2dAlgo.Execute();

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

Function Examples

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

auto result = dijkstraShortestPath2d( polystyrene, polystyrene_sep, DijkstraShortestPath2d::Axis::X_AXIS, DijkstraShortestPath2d::IntensityMode::BRIGHT );

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

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))
polystyrene_sep = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep.vip"))

result = imagedev.dijkstra_shortest_path_2d( polystyrene, polystyrene_sep, imagedev.DijkstraShortestPath2d.X_AXIS, imagedev.DijkstraShortestPath2d.BRIGHT )

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

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

IOLink.ImageView result = Processing.DijkstraShortestPath2d( polystyrene, polystyrene_sep, DijkstraShortestPath2d.Axis.X_AXIS, DijkstraShortestPath2d.IntensityMode.BRIGHT );

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

DijkstraShortestPath2d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax