Download STILTS - Starlink Tables Infrastructure Library Tool Set Version 3.0

Transcript
SUN/256
•
•
•
•
•
•
•
330
calculate statistics
display metadata
select rows in various ways, including algebraically
define new columns as algebraic functions of old ones
delete or rearrange columns
sort rows
convert between table formats
and combine these operations. You can think of it as a supercharged table copying tool.
The basic operation of tpipe is that it reads an input table, performs zero or more processing steps
on it, and then does something with the output. There are therefore three classes of things you need
to tell it when it runs:
Input table location
Specified by the in, ifmt and istream parameters.
Processing steps
Either provide a string giving steps as the value of one or more cmd parameters, or the name of
a file containing the steps using the script parameter. The steps that you can perform are
described in Section 6.1.
Output table destination
What happens to the output table is determined by the value of the omode parameter. By
default, omode=out, in which case the table is written to a new table file in a format determined
by ofmt. However, you can do other things with the result such as calculate the per-column
statistics (omode=stats), view only the table and column metadata (omode=meta), display it
directly in TOPCAT (omode=topcat) etc.
See Section 6 for a more detailed explanation of these ideas.
The parameters mentioned above are listed in detail in the next section.
B.35.1 Usage
The usage of tpipe is
stilts <stilts-flags> tpipe ifmt=<in-format> istream=true|false cmd=<cmds>
omode=out|meta|stats|count|cgi|discard|topcat|samp|plastic|tosq
out=<out-table> ofmt=<out-format>
[in=]<table>
If you don't have the stilts script installed, write "java -jar stilts.jar" instead of "stilts" see Section 3. The available <stilts-flags> are listed in Section 2.1. For programmatic
invocation, the Task class for this command is uk.ac.starlink.ttools.task.TablePipe.
Parameter values are assigned on the command line as explained in Section 2.3. They are as
follows:
(ProcessingStep[])
Specifies processing to be performed on the input table as specified by parameter in, before
any other processing has taken place. The value of this parameter is one or more of the filter
commands described in Section 6.1. If more than one is given, they must be separated by
semicolon characters (";"). This parameter can be repeated multiple times on the same
command line to build up a list of processing steps. The sequence of commands given in this
way defines the processing pipeline which is performed on the table.
cmd = <cmds>
Commands may alteratively be supplied in an external file, by using the indirection character
'@'. Thus a value of "@filename" causes the file filename to be read for a list of filter