The features described in this topic are obsolete
and should not be used in new IDL code.
LIVE_EXPORT
Syntax | Arguments | Keywords | Examples | Version History
The LIVE_EXPORT procedure allows the user to export a given visualization or window to an image file.
Syntax
LIVE_EXPORT [, /APPEND] [, COMPRESSION={0 | 1 | 2}{TIFF only}] [, /DIALOG] [, DIMENSIONS=[width, height]] [, ERROR=variable] [, FILENAME=string] [, ORDER={0 | 1}{JPEG or TIFF}] [, /PROGRESSIVE{JPEG only}] [, QUALITY={0 | 1 | 2}{for VRML} | {0 to 100}{for JPEG}] [, RESOLUTION=value] [, TYPE={'BMP' | 'JPG' | 'PIC' | 'SRF' | 'TIF' | 'XWD' | 'VRML'}] [, UNITS={0 | 1 | 2}] [, VISUALIZATION_IN=string] [, WINDOW_IN=string]
Arguments
None
Keywords
APPEND
Specifies that the image should be added to the existing file, creating a multi-image TIFF file.
COMPRESSION (TIFF)
Set this keyword to select the type of compression to be used:
DIALOG
Set this keyword to have a dialog appear allowing the user to choose the image type and specifications.
DIMENSIONS
Set this keyword to a two-element vector of the form [width, height] to specify the dimensions of the image in units specified by the UNITS keyword. The default is [640, 480] pixels.
ERROR
Set this keyword to a named variable to contain the returned error message (string). An empty string is returned if no errors occurred during the operation. By default, errors are reported via a GUI.
Note
If a named variable is passed in this keyword and an error occurs, the error GUI will not be displayed.
FILENAME
Set this keyword equal to a string specifying the desired name of the image file. The default is live_export.extension, where extension is one of the following:
ORDER (JPEG, TIFF)
Set this keyword to have the image written from top to bottom. Default is bottom to top.
PROGRESSIVE (JPEG)
Set this keyword to write the image as a series of scans of increasing quality. When used with a slow communications link, a decoder can generate a low-quality image very quickly, and then improve its quality as more scans are received.
QUALITY (JPEG, VRML)
This keyword specifies the quality index of VRML images and JPEG images. For VRML, the values are 0=Low, 1=Medium, 2=High. For JPEG the range is 0 ("terrible") to 100 ("excellent"). This keyword has no effect on non-JPEG or non-VRML images.
RESOLUTION
Set this keyword to a floating-point value specifying the device resolution in centimeters per pixel. The default is 72 DPI=2.54 (cm/in)/ 0.0352778 (cm/pixel).
Note
It is important to match the eventual output device's resolution so that text is scaled properly.
TYPE
Set this keyword equal to a string specifying the image type to write. Valid strings are: `BMP', `JPG', `JPEG' (default), `PIC', `PICT', `SRF', `TIF', `TIFF', `XWD', and `VRML'.
UNITS
Set this keyword to indicate the units of measure for the DIMENSIONS keyword. Valid values are 0=Device (default), 1=Inches, 2=Centimeters.
VISUALIZATION_IN
Set this keyword equal to the name (string, case-insensitive) of a LIVE tool visualization to export. The VIS field from the REFERENCE_OUT keyword from the creation of the LIVE tool will provide the visualization name. If VISUALIZATION_IN is not specified, the whole window or buffer (WINDOW_IN) will be exported.
WINDOW_IN
Set this keyword equal to a name (string, case-sensitive) of a LIVE tool window or a LIVE tool buffer, to export. The WIN tag of the REFERENCE_OUT structure from the creation of the LIVE tool will provide the window or buffer name. Window names are also visible in visualization window titlebars. If only one LIVE tool window (or buffer) is present in the IDL session, this keyword will default to it.
Examples
Version History
Introduced: 5.1
