WriteVipImage

Saves any image that has been generated with ImageDev on disk.

Access to parameter description

For an introduction: section Image Access

This algorithm saves an ImageView into a disk file. This file is written in the VIP format, which is a raw format designed to support any image generated by ImageDev. VIP image files generally have the vip extension.

See also

ReadVipImage

Function Syntax

This function returns None.

// Function prototype
void
writeVipImage( std::shared_ptr< iolink::ImageView > inputImage,
               std::string filePath,
               bool overwrite,
               bool autoDetermineBestVersion,
               uint32_t fileFormatVersion );

This function returns None.

// Function prototype.
write_vip_image( input_image,
                 file_path = "",
                 overwrite = False,
                 auto_determine_best_version = True,
                 file_format_version = 5 )

This function returns None.

// Function prototype.
public static void
WriteVipImage( IOLink.ImageView inputImage,
               String filePath = "",
               bool overwrite = false,
               bool autoDetermineBestVersion = true,
               UInt32 fileFormatVersion = 5 );

Class Syntax

// Command constructor.
WriteVipImage();

/// Gets the inputImage parameter.
/// The input image to save on disk.
std::shared_ptr< iolink::ImageView > inputImage() const;
/// Sets the inputImage parameter.
/// The input image to save on disk.
void setInputImage( std::shared_ptr< iolink::ImageView > inputImage );

/// Gets the filePath parameter.
/// The path of the image file to save. Its recommended extension is ".vip".
std::string filePath() const;
/// Sets the filePath parameter.
/// The path of the image file to save. Its recommended extension is ".vip".
void setFilePath( const std::string& filePath );

/// Gets the overwrite parameter.
/// The decision to take if the file already exists. If true, an existing file is overwritten. If false, an exeption is thrown when the output file already exists.
bool overwrite() const;
/// Sets the overwrite parameter.
/// The decision to take if the file already exists. If true, an existing file is overwritten. If false, an exeption is thrown when the output file already exists.
void setOverwrite( const bool& overwrite );

/// Gets the autoDetermineBestVersion parameter.
/// The way to tag the VIP format version in the file. If true, the version is automatically identified.
bool autoDetermineBestVersion() const;
/// Sets the autoDetermineBestVersion parameter.
/// The way to tag the VIP format version in the file. If true, the version is automatically identified.
void setAutoDetermineBestVersion( const bool& autoDetermineBestVersion );

/// Gets the fileFormatVersion parameter.
/// The  VIP format version in the file to indicate in the file. This parameter is ignored if the autoDetermineBestVersion parameter is true.
uint32_t fileFormatVersion() const;
/// Sets the fileFormatVersion parameter.
/// The  VIP format version in the file to indicate in the file. This parameter is ignored if the autoDetermineBestVersion parameter is true.
void setFileFormatVersion( const uint32_t& fileFormatVersion );


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

# Property of the inputImage parameter.
WriteVipImage.input_image
# Property of the filePath parameter.
WriteVipImage.file_path
# Property of the overwrite parameter.
WriteVipImage.overwrite
# Property of the autoDetermineBestVersion parameter.
WriteVipImage.auto_determine_best_version
# Property of the fileFormatVersion parameter.
WriteVipImage.file_format_version

// Method to launch the command.
execute()

// Command constructor.
WriteVipImage()

// Property of the inputImage parameter.
WriteVipImage.inputImage
// Property of the filePath parameter.
WriteVipImage.filePath
// Property of the overwrite parameter.
WriteVipImage.overwrite
// Property of the autoDetermineBestVersion parameter.
WriteVipImage.autoDetermineBestVersion
// Property of the fileFormatVersion parameter.
WriteVipImage.fileFormatVersion

// Method to launch the command.
Execute()

Parameters

	Description	Type	Supported Values	Default Value
inputImage	The input image to save on disk.	Image	Binary, Label, Grayscale or Multispectral	nullptr
filePath	The path of the image file to save. Its recommended extension is ".vip".	String		""
overwrite	The decision to take if the file already exists. If true, an existing file is overwritten. If false, an exeption is thrown when the output file already exists.	Bool		false
autoDetermineBestVersion	The way to tag the VIP format version in the file. If true, the version is automatically identified.	Bool		true
fileFormatVersion	The VIP format version in the file to indicate in the file. This parameter is ignored if the autoDetermineBestVersion parameter is true.	UInt32	<=5	5

Description	Type	Supported Values	Default Value
input_image	The input image to save on disk.	image	Binary, Label, Grayscale or Multispectral	None
file_path	The path of the image file to save. Its recommended extension is ".vip".	string		""
overwrite	The decision to take if the file already exists. If true, an existing file is overwritten. If false, an exeption is thrown when the output file already exists.	bool		False
auto_determine_best_version	The way to tag the VIP format version in the file. If true, the version is automatically identified.	bool		True
file_format_version	The VIP format version in the file to indicate in the file. This parameter is ignored if the autoDetermineBestVersion parameter is true.	uint32	<=5	5

Description	Type	Supported Values	Default Value
inputImage	The input image to save on disk.	Image	Binary, Label, Grayscale or Multispectral	null
filePath	The path of the image file to save. Its recommended extension is ".vip".	String		""
overwrite	The decision to take if the file already exists. If true, an existing file is overwritten. If false, an exeption is thrown when the output file already exists.	Bool		false
autoDetermineBestVersion	The way to tag the VIP format version in the file. If true, the version is automatically identified.	Bool		true
fileFormatVersion	The VIP format version in the file to indicate in the file. This parameter is ignored if the autoDetermineBestVersion parameter is true.	UInt32	<=5	5

Object Examples

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

WriteVipImage writeVipImageAlgo;
writeVipImageAlgo.setInputImage( polystyrene );
writeVipImageAlgo.setFilePath( "output_writeVipImage.vip" );
writeVipImageAlgo.setOverwrite( true );
writeVipImageAlgo.setAutoDetermineBestVersion( true );
writeVipImageAlgo.setFileFormatVersion( 2 );
writeVipImageAlgo.execute();

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

write_vip_image_algo = imagedev.WriteVipImage()
write_vip_image_algo.input_image = polystyrene
write_vip_image_algo.file_path = "output_writeVipImage.vip"
write_vip_image_algo.overwrite = True
write_vip_image_algo.auto_determine_best_version = True
write_vip_image_algo.file_format_version = 2
write_vip_image_algo.execute()

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

WriteVipImage writeVipImageAlgo = new WriteVipImage
{
    inputImage = polystyrene,
    filePath = "output_writeVipImage.vip",
    overwrite = true,
    autoDetermineBestVersion = true,
    fileFormatVersion = 2
};
writeVipImageAlgo.Execute();

Function Examples

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

writeVipImage( polystyrene, "output_writeVipImage.vip", true, true, 2 );

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

imagedev.write_vip_image( polystyrene, "output_writeVipImage.vip", True, True, 2 )

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

Data.WriteVipImage( polystyrene, "output_writeVipImage.vip", true, true, 2 );

WriteVipImage

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax