333333333 3333 AVS MODULE R333333333333EFERENCE Release 5 February, 1993 Advanced Visual Systems Inc.33333333 Part Number: 320-0014-03, Rev A NOTICE This document, and the software and other products described or referenced in it, are con®dential and proprietary products of Advanced Visual Systems Inc. (AVS Inc.) or its licensors. They are provided under, and are subject to, the terms and conditions of a written license agreement between AVS Inc. and its customer, and may not be transferred, disclosed or otherwise provided to third parties, unless otherwise permitted by that agreement. NO REPRESENTATION OR OTHER AFFIRMATION OF FACT CONTAINED IN THIS DOCUMENT, INCLUDING WITHOUT LIMITATION STATEMENTS REGARDING CAPACITY, PERFORMANCE, OR SUITABILITY FOR USE OF SOFTWARE DESCRIBED HEREIN, SHALL BE DEEMED TO BE A WARRANTY BY AVS INC. FOR ANY PURPOSE OR GIVE RISE TO ANY LIABILITY OF AVS INC. WHATSOEVER. AVS INC. MAKES NO WARRANTY OF ANY KIND IN OR WITH REGARD TO THIS DOCUMENT, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. AVS INC. SHALL NOT BE RESPONSIBLE FOR ANY ERRORS THAT MAY APPEAR IN THIS DOCUMENT AND SHALL NOT BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION INCIDENTAL, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATED TO THIS DOCUMENT OR THE INFORMATION CONTAINED IN IT, EVEN IF AVS INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The speci®cations and other information contained in this document for some purposes may not be complete, current or correct, and are subject to change without notice. The reader should consult AVS Inc. for more detailed and current information. Copyright 1989, 1990, 1991, 1992, 1993 Advanced Visual Systems Inc. All Rights Reserved AVS is a trademark of Advanced Visual Systems Inc. STARDENT is a registered trademark of Advanced Visual Systems Inc. IBM is a registered trademark of International Business Machines Corporation. AIX, AIXwindows, and RISC System/6000 are trademarks of International Business Machines Corporation. DEC, ULTRIX, OpenVMS, VMS, DECwindows, DMS, VAX, ULTRIX Worksystem Software, and the DIGITAL logo are trademarks or registered trademarks of Digital Equipment Corporation. NFS was created and developed by, and is a trademark of Sun Microsystems, Inc. HP is a trademark of Hewlett-Packard. CRAY, CRAY X-MP EA, and CRAY Y-MP are registered trademarks of Cray Research, Inc. Sun Microsystems is a registered trademark of Sun Microsystems, Inc. SPARC is a registered trademark of SPARC International. SPARCstation is a registered trademark of SPARC International, licensed exclusively to Sun Microsystems, Inc. OpenWindows, SunOS, Solaris, XDR, XGL, and SunVision are trademarks or registered trademarks of Sun Microsystems, Inc. UNIX and OPEN LOOK are registered trademarks of UNIX System Laboratories, Inc. Motif is a trademark of the Open Software Foundation. IRIS and Silicon Graphics are registered trademarks of Silicon Graphics, Inc. IRIX, IRIS Indigo, IRIS GL, Elan Graphics, IRIS Crimson, and Personal IRIS are trademarks of Silicon Graphics, Inc. DG/UX and AViiON are trademarks and registered trademarks of Data General Corporation. Mathematica is a trademark of Wolfram Research, Inc. X WINDOW SYSTEM is a trademark of MIT. PostScript is a registered trademark of Adobe Systems, Inc. FLEXlm is a trademark of Highland Software, Inc. RESTRICTED RIGHTS LEGEND (U.S. Department of Defense Users) Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights In Technical Data and Computer Software clause at DFARS 252.227±7013. RESTRICTED RIGHTS NOTICE (U.S. Government Users excluding DoD) Notwithstanding any other lease or license agreement that may pertain to, or accompany the delivery of this computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in the Commercial Computer Software Ð Restricted Rights clause at FAR 52.227±19(c)(2). Advanced Visual Systems Inc. 300 Fifth Ave. Waltham, MA 02154 3333333333333333333AVS Modules NAME AVS modules ± introduction to manual pages for AVS modules DESCRIPTION This man page summarizes all modules available with the AVS distribution in alpha- betical order. The individual module man pages follow in alphabetical order. The manual pages are also available on-line. You can view them within AVS by clicking on the small square "dimple" in any module icon with the middle or right mouse button to open its Module Editor window. Then click the Show Module Documentation button to view the complete manual page for the module. They may also be seen using the regular help browser, in the following directory: $AVS_PATH/runtime/help/modules MODULE LIBRARIES Modules are organized into module libraries for easy interactive access. By default, these module libraries appear when you ®rst start AVS: Supported Imaging Volume UCD FiniteDiff Animation (if present on your system) Chemistry Unsupported All modules are in the Supported module library except Animation, Chemistry, and the Unsupported modules. Any one module can be in multiple module libraries. At the top of each module's man page there is an "Availability" line that lists which module libraries the module can be found in, in addition to the default Supported library. Each module library is described on its own man page. INPUT/OUTPUT DATA TYPE NOTATION The data-types that AVS modules operate on are described in the "Importing Data into AVS" chapter of the AVS User's Guide, and in the AVS Developer's Guide in the chapter, "AVS Data Types". Throughout the manual pages for AVS modules, a number of terms are used to describe these data types. It is important to understand these terms, as they specify what inputs a given module can receive, and what out- puts it will generate. any-dimension: when a module accepts ®elds of any-dimension, this means that it can process ®elds that are 1D, 2D, 3D, and in some cases 4D; but never more than this. n-vector: if a ®eld has one value at each location, it is a scalar ®eld. When a module accepts n-vector ®elds, it can receive ®elds with an indeterminate number of values at each location. any-data: if a module accepts any-data, this means it can receive byte, short, integer, ¯oat, or double data. If it is more restrictive, this will be declared. any-coordinates: if a module accepts data of any-coordinates, this means that it can operate on 33333333333333333333333333®elds which have uniform, rectilinear, or irregular coordinates. If a module AVS Module Reference Manual 1 AVS3333333333333333333 Modules cannot operate on one of these types of ®eld, this will be declared. PLATFORM DEPENDENCE Some mapper modules required specialized graphics rendering support such as 3D texture mapping (brick, excavate brick, etc.) and object transparency (alpha blend, volume render, etc.). This specialized rendering support can be provided in software (via the software renderer), or by hardware. However, not all hardware rendering platforms support all specialized rendering features. The hardware rendering features available on your platform should be de®ned in a table in the release notes that accompany the AVS software product for that platform. The software renderer supports most specialized rendering features except vertex tran- sparency. Each module with specialized rendering requirements has an "Availability" notation near the top of its module man page that de®nes the support needed. If your renderer does not support the function, the picture will not appear as documented. For example, a texture-mapped object will appear as an uncolored, featureless object. Transparent objects will be opaque, or not drawn at all. You can almost always acquire the specialized rendering support by switching on the Software Renderer option on the Geometry Viewer's Cameras submenu. If no such selection appears on the Cameras submenu, it means that the software renderer is probably the only renderer available and is already performing rendering functions in the AVS Geometry Viewer. MODULE LISTING The modules included in this release of AVS are: AVS modules introduction to manual pages for AVS modules Finite Difference Module Library a list of supported modules that are also in the FiniteDiff module library Imaging Module Library a list of supported modules that are also in the Imaging module library UCD Module Library a list of supported modules that are also in the UCD module library Unsupported Module Library a list of unsupported modules Volume Module Library a list of supported modules that are also in the Volume module library AVS module groups Types of AVS modules avs Starting the Application Visualization System. Describes AVS command line options, .avsrc startup ®le keywords, and environment variables. alpha blend generate 2D image from 3D colored data (unsupported library) animated ¯oat send a sequence of ¯oating point numbers to a module's parameter port animated integer send a sequence of integers to a module's parameter port 33333333333333333333333333 2 AVS Module Reference Manual 3333333333333333333AVS Modules animate lines animate stream lines for a vector ®eld antialias antialias an image arbitrary slicer map 3D scalar ®eld to 3D mesh average down downsize a ®eld in X, Y, or Z by averaging AVS Animator keyframe animation module (Animation library) background create a shaded backdrop image blend colormaps interpolate between two colormaps in HSVA space boolean send a user-entered boolean