The usage of
stilts <stilts-flags> plot2sphere xpix=<int-value> ypix=<int-value> insets=<top>,<left>,<bottom>,<right> omode=swing|out|cgi|discard|auto storage=simple|memory|disk|policy|cache|basic-cache|persistent|parallel seq=<suffix>[,...] legend=true|false legborder=true|false legopaque=true|false legseq=<suffix>[,...] legpos=<xfrac,yfrac> title=<value> auxmap=<map-name>|<color>-<color>[-<color>...] auxclip=<lo>,<hi> auxflip=true|false auxquant=<number> auxfunc=log|linear|histogram|histolog|sqrt|square|acos|cos auxmin=<number> auxmax=<number> auxlabel=<text> auxcrowd=<factor> auxwidth=<pixels> auxvisible=true|false forcebitmap=true|false compositor=0..1 animate=<table> afmt=<in-format> astream=true|false acmd=<cmds> parallel=<int-value> crowd=<number> frame=true|false minor=true|false gridaa=true|false texttype=plain|antialias|latex fontsize=<int-value> fontstyle=standard|serif|mono fontweight=plain|bold|italic|bold_italic cx=<number> cy=<number> cz=<number> scale=<number> phi=<degrees> theta=<degrees> psi=<degrees> zoom=<factor> xoff=<pixels> yoff=<pixels> zoomfactor=<number> leglabelN=<text> layerN=<layer-type> <layerN-specific-params>If you don't have the
stiltsscript 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
Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:
acmd = <cmds>(ProcessingStep)
animate, 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 "
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.
afmt = <in-format>(String)
animate. The known formats are listed in Section 5.1.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. This parameter is ignored for scheme-specified tables.
animate = <table>(StarTable)
The location of the animation control table. This may take one of the following forms:
-", meaning standard input. In this case the input format must be given explicitly using the
afmtparameter. 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.
astream = true|false(Boolean)
animateparameter will be read as a stream. It is necessary to give the
afmtparameter 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). This parameter is ignored for scheme-specified tables.
auxclip = <lo>,<hi>(Subrange)
If the full range
0,1 is used,
the whole range of colours specified by the selected
shader will be used.
But if for instance a value of
0,0.5 is given,
only those colours at the left hand end of the ramp
will be seen.
If the null (default) value is chosen,
a default clip will be used.
This generally covers most or all of the range 0-1
but for colour maps which fade to white,
a small proportion of the lower end may be excluded,
to ensure that all the colours are visually distinguishable
from a white background.
This default is usually a good idea if the colour map
is being used with something like a scatter plot,
where markers are plotted against a white background.
However, for something like a density map when the whole
plotting area is tiled with colours from the map,
it may be better to supply the whole range
auxcrowd = <factor>(Double)
auxflip = true|false(Boolean)
auxfunc = log|linear|histogram|histolog|sqrt|square|acos|cos(Scaling)
The available options are:
log: Logarithmic scaling
linear: Linear scaling
histogram: Scaling follows data distribution, with linear axis
histolog: Scaling follows data distribution, with logarithmic axis
sqrt: Square root scaling
square: Square scaling
acos: Arccos Scaling
cos: Cos Scaling
For all these options,
the full range of data values is used,
and displayed on the colour bar
just apply the named function to the full data range.
The histogram options on the other hand use a scaling function
that corresponds to the actual distribution of the data, so that
there are about the same number of points (or pixels, or whatever
is being scaled) of each colour.
The histogram options are somewhat more expensive,
but can be a good choice if you are exploring data whose
distribution is unknown or not well-behaved over
its min-max range.
HistoLog options both
assign the colours in the same way, but they display the colour
ramp with linear or logarithmic annotation respectively;
HistoLog option also ignores
auxlabel = <text>(String)
auxmap = <map-name>|<color>-<color>[-<color>...](Shader)
A mixed bag of colour ramps are available:
many of these, including rainbow-like ones,
are frowned upon by the visualisation community.
You can also construct your own custom colour map
by giving a sequence of colour names separated by
minus sign ("
In this case the ramp is a linear interpolation
between each pair of colours named,
using the same syntax as when specifying
a colour value.
So for instance
would shade from yellow via hot pink to blue.
auxmax = <number>(Double)
auxmin = <number>(Double)
auxquant = <number>(Double)
If left blank, the colour map is nominally continuous (though in practice it may be quantised to a medium-sized number like 256).
auxvisible = true|false(Boolean)
If not supplied (the default), the aux axis will be visible when aux shading is used in any of the plotted layers.
auxwidth = <pixels>(Integer)
compositor = 0..1(Compositor)
Currently, this parameter takes a "boost" value in the range 0..1. If the value is zero, saturation semantics are used: RGB colours are added in proporition to their associated alpha value until the total alpha is saturated (reaches 1), after which additional pixels have no further effect. For larger boost values, the effect is similar, but any non-zero alpha in the output is boosted to the given minimum value. The effect of this is that even very slightly populated pixels can be visually distinguished from unpopulated ones which may not be the case for saturation composition.
crowd = <number>(Double)
cx = <number>(Double)
cy = <number>(Double)
cz = <number>(Double)
fontsize = <int-value>(Integer)
fontstyle = standard|serif|mono(FontType)
The available options are:
fontweight = plain|bold|italic|bold_italic(FontWeight)
The available options are:
forcebitmap = true|false(Boolean)
shadingN=density) it will have no effect, since this kind of rendering happens in any case.
When writing to vector graphics formats (PDF and PostScript), setting it true will force the data contents to be bitmapped. This may make the output less beautiful (round markers will no longer be perfectly round), but it may result in a much smaller file if there are very many data points.
When writing to bitmapped output formats (PNG, GIF, JPEG, ...), it fixes shapes to be the same as seen on the screen rather than be rendered at the mercy of the graphics system, which sometimes introduces small distortions.
frame = true|false(Boolean)
gridaa = true|false(Boolean)
insets = <top>,<left>,<bottom>,<right>(Padding)
The size and position of the actual plotting area
is determined by this parameter along with
The value of this parameter is 4 comma separated integers:
Any or all of these values may be left blank,
in which case the corresponding margin will be calculated
automatically according to how much space is required.
layerN = <layer-type> <layerN-specific-params>(LayerType)
layer<N>where the suffix "
<N>" is a label identifying the layer and is appended to all the parameter names which configure that layer. Suffixes may be any string, including the empty string.
This parameter may take one of the following values, described in more detail in Section 8.3:
Each of these layer types comes with a list of type-specific parameters to define the details of that layer, including some or all of the following groups:
Every parameter notionally carries the same suffix
However, if the suffix is not present,
the application will try looking for a parameter with the
same name with no suffix instead.
In this way, if several layers have the same value for a given
parameter (for instance input table),
you can supply it using one unsuffixed parameter
to save having to supply several parameters with the same
value but different suffixes.
legborder = true|false(Boolean)
legend = true|false(Boolean)
leglabelN = <text>(String)
If no value is supplied (the default), the suffix itself is used as the label.
legopaque = true|false(Boolean)
legpos = <xfrac,yfrac>(double)
0.5,0.5" will put the legend right in the middle of the plot. If no value is supplied, the legend will appear outside the plot boundary.
legseq = <suffix>[,...](String)
leglabelNparameter). If multiple layers have the same label, they will contribute to the same entry in the legend, with style icons plotted over each other. The value of this parameter is a comma-separated sequence of layer suffixes, which determines the order in which the legend entries appear. Layers with suffixes missing from this list do not show up in the legend at all.
If no value is supplied (the default),
the sequence is the same as the layer plotting sequence
minor = true|false(Boolean)
omode = swing|out|cgi|discard|auto(PaintMode)
swing: Plot will be displayed in a window on the screen. This plot is "live"; it can be resized and (except for old-style plots) navigated around with mouse actions in the same way as plots in TOPCAT.
out: Plot will be written to a file given by
outusing the graphics format given by
cgi: Plot will be written in a way suitable for CGI use direct from a web server. The output is in the graphics format given by
ofmt, preceded by a suitable "Content-type" declaration.
discard: Plot is drawn, but discarded. There is no output.
auto: Behaves as
outmode depending on presence of
parallel = <int-value>(Integer)
animateparameter is supplied. The default value is the number of processors apparently available to the JVM.
phi = <degrees>(Double)
psi = <degrees>(Double)
scale = <number>(Double)
seq = <suffix>[,...](String)
When specifying a plot, multiple layers may be specified,
each introduced by a parameter
<N> is a different (arbitrary)
suffix labelling the layer,
and is appended to all the parameters
specific to defining that layer.
By default the layers are drawn on the plot in the order
in which the
appear on the command line.
However if this parameter is specified, each comma-separated
element is interpreted as a layer suffix,
giving the ordered list of layers to plot.
Every element of the list must be a suffix with a corresponding
but missing or repeated elements are allowed.
storage = simple|memory|disk|policy|cache|basic-cache|persistent|parallel(DataStoreFactory)
The options are:
simple: no caching, data read directly from input table
memory: cached to memory; OutOfMemoryError possible for very large plots
disk: cached to disk
policy: cached using application-wide default storage policy, which is usually adaptive (memory/disk hybrid)
persistent: cached to persistent files on disk, in the system temporary directory (defined by system property
java.io.tmpdir). If this is used, plot data will be stored on disk in a way that means they can be re-used between STILTS invocations, so data preparation can be avoided on subsequent runs. Note however it can leave potentially large files in your temporary directory.
cache: synonym for
basic-cache: dumber version of
memory(no optimisation for constant-valued columns)
parallel: experimental version of memory-based cache that reads into the cache in parallel for large files. This will make the plot faster to prepare, but interaction is a bit slower and sequence-dependent attributes of the plot may not come out right. This experimental option may be withdrawn or modified in future releases.
The default value is
if a live plot is being generated
since in that case the plot needs to be redrawn every time
the user performs plot navigation actions or resizes the window,
or if animations are being produced.
Otherwise (e.g. output to a graphics file) the default is
texttype = plain|antialias|latex(TextSyntax)
Antialiasboth take the text at face value, but
Antialiassmooths the characters.
LaTeXinterprets the text as LaTeX source code and typesets it accordingly.
When not using LaTeX, antialiased text usually looks nicer, but can be perceptibly slower to plot. At time of writing, on MacOS antialiased text seems to be required to stop the writing coming out upside-down for non-horizontal text (MacOS java bug).
theta = <degrees>(Double)
title = <value>(String)
xoff = <pixels>(Double)
xpix = <int-value>(Integer)
yoff = <pixels>(Double)
ypix = <int-value>(Integer)
zoom = <factor>(Double)
zoomfactor = <number>(Double)