/usr/share/doc/stilts/sun256/pixsample-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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | <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="pixsample-examples.html">Next</a> <a href="pixsample.html">Previous</a> <a href="pixsample.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="pixsample-examples.html">Examples</a><br>
<b>Up: </b><a href="pixsample.html">pixsample: Samples from a HEALPix pixel data file</a><br>
<b>Previous: </b><a href="pixsample.html">pixsample: Samples from a HEALPix pixel data file</a><br>
<hr>
<h3><a name="pixsample-usage">B.6.1 Usage</a></h3>
<p>The usage of <code>pixsample</code> is
<pre>
stilts <stilts-flags> pixsample in=<table> ifmt=<in-format> icmd=<cmds>
pixdata=<pix-table> pfmt=<in-format>
pcmd=<cmds> ocmd=<cmds>
omode=out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui
out=<out-table> ofmt=<out-format>
pixorder=nested|ring|(auto) stat=point|mean
lon=<expr> lat=<expr>
insys=icrs|fk5|fk4|galactic|supergalactic|ecliptic
pixsys=icrs|fk5|fk4|galactic|supergalactic|ecliptic
radius=<expr>
</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.PixSample</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>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>insys = icrs|fk5|fk4|galactic|supergalactic|ecliptic</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/convert/SkySystem.html">SkySystem</a>)</em></strong></dt>
<dd>Specifies the sky coordinate system in which
sample positions are provided by the
<code>lon</code>/<code>lat</code>
parameters.
If the sample positions are given
in the same coordinate system as that given by
the pixel data table, both the <code>insys</code> and <code>pixsys</code> parameters may be set <code>null</code>.
<p>The available coordinate systems are:
<ul>
<li><code>icrs</code>: ICRS (Hipparcos) (Right Ascension, Declination)
</li>
<li><code>fk5</code>: FK5 J2000.0 (Right Ascension, Declination)
</li>
<li><code>fk4</code>: FK4 B1950.0 (Right Ascension, Declination)
</li>
<li><code>galactic</code>: IAU 1958 Galactic (Longitude, Latitude)
</li>
<li><code>supergalactic</code>: de Vaucouleurs Supergalactic (Longitude, Latitude)
</li>
<li><code>ecliptic</code>: Ecliptic (Longitude, Latitude)
</li>
</ul>
</p>
</dd>
<dt><strong><code>lat = <expr></code> <em>(String)</em></strong></dt>
<dd>Expression which evaluates to the latitude coordinate
in degrees in the input table at which
positions are to be sampled from the pixel data table.
This will usually be the name or ID of a column
in the input table,
or an expression involving one.
If this coordinate does not match the coordinate
system used by the pixel data table,
both coordinate systems must be set using the
<code>insys</code> and <code>pixsys</code> parameters.
</dd>
<dt><strong><code>lon = <expr></code> <em>(String)</em></strong></dt>
<dd>Expression which evaluates to the longitude coordinate
in degrees in the input table at which
positions are to be sampled from the pixel data table.
This will usually be the name or ID of a column
in the input table,
or an expression involving one.
If this coordinate does not match the coordinate
system used by the pixel data table,
both coordinate systems must be set using the
<code>insys</code> and <code>pixsys</code> parameters.
</dd>
<dt><strong><code>ocmd = <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 output table,
after all 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>ofmt = <out-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format in which the output table will be written
(one of the ones in <a href="outFormats.html">Section 5.2.2</a> - matching is
case-insensitive and you can use just the first few letters).
If it has the special value
"<code>(auto)</code>"
(the default),
then the output filename will be
examined to try to guess what sort of file is required
usually by looking at the extension.
If it's not obvious from the filename what output format is
intended, an error will result.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>omode = out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/mode/ProcessingMode.html">ProcessingMode</a>)</em></strong></dt>
<dd>The mode in which the result table will be output.
The default mode is <code>out</code>, which means that
the result will be written as a new table to disk or elsewhere,
as determined by the <code>out</code> and <code>ofmt</code>
parameters.
However, there are other possibilities, which correspond
to uses to which a table can be put other than outputting it,
such as displaying metadata, calculating statistics,
or populating a table in an SQL database.
For some values of this parameter, additional parameters
(<code><mode-args></code>)
are required to determine the exact behaviour.
<p>Possible values are
<ul>
<li><code>out</code></li>
<li><code>meta</code></li>
<li><code>stats</code></li>
<li><code>count</code></li>
<li><code>cgi</code></li>
<li><code>discard</code></li>
<li><code>topcat</code></li>
<li><code>samp</code></li>
<li><code>tosql</code></li>
<li><code>gui</code></li>
</ul>
Use the <code>help=omode</code> flag
or see <a href="outModes.html">Section 6.4</a> for more information.
</p>
<p>[Default: <code>out</code>]
</p>
</dd>
<dt><strong><code>out = <out-table></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/TableConsumer.html">TableConsumer</a>)</em></strong></dt>
<dd>The location of the output table. This is usually a filename
to write to.
If it is equal to the special value "-" (the default)
the output table will be written to standard output.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>pcmd = <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
pixel data table as specified by parameter <code>pixdata</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>pfmt = <in-format></code> <em>(String)</em></strong></dt>
<dd>File format for the HEALPix pixel data table.
This is usually, but not necessarily, FITS.
<p>[Default: <code>fits</code>]
</p>
</dd>
<dt><strong><code>pixdata = <pix-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 table containing the pixel data.
The data must be in the form of a HEALPix table,
with one pixel per row in HEALPix order.
These files are typically, but not necessarily,
FITS tables.
A filename or URL may be used, but a local file will be
more efficient.
<p>Some HEALPix format FITS tables seem to have rows
which contain 1024-element arrays of pixels
instead of single pixel values.
This (rather perverse?) format is not currently supported
here, but if there is demand support could be added.
</p>
</dd>
<dt><strong><code>pixorder = nested|ring|(auto)</code> <em>(HealpixScheme)</em></strong></dt>
<dd>Selects the pixel ordering scheme used by the
pixel data file.
There are two different ways of ordering pixels in a
HEALPix file, "ring" and "nested", and the sampler
needs to know which one is in use.
If you know which is in use, choose the appropriate value
for this parameter;
if <code>(auto)</code> is used
it will attempt to work it out from headers in the file
(the ORDERING header).
If no reliable ordering scheme can be determined,
the command will fail with an error.
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>pixsys = icrs|fk5|fk4|galactic|supergalactic|ecliptic</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/convert/SkySystem.html">SkySystem</a>)</em></strong></dt>
<dd>Specifies the sky coordinate system
used for the HEALPix data in the pixdata file.
If the sample positions are given
in the same coordinate system as that given by
the pixel data table, both the <code>insys</code> and <code>pixsys</code> parameters may be set <code>null</code>.
<p>The available coordinate systems are:
<ul>
<li><code>icrs</code>: ICRS (Hipparcos) (Right Ascension, Declination)
</li>
<li><code>fk5</code>: FK5 J2000.0 (Right Ascension, Declination)
</li>
<li><code>fk4</code>: FK4 B1950.0 (Right Ascension, Declination)
</li>
<li><code>galactic</code>: IAU 1958 Galactic (Longitude, Latitude)
</li>
<li><code>supergalactic</code>: de Vaucouleurs Supergalactic (Longitude, Latitude)
</li>
<li><code>ecliptic</code>: Ecliptic (Longitude, Latitude)
</li>
</ul>
</p>
</dd>
<dt><strong><code>radius = <expr></code> <em>(String)</em></strong></dt>
<dd>Determines the radius in degrees over which pixels will be
sampled to generate the output statistic
in accordance with the value of the
<code>stat</code> parameter.
This will typically be a constant value,
but it may be an algebraic expression based on
columns from the input table.
<p>Not used if <code>stat=point</code>.
</p>
</dd>
<dt><strong><code>stat = point|mean</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/task/PixSampler.StatMode.html">StatMode</a>)</em></strong></dt>
<dd>Determines how the pixel values will be sampled
to generate an output value.
The options are:
<ul>
<li><code>point</code>:
Uses the value at the pixel covering the supplied position.
In this case the <code>radius</code>
parameter is not used.
</li>
<li><code>mean</code>:
Averages the values over all the pixels within a radius
given by the <code>radius</code>
parameter.
This averaging is somewhat approximate;
all pixels which are mostly within the radius
are averaged with equal weights.
</li>
</ul>
<p>[Default: <code>point</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="pixsample-examples.html">Next</a> <a href="pixsample.html">Previous</a> <a href="pixsample.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="pixsample-examples.html">Examples</a><br>
<b>Up: </b><a href="pixsample.html">pixsample: Samples from a HEALPix pixel data file</a><br>
<b>Previous: </b><a href="pixsample.html">pixsample: Samples from a HEALPix pixel data file</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>
|