compress_tool

Synopsis

Combines the compress and examine_field user macros, and merges their ui's into a single UImod_panel, to provide a convenient compression tool. Array information is listed below controls to perform compression on the arrays.

Input Ports

&data group reference the input field components

Parameters

compress_all int triggers compression of all arrays.
uncompress_all int triggers uncompression of all arrays.
process_nth int triggers compression/uncompression of the nth array.
nth int the array number of the array to process.

Description

Compresses / uncompresses arrays within an AVS/Express field. See documentation for compress and examine_field for full details.

Input Ports

& data

A reference to the input data, which must be in the form of certain field sub-objects. The following objects must be present in the group : int nnodes, int nspace, Data_Array coordinates. All the other sub-objects of a field are optional. Thus, any valid field or sub-set of a field (e.g. Mesh+Node_Data) will be accepted.

Parameters

compress_all

Invokes the method to compress all arrays when set to non-zero. Is reset to zero after the method has finished executing.

uncompress_all

Invokes the method to uncompress all arrays when set to non-zero. Is reset to zero after the method has finished executing.

process_nth

Invokes the method to compress or uncompress the nth array when set to non-zero. If the nth array is in an uncompressed state it is compressed, if it is in a compressed state it is uncompressed. Is reset to zero after the method has finished executing.

nth

The array number of the array to process when the process_nth parameter is set to non-zero.

Utility Macros

The user macro compress_tool combines the user macros compress and examine_field. In compress_tool these macros share a single UImod_panel rather than having separate interfaces.

Example

An example application Compress_Tool_Eg is provided, which uses the AVS/Express sample data file bluntfin.fld. This data file contains six arrays (one grid plus five node data). Executing compression on any of the arrays can be seen to change the size and type of the array in the field.

Files

iac_proj/comptool/comptool_macs.v
contains the V definitions for the user macro compress_tool and the example application Compress_Eg.

iac_proj/Compress/INSTALL
contains instructions on how to add the Compress_Tool project macro to the IAC library structure.

iac_proj/Compress/README
contains instructions on how to install the Compress_Tool project macro.

Additional files are required for the pre-requisite projects (see below).

Other Notes

This macro requires the compress and examine_field macros, so the Compress and Examine_Field projects must first be obtained and installed. These are also available from http://www.iavsc.org/. Note, that these modules also have pre-requisites; check the documentation supplied with the projects for details.

Author

Amardeep S Bhattal.
Manchester Visualisation Centre,
Manchester Computing,
University of Manchester,
Oxford Road,
Manchester,
M13 9PL,
UK.

See Also

compress, Compress_Prim, examine_field, Examine_Field_Prim, utils_xp.

Copyright / Disclaimer

This software/documentation was produced as part of the INDEX project (Intelligent Data Extraction) which is funded under contract ESPRIT EP22745 of the European Community. For further details see http://www.man.ac.uk/MVC/research/INDEX/Public/. Copyright (c) June 1998, Manchester Visualisation Centre, UK. All Rights Reserved. Permission to use, copy, modify and distribute this software and its documentation is hereby granted without fee, provided that the above copyright notice and this permission notice appear in all copies of this software / documentation. This software/documentation is provided with no warranty, express or implied, including, without limitation, warrant of merchantability or fitness for a particular purpose.