aboutsummaryrefslogtreecommitdiff
path: root/vo/doc/vizier.hlp
blob: 4cfe51464f93f12c786d5b7aa2b75c6f4280e37a (plain) (blame)
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
.help vizier Aug06 nvo
.ih
NAME
vizier -- Download one or more VizieR tables
.ih
USAGE
vizier tab_id
.ih
PARAMETERS
.ls tab_id
A registry ShortName or Identifier string used to resolve to a specific
ServiceUrl for the table.
.le
.ls output = "STDOUT"
Output filename or STDOUT to print the table to the screen.
.le
.ls otype = "ascii"
Type of output table.   The default return from a Cone service is a standard
VOTable (xml format).  This table may be automatically converted to some
other format for use by other tasks by resetting this parameter.  Allowed
output table types include:
.ls ascii
Simple space-separated ASCII file format.  Note that string values in the
original VOTable will be quoted.
.le
.ls csv
Comma-Separated Value format. The first line is a header which contains 
the column names.
.le
.ls fits
Convert VOTable to FITS binary table.  Primary HDU is data-less, first
extension contains a FITS binary table.
.le
.ls votable
Do not process returned VOTable and output it directly.
.le

For a full description of the supported STILTS output formats see
.nf

  http://www.star.bris.ac.uk/~mbt/stilts/sun256/outFormats.html
.fi
.le
.le
.ls all = yes
Download all matching tables?  If enabled then each table matching the
given \fBtab_id\fR will be download and the \fBoutput\fR filename will
be the root filename and each table will be appended with a running number.

A Registry ShortName typically refer to a single publication, while the
identifier refer to a specific table within that paper.  To download all
tables in a given paper, run this task with the \fBtab_id\fR as the 
Registry ShortName entry and the \fBall\fR parameter enabled.  If you will
to download a specific table, call the task with the \fBIdentifier\fR field.
.le
.ls verbose = no
Verbose output flag.
.le
.ls status = ""
Status return code of task (output).
.le

.ih
DESCRIPTION

The \fBVIZIER\fR task ......

.ih
EXAMPLES
1.

.nf
.fi


2.

.nf
.fi

.ih
REVISIONS
.le
.ih
SEE ALSO
voclient
.endhelp