The usage of votcopy
is
stilts <stilts-flags> votcopy version=1.0|1.1|1.2|1.3|1.4|1.5 charset=<xml-encoding> cache=true|false href=true|false nomagic=true|false base=<location> [in=]<location> [out=]<location> [format=]TABLEDATA|BINARY|BINARY2|FITSIf 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.VotCopy
.
Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:
base = <location>
(String)
href
flag is true.
Normally these are given names based on the name of the
output file.
But if this flag is given, the names will be based on the
<location>
string.
This flag is compulsory if
href
is true
and out=-
(output is to standard out),
since in this case there is no default base name to use.
cache = true|false
(Boolean)
charset = <xml-encoding>
(Charset)
help=charset
for a full listing.
Setting the value null will use the JVM's system default.
[Default: UTF-8
]
format = TABLEDATA|BINARY|BINARY2|FITS
(uk.ac.starlink.votable.DataFormat)
null
is selected, then the tables will be
data-less (will contain no DATA element), leaving only
the document structure.
Data-less tables are legal VOTable elements.
The BINARY2
format is only available for
version
=1.3
[Default: TABLEDATA
]
href = true|false
(Boolean)
base
flag.
in = <location>
(String)
[Default: -
]
nomagic = true|false
(Boolean)
null
attributes of
VALUES
elements
where they are no longer required.
In VOTable versions <=1.2, the only way to specify
null values for integer-type scalar columns was to use
the null
attribute of the VALUES
element to indicate an in-band magic value representing null.
From VOTable v1.3, null values can be represented using
empty <TD>
elements or flagged
specially in BINARY2
streams.
In these cases, it is recommended (though not required)
not to use the VALUES
/null
mechanism.
If this parameter is set true, then any
VALUES
/null
attributes will be removed in VOTable 1.3 BINARY2 or TABLEDATA
output.
If this results in an empty VALUES
element,
it too will be removed.
This parameter is ignored if the output VOTable version
is lower than 1.3 or if
format
=BINARY/FITS.
[Default: true
]
out = <location>
(String)
[Default: -
]
version = 1.0|1.1|1.2|1.3|1.4|1.5
(uk.ac.starlink.votable.VOTableVersion)