STILTS-PLOT2SPHERE(1) | Stilts commands | STILTS-PLOT2SPHERE(1) |
NAME¶
stilts-plot2sphere - Draws a sphere plot
SYNOPSIS¶
stilts 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>] [labelangle=horizontal|angled|adaptive] [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>]
DESCRIPTION¶
plot2sphere draws plots in an isotropic 3-dimensional space using spherical polar coordinates. The plotting volume is a cube, which is viewed from the outside and usually bounded by a wire frame annotated by Cartesian coordinates. This viewing cube is not necessarily centered on the coordinate origin.
This plotting geometry is like that used by plot2cube, but the coordinate unit size is always the same in the three dimensions, and the coordinates are specified differently.
Positional coordinates are specified as lon, lat, r triples, e.g.: plot2sphere layer1=mark in1=survey.fits lon1=RA lat1=DEC r1=REDSHIFT
Content is added to the plot by specifying one or more plot layers using the layerN parameter. The N part is a suffix applied to all the parameters affecting a given layer; any suffix (including the empty string) may be used. Available layers for this plot type are: mark, size, sizexy, link2, mark2, poly4, mark4, polygon, area, central, label, arealabel, line3d, contour, spheregrid.
OPTIONS¶
The size and position of the actual plotting area is determined by this parameter along with xpix and ypix.
The value of this parameter is 4 comma separated integers: <top>,<left>,<bottom>,<right>. 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.
- 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 out using the graphics format given by ofmt.
- 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 swing or out mode depending on presence of out parameter
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 memory (backward compatibility)
- 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 memory if a live plot is being generated (omode=swing), 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 simple.
When specifying a plot, multiple layers may be specified, each introduced by a parameter layer<N>, where <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 layer* parameters 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 layer parameter, but missing or repeated elements are allowed.
If no value is supplied (the default), the sequence is the same as the layer plotting sequence (see seq).
A mixed bag of colour ramps are available as listed in SUN/256: inferno, magma, plasma, viridis, cividis, cubehelix, sron, rainbow, rainbow2, rainbow3, pastel, cosmic, ember, gothic, rainforest, voltage, bubblegum, gem, chroma, sunset, neon, tropical, accent, gnuplot, gnuplot2, specxby, set1, paired, hotcold, guppy, iceburn, redshift, pride, rdbu, piyg, brbg, cyan-magenta, red-blue, brg, heat, cold, light, greyscale, colour, standard, bugn, bupu, orrd, pubu, purd, painbow, huecl, infinity, hue, intensity, rgb_red, rgb_green, rgb_blue, hsv_h, hsv_s, hsv_v, yuv_y, yuv_u, yuv_v, scale_hsv_s, scale_hsv_v, scale_yuv_y, mask, blacker, whiter, transparency. Note: 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 ("-") characters. 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 "yellow-hotpink-#0000ff" would shade from yellow via hot pink to blue.
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 0,1 explicitly.
If left blank, the colour map is nominally continuous (though in practice it may be quantised to a medium-sized number like 256).
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 if applicable. The Linear, Log, Square and Sqrt options 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. The Histogram and HistoLog options both assign the colours in the same way, but they display the colour ramp with linear or logarithmic annotation respectively; the HistoLog option also ignores non-positive values.
If not supplied (the default), the aux axis will be visible when aux shading is used in any of the plotted layers.
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.
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.
The location of the animation control table. This may take one of the following forms:
- A filename.
- A URL.
- The special value "-", meaning standard input. In this case the input format must be given explicitly using the afmt parameter. Note that not all formats can be streamed in this way.
- A scheme specification of the form :<scheme-name>:<scheme-args>.
- A system command line with either a "<" 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.
In any case, compressed data in one of the supported compression formats (gzip, Unix compress or bzip2) will be decompressed transparently.
Commands may alternatively 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. A backslash character '\fR' at the end of a line joins it with the following line.
The available options are:
- horizontal: axis labels are horizontal
- angled: axis labels are angled
- adaptive: axis labels are horizontal if possible, but angled if necessary to fit more in
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).
The available options are:
- standard
- serif
- mono
The available options are:
- plain
- bold
- italic
- bold_italic
If no value is supplied (the default), the suffix itself is used as the label.
This parameter may take one of the following values, described in more detail in SUN/256:
- mark
- size
- sizexy
- link2
- mark2
- poly4
- mark4
- polygon
- area
- central
- label
- arealabel
- line3d
- contour
- spheregrid
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:
- input table parameters (e.g. inN, icmdN)
- coordinate params referring to input table columns (e.g. xN, yN)
- layer style parameters (e.g. shadingN, colorN)
Every parameter notionally carries the same suffix N. 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.
SEE ALSO¶
If the package stilts-doc is installed, the full documentation
SUN/256 is available in HTML format:
file:///usr/share/doc/stilts/sun256/index.html
VERSION¶
STILTS version 3.5.1-debian
This is the Debian version of Stilts, which lack the support of
some file formats and network protocols. For differences see
file:///usr/share/doc/stilts/README.Debian
AUTHOR¶
Mark Taylor (Bristol University)
Mar 2017 |