Save

_ImageSave, _ImageSaveAs, ImageExportToAVI, ImageSave, ImageSaveAs, ImageSaveAsEx, SaveAll, SaveCurrentDocument, ShowImageInfoBeforeSaveAs

ImageExportToAVI

Description 

 ImageExportToAVI(
   char *AviFilename,
   int  AviUseTime,
   int  AviSeparateXY,
   int  AviUseZ,
   int  AviFrameInterval,
   char *AviCodec
);

This function creates an AVI movie out of the current ND2 document.

Parameters

char *AviFilename

The destination file name incl. extension (.AVI).

int AviUseTime

Use the time dimension?

0

No

1

Yes

int AviSeparateXY

Multipoint saving mode (all multipoints in one document or each one in a separate file).

int AviUseZ

Use the Z dimension?

0

No

1

Yes

int AviFrameInterval

Time between two frames in milliseconds.

0

The original time from the source ND2 file will be used.

Note

The AVI format does not support irregular frame intervals. This is solved by inserting empty frames to the AVI. As a result, the exported file has a fixed frame rate of 100 fps.

char *AviCodec

The codec to be used to encode the video sequence. If left blank, the default codec will be used.

ImageSave

Interactive menu command to this function: File > Save

Description 

 ImageSave();

This function saves current image.

Note

This function does not save a new (e.g. captured) image. If you want to save the new image, use the ImageSaveAs function.

See Also 
_ImageSave, ImageSaveAs

ImageSaveAs

Interactive menu command to this function: File > Save As

Description 

 ImageSaveAs(
   char *Image,
   int  ImType,
   int  ImCompr
);

Saves the existing image under a different name based on the following parameters.

Parameters

char *Image

Complete path to the image.

int ImType

Type of image to be saved.

1

Binary image

2

Color image

3

Color image with binary

8

Vector annotations

14

All layers (ND2 file)

15

All layers with binary (ND2 file)

18

All layers (TIF, TIFF file)

19

All layers with binary (TIF, TIFF file)

30

All layers (OME-TIFF file)

31

All layers with binary (OME-TIFF file)

int ImCompr

Image compression.

0

ND2 format - lossless

0

TIF, TIFF format - no compression

1

TIF, TIFF format - LZW compression

2

TIF, TIFF format - LZMA compression

0-4

JPG, JPEG format - level of compression (0 = Lowest, 4 = Highest)

0

ICS format - no compression

0

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - no compression

1

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - LZW compression

0

JSON format - no compression

1

JSON format - LZW compression

0

LSM format - no compression

0

LIM format - lossless

2

LIM format - no compression

0

BMP format - no compression

0-5

JP2 format - level of compression (0 = lossless)

0

GIF format - lossless (not binary image, key needed)

0

PNG format - no compression

0

AVI format - this parameter is ignored. Compression depends on the selected codec an its settings.

0

MP4 format - this parameter is ignored. Compression depends on the selected codec an its settings.

Note

Images with color depth > 8bits are converted to 8 bits using optimized palette.

See Also 
ImageSaveAsEx, _ImageSaveAs, SaveCurrentDocument, _ImageSaveAs

ImageSaveAsEx

Description 

 ImageSaveAsEx(
   int  PicConst,
   char *Image,
   int  ImType,
   int  ImCompr
);

This function enables you to store the image according to options.

Parameters

int PicConst

Number of custom picture to save

0

Current image

1

Reference image (Freeware only)

4

Mask image (Freeware only)

char *Image

Complete path to the image.

int ImType

Type of image to be saved.

1

Binary image

2

Color image

3

Color image with binary

8

Vector annotations

14

All layers (ND2 file)

15

All layers with binary (ND2 file)

18

All layers (TIF, TIFF file)

19

All layers with binary (TIF, TIFF file)

30

All layers (OME-TIFF file)

31

All layers with binary (OME-TIFF file)

int ImCompr

Image compression.

0

ND2 format - lossless

0

TIF, TIFF format - no compression

1

TIF, TIFF format - LZW compression

2

TIF, TIFF format - LZMA compression

0-4

JPG, JPEG format - level of compression (0 = Lowest, 4 = Highest)

0

ICS format - no compression

0

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - no compression

1

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - LZW compression

0

JSON format - no compression

1

JSON format - LZW compression

0

LSM format - no compression

0

LIM format - lossless

2

LIM format - no compression

0

BMP format - no compression

0-5

JP2 format - level of compression (0 = lossless)

0

GIF format - lossless (not binary image, key needed)

0

PNG format - no compression

0

AVI format - this parameter is ignored. Compression depends on the selected codec an its settings.

0

MP4 format - this parameter is ignored. Compression depends on the selected codec an its settings.

Note

Images with color depth > 8bits are converted to 8 bits using an optimized palette.

See Also 
ImageSaveAs, _ImageSaveAs, _ImageSaveAs

SaveAll

Description 

 SaveAll();

This function saves all modified documents. The operation is performed on image Intensity values.

See Also 
SaveCurrentDocument

SaveCurrentDocument

Description 

 SaveCurrentDocument(
   char *Image,
   int  ImDocuType,
   int  ImCompr,
   int  Overwrite
);

This function stores current image according to options.

Parameters

char *Image

Complete path to the image.

int ImDocuType

Type of image to be saved. This parameter can be one or more of the following values.

1

Color image.

2

Binary image.

int ImCompr

Image compression.

0

ND2 format - lossless

0

TIF, TIFF format - no compression

1

TIF, TIFF format - LZW compression

2

TIF, TIFF format - LZMA compression

0-4

JPG, JPEG format - level of compression (0 = Lowest, 4 = Highest)

0

ICS format - no compression

0

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - no compression

1

OME.TIF, OME.TIFF, OME.TF2, OME.TF8, OME.BTF format - LZW compression

0

JSON format - no compression

1

JSON format - LZW compression

0

LSM format - no compression

0

LIM format - lossless

2

LIM format - no compression

0

BMP format - no compression

0-5

JP2 format - level of compression (0 = lossless)

0

GIF format - lossless (not binary image, key needed)

0

PNG format - no compression

0

AVI format - this parameter is ignored. Compression depends on the selected codec an its settings.

0

MP4 format - this parameter is ignored. Compression depends on the selected codec an its settings.

int Overwrite

Action, if document Image already exists.

0

Ask to overwrite.

1

Overwrite.

1

Do not save.

Note

ImCompr is ignored for BMP, GIF, PNG , DCM, ND2 and AVI format. For AVI format, the compression depends on the selected codec and its settings.

See Also 
ImageSaveAs, ImageSaveAsEx

ShowImageInfoBeforeSaveAs

Description 

 ShowImageInfoBeforeSaveAs(
   bool  ShowImageInfo
);

Determines whether show image informations dialog before saving the file.

Parameters

bool ShowImageInfo

Show image informations dialog before saving the file

0, FALSE

do not show

1, TRUE

show

_ImageSave

This function runs the File > Save menu command.

Description 

 _ImageSave();

This function saves the current image.

Note

If the image was not saved before, the function _ImageSaveAs is called.

See Also 
ImageSave, _ImageSaveAs

_ImageSaveAs

This function runs the File > Save As menu command.

Description 

 _ImageSaveAs();

The function displays the Save As Image dialog box.

See Also 
ImageSaveAs

Copyright 1991-2025 Laboratory Imaging s.r.o.