/usr/share/doc/stilts/sun256/pixfoot-usage.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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Usage</title>
</head>
<body>
<hr>
<a href="pixfoot-examples.html">Next</a> <a href="pixfoot.html">Previous</a> <a href="pixfoot.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="pixfoot-examples.html">Examples</a><br>
<b>Up: </b><a href="pixfoot.html">pixfoot: Generates Multi-Order Coverage maps</a><br>
<b>Previous: </b><a href="pixfoot.html">pixfoot: Generates Multi-Order Coverage maps</a><br>
<hr>
<h3><a name="pixfoot-usage">B.5.1 Usage</a></h3>
<p>The usage of <code>pixfoot</code> is
<pre>
stilts <stilts-flags> pixfoot ifmt=<in-format> istream=true|false
icmd=<cmds> order=<int-value> ra=<expr>
dec=<expr> radius=<expr> mocfmt=fits|json
out=<out-file>
[in=]<table>
</pre>
If you don't have the <code>stilts</code> script installed,
write "<code>java -jar stilts.jar</code>" instead of
"<code>stilts</code>" - see <a href="invoke.html">Section 3</a>.
The available <code><stilts-flags></code> are listed
in <a href="stilts-flags.html">Section 2.1</a>.
For programmatic invocation, the Task class for this
command is <code>uk.ac.starlink.ttools.task.PixFootprint</code>.
</p>
<p>Parameter values are assigned on the command line
as explained in <a href="task-args.html">Section 2.3</a>.
They are as follows:
</p>
<p>
<dl>
<dt><strong><code>dec = <expr></code> <em>(String)</em></strong></dt>
<dd>Declination in degrees
for the position of each row of the input table.
This may simply be a column name, or it may be an
algebraic expression calculated from columns as explained
in <a href="jel.html">Section 10</a>.
If left blank, an attempt is made to guess from UCDs,
column names and unit annotations what expression to use.
</dd>
<dt><strong><code>icmd = <cmds></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/filter/ProcessingStep.html">ProcessingStep[]</a>)</em></strong></dt>
<dd>Specifies processing to be performed on
the input table as specified by parameter <code>in</code>,
before any other processing has taken place.
The value of this parameter is one or more of the filter
commands described in <a href="filterSteps.html">Section 6.1</a>.
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.
<p>Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "<code>@filename</code>"
causes the file <code>filename</code> to be read for a list
of filter commands to execute. The commands in the file
may be separated by newline characters and/or semicolons.
</p>
</dd>
<dt><strong><code>ifmt = <in-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format of the input table as specified by parameter <code>in</code>.
The known formats are listed in <a href="inFormats.html">Section 5.2.1</a>.
This flag can be used if you know what format your
table is in.
If it has the special value
<code>(auto)</code> (the default),
then an attempt will be
made to detect the format of the table automatically.
This cannot always be done correctly however, in which case
the program will exit with an error explaining which
formats were attempted.
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>in = <table></code> <em>(<a href="http://www.starlink.ac.uk/stil/javadocs/uk/ac/starlink/table/StarTable.html">StarTable</a>)</em></strong></dt>
<dd>The location of the input table.
This may take one of the following forms:
<ul>
<li>A filename.</li>
<li>A URL.</li>
<li>The special value "<code>-</code>",
meaning standard input.
In this case the input format must be given explicitly
using the <code>ifmt</code>
parameter.
Note that not all formats can be streamed in this way.
</li>
<li>A system command line with
either a "<code><</code>" character at the start,
or a "<code>|</code>" character at the end
("<code><syscmd</code>" or
"<code>syscmd|</code>").
This executes the given pipeline and reads from its
standard output.
This will probably only work on unix-like systems.
</li>
</ul>
In any case, compressed data in one of the supported compression
formats (gzip, Unix compress or bzip2) will be decompressed
transparently.
</dd>
<dt><strong><code>istream = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If set true, the input table
specified by the <code>in</code> parameter
will be read as a stream.
It is necessary to give the
<code>ifmt</code> parameter
in this case.
Depending on the required operations and processing mode,
this may cause the read to fail (sometimes it is necessary
to read the table more than once).
It is not normally necessary to set this flag;
in most cases the data will be streamed automatically
if that is the best thing to do.
However it can sometimes result in less resource usage when
processing large files in certain formats (such as VOTable).
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>mocfmt = fits|json</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/cone/MocFormat.html">MocFormat</a>)</em></strong></dt>
<dd>Determines the output format for the MOC file.
<p>[Default: <code>fits</code>]
</p>
</dd>
<dt><strong><code>order = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Maximum HEALPix order for the MOC.
This defines the maximum resolution of the output coverage map.
The angular resolution corresponding to order <em>k</em>
is approximately 180/sqrt(3.Pi)/2^<em>k</em>
(3520*2^<em>-k</em> arcmin).
<p>[Default: <code>13</code>]
</p>
</dd>
<dt><strong><code>out = <out-file></code> <em>(uk.ac.starlink.util.Destination)</em></strong></dt>
<dd>The location of the output file. This is usually a filename
to write to.
If it is equal to the special value "-"
the output will be written to standard output.
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>ra = <expr></code> <em>(String)</em></strong></dt>
<dd>Right ascension in degrees
for the position of each row of the input table.
This may simply be a column name, or it may be an
algebraic expression calculated from columns as explained
in <a href="jel.html">Section 10</a>.
If left blank, an attempt is made to guess from UCDs,
column names and unit annotations what expression to use.
</dd>
<dt><strong><code>radius = <expr></code> <em>(String)</em></strong></dt>
<dd>Expression which evaluates to the radius in degrees
of the cone at each row of the input table.
The default is "<code>0</code>",
which treats each position as a point rather than a cone,
but a constant or an expression as described in
<a href="jel.html">Section 10</a> may be used instead.
<p>[Default: <code>0</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="pixfoot-examples.html">Next</a> <a href="pixfoot.html">Previous</a> <a href="pixfoot.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="pixfoot-examples.html">Examples</a><br>
<b>Up: </b><a href="pixfoot.html">pixfoot: Generates Multi-Order Coverage maps</a><br>
<b>Previous: </b><a href="pixfoot.html">pixfoot: Generates Multi-Order Coverage maps</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>
|