The usage of tcube
is
stilts <stilts-flags> tcube cols=<col-id> ... ifmt=<in-format> istream=true|false icmd=<cmds> bounds=[<lo>]:[<hi>] ... binsizes=<size> ... nbins=<num> ... out=<out-file> otype=byte|short|int|long|float|double scale=<col-id> [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.
For programmatic invocation, the Task class for this
command is uk.ac.starlink.ttools.task.TableCube
.
Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:
binsizes = <size> ...
(String[])nbins
parameter
must be supplied.
bounds = [<lo>]:[<hi>] ...
(String[])If any of the bounds need to be determined automatically in this way, two passes through the data will be required, the first to determine bounds and the second to populate the cube.
cols = <col-id> ...
(String[])<col-id>
elements,
separated by spaces, should be given.
Each one represents a column in the table, using either its
name or index.
The number of columns listed in the value of this parameter defines the dimensionality of the output data cube.
icmd = <cmds>
(ProcessingStep[])in
,
before any 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.
ifmt = <in-format>
(String)in
.
The known formats are listed in Section 5.2.1.
This flag can be used if you know what format your
table is in.
If it has the special value
(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>
(StarTable)-
",
meaning standard input.
In this case the input format must be given explicitly
using the ifmt
parameter.
Note that not all formats can be streamed in this way.
<
" character at the start,
or a "|
" character at the end
("<syscmd
" or
"syscmd|
").
This executes the given pipeline and reads from its
standard output.
This will probably only work on unix-like systems.
istream = true|false
(Boolean)in
parameter
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 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
]
nbins = <num> ...
(String[])binsizes
parameter
must be supplied.
otype = byte|short|int|long|float|double
(Class)out = <out-file>
(uk.ac.starlink.util.Destination)The output cube is currently written as a single-HDU FITS file.
[Default: -
]
scale = <col-id>
(String)null
(the default) then for each
row that falls within the bounds of a pixel, the pixel value
will be incremented by 1.
If a column ID is given, then instead of 1 being added,
the value of that column for the row in question is added.
The effect of this is that the output image contains the mean
of the given column for the rows corresponding to each pixel
rather than just a count of them.