/usr/share/doc/stilts/sun256/tapskymatch-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 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | <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.23.2.html">Next</a> <a href="tapskymatch.html">Previous</a> <a href="tapskymatch.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.23.2.html">Examples</a><br>
<b>Up: </b><a href="tapskymatch.html">tapskymatch:
Crossmatches table on sky position against TAP table</a><br>
<b>Previous: </b><a href="tapskymatch.html">tapskymatch:
Crossmatches table on sky position against TAP table</a><br>
<hr>
<h3><a name="tapskymatch-usage">B.23.1 Usage</a></h3>
<p>The usage of <code>tapskymatch</code> is
<pre>
stilts <stilts-flags> tapskymatch 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>
inlon=<expr/deg> inlat=<expr/deg>
tapurl=<url-value> taptable=<name>
taplon=<column> taplat=<column>
tapcols=<colname,...> sr=<expr/deg>
find=all|best|each|each-dist
blocksize=<int-value> maxrec=<int-value>
sync=true|false blockmaxrec=<nrow>
compress=true|false fixcols=none|dups|all
suffixin=<label> suffixremote=<label>
[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.TapUploadSkyMatch</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>blockmaxrec = <nrow></code> <em>(Long)</em></strong></dt>
<dd>Sets the MAXREC parameter passed to the TAP service
for each uploaded block.
This allows you to request that the service overrides its
default limit for the number of rows output from a single query.
The service may still impose some "hard" limit beyond which
the output row count cannot be increased.
<p>Note this differs from the
<code>maxrec</code>
parameter, which gives the maximum total number of rows
to be returned from this command.
</p>
</dd>
<dt><strong><code>blocksize = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>The number of rows uploaded in each TAP query.
TAP services may have limits on the number of rows in
a table uploaded for matching.
This command can therefore break up input tables into blocks
and make a number of individual TAP queries to generate the
result.
This parameter controls the maximum number of rows uploaded
in each individual request.
For an input table with fewer rows than this value,
the whole thing is done as a single query.
<p>[Default: <code>5000</code>]
</p>
</dd>
<dt><strong><code>compress = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, the service is requested to provide HTTP-level
compression for the response stream
(Accept-Encoding header is set to "<code>gzip</code>",
see RFC 2616).
This does not guarantee that compression will happen
but if the service honours this request it may result in
a smaller amount of network traffic
at the expense of more processing on the server and client.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>find = all|best|each|each-dist</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/task/UserFindMode.html">UserFindMode</a>)</em></strong></dt>
<dd>Determines which pair matches are included in the result.
<ul>
<li><code>all</code>: All matches
</li>
<li><code>best</code>: Matched rows, best remote row for each input row
</li>
<li><code>each</code>: One row per input row, contains best remote match or blank
</li>
<li><code>each-dist</code>: One row per input row, column giving distance only for best match
</li>
</ul>
Note only the <code>all</code> mode
is symmetric between the two tables.
<p>[Default: <code>all</code>]
</p>
</dd>
<dt><strong><code>fixcols = none|dups|all</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/task/JoinFixActionParameter.Fixer.html">Fixer</a>)</em></strong></dt>
<dd>Determines how input columns are renamed before
use in the output table. The choices are:
<ul>
<li><code>none</code>: columns are not renamed
</li>
<li><code>dups</code>: columns which would otherwise have duplicate names in the output will be renamed
to indicate which table they came from
</li>
<li><code>all</code>: all columns will be renamed to indicate which table they came from
</li>
</ul>
If columns are renamed, the new ones are determined
by <code>suffix*</code> parameters.
<p>[Default: <code>dups</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>inlat = <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 coordinate system must match that used for the
coordinates in the remote table.
</dd>
<dt><strong><code>inlon = <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 coordinate system must match that used for the
coordinates in the remote table.
</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>maxrec = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Limit to the number of rows resulting from this operation.
If the value is negative (the default) no limit is imposed.
Note however that there can be truncation of the result
if the number of records returned from a single chunk
exceeds limits imposed by the service.
<p>[Default: <code>-1</code>]
</p>
</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>sr = <expr/deg></code> <em>(String)</em></strong></dt>
<dd>Maximum distance in degrees
from the local table (lat,lon) position
at which counterparts from the remote table will be identified.
This is an ADQL expression interpreted within the TAP service,
so it may be a constant value or may involve columns in
the remote table.
</dd>
<dt><strong><code>suffixin = <label></code> <em>(String)</em></strong></dt>
<dd>If the <code>fixcols</code> parameter
is set so that input columns are renamed for insertion into
the output table, this parameter determines how the
renaming is done.
It gives a suffix which is appended to all renamed columns
from the input table.
<p>[Default: <code>_in</code>]
</p>
</dd>
<dt><strong><code>suffixremote = <label></code> <em>(String)</em></strong></dt>
<dd>If the <code>fixcols</code> parameter
is set so that input columns are renamed for insertion into
the output table, this parameter determines how the
renaming is done.
It gives a suffix which is appended to all renamed columns
from the TAP result table.
<p>[Default: <code>_tap</code>]
</p>
</dd>
<dt><strong><code>sync = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether the TAP queries are submitted
in synchronous or asynchronous mode.
Since this command uses chunking to keep requests to a
reasonable size, hopefully requests will not take too
long to execute, therefore the default is synchronous (true).
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>tapcols = <colname,...></code> <em>(String[])</em></strong></dt>
<dd>Comma-separated list of column names
to retrieve from the remote table.
If no value is supplied (the default),
all columns from the remote table will be returned.
</dd>
<dt><strong><code>taplat = <column></code> <em>(String)</em></strong></dt>
<dd>Latitude in degrees for the position of each row
in the remote table.
This is an ADQL expression interpreted within the TAP service,
typically just a column name.
The coordinate system must match that used for the input table.
</dd>
<dt><strong><code>taplon = <column></code> <em>(String)</em></strong></dt>
<dd>Longitude in degrees for the position of each row
in the remote table.
This is an ADQL expression interpreted within the TAP service,
typically just a column name.
The coordinate system must match that used for the input table.
</dd>
<dt><strong><code>taptable = <name></code> <em>(String)</em></strong></dt>
<dd>Name of the table in the given TAP service
against which the matching will be performed.
</dd>
<dt><strong><code>tapurl = <url-value></code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
<dd>The base URL of a Table Access Protocol service.
This is the bare URL without a trailing "/[a]sync".
<p>The default values of the various endpoints
(sync and async query submission, tables metadata,
service-provided examples etc)
use this URL as a parent
and append standard sub-paths.
However, other parameters (<code>syncurl</code>, <code>asyncurl</code>, ...)
are provided so that the different endpoints
can be set individually if required.
</p>
</dd>
</dl>
</p>
<hr><a href="secB.23.2.html">Next</a> <a href="tapskymatch.html">Previous</a> <a href="tapskymatch.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.23.2.html">Examples</a><br>
<b>Up: </b><a href="tapskymatch.html">tapskymatch:
Crossmatches table on sky position against TAP table</a><br>
<b>Previous: </b><a href="tapskymatch.html">tapskymatch:
Crossmatches table on sky position against TAP table</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>
|