Overview
Command Line AverageUcf Usage
The command line follows this pattern: "java {optional java arguments} -jar {optional command line arguments} input_file output_file". The "optional command line arguments" are described by the table in the next section, and by the
illustrative examples that follow. The "optional java arguments' control the behavior of the Java
virtual machine used to run the application and, with one exception, are seldom used. That exception
is the memory allocation argument, -Xmx{number}, which asks your computer's operating system to
give more memory to the Java virtual machine that it ordinarily gets. This is used when the
data to be manipulated exceed the amount of memory. If you run the program and see an error
with text resembling
"Out of Memory"
then you will probably want to add the memory argument. To increase the amount of JVM memory, pass an argument to Your java an argument:
java -Xmx512M -jar ShapeCurvature.jar input_file output_file
this sets the ammount of memory to 512MB. Note: the -Xmx512M is the argument that requests additional memory.
Command line arguments
The program is controlled by use of command line arguments. The complete table of command line arguments follows. The "Default" values listed are the values used by the program if the corrosponding command line argument is
not specified.
Not all arguments need be specified by a user; generally, an argument is used only to override an
unwanted default behavior of the program.
| Argument | Default | Description | Notes |
|---|
| -version | n/a | prints a version string to the console output and exits normally. | |
| -help | n/a | prints usage string to the console output and exits normally. | |
| -out | outputFile | specify output file name. | |
| -verbose | false | enables detailed status messages during calculations. | |
| -examples | n/a | prints examples of common usage | |
Examples of common usage
In these examples we assume that the AverageUcf application is saved in a file
named AverageUcf.jar.
Ex 1) Print a usage summary to the console output.
Use this command:
java -jar AverageUcf.jar -help
Ex 2) Read input file from input1.ucf, input2.ucf, and input3.ucf. .
Use this command:
java -jar AverageUcf.jar -out outputFileName input1.ucf input2.ucf input3.ucf
Detailed Description of the program
- No input or output file
- if both input file and output file are not provided the application will exit.
- Not appropriate input file
- if input file doesn't exist, or cannot be read the application wlll exit.
- Not appropriate output file
- if it is not possible to write the output file then the application will exit.
- Not appropriate output type
- if input file type doesn't match output type the application will exit.
- Not appropriate shape
- if shape has no face set or the face set has no faces the application will exit.
Any mesh files supported by the
ShapeTools library may be read by this program, however, it is possible that a valid file may not contain a closed mesh surface. Loni Ucf files are a particular example of this.
Loni Ucf files may in some circumstances be explicitly interpolated to form a surface mesh. Please
see the shape tools
InterpolateContour application for more details.
The following input formats are currently supported (4 December 2006)
| Abbreviated Name | Descripoint | Notes |
|---|
| Ucf | Loni Universal Contour Format files. | Not a mesh format, however, adjacent polyline contours with equal numbers of vertices may be interpreted as a square grid mesh. |
| OBJ | Montreal Neurological Institute surface mesh Object files. | Do not allow arbitrary data values at mesh vertices. Does support color and vertex normals |
| OFF | Geomview surface mesh files. | Do not allow arbitrary data values at mesh vertices. Does support color and vertex normals |
| DX | OpenDX general format data files (using "positions" and "connections" to define the mesh). | supports arbitrary data components at all mesh vertices |
The following output formats are currently supported (4 December 2006)
System requirements
- Platform - Platform independent
- Operating System - Any OS that has Java 1.4.2 or greater.
Restrictions, Exclusions, Limitations
- Duplicate vertices are not allowed.
- Surfaces with holes are not allowed.
- Faces that vertices originally came from are assumed to be not distorted.
Acknowledgements
This program is a product of the CCB
Shape Tools program.
