The usage of coneskymatch
is
stilts <stilts-flags> coneskymatch ifmt=<in-format> istream=true|false icmd=<cmds> ocmd=<cmds> omode=<out-mode> <mode-args> out=<out-table> ofmt=<out-format> ra=<expr> dec=<expr> sr=<expr> find=best|all|each 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 [in=]<table>If you don't have the
stilts
script installed,
write "java -jar stilts.jar
" instead of
"stilts
" - see Section 3.
The available <stilts-flags>
are listed
in Section 2.1.
Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:
copycols = <colid-list>
*
", which means that
all columns from the input table are included in the output.
[Default: *
]
dataformat = <value>
servicetype
parameter:
servicetype=cone
:
not usedservicetype=sia
:
gives the MIME type of images referenced in the output table, also special values "GRAPHIC
" and "ALL
".(value of the SIA FORMAT parameter)servicetype=ssa
:
gives the MIME type of spectra referenced in the output table, also special values "votable
", "fits
", "compliant
", "graphic
", "all
", and others
(value of the SSA FORMAT parameter).dec = <expr>
emptyok = true|false
true
, 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
false
. 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.
[Default: true
]
erract = abort|ignore|retry|retry<n>
abort
:
failure of any query terminates the task
ignore
:
failure of a query is treated the same as a query which
returns no rows
retry
:
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
retry<n>
:
failed queries are retried at most a fixed number
<n>
of times
If they still fail the task terminates.
[Default: abort
]
find = best|all|each
best
:
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
best1
option in the pair matching commands, and best1
is a permitted alias).
all
:
All query table rows which match
the input table row will be output.
Input table rows with no matches will be omitted.
each
:
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.
[Default: all
]
fixcols = none|dups|all
none
: columns are not renameddups
: columns which would otherwise have duplicate names in the output will be renamed to indicate which table they came fromall
: all columns will be renamed to indicate which table they came fromsuffix*
parameters.
[Default: dups
]
icmd = <cmds>
The value of this parameter is one or more of the filter commands described in Section 6.1. 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.
Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus "icmd=@filename
"
causes the file filename
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.
ifmt = <in-format>
(auto)
(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.
[Default: (auto)
]
in = <table>
ifmt
parameter.
istream = true|false
in
table
will be read as a stream.
It is necessary to give the
ifmt
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 input 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).
[Default: false
]
ocmd = <cmds>
The value of this parameter is one or more of the filter commands described in Section 6.1. 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.
Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus "ocmd=@filename
"
causes the file filename
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.
ofmt = <out-format>
(auto)
"
(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.
This parameter must only be given if
omode
has its default value of "out
".
[Default: (auto)
]
omode = <out-mode> <mode-args>
out
, which means that
the result will be written as a new table to disk or elsewhere,
as determined by the out
and ofmt
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
(<mode-args>
)
are required to determine the exact behaviour.
Possible values are
out
meta
stats
count
cgi
discard
topcat
samp
plastic
tosql
help=omode
flag
or see Section 6.4 for more information.
[Default: out
]
ostream = true|false
[Default: false
]
out = <out-table>
This parameter must only be given if
omode
has its default value of "out
".
[Default: -
]
parallel = <n>
<n>
, then queries will be overlapped
in such a way that up to approximately <n>
may be running at any one time.
Whether this is a good idea, and what might be a sensible
maximum value for <n>
, depends on the
characteristics of the service being queried.
[Default: 1
]
ra = <expr>
scorecol = <col-name>
[Default: Separation
]
servicetype = cone|sia|ssa
cone
:
Cone Search protocol - returns a table of objects found near each location.
See Cone Search standard.sia
:
Simple Image Access protocol - returns a table of images near each location.
See SIA standard.ssa
:
Simple Spectral Access protocol - returns a table of spectra near each location.
See SSA standard.[Default: cone
]
serviceurl = <url-value>
name=value
", separated by '&' characters).
If this value does not end in either a '?' or a '&',
one will be added as appropriate.
See Appendix B.2.3 for discussion of how to locate service URLs corresponding to given datasets.
sr = <expr>
suffix0 = <label>
fixcols
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.
[Default: _0
]
suffix1 = <label>
fixcols
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.
[Default: _1
]
verb = 1|2|3