ImageDev

ReadVipImage

Loads an image that has been generated and saved with ImageDev.

Access to parameter description

For an introduction: section Image Access

This algorithm loads an ImageView from a disk file identified by a path. This file must be in the VIP format, generally having the vip extension.

When the image has been partially loaded (content was loaded but some flags could not be set), an exception is raised with a flag that indicates that the file has been partially loaded.

See also

Function Syntax

This function returns outputImage. 
// Function prototype
std::shared_ptr< iolink::ImageView >
readVipImage( std::string filePath, std::shared_ptr< iolink::ImageView > outputImage = NULL );
This function returns outputImage. 
// Function prototype.
read_vip_image( file_path = "", output_image = None )
This function returns outputImage. 
// Function prototype.
public static IOLink.ImageView
ReadVipImage( String filePath = "", IOLink.ImageView outputImage = null );

Class Syntax

Parameters

Parameter Name Description Type Supported Values Default Value
input
filePath
The path of the image file at the VIP format. String ""
output
outputImage
The image data readden from the file. Image nullptr
Parameter Name Description Type Supported Values Default Value
input
file_path
The path of the image file at the VIP format. string ""
output
output_image
The image data readden from the file. image None
Parameter Name Description Type Supported Values Default Value
input
filePath
The path of the image file at the VIP format. String ""
output
outputImage
The image data readden from the file. Image null

Object Examples


ReadVipImage readVipImageAlgo;
readVipImageAlgo.setFilePath( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene_sep.vip" );
readVipImageAlgo.execute();

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


read_vip_image_algo = imagedev.ReadVipImage()
read_vip_image_algo.file_path = imagedev_data.get_image_path("polystyrene_sep.vip")
read_vip_image_algo.execute()

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


ReadVipImage readVipImageAlgo = new ReadVipImage
{
    filePath = @"Data/images/polystyrene_sep.vip"
};
readVipImageAlgo.Execute();

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

Function Examples


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

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


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

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


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

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