Bookshelf Contents Previous Next Glossary Index Search



List of Stand-alone Utilities

The following is a set of stand-alone programs that can be used with Alias. Some of these utilities are optional components of the Alias system. All of these stand-alone utilities are run from a UNIX shell.

AlToCa translates Alias wire files to CAI files.
AlToIv translates Alias wire files to Inventor files.
AliasToRenderman creates a RIB file from an Alias wire file.
Alias is the Alias interactive package's binary file.
Alias sets all environment variables required and runs the interactive package in the same location as this file.
AliasBatch The standalone utility Alias -B has been replaced by the application AliasBatch, which uses the OpenModel API
alias_to_sgo converts Alias triangle files to SGI sgo files.
AlToSt converts Alias wire files to ISO10303 format
alias_render_demon is part of Distributed Render Control.
aliasWarning displays error messages for the interactive package.
aquant (Alias Image Quantizer) quantizes Alias image files down into fewer bits per pixel.
aXe is a text editor program.
axe is a script that sets important variables for the executable aXe.
beep rings the console bell.
convert provides a number of simple image processing tools such as changing the number of channels or creating a complimentary image.
depthmap converts a camera depth_file into an Alias run-length encoded mask (8-bit) file.
dxf_info provides information on DXF entities.
fastrender is a real-time renderer that uses SGI's Reality Engine.
filace interlaces scanlines of images rendered on fields into a single interlaced image.
findit is a shell script that checks whether a given picture file exists on the render engine. It is used internally by Alias for the standard render control window.
FLEXlm is a licence management program from Globetrotter Software.
flipbook is an Animation preview utility with advanced playback and compression options.
fmovie converts a sequence of Alias image files into an SGI or Apple QuickTime movie.
fpaste pastes images together incompletely rendered images.
froam roams through pix files that are larger than the screen size.
fstats provides information on the number of completed scanlines in an Alias format pix file.
ftarga converts AT&T TARGA Format 10 image files to Alias pix files (and vice versa).
ftiff converts Alias pix files to TIFF format.
ftile tiles a sequence of images into a single, larger image.
gamma applies a specified gamma conversion factor to an image.
get_alias_variable determines the value of an Alias preference variable.
getid displays Alias system information.
harry converts Harry format files to or from Alias format.
hp_glplotf, hp_gl2plotf translates Alias plot files into HP-GL (IBM-GL) and HP-GL2 formats.
iges_info provides information on IGES entities.
IncreaseVSwap verifies that the size of a machine's virtual swap space is at the optimal level.
install_glib installs the games library
IvToAl translates Inventor files to Alias wire files.
linerender renders the polyline files created during a PowerToon render.
makebot creates block ordered texture file
lmutil is the executable that runs the FLEXlm license management program. See the FLEXlm section in this manual.
make_pix_icons produces icons to represent image files in the File Browser.
matteRGB converts 8-bit matte files to Alias format.
nprocs displays information about the host machine's processor(s)
onlineDocs opens online documentation viewer (HyperHelp) with welcome window.
pim plug-in manager
pixdiff compares two pix files for differences.
pix2omf converts Alias run-length encoded files to OMFI format.
powercaster is a command line parallel renderer for Alias SDL files. See the description for the renderer/raytracer (incl. powercaster/powertracer) stand-alone.
powertracer is a command line parallel raytracer for Alias SDL files. See the description for the renderer/raytracer (incl. powercaster/powertracer) stand-alone.
PRenderToAlias converts Pro/Engineer Render Format files to Alias wire files to import them into Alias.
print_wire_header views the header of wire files.
psplotf translates Alias plot files into PostScript.
pst, pstget creates simple editor windows of the type used by Alias.
raytracer is a command line raytracer for Alias SDL files.
rb_stereo combines stereo pairs of images for viewing with red/blue glasses.
renderer/raytracer (incl. powercaster/powertracer) is a command line renderer for Alias SDL files.
renderit is a shell script to execute the rendering code. It copies files to the proper locations and, if necessary, starts the renderit script on a remote machine.
rndctl runs the distributed render job control window from outside Alias.
runalias starts the Alias interactive package and sets the environment variables.
Run3Design starts the 3Design program and sets the environment variables.
RunComposer starts the Record Only Composer program and sets the environment variables.
setupacct customizes user account for use with Alias software.
showstereo loads images onto Stereographics monitor.
sla translates files for SLA-1 output.
StToAl Converts ISO10303 files to Alias wire files.
surfmate processes triangle data to ensure that objects are topologically closed (watertight).
systemInfo displays Alias system information in a window. See the getid stand-alone description for more information.
unlace splits one or more image files into separate even and odd fields.
vda_info provides information about VDA entities.
viewErrlog opens the Alias error log file in a text editor. For more information, see File View errlog... in the Alias Menu Book.
write_multiple_sdl converts wire files to SDL files.
wrl displays Alias files on the screen.

AliasBatch

Purpose

The standalone utility Alias -B has been replaced by the application AliasBatch, which uses the OpenModel API. You will find this new application offers more robustness. For help on this new facility, type:

AliasBatch -h
Note:

Alias -B is no longer supported.

Description

The usage statement for AliasBatch is as follows:

:

AliasBatch [-h] [-w -sdl -r1 -r2] [-o...] -s RetFile...
AliasBatch launches the Alias Batch Processor, reads in RetFile, translates according to settings in an options file, writes out as SavFile, and then exits
-h Displays help information
-o[OptFile] Loads the options file OptFile (its full path is required).
-s[SavFile] Writes output to SavFile. This option is compulsory.
-w Overwrites SavFile if it exists
-sdl Sets the format to SDL; overrides the save format in the options file
-r1 Optimizes redundant pre-V5.0 trimmed surfaces by converting them to surfaces
-r2 Optimizes redundant pre-V5.0 trimmed surfaces by converting to face geometry
RetFile Retrieves files at start up (wire, DXF, IGES, etc.)

AlToCa

Purpose

AlToCa translates Alias wire file to CAI (CATIA/Alias Interoperability) format files.

Description

The usage statement for AlToCa is as follows:

:

AlToCa [ options ] -i<input Wire file> -o<output CAI file>

Options:
-h outputs online help
-b displays a log file on screen during execution
-x produces an extended log file
-i input Wire file filename; if not specified, stdin is used
-o output CAI filename; must be specified

AlToIv

Purpose

AlToIv translates Alias wire file to Inventor format files.

Description

The usage statement for AlToIv is as follows:

:

AlToIv [ options ] [<infile> [<outfile>]]

Options:
-h outputs online help
-binary switches the output to a more compact Inventor binary format. The default is Inventor ASCII format.
-ascii outputs the ASCII inventor
-verbose displays all messages.
-quiet operates with no feedback
-notransforms outputs world space objects
-alltransforms outputs a full hierachy with transforms at each DAG node and each object space object
-transforms outputs required transforms at each DAG node and at each object space object
-tri tesselates all NURBS surfaces to triangles using settings from the Render Stats window
-quad tesselates all NURBS surfaces to quadrangles wherever possible, using settings from thje Render Stats window
-nurb outputs NURBS surfaces
-cameras outputs cameras
-nocameras does not output cameras
-instances converts Alias instances to Inventor instances
-noinstances converts Alias instances to copies
-inline creates inline texture date instead of references
-noinline creates referenced textures where possible (for file textures only)
-inventory creates a single Inventor material or texture for each Alias material or texture, and an instance for each object
-noinventory creates an Inventor material or texture for each object
-units name outputs units with a specific name to indicate the type of the units. Name can be:
  • MICRONS (units are in microns)
  • MILLIMETERS (units are in millimeters)
  • CENTIMETERS (units are in centimeters)
  • METERS (units are in meters)
  • KILOMETERS (units are in kilometers)
  • INCHES (units are in inches)
  • FEET (units are in feet)
  • MILES (units are in miles)
-nounits don't output units
-scale scale scale the Inventor file by a specified amount
-xres resolution Non-file textures sample to this X resolution
-yres resolution Non-file textures sample to this Y resolution
-noinstances does not convert Alias instances to Inventor instances
Where:
<infile> specifies an Alias wire file to use as input. If not specified, input comes from stdin.
<outfile> specifies an Inventor file to write output to. If it is not specified, the output is written to stdout.

AliasToRenderman

Purpose

AliasToRenderman converts Alias wire files to Renderman Interchange Bytestream (RIB) format files.

Description

The usage statement for AliasToRenderman is as follows:

:

AliasToRenderman [-a #] [-A #] [-b #] [-B #] [-c #] [-C <channels>] [-e #] [-E #] [-f #] [-F

<format>] [-h#] [-H] [-I <include_file>] [-j #] [-L <light_file>] [-m #] [-N <extract_name>] [-o 
<rib_file>] [-O <object_file>] [-p <image_file> ] [-r #] [-s #] [-S <shader_file>] [-T #] [-v #] [-w 
#] [-x #] <alias_wire_file>
where
-a # specifies # as the supersampling rate. The supersampling rate is also known as the AAlevel or PixelSamples. The value # is treated as an integer. There is no constraint on the value of this field nor is any checking performed. The default value is 2.
-A # specifies # as the shutter angle. This option is ignored if there is no animation or if motion blur is turned off. When animation exists and motion blur is being used, this option specifies the duration of the shutter opening. # is specified in degrees by convention. Zero degrees means zero duration, 360 degrees means one full frame, 180 degrees means one half of a frame time, and so on. The shutter is considered to open at current_frame time and to close at current_frame+(shutter_angle/360). A value of zero forces motion blur to be off. The value # is treated as a floating point number. There are no limits on the value #. The default value is 180.
-b # specifies # as the increment in frame time between frames of an animation. This is ignored if the model does not contain any animation. The value # is treated as a floating point number, and must be greater than zero. A value less than or equal to zero is ignored and the default value is used. The default value is 1. See option -o for a discussion of the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size.
-B # specifies # as the increment to the file name extensions when outputting an animation. This option is ignored if the model does not contain any animation. The value # is treated as an integer, and must be greater than zero. A value less than or equal to zero is ignored and the default is used. The default value is the smallest integer greater than or equal to by_frame. See option -o for a discussion of the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size.
-c # specifies the form of the output. If # is zero, all RIB output is in compacted (binary) form. If # is any other value, RIB output is in ASCII text form. The default is to output in ASCII format.
-C <channels> controls the number and type of image channels to be output by the renderer. <channels> specifies the string to pass directly to the RIB output via the mode parameter to the Display command. There is no constraint on the value of this option. The default value is "rgba".
-e # specifies # as the ending frame time of the animation. # does not need to relate to the actual animation range of the model at all. This option is ignored if the model does not contain animation. The value # is treated as a floating point number and must be greater than or equal to the start frame. If it is not, the translator automatically swaps them. The default value is 1. See option -o for a discussion of the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size.
-E # specifies # as the minimum field size for the file name extension when generating multiple files for an animation. This option is ignored if the model does not contain any animation. The actual extension size used is the larger of the value given and the actual size of start_extension. The actual size of start_extension may in turn derive from its default. The value # is treated as an integer. The default is the actual size of start_extension. See option -o for a discussion of the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size.
-f # specifies how faces are output. If # is zero, all Alias faces are output as trimmed NURBS. If # is any other value, faces are output as polygons. The default is to output faces as polygons.
-F <format> controls the destination of the rendered output where <format> is a string which is passed directly to the RIB output via the mode parameter to the Display command. There is no constraint on the value of this field nor is any checking performed. The default <format> is file.
-h # specifies # as the height of the rendered image. The value # is treated as an integer and must be greater than zero. Invalid values are ignored and the default value is used. The default value is 486 (NTSC).
-H prints usage information on standard output and exits the translator. This is the only option which does not require an argument.
-I <include_file> copies the file to the RIB output file. <include_file> is a string that is interpreted as a UNIX filename. If you are animating the file, it is copied to each of the output files generated. Any I/O problems are reported as errors. The default is that no file is included.
-j # controls jittering. If # is 0, jittering is not used for the rendering. If # is any other value, jittering is used for the rendering. The amount of jittering depends on the renderer implementation. The default is 0.
-L <light_file> specifies a light extraction file. <light_file> is a string that is interpreted as a UNIX filename. Which lights are output is controlled by the -N option to be either all lights or only the light named by -N. This output is in addition to any other specified output files. The actual filename used has an extension appended in the same manner as other output files. Only light definitions and messages are output to this file. No other information is output to this file. The default is that no light file is created. See the -o option for further information.
-m # specifies the state of motion blur. If # is 0, motion blur is turned off in the output. If # is any other value, motion blur is turned on. The default is that motion blur is on.
-N <extract_name> specifies the name of an item in the model as the string <extract_name>. If <extract_name> is specified, only the item named is output to an extract file. Since items in an Alias model have unique names, only one item can possibly match no matter how many extract files are specified. If no extract files are specified, the extract name is ignored. If no extract name is specified, then each extract file contains all items of the appropriate type. The default behavior is that no extract name is specified. See the -L, -O, and -S options for further information.
-o <rib_file> specifies that the entire Alias model is to be translated and output to <rib_file> where <rib_file> is a string that is interpreted as a UNIX filename. The <rib_file> output is in addition to any output that may be generated by extract files. For further information see -L, -O and -S. If the Alias model contains animation, the translator is animating. When animating, each frame to be output generates a separate file using a filename consisting of the given filename with an extension. The extension is a positive integer. The number of output frames is controlled by the values of start_frame (-s), by_frame (-b), and end_frame (-e). The sense of frame time is first set to the start_frame value and one file is generated. Frame time then increments by the by_frame value and tests against the end_frame value. If the current frame time is less than or equal to the end_frame value, another file is output. This continues until the test of frame time fails. Each output file generated has an extension. The first file has an extension specified as start_extension (-T). Each subsequent file has the extension number incremented by the by_extension value (-B). All extension numbers are increased by high order zeros to a length specified by extension_size characters (-E). The values of the extensions do not need to be related to the sense of frame time in any way except that they are constrained to increase over the course of the animation. All extracted files, lights (-L), objects (-O), and shaders (-S), also have extensions appended in the same manner. Start_frame, by_frame, and end_frame all default to 1. Start_extension and by_extension default to the actual values for start_frame and by_frame respectively. None of these values reflect the actual animation range of the model unless you specify it. Information messages are generated stating both the range occurring in the model and the range you specified. If the Alias model contains no animation, the translator does not animate. When not animating, only one file of each type discussed above (-L, -O, -o, and -S) is created. The file generated does not have an extension. The values of start_frame, by_frame, end_frame, start_extension, by_extension, and motion blur are all ignored. The value of <rib_file> is not verified. The value of <rib_file> is used to construct the default value for the rendered image. For further information see -p. <rib_file> has no default value of its own. The default behavior is to not translate the Alias model at all.
-O <object_file> specifies the file where objects in the model are to be stored. <object_file> is a string that is interpreted as a UNIX filename. Which objects are output is controlled by the -N option to be either all objects or only the object named by -N. This output is in addition to any going to other output files. The actual filename used has an extension in the same manner as other output files. See the -o option for further information. Only object definitions and messages are output to this file. No other information is output to this file. The default is that no object file is created.
-p <image_file> passes the name of the rendered output to the RIB file using the Display command. <image_file> is the name of the rendered output. If the rendered output is an animation, the name specified has an extension as if it were a filename. The name given is not checked for validity in any way. The default name is <rib_file>.tiff. For further information see the -o option.
-r # specifies # as the pixel aspect ratio of the rendering. The pixel aspect ratio of the rendering is passed on to the output via the Format command. The value # is treated as a floating point number. The default value is 1.
-s # specifies # as the starting frame time of the animation. The starting frame time does not need to relate to the actual animation range of the model, except that it is ignored if the model does not contain any animation. The value must be less than or equal to the end frame. If it is not, the translator automatically swaps the start and end frame times. See option -o for further information about the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size. The value # is treated as a floating point number. The default is 1.
-S <shader_file> outputs the shaders in the model to the specified file where <shader_file> is a string that is interpreted as a UNIX filename. Which shaders are output is controlled by the -N option to be either all shaders or only the shader named by -N. This output is in addition to any other output files. The actual filename used has an extension in the same manner as other output files. See the -o option for further information. Only shader definitions and messages are output to this file. No other information is output to this file. The default is that no shader file is created.
-T # specifies # as the starting number for the file name extensions when outputting an animation. This option is ignored if the model does not contain animation. The value # is treated as an integer, and must be greater than or equal to zero. A value less than zero is ignored and the default is used. See option -o for a discussion of the inter-related values of start_frame, end_frame, by_frame, start_extension, by_extension, and extension_size. The default value is the smallest integer greater than or equal to start_frame.
-v # specifies the type of messages to output. If # is zero, only error messages are output. If # is any other value, information messages are also output. Error messages are output to all output files as comments as well as to stderr at all times. Information messages are output to all output files and to stderr, only if this option is on. The default is to output all messages.
-w # specifies # as the width of the rendered image. The value # is treated as an integer and must be greater than zero. An invalid value is ignored and the default is used. The default value is 645 (NTSC).
-x # specifies whether or not header information will be displayed. If # is zero, all RIB header information (Format, Display, Hider, and PixelSamples) are output. If # is any other value, the header information is suppressed. This is useful if the header is supplied by an include file. The default is to output header information.

Using Options

All options except -H require an argument.

You do not need to specify any options, but omitted options assume their default value or behavior.

You can specify any combination of options in any order.

Limitations

  1. Procedural textures in Alias are not supported in our RIB output. This is due to the large differences between Alias's and PIXAR's shading languages. We have no plans to write Alias's textures in RenderMan format.
  2. There is not a one-to-one mapping from Alias's shaders to PIXAR's shaders. We try to approximate the look as best we can, but a test render should always be done before committing an entire animation.
  3. Other significant features of Alias which are unsupported include linear lights, area lights, backgrounds (all types), ambient shade, bump mapping, displacement mapping, and LAYERED fog.
  4. AliasToRenderman does not support Orthographic cameras. If more than one perspective camera is present, only the first is output.
  5. RenderMan does not perform automatic generation of shadow maps for spotlights, therefore Alias's RIB output does not either. For information on creating shadows, please refer to The RenderMan Companion by Steve Upstill, Addison Wesley, 1990, ISBN 0-201-50868-0.

alias_to_sgo

Purpose

alias_to_sgo converts Alias extended triangle files to Silicon Graphics Object (SGO) files.

An Alias extended triangle file is produced by saving an Alias model using the Object Separators option of the Polygon File Output Options window (File Export Save polygons - ).

Description

The usage statement for alias_to_sgo is as follows:

:

alias_to_sgo [-h] [-t] [-v] <alias.tri> <sgi.sgo>

where
alias.tri is an Alias extended triangle file.
-h prints the usage information.
-t prints object and triangle count totals.
-v prints the name and number of triangles for each Alias object processed as well as the total number of objects and triangles.
sgi.sgo is an SGO file.

To view the results of the conversion, use the following command:/usr/demos/bin/perfly -d cube.sgo

Example

An example of a usage statement for alias_to_sgo is as follows:alias_to_sgo -v cube.tri cube.sgo

Hints for Using alias_to_sgo

Color

The color-per-vertex value stored with each triangle vertex in the Alias extended triangle file is affected by Alias lighting and shading calculations.

To avoid permanent highlights on objects in the resulting SGO file:

Normals

When you import an SGO file created by alias_to_sgo to another program (for example, the SGI Performer demo perfly), you may notice that some surfaces are missing, or are rendered transparent or black. This occurs because the surface normals are pointing away from you. The program you imported the SGO to renders only surfaces where the normals are pointing toward you.

To avoid this problem, make sure that the surface normals are pointing in the direction you want them before you create the Alias extended triangle file. Preferably, check the surface normals as you create each surface.

When creating a surface or group of surfaces that describe an enclosed volume, make sure that the surface normals of each surface point toward the outside of the volume (like a porcupine).

You can examine surface normals by using Evaluate Continuity Surface continuity, Locators Deviation measures MinMax deviation, or by simulating the other program's rendering as follows.

Any surface that has its normals reversed (that is, pointing into the volume) will not be rendered when you are looking directly at it, and will allow you to see through the volume.

If you can't see completely through the volume, a surface on the other side of the volume also has its normals pointing towards the inside of the volume.

To flip the normals of a surface to be in the correct direction, use Object Edit Reverse Reverse direction and choose either U or V from the option box and click Go.

Model Complexity

When the Alias extended triangle file is created, the number of triangles produced for each surface is governed by the rendering subdivision type. This can be set using Render globals and Windows Render stats....

To produce the minimum number of triangles for surfaces and also the lowest quality, use the following instructions according to which command you have chosen to use.

In the Object Rendering Parameters window, toggle Adaptive Subdiv OFF and set the Minimum and Maximum Subdiv levels to 1.

In the Render Globals window, select LOW for the Global Quality Level, Adaptive for the Subdivision type, and set the Adaptive Maximum level to 1.

AlToSt

Purpose

Converts Alias wire files to ISO10303 format, specifically application protocols ISO10303-203 (Configuration Controlled Design) conformance classes 1-4, and ISO10303-214 (Core Data for Automotive Mechanical Design Process) conformance classes 1-2. The import and export of this data is supported via ISO10303-21 Physical file exchange.

Application Protocol Support

The geometric data contained within ISO10303-203 and ISO10303-214 are identical. This comprises the core of the implementation of the translator. The following table shows the mappings made.

Step Entity Alias Entity
Cartesian Point Point
Line B-Spline Curve
Circle B-Spline Curve
Ellipse B-Spline Curve
Parabola B-Spline Curve
Hyperbola B-Spline Curve
PolyLine B-Spline Curve
Composite Curve B-Spline Curve (Grouped)
Trimmed Curve B-Spline Curve
B-Spline Curve B-Spline Curve
Plane B-Spline Surface
Cylindrical Surface B-Spline Surface
Conical Surface B-Spline Surface
Spherical Surface B-Spline Surface
Toroidal Surface B-Spline Surface
Surface of Linear Extrusion B-Spline Surface
Surface of Revolution B-Spline Surface
B-Spline Surface B-Spline Surface
Rectangular Trimmed Surface Trimmed Surface
Curve Bounded Surface Trimmed Surface
Offset Surface B-Spline Surface
Manifold Solid Brep Shell (Closed)
Shell Based Surface Model Shell (Open/Closed)

STEP Logfile

When retrieval is finished, without errors this message is displayed:STEP files retrieved successfully.

If there were errors in the retrieval, this message is displayed:Problem Reading Step File, refer to log file for details.

The STEP logfile contain a specific error message for each problem entity that is encountered. Each error contains the STEP entity ID and entity type.

Description

The usage statement for AlToSt is as follows:

AlToSt [ <options> ] <infile> <outfile>
Options:
-p specifies which AP to output: either 203 or 214. The default is AP214
-m value specifies which model representation to output. Value can be one of:
  • 1 = wireframes
  • 2 = surface models
  • 3 = manifold surface models (shells)
  • 5 = brep solids
  • 6 = hybrid models (the default)
-t value specifies the type of trimming that is done. This option is valid for surface models only. Value can be one of:
  • 1 = parameter space trimming (the default)
  • 2= world space trimming
-g value specifies the type of geometry to output. This option is valid only for shells. Value can be one of:
  • 1 = shells only (the default)
  • 2 = all geometry
-c outputs presentation data. This option is valid only for AP214 files.
-l outputs layer data. This option is valid only for AP214 files.
-h Displays help on usage
Where:
<infile> specifies an Alias wire file to use as input.
<outfile> specifies the STEP file to write output to.

aquant (Alias Image Quantizer)

Purpose

aquant quantizes 24-bit images down to 16 or fewer bits.

Description

By default, aquant creates a 24-bit image, with the same name as the input pix file, but adding the extension _quant. This new image is in the same file format as the input file and uses only the colors calculated in the reduced color table.

The usage statement for aquant is as follows:

aquant [-s#] [-e#] [-b#] [-E#] [-f] [-F] [-a] [-d#] [-p] [-P<str>] [-T] [-Z] [-z] [-v] [-h]<pix_file_name>

where
-s # sets the start frame for <pix_file_name>.
-e # sets the end frame for <pix_file_name>.
-b # sets the by frame for <pix_file_name>.
-E # sets the character length of the frame extension (i.e. 2 -> \Q.01').
-f applies a Floyd/Steinberg dither.
-F applies a modified Floyd/Steinberg dither.
-a uses average deviation rather than number of pixels for the median cut.
-d# sets the bit depth of quantization. The default is 8-bit or 256 colors. The maximum is 16-bit or 65,536 colors.
-p prints the color table in ASCII to stdout.
-P <str> reads an ASCII color table from the file `str'.
-T stores everything in a TIFF file with the extension _tiff added to the input filename.
-Z eliminates all (0,0,0) pixels from the input.
-z forces all colors (0,0,0) to be quantized to (0,0,1) at output.
-v prints all warnings and other messages.
-h prints the online help.

TIFF files can only be generated for quantization to 8 bits/pixel.

Example

The usual method for quantizing an animation for playback on 8-bit hardware (such as a games system) is a 2-step process:

  1. Create the color map table from a sample of the complete animation.
  2. Use the generated table to quantize the complete animation.

Create the color map table from a sample of the complete animation

  1. Produce a good sample of the color map for the animation by quantizing a portion of the complete sequence of 201 frames. Example: starting at frame 1 and setting a by-frame of 50. The following files are produced: file.1file.51file.101file.151file.201
  2. Generate the color map for the sequence of frames using the following command: aquant -s 1 -e 201 -b 50 -d 8 -p file > color.map
  3. The by-frame (-b) is set to 50 in order to sample just a few of the frames.

    The colour map generated is redirected (>) to the file color.map with a median cut algorithm on all the pixels of the files listed above.

Use the generated table to quantize the complete animation

Use the file color.map generated in the above run as input to aquant for a 2nd pass to quantize all of the files in the sequence. The following command quantizes each image of the full sequence when rendering: aquant -s 1 -e 201 -b 1 -F -P color.map file

The by-frame (-b) value is now set to be 1, to quantize each frame. The -P option specifies the colour map file to use.

aquant creates a quantized version of each file in the animation called file_quant.<frame>t

aXe

Purpose

aXe provides an easy introduction to text editing, but it is hoped that it is also sufficiently flexible to continue to meet most of your needs as your editing skills develop.

Overview

aXe can be used to edit several files at once, with each file allocated to an editing buffer. An aXe window can support many buffers, but only one is visible at a time. You determine the allocation of files to buffers, and hence to windows.

aXe's Layout

The aXe window consists of five visible parts as follows:

Filename Line

The Filename Line is a field showing the name of the file currently displayed in the editing buffer window. If a file has not been associated with this window then No name is displayed on the Filename Line.

The filename is preceded by * if the text in the Editing buffer contains unsaved changes.

The symbol ~ at the beginning of a filename is shorthand for your home directory.

You can suppress the display of the Filename line. See the Help Menu -> customize for details.

Information Line

The Information Line is a field that is updated with brief explanations of the action that would be performed if the left mouse button were clicked with the mouse pointer in the current position.

The information line also displays information arising from some actions, and for some error messages.

If an action can be performed using a keyboard shortcut, the information line contains a description of the shortcut. The shortcut is enclosed in square brackets as follows [ Ctrl-a ].

You can suppress the display of the Information line. See the Help Menu Customise for details.

Keyboard Shortcuts

Many of the operations found in the menus, and some operations of the buttons, have keyboard shortcuts. The complete set of default shortcuts can be seen in a separate window by selecting Bindings from the Help menu.

The keyboard shortcut Ctrl-a, which moves you to the beginning of the line, means press and hold down the Ctrl key, press and release the A key, and then release the Ctrl key.

Other operations involve the use of the Alt key. The Alt key is used similarly to the Ctrl key.

Some of the operations that are available via the menus and buttons do not have default keyboard shortcuts. Instructions on how they too can be associated with key strokes can be viewed in a separate window by selecting Customise from the Help menu.

Customizing keyboard shortcuts assumes you know how to use and specify X resources.

Menu Bar

The Menu Bar contains pulldown menus.

To open a pulldown menu:

To select a menu item, drag down the menu list, and release the button when the pointer is over the menu item you want to select.

As the mouse pointer moves over a menu entry a one line explanation of the item's function is displayed in the information bar immediately above.

Move Menu

The Move menu appears as follows:

The Move menu contains commands to control the position of the cursor within the editing buffer.

Search Menu

The Search menu appears as follows:

The Search menu contains commands to search within the text in the editing buffer.

The Text entry with the upward pointing arrow searches backward through the text for the item you have selected.

The Text entry with the downward pointing arrow searches forward through the text for the item you have selected.

The Line entry searches for a specific line in the text in the editing buffer.

The Caret entry searches for the text insertion point within the text in the editing buffer.

The Selection entry with the upward pointing arrow searches backward through the text for the item you have selected.

The Selection entry with the downward pointing arrow searches forward through the text for the item you have selected.

Insert Menu

The Insert menu appears as follows:

The Insert menu contains commands to add text or codes to the text in the editing buffer.

Delete Menu

The Delete menu appears as follows:

The Delete menu contains commands to remove text or codes from the text in the editing buffer.

Help Menu

The Help menu appears as follows:

The General entry displays the general help information about aXe.

The Bindings entry creates custom keyboard shortcuts for menu commands. For further information, see the Keyboard Shortcuts section above.

The Customise entry creates a special set of buttons for menu commands. For further information, see the Menu Buttons section below.

Misc Menu

The Misc menu appears as follows:

The Where? entry displays the pathname to the location of the text in the editing buffer.

The Size? entry displays information about the size of the text file in the editing buffer.

The first Centre entry positions the text equidistantly from the beginning and the end of the editing buffer.

The second Centre entry positions the text in the centre of the editing buffer equidistantly from the sides.

Font Menu

The Font menu appears as follows:

The Font menu contains options for you to specify the size of the text in the editing buffer.

Window Menu

The Window menu appears as follows:

The Window menu contains options for you to open, load, close, minimize, or maximize editing buffer windows.

Buffer Menu

The Buffer menu appears as follows:

The Buffer menu contains options for you to open, clear, or close the editing buffer window.

Show Menu

The Show menu appears as follows:

The Show menu shows the names of all of the files you have loaded into buffers. The name of the file in the current editing buffer window has a check mark beside it.

Dividing lines are drawn to group the files associated with individual windows.

File Menu

The File menu appears as follows:

The File menu contains the save and load functions.

Quit Menu

The Quit menu appears as follows:

The Quit menu contains the functions that save text files and close the editing buffer windows and the aXe window.

aXe Menu

The aXe menu appears as follows:

Clicking the axe icon in the menu bar opens the above information window about the version of aXe you have on your machine.

Menu Buttons

After a time you may find it too slow to access operations you perform frequently using the menus. There is an optional button interface in which an array of buttons representing every menu bar menu entry is permanently displayed underneath the menu bar.

To use the button interface, start aXe with the following command:axe -buttons

To use a menu button, click the left mouse button when the mouse pointer is over it and the button is highlighted.

You can display a customized set of buttons by selecting Help Customise. A good compromise is to have your most frequently used operations available via buttons and the less frequently used operations still in the menus.

Editing Buffer

The Editing Buffer is an area displaying the text of the file that is being edited or created.

You can move through the text in the editing buffer and make changes to it from the keyboard or by using the mouse.

The current position, or insertion point, in the text is denoted by a caret (^). It lies between characters and is initially right at the top of the file before the first character.

In order to edit using the keyboard, the mouse pointer - the symbol that moves around the screen as the mouse is moved - must lie somewhere within the editing buffer area.

The pointer symbol changes depending on which part of the screen it is over. When it is in an editable text area, the editing buffer or the Mini Buffer, it looks similar to the letter I.

With the pointer in the editing buffer area, typing on the keyboard inserts the characters typed at the insertion point.The character immediately to the left of the insertion point is erased by using the Delete key.

The insertion point can be moved one line or one character at a time by using the cursor (arrow) keys.

An easier way to move the insertion point, especially if you want it to be some way away from the current position, is to move the mouse until the vertical bar of the pointer lies over the character to the right of where you want the insertion point to be. Press and release the left mouse button. The information line updates to show the new line number.

Selecting Text

Text is selected so that some operation can be applied to it, for example deletion or copying to another part of the file.

Slightly moving the mouse while the button is pressed down may result in one or more characters highlighting. If this happens, you can either try again or simply ignore it for the time being.

Some features involve the notion of selected text. Selected text is identifiable as an area of highlighted text. You may already have accidentally created one by moving the mouse with the left button pressed down when attempting to adjust the insertion point.

One way to create a selection is as follows:

Another way to make a selection is to move the pointer to where you want the selection to start and click-drag with the left mouse button to the end point. You can then adjust the selection with the right mouse button.

You can cancel a selection by clicking the left mouse button within the buffer.

Clicking the left mouse button within the buffer usually moves the insertion point to the place where you clicked.

If you didn't highlight the text you wanted, a selection can be adjusted at either end. Just move the pointer to the new end point and click (quickly press and release) the right mouse button, or press the right mouse button and drag toward the new end point while continuing to hold the button down. Release the mouse button when the correct text is highlighted.

Another way to highlight text is to rapidly click the left mouse button the following number of times:

2 selects the word under the pointer. Words are delimited by spaces, tabs, and carriage returns.

3 selects the line under the pointer.

4 selects the paragraph under the pointer. A paragraph boundary is defined two carriage returns with only spaces or tabs between them.

5 selects the entire text.

You should be aware that the selection mechanism is not peculiar to this application. Many other X applications support it, but there can only be one selection across all applications at any one time. Insert/Selection, however, results in the selection, whichever application owns it, being inserted at the current insertion point. And a selection made in this application can be transferred to some other by using its insertion method - usually by clicking the middle mouse button.

Copying Text

You can copy text by choosing Insert Selection or by clicking the middle mouse button. The selection is inserted at the current insertion point. The insertion is at one of the ends of the selection immediately after it has been made, so it will normally have to be moved.

Using the mouse to move the insertion point causes the selection to unhighlight, but it will remain available for insertion until another one is made.

Mini Buffer

The Mini Buffer area contains a menu and a one line text buffer.

The miniMenu for the Mini Buffer appears as follows:

The miniMenu provides convenient access to some of the more complicated facilities that are only available via the Mini Buffer. The options feed the contents of the editing buffer to an external UNIX command for processing and display the output, if any, in a fresh window.

You can suppress the display of the Mini Buffer. See Help Menu Customise for details.

beep

Purpose

beep causes the console to make a beep sound.

Overview

beep has several uses. One common use of beep is to have the console beep at you when a render is complete.

Description

The usage statement for beep is as follows:beep

convert

Purpose

convert uses an input image to produce the following:

Overview

convert accepts and produces the following file formats:

Description

The usage statement for convert is as follows:

:

convert [-a] [-b] [-c] [-C] [-f <format>] [-g] [-h] [-l] [-L] [-r] [-s] [-t] [-T] [-x] [-X] [-y] [-z] [-Z] [-0] [-1] [-3] [-4] infile [alpha_file] outfile
where
-a extracts alpha.
-b extracts blue.
-c extracts a complementary image.
-C extracts a complementary image with black fixed.
-f <format> specifies the format for the output file created.
-g extracts green.
-h extracts hue at full saturation.
-l extracts lightness in grey scale.
-L extracts lightness in the same primary colors as the source image.
-r extracts red.
-s extracts saturation in grey scale.
-t extracts a two-tone image where black stays black and the remainder is white.
-T extracts a two-tone image where black becomes white and the remainder is black.
-x maximizes red, green, blue values, and alpha values if applicable.
-X maximizes red, green, blue values, and alpha values if applicable, unless the value is 0.
-y extracts luminance.
-z zeroes red, green, blue values, and alpha values if applicable.
-Z zeroes red, green, blue values, and alpha values if applicable, unless the value is 255.
-0 preserves X and Y offsets within the file. This option is only valid with Alias image format files.
-1 creates 8-bit (1 byte matte) output files.
-3 creates 24-bit (3 byte RGB) output files.
-4 creates 32-bit (4 byte RGB and matte) output files.
alpha_file specifies that the matte values are to be taken from this image.

Type convert at the command line to see the list of options.

The default usage statement is as follows:convert -rgby3 infile outfile

Options y, h, l, L, s, c, C, t, T, x, X, z, and Z are mutually exclusive operations. That is, only one of these options may appear on the command line at a time.

Options 1, 3, and 4 are mutually exclusive. That is, only one of these options may appear on the command line at a time.

Options 0, 1, 3, and 4 may be used in conjunction with any option from among the y to Z sub-list, above.

One or more of r, g, b, and a can be used with L, c, C, t, T, x, X, z, and Z. If none of r, g, b, or a is specified, all three colors and alpha will be extracted.

Options y, h, l, and s extract r, g, and b automatically.

If the option x is used alone (for example without r, g, b, or a) the resulting image will be entirely white.

The h, y, and s options use only r, g, and b in their evaluation. However, if you use the a option with y (luminance) or s (saturation), the alpha channel output is the same intensity as the r, g, and b values. If a is not used, the alpha value is zero.

h has no effect on the output alpha.

TIFF, TIFF16, and RLA formats are always 32 bits deep. Therefore, the 4 option is automatically used if the output file ends in .tiff, .tiff16, or .rla.

The input file must be 24 or 32 bits deep.

depthmap

Purpose

depthmap converts camera depth files into Alias run-length-encoded, mask or PIX files.

Overview

depthmap converts the Z depth information of a depth file into an alpha mask or PIX file. The depth file is created with the depth directive in the camera by toggling on Camera Mask in the Image File Output section of the Render Globals window (Render Globals...).

Description

The usage statement for depthmap is as follows:


depthmap [-a # # #] [-d] [-h] <infile> <outfile>
where:
-a # # # converts an animation. The # options represent 3 integers required to specify the startframe, endframe, and byframe.
-d outputs depthmaps to 3 channel Alias pix files instead of the 1 channel Alias mask files created by default. However, in the 3 channel file, the R, G, B, and A values are equal.
-h displays the on-line help.

dxf_info

Purpose

dxf_info prints on the screen a summary of the dxf entities used in the named dxf files.

Description

The usage statement for dxf_info is as follows:dxf_info file [file ...]

Example

The following is an example of how dxf_info is used.dxf_info SAMPLE.DXF

Information about the file SAMPLE.DXF is displayed as follows:Summary of file SAMPLE.DXF ---------------------------------------------entity unsupported if marked *** BLOCKS SECTION:


entity BLOCK occurs 14 times
entity CIRCLE occurs 91 times
entity POLYLINE occurs 38 times
entity VERTEX occurs 1661 times
entity LINE occurs 61536 times
entity 3DFACE occurs 597 times
entity POINT occurs 1 times
entity ARC occurs 2 times

ENTITIES SECTION:

entity LINE occurs 672 times
entity ARC occurs 44 times
entity 3DFACE occurs 44 times
entity POLYLINE occurs 164 times
entity VERTEX occurs 1705 times
entity CIRCLE occurs 34 times
entity INSERT occurs 129 times
entity TEXT*** occurs 4 times

fastrender

Purpose

fastrender is a real time rendering tool capable of handling arbitrary Alias models, multiple light sources, textures, and reflection mapping.

Overview

fastrender is designed to make the best use of the RealityEngine developed by SGI. Therefore, for the fastest rendering, we suggest that you use the RealityEngine. However, lower-end SGI hardware supports fastrender as well.

fastrender cannot be used to preview animations. If the model is animated, fastrender displays snapshots of the animation. However, camera animation is supported.

fastrender cannot be used to preview transparency maps and bump maps. Regular transparency, achieved by value as opposed to by texture maps, is supported.

Other features are supported with toggle shade (Display Tgl shade) excluding solid textures, linear or area lights, glows, and particle systems.

All geometry, lights, shaders, textures, backgrounds, and viewing windows are grouped as one object known as a stage. Many stages can be created in one model. The geometry in each stage can be displayed simultaneously or the display of geometry for selected stages can be turned off. The perspective window view or background for any stage can be chosen as the window or background for all the stages. This allows you to create parts of a model in different stages.

Description

The usage statement for fastrender is as follows:fastrender [datafile]

The option [datafile] must be a fastrender datafile. If no datafile is specified in the command, one can be selected while the program is running.

For additional information about fastrender, see the Alias Menu Book.

filace

Purpose

filace interlaces scanlines of images rendered on fields into a single interlaced image.

Description

The usage statement for filace is as follows:

:

filace [-a # # #] [-e #] [-f] [-h] base_image_name [output]

where
-a # # # specifies an animation to be interlaced. The three numbers are start frame, end frame, and by frame. The start, end, and by frame numbers must be integers.
-e # specifies the padding length of animation frame numbers.
-f specifies that the image.odd and that the image.even were rendered at full resolution. This means that half of each image is wasted and that the anti-aliasing is not at the highest quality.
-h displays the on-line help.

The scanlines used for the first field come from the odd image. These scanlines are then interlaced with the scanlines from the even image to create the second field. Both images should be half the height of the output image you want to create.

If output is not specified, the interlaced image is sent to standard output.

findit

Purpose

findit determines if a specified picture file exists on the render engine.

Description

The usage statement for findit is as follows:

:

findit <pix_path> <machine_name>

where
<pix_path> specifies the picture file to locate.
<machine_name> specifies the name of the render engine on which to search for the picture file.

findit completes the search for the picture file and then returns on of the following values:

$1 is the render code location, the location of picturefile.1.
$2 is the host machine directory location.

findit is used by Alias for remote rendering using the V7 Render Control window.

If the picture file exists, findit writes information about it to the file _lout on the host machine.



Bookshelf Contents Previous Next Glossary Index Search



[email protected]

Copyright © 1998, Alias|Wavefront, a division of Silicon Graphics Limited. All rights reserved.