The XVOLUME_WRITE_IMAGE procedure is used to write the volume currently displayed in XVOLUME to an image file with the specified name and file format. XVOLUME must be called prior to calling XVOLUME_WRITE_IMAGE.

This routine is written in the IDL language. Its source code can be found in the file xvolume_write_image.pro in the lib/utilities subdirectory of the IDL distribution.

Examples


See XVOLUME_ROTATE.

Syntax


XVOLUME_WRITE_IMAGE, Filename, Format [, DIMENSIONS=[x, y] ]

Arguments


Filename

A scalar string containing the name of the file to write.

Format

A scalar string containing the name of the file format to write. See QUERY_IMAGE for a list of supported formats.

Keywords


DIMENSIONS

Set this keyword to a 2-element vector of the form [xy] specifying the size of the output image, in pixels. If this keyword is not specified, the image will be written using the dimensions of the current XVOLUME draw widget.

Version History


5.4

Introduced

See Also


XVOLUME, XVOLUME_ROTATE