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>

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:
  - `servicetype=cone`: not used
  - `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).
  - `servicetype=sia1`: gives the MIME type required for images/resources referenced in the output table, corresponding to the SIA FORMAT parameter. The special values "`GRAPHIC`" (all graphics formats) and "`ALL`" (no restriction) as defined by SIAv1 are also permissible. For SIA version 1 only, this defaults to`"image/fits"`.
  - `servicetype=sia2`: gives the MIME type required for images/resources referenced in the output table, corresponding to the SIA FORMAT parameter. The special values "`GRAPHIC`" (all graphics formats) and "`ALL`" (no restriction) as defined by SIAv1 are also permissible.
  - `servicetype=sia`: gives the MIME type required for images/resources referenced in the output table, corresponding to the SIA FORMAT parameter. The special values "`GRAPHIC`" (all graphics formats) and "`ALL`" (no restriction) as defined by SIAv1 are also permissible. For SIA version 1 only, this defaults to`"image/fits"`.
`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.
`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:
  - `cone`: Cone Search protocol - returns a table of objects found near each location. See Cone Search standard.
  - `ssa`: Simple Spectral Access protocol - returns a table of spectra near each location. See SSA standard.
  - `sia1`: Simple Image Access protocol version 1 - returns a table of images near each location. See SIA 1.0 standard.
  - `sia2`: Simple Image Access protocol version 2 - returns a table of images near each location. See SIA 2.0 standard.
  - `sia`: alias for `sia1`

  [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