previous up next print clean
Next: Acknowledgments Up: Dellinger & Tálas: SEPlib Previous: Conclusions

QUICK SUMMARY

SEPlib programs begin with a capital letter. Almost all of them read the standard input and write to the standard output. Type the name of a SEPlib program without arguments and it will give you a brief documentation.

SEPlib parameter files contain lists of parameters in the format parameter=value. There is NO SPACE on either side of the =. Parameters can be specified either in a history file, directly on the command line, or by specifying par=file (where file is a parameter file) on the command line or in a parameter file. The last occurrence of a parameter is the one that is used.

SEPlib history files are a special kind of SEPlib parameter files. Programs append information onto the history file, so it always contains a history of the programs run and parameters specified that went into making the file.

History files must contain at a minimum the parameters in, esize, and n1. The parameter in gives the file system location of the associated data file, using either a relative or absolute pathname. The parameter esize gives the size of the individual elements in the data file. esize=1 means bytes, esize=4 means IEEE single-precision floating-point, esize=8 means complex or floating-point coordinate pairs. (As a special case esize=0 means the data file is ASCII. Only a few programs recognize this.)

The data file is a flat UNIX file, assumed to consist of a regular ``cube'' of data with fastest dimension n1 (must be specified), next fastest n2 (defaults 1 if not specified), and slowest n3 (defaults 1 if not specified). The size of the data file in bytes should be equal to esize * n1 * n2 * n3. (As a special case n1=-1 means the data file is of unknown length. Only a few programs recognize this.) Some programs allow 4-dimensional datasets using n4.

Optional but commonly used parameters in history files include:
d1, d2, d3: sampling rates for fastest, middle, and slowest axes.
o1, o2, o3: coordinate of first element on fastest, middle, and slowest axes.
label1, label2, label3: axis labels or physical axis dimensions.
title: title.

For other parameters recognized by particular programs refer to self-docs.

The programs were written by dozens of people over a span of years, and are of variable quality as to their robustness and generality. Every program included in the distribution has passed minimum tests of usefulness and usability.


previous up next print clean
Next: Acknowledgments Up: Dellinger & Tálas: SEPlib Previous: Conclusions
Stanford Exploration Project
11/18/1997