/usr/share/doc/stilts/sun256/coneskymatch-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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | <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.3.2.html">Next</a> <a href="coneskymatch.html">Previous</a> <a href="coneskymatch.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.3.2.html">Examples</a><br>
<b>Up: </b><a href="coneskymatch.html">coneskymatch:
Crossmatches table on sky position against remote cone service</a><br>
<b>Previous: </b><a href="coneskymatch.html">coneskymatch:
Crossmatches table on sky position against remote cone service</a><br>
<hr>
<h3><a name="coneskymatch-usage">B.3.1 Usage</a></h3>
<p>The usage of <code>coneskymatch</code> is
<pre>
stilts <stilts-flags> coneskymatch 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>
ra=<expr> dec=<expr> sr=<expr/deg>
find=best|all|each usefoot=true|false
footnside=<int-value>
copycols=<colid-list>
scorecol=<col-name> parallel=<n>
erract=abort|ignore|retry|retry<n>
ostream=true|false fixcols=none|dups|all
suffix0=<label> suffix1=<label>
servicetype=cone|sia|ssa
serviceurl=<url-value> verb=1|2|3
dataformat=<value> emptyok=true|false
compress=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.MultiCone</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>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>copycols = <colid-list></code> <em>(String)</em></strong></dt>
<dd>List of columns from the input table which are to be copied
to the output table.
Each column identified here will be prepended to the
columns of the combined output table,
and its value for each row taken from the input table row
which provided the parameters of the query which produced it.
See <a href="colid-list.html">Section 6.3</a> for list syntax.
The default setting is "<code>*</code>", which means that
all columns from the input table are included in the output.
<p>[Default: <code>*</code>]
</p>
</dd>
<dt><strong><code>dataformat = <value></code> <em>(String)</em></strong></dt>
<dd>Indicates the format of data objects described in the
returned table.
The meaning of this is dependent on the value of the
<code>servicetype</code>
parameter:
<ul>
<li><code>servicetype=cone</code>:
not used
</li>
<li><code>servicetype=sia</code>:
gives the MIME type of images referenced in the output table, also special values
"<code>GRAPHIC</code>" and "<code>ALL</code>".(value of the SIA FORMAT parameter)
</li>
<li><code>servicetype=ssa</code>:
gives the MIME type of spectra referenced in the output table, also special values
"<code>votable</code>", "<code>fits</code>", "<code>compliant</code>", "<code>graphic</code>", "<code>all</code>", and others
(value of the SSA FORMAT parameter).
</li>
</ul>
</dd>
<dt><strong><code>dec = <expr></code> <em>(String)</em></strong></dt>
<dd>Declination in degrees in the ICRS coordinate system
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>emptyok = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Whether the table metadata which is returned from a search
result with zero rows is to be believed.
According to the spirit, though not the letter, of the
cone search standard, a cone search service which returns no data
ought nevertheless to return the correct column headings.
Unfortunately this is not always the case.
If this parameter is set <code>true</code>, it is assumed
that the service behaves properly in this respect; if it does not
an error may result. In that case, set this parameter
<code>false</code>. A consequence of setting it false is that
in the event of no results being returned, the task will
return no table at all, rather than an empty one.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>erract = abort|ignore|retry|retry<n></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/cone/ConeErrorPolicy.html">ConeErrorPolicy</a>)</em></strong></dt>
<dd>Determines what will happen if any of the individual cone
search requests fails. By default the task aborts.
That may be the best thing to do, but for unreliable or
poorly implemented services you may find that some searches
fail and others succeed so it can be best to continue
operation in the face of a few failures.
The options are:
<ul>
<li><code>abort</code>:
failure of any query terminates the task
</li>
<li><code>ignore</code>:
failure of a query is treated the same as a query which
returns no rows
</li>
<li><code>retry</code>:
failed queries are retried until they succeed;
use with care - if the failure is for some good, or at least
reproducible reason this could prevent the task from ever
completing
</li>
<li><code>retry<n></code>:
failed queries are retried at most a fixed number
<code><n></code> of times
If they still fail the task terminates.
</li>
</ul>
<p>[Default: <code>abort</code>]
</p>
</dd>
<dt><strong><code>find = best|all|each</code> <em>(String)</em></strong></dt>
<dd>Determines which matches are retained.
<ul>
<li><code>best</code>:
Only the matching query table row closest to
the input table row will be output.
Input table rows with no matches will be omitted.
(Note this corresponds to the
<code>best1</code>
option in the pair matching commands, and <code>best1</code>
is a permitted alias).
</li>
<li><code>all</code>:
All query table rows which match
the input table row will be output.
Input table rows with no matches will be omitted.
</li>
<li><code>each</code>:
There will be one output table row for each input table row.
If matches are found, the closest one from the query table
will be output, and in the case of no matches,
the query table columns will be blank.
</li>
</ul>
<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>footnside = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Determines the HEALPix Nside parameter for use with the MOC
footprint service.
This tuning parameter determines the resolution of the footprint
if available.
Larger values give better resolution, hence a better chance of
avoiding unnecessary queries, but processing them takes longer
and retrieving and storing them is more expensive.
<p>The value must be a power of 2,
and at the time of writing, the MOC service will not supply
footprints at resolutions greater than nside=512,
so it should be <=512.
</p>
<p>Only used if <code>usefoot=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>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>ostream = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If set true, this will cause the operation to stream on
output, so that the output table is built up as the results
are obtained from the cone search service.
The disadvantage of this is that some output modes and formats
need multiple passes through the data to work, so depending
on the output destination, the operation may fail if this is set.
Use with care (or be prepared for the operation to fail).
<p>[Default: <code>false</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>parallel = <n></code> <em>(Integer)</em></strong></dt>
<dd>Allows multiple cone searches to be performed concurrently.
If set to the default value, 1, the cone query corresponding
to the first row of the input table will be dispatched,
when that is completed the query corresponding to the
second row will be dispatched, and so on.
If set to <code><n></code>, then queries will be overlapped
in such a way that up to approximately <code><n></code>
may be running at any one time.
<p>Whether increasing <code><n></code> is a good idea,
and what might be a sensible maximum value, depends on the
characteristics of the service being queried.
In particular, setting it to too large a number may overload
the service resulting in some combination of failed queries,
ultimately slower runtimes, and unpopularity with server admins.
</p>
<p>The maximum value permitted for this parameter by default is
10.
This limit may be raised by use of the
service.maxparallel system property
but use that option with great care since you may overload
services and make yourself unpopular with data centre admins.
As a rule, you should only increase this value if you have
obtained permission from the data centres whose services
on which you will be using the increased parallelism.
</p>
<p>[Default: <code>1</code>]
</p>
</dd>
<dt><strong><code>ra = <expr></code> <em>(String)</em></strong></dt>
<dd>Right ascension in degrees in the ICRS coordinate system
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>scorecol = <col-name></code> <em>(String)</em></strong></dt>
<dd>Gives the name of a column in the output table to contain
the distance between the requested central position and the
actual position of the returned row.
The distance returned is an angular distance in degrees.
If a null value is chosen, no distance column will appear
in the output table.
<p>[Default: <code>Separation</code>]
</p>
</dd>
<dt><strong><code>servicetype = cone|sia|ssa</code> <em>(ServiceType)</em></strong></dt>
<dd>Selects the type of data access service to contact.
Most commonly this will be the Cone Search service itself,
but there are one or two other possibilities:
<ul>
<li><code>cone</code>:
Cone Search protocol - returns a table of objects found near each location.
See <a href="http://www.ivoa.net/Documents/latest/ConeSearch.html">Cone Search standard</a>.
</li>
<li><code>sia</code>:
Simple Image Access protocol - returns a table of images near each location.
See <a href="http://www.ivoa.net/Documents/latest/SIA.html">SIA standard</a>.
</li>
<li><code>ssa</code>:
Simple Spectral Access protocol - returns a table of spectra near each location.
See <a href="http://www.ivoa.net/Documents/latest/SSA.html">SSA standard</a>.
</li>
</ul>
<p>[Default: <code>cone</code>]
</p>
</dd>
<dt><strong><code>serviceurl = <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 part of a URL which defines the queries to be made.
Additional parameters will be appended to this using CGI syntax
("<code>name=value</code>", separated by '&' characters).
If this value does not end in either a '?' or a '&',
one will be added as appropriate.
<p>See <a href="coneService.html">Appendix B.3.3</a> for discussion of how to locate
service URLs corresponding to given datasets.
</p>
</dd>
<dt><strong><code>sr = <expr/deg></code> <em>(String)</em></strong></dt>
<dd>Expression which evaluates to the search radius in degrees
for the request at each row of the input table.
This will often be a constant numerical value, but may be
the name or ID of a column in the input table,
or a function involving one.
</dd>
<dt><strong><code>suffix0 = <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>_0</code>]
</p>
</dd>
<dt><strong><code>suffix1 = <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 cone result table.
<p>[Default: <code>_1</code>]
</p>
</dd>
<dt><strong><code>usefoot = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether an attempt will be made to restrict
searches in accordance with available footprint information.
If this is set true, then before any of the per-row queries
are performed, an attempt may be made to acquire footprint
information about the servce.
If such information can be obtained, then queries which
fall outside the footprint, and hence which are known to
yield no results, are skipped. This can speed up the search
considerably.
<p>Currently, the only footprints available are those
provided by the CDS MOC (Multi-Order Coverage map) service,
which covers VizieR and a few other cone search services.
</p>
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>verb = 1|2|3</code> <em>(String)</em></strong></dt>
<dd>Verbosity level of the tables returned by the query service.
A value of 1 indicates the bare minimum and
3 indicates all available information.
</dd>
</dl>
</p>
<hr><a href="secB.3.2.html">Next</a> <a href="coneskymatch.html">Previous</a> <a href="coneskymatch.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.3.2.html">Examples</a><br>
<b>Up: </b><a href="coneskymatch.html">coneskymatch:
Crossmatches table on sky position against remote cone service</a><br>
<b>Previous: </b><a href="coneskymatch.html">coneskymatch:
Crossmatches table on sky position against remote cone service</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>
|