Next Previous Up Contents
Next: Examples
Up: cone: Executes a Cone Search-like query
Previous: cone: Executes a Cone Search-like query

B.3.1 Usage

The usage of cone is

   stilts <stilts-flags> cone serviceurl=<url-value> lon=<degrees>
                              lat=<degrees> radius=<degrees>
                              skysys=icrs|fk5|fk4|galactic|supergalactic|ecliptic
                              servicetype=cone|ssa|sia1|sia2|sia verb=1|2|3
                              compress=true|false dataformat=<value>
                              ocmd=<cmds>
                              omode=out|meta|stats|count|checksum|cgi|discard|topcat|samp|plastic|tosql|gui
                              out=<out-table> ofmt=<out-format>
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. For programmatic invocation, the Task class for this command is uk.ac.starlink.ttools.task.TableCone.

Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:

compress = true|false       (Boolean)
If true, the service is requested to provide HTTP-level compression for the response stream (Accept-Encoding header is set to "gzip", 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.

[Default: true]

dataformat = <value>       (String)
Indicates the format of data objects described in the returned table. The meaning of this is dependent on the value of the servicetype parameter:
lat = <degrees>       (Double)
Central latitude position for cone search. By default this is the Declination, but depending on the value of the skysys parameter it may be in a different sky system.
lon = <degrees>       (Double)
Central longitude position for cone search. By default this is the Right Ascension, but depending on the value of the skysys parameter it may be in a different sky system.
ocmd = <cmds>       (ProcessingStep[])
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 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 a value of "@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, and lines which are blank or which start with a '#' character are ignored.

ofmt = <out-format>       (String)
Specifies the format in which the output table will be written (one of the ones in Section 5.1.2 - matching is case-insensitive and you can use just the first few letters). If it has the special value "(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|meta|stats|count|checksum|cgi|discard|topcat|samp|plastic|tosql|gui       (ProcessingMode)
The mode in which the result table will be output. The default mode is 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

Use the help=omode flag or see Section 6.4 for more information.

[Default: out]

out = <out-table>       (TableConsumer)
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.

This parameter must only be given if omode has its default value of "out".

[Default: -]

radius = <degrees>       (Double)
Search radius in degrees.
servicetype = cone|ssa|sia1|sia2|sia       (ServiceType)
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:

[Default: cone]

serviceurl = <url-value>       (URL)
The base part of a URL which defines the query to be made. Additional parameters will be appended to this using CGI syntax ("name=value", separated by '&' characters). If this value does not end in either a '?' or a '&', one will be added as appropriate.
skysys = icrs|fk5|fk4|galactic|supergalactic|ecliptic       (SkySystem)
Sky coordinate system used to interpret the lon and lat parameters. If the value is ICRS (the default) the provided values are assumed to be Right Ascension and Declination and are sent unchanged; for other values they will be converted from the named system into RA and Dec first.

[Default: icrs]

verb = 1|2|3       (String)
Verbosity level of the tables returned by the query service. A value of 1 indicates the bare minimum and 3 indicates all available information.


Next Previous Up Contents
Next: Examples
Up: cone: Executes a Cone Search-like query
Previous: cone: Executes a Cone Search-like query

STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note256
STILTS web page: http://www.starlink.ac.uk/stilts/
Author email: m.b.taylor@bristol.ac.uk
Mailing list: topcat-user@jiscmail.ac.uk