Iwrite_image

[ XITE Reference Manual | XITE home ]

Name

Iwrite_image - write a BIFF image to file

Syntax

 #include <xite/biff.h>

 BiffStatus Iwrite_image( IMAGE i,
    char* filename );

Description

Write an entire image i to file (currently not block data). If the overwrite status is TRUE, an existing file of that name is overwritten. If the overwrite status is FALSE and the file exists, the function returns with an error indication.

filename may be "-n", n beeing an integer, meaning that the image should be written to channel n. Use "-1" or empty filename to write to stdout.

The file name may contain a "~" (tilde) which is expanded to the appropriate user home directory.

Restrictions

Directory must be writeable. If overwrite=FALSE, the file must not exist. The image must be in Ilocal status.

See also

Iread_image(5), Iwrite_band(5), Iopen_image(5), Iclose_image(5), Init_image(5)

Return value

status.

Author

Tor Lønnestad, BLAB, Ifi, UiO