/usr/share/doc/stilts/sun256/tpipe.html is in stilts-doc 3.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>tpipe: Performs pipeline processing on a table</title>
</head>
<body>
<hr>
<a href="tpipe-usage.html">Next</a> <a href="secB.34.2.html">Previous</a> <a href="cmdUsage.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="tpipe-usage.html">Usage</a><br>
<b>Up: </b><a href="cmdUsage.html">Command Reference</a><br>
<b>Previous: </b><a href="secB.34.2.html">Examples</a><br>
<hr>
<hr>
<h2><a name="tpipe">B.35 <code>tpipe</code>: Performs pipeline processing on a table</a></h2>
<p><code>tpipe</code> performs all kinds of general purpose manipulations
which take one table as input.
It is extremely flexible, and can do the following things
amongst others:
<ul>
<li>calculate statistics</li>
<li>display metadata</li>
<li>select rows in various ways, including algebraically</li>
<li>define new columns as algebraic functions of old ones</li>
<li>delete or rearrange columns</li>
<li>sort rows</li>
<li>convert between table formats</li>
</ul>
and combine these operations.
You can think of it as a supercharged table copying tool.
</p>
<p>The basic operation of <code>tpipe</code> 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:
<dl>
<dt><strong>Input table location</strong></dt>
<dd>Specified by the <code>in</code>, <code>ifmt</code> and
<code>istream</code> parameters.
</dd>
<dt><strong>Processing steps</strong></dt>
<dd>Either provide a string giving steps as the value
of one or more <code>cmd</code> parameters, or the name of a file
containing the steps using the <code>script</code> parameter.
The steps that you can perform are described in
<a href="filterSteps.html">Section 6.1</a>.
</dd>
<dt><strong>Output table destination</strong></dt>
<dd>What happens to the output table is determined by the value of
the <code>omode</code> parameter.
By default, <code>omode=out</code>,
in which case the table is written to a new table file in a format
determined by <code>ofmt</code>. However, you can do other things
with the result such as
calculate the per-column statistics (<code>omode=stats</code>),
view only the table and column metadata (<code>omode=meta</code>),
display it directly in TOPCAT (<code>omode=topcat</code>) etc.
</dd>
</dl>
See <a href="pipes.html">Section 6</a> for a more detailed explanation of these ideas.
</p>
<p>The parameters mentioned above are listed in detail in the next section.
</p>
<ul>
<li><a href="tpipe-usage.html">B.35.1 Usage</a></li>
<li><a href="tpipeExamples.html">B.35.2 Examples</a></li>
</ul>
<hr><a href="tpipe-usage.html">Next</a> <a href="secB.34.2.html">Previous</a> <a href="cmdUsage.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="tpipe-usage.html">Usage</a><br>
<b>Up: </b><a href="cmdUsage.html">Command Reference</a><br>
<b>Previous: </b><a href="secB.34.2.html">Examples</a><br>
<hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
<a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
<a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
<a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>
|