Synopsis
Outputs the image displayed by the viewer module to a file
Input Ports
|
view_in |
GDview_templ |
|
ui_parent |
user interface parent object |
Parameters
|
Image Filename |
UIfileSB |
pick file to output |
|
Write File |
UIbutton |
writes to file |
|
Overwrite |
UItoggle |
writes automatically everytime there is an input |
|
flip |
UItoggle |
flips the data vertically before output |
|
File Format |
UIradioBox |
file format |
|
Bits Per Pixel |
UIradioBox |
depth of image |
|
Color Type |
UIradioBox |
RGB, greyscale, etc |
|
Compression Type |
UIradioBox |
file compression to use |
|
Quality |
UIslider |
quality of compression |
|
Reduction Type |
UIradioBox |
color quantization to use |
|
File Type |
UIradioBox |
binary or ASCII |
Output Ports
none
Description
OutputImage takes as input the output of the viewer module and writes the image displayed by the viewer module to file in the prescribed format.
Input Ports
view_in
A view. The contents of the input view are captured and written to the specified file.
ui_parent
A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)
Parameters
Image Filename
UIfileSB. Selects the disk file to be written to.
Write file
UIbutton. Begins writing to file.
Overwrite
UItoggle. If this parameter is turned on, there is no need to click on the Write file parameter to output the image. Everytime there is an input, the input data is automatically written to file.
flip
UItoggle. Sets whether the image data is to be flipped vertically before output. Normally, the image file assumes the upper left corner to be the origin of the image and hence, it is necessary for this parameter to be turned on. The default value of this parameter is on.
File format
UIradioBox. Sets the file format.The following image formats
are currently supported:
AVS .x
JPEG (JFIF: JPEG File Interchange Format)
PBM (Portable Bitmap Utilities)
SGI Image
Sun Raster
GIF (Graphics Interchange Format)
Sun Raster
GIF (Graphics Interchange Format)
Developer Edition users wishing to create runtimes that include support for writing GIF image format, which uses the patented LZWcompression algorithm, must first obtain a license from Unisys Corporation:
WARNING: Use of this software for providing LZW capability for any purpose is not authorized unless user first enters into a license agreement with Unisys under U.S. Patent No. 4,558,302 and foreign counterparts. For information concering licensing, please contact:
Unisys Corporation
Once you have entered into such a license agreement with Unisys Corp, runtime generation support for GIF can be enabled in AVS/Express at no additional cost. Contact Advanced Visual Systems customer support for details.
Bits Per Pixel
UIradioBox. Sets the depth (color resolution) of the image. For many formats this is fixed, for example GIF is always 8, AVS .x always 32.
Color Type
UIradigoBox. Sets whether separate red, green and blue values, or grey levels, or dithered black and white 2 level values should be written. This option is only appropriate for certain formats, for example GIF.
Compression Type
UIradioBox. Sets the type of compression to be used when writing the file. For most formats there is no choice, for example GIF is always written using LZW and AVS .x files are always uncompressed. TIFF, however, can support a number of different compression types.
Quality
UIslider. Sets the quality of compression.
Reduction Type
UIradioBox. Sets which method to use when the 8 bit red, green and blue values of the input field have to be reduced ("quantized") to 8 bit colormap indices, for example.
File Type
UIradioBox. Sets whether the output file should be written in binary or ASCII. This option is only appropriate for certain formats, for example PBM.
Example
File
See also