/usr/share/doc/stilts/sun256/tskymap-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 | <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="secB.36.2.html">Next</a> <a href="tskymap.html">Previous</a> <a href="tskymap.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.36.2.html">Examples</a><br>
<b>Up: </b><a href="tskymap.html">tskymap: Calculates sky density maps</a><br>
<b>Previous: </b><a href="tskymap.html">tskymap: Calculates sky density maps</a><br>
<hr>
<h3><a name="tskymap-usage">B.36.1 Usage</a></h3>
<p>The usage of <code>tskymap</code> is
<pre>
stilts <stilts-flags> tskymap ifmt=<in-format> istream=true|false
icmd=<cmds> ocmd=<cmds>
omode=out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui
out=<out-table> ofmt=<out-format>
lon=<expr/deg> lat=<expr/deg>
tiling=hpx<K>|healpixnest<K>|healpixring<K>|htm<K>
count=true|false cols=<expr> ...
combine=sum|mean|median|min|max|stdev|count|hit
complete=true|false
[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.SkyDensityMap</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>cols = <expr> ...</code> <em>(String[])</em></strong></dt>
<dd>Selects the columns to be aggregated into bins.
The value is a space-separated list of items,
where each item may be either a column name
or an expression using the
<a href="jel.html">expression language</a>.
The output table will have one column for each of the
items in this list.
</dd>
<dt><strong><code>combine = sum|mean|median|min|max|stdev|count|hit</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/layer/Combiner.html">Combiner</a>)</em></strong></dt>
<dd>Combination mode for aggregating binned quantities.
Possible values are:
<ul>
<li><code>sum</code>: the sum of all the combined values
</li>
<li><code>mean</code>: the mean of the combined values
</li>
<li><code>median</code>: the median of the combined values (may be slow)
</li>
<li><code>min</code>: the minimum of all the combined values
</li>
<li><code>max</code>: the maximum of all the combined values
</li>
<li><code>stdev</code>: the sample standard deviation of the combined values
</li>
<li><code>count</code>: the number of non-blank values (weight is ignored)
</li>
<li><code>hit</code>: 1 if any values present, NaN otherwise (weight is ignored)
</li>
</ul>
<p>[Default: <code>mean</code>]
</p>
</dd>
<dt><strong><code>complete = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether the output table contains a row
for every pixel in the tiling, or only the rows for
pixels in which some of the input data fell.
<p>The value of this parameter may affect performance as well
as output. If you know that most pixels on the sky will
be covered, it's probably a good idea to set this true,
and if you know that only a small patch of sky will be
covered, it's better to set it false.
</p>
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>count = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Controls whether a COUNT column is added to the output table
along with any other columns that may have been requested.
If included, this reports the number of rows from the input table
that fell within the corresponding bin.
<p>[Default: <code>true</code>]
</p>
</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>lat = <expr/deg></code> <em>(String)</em></strong></dt>
<dd>Latitude in degrees for the position of each row
in the input table.
This may simply be a column name, or it may be
an algebraic expression as explained in <a href="jel.html">Section 10</a>.
The sky system used here will determine the
grid on which the output map is built.
</dd>
<dt><strong><code>lon = <expr/deg></code> <em>(String)</em></strong></dt>
<dd>Longitude in degrees for the position of each row
in the input table.
This may simply be a column name, or it may be
an algebraic expression as explained in <a href="jel.html">Section 10</a>.
The sky system used here will determine the
grid on which the output map is built.
</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>tiling = hpx<K>|healpixnest<K>|healpixring<K>|htm<K></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/cone/SkyTiling.html">SkyTiling</a>)</em></strong></dt>
<dd>Describes the sky tiling scheme that is in use.
One of the following values may be used:
<ul>
<li><code>hpxK</code>:
alias for <code>healpixnestK</code></li>
<li><code>healpixnestK</code>:
HEALPix using the Nest scheme at order <code>K</code></li>
<li><code>healpixringK</code>:
HEALPix using the Ring scheme at order <code>K</code></li>
<li><code>htmK</code>:
Hierarchical Triangular Mesh at level <code>K</code></li>
</ul>
So for instance
<code>hpx5</code> or
<code>healpixnest5</code>
would both indicate the HEALPix NEST tiling scheme at order 5.
<p>At level K, there are 12*4^K HEALPix pixels,
or 8*4^K HTM pixels on the sky.
More information about these tiling schemes can be found at
the <a href="http://healpix.jpl.nasa.gov/">HEALPix</a>
and <a href="http://www.skyserver.org/htm/">HTM</a>
web sites.
</p>
<p>[Default: <code>hpx5</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="secB.36.2.html">Next</a> <a href="tskymap.html">Previous</a> <a href="tskymap.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.36.2.html">Examples</a><br>
<b>Up: </b><a href="tskymap.html">tskymap: Calculates sky density maps</a><br>
<b>Previous: </b><a href="tskymap.html">tskymap: Calculates sky density 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>
|