/usr/share/doc/stilts/sun256/plot2sky-usage.html is in stilts-doc 3.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Usage</title>
</head>
<body>
<hr>
<a href="plot2sky-examples.html">Next</a> <a href="plot2sky.html">Previous</a> <a href="plot2sky.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="plot2sky-examples.html">Examples</a><br>
<b>Up: </b><a href="plot2sky.html">plot2sky: Draws a sky plot</a><br>
<b>Previous: </b><a href="plot2sky.html">plot2sky: Draws a sky plot</a><br>
<hr>
<h3><a name="plot2sky-usage">B.8.1 Usage</a></h3>
<p>The usage of <code>plot2sky</code> is
<pre>
stilts <stilts-flags> plot2sky xpix=<int-value> ypix=<int-value>
insets=<top>,<left>,<bottom>,<right>
omode=swing|out|cgi|discard|auto
storage=simple|cache|basic-cache
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|sqrt|square
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>
projection=sin|aitoff|car
viewsys=equatorial|galactic|supergalactic|ecliptic
reflectlon=true|false grid=true|false
labelpos=Auto|External|Internal|Basic|Hybrid|None
sex=true|false crowd=<number>
gridcolor=<rrggbb>|red|blue|...
labelcolor=<rrggbb>|red|blue|...
gridaa=true|false
texttype=plain|antialias|latex
fontsize=<int-value>
fontstyle=standard|serif|mono
fontweight=plain|bold|italic|bold_italic
clon=<degrees> clat=<degrees>
radius=<degrees> zoomfactor=<number>
leglabelN=<text>
layerN=<layer-type> <layerN-specific-params>
</pre>
If you don't have the <code>stilts</code> script installed,
write "<code>java -jar stilts.jar</code>" instead of
"<code>stilts</code>" - see <a href="invoke.html">Section 3</a>.
The available <code><stilts-flags></code> are listed
in <a href="stilts-flags.html">Section 2.1</a>.
For programmatic invocation, the Task class for this
command is <code>uk.ac.starlink.ttools.plot2.task.SkyPlot2Task</code>.
</p>
<p>Parameter values are assigned on the command line
as explained in <a href="task-args.html">Section 2.3</a>.
They are as follows:
</p>
<p>
<dl>
<dt><strong><code>acmd = <cmds></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/filter/ProcessingStep.html">ProcessingStep[]</a>)</em></strong></dt>
<dd>Specifies processing to be performed on
the animation control table as specified by parameter <code>animate</code>,
before any other processing has taken place.
The value of this parameter is one or more of the filter
commands described in <a href="filterSteps.html">Section 6.1</a>.
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.
<p>Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "<code>@filename</code>"
causes the file <code>filename</code> 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.
</p>
</dd>
<dt><strong><code>afmt = <in-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format of the animation control table as specified by parameter <code>animate</code>.
The known formats are listed in <a href="inFormats.html">Section 5.2.1</a>.
This flag can be used if you know what format your
table is in.
If it has the special value
<code>(auto)</code> (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.
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>animate = <table></code> <em>(<a href="http://www.starlink.ac.uk/stil/javadocs/uk/ac/starlink/table/StarTable.html">StarTable</a>)</em></strong></dt>
<dd>If not null, this parameter causes the command
to create a sequence of plots instead of just one.
The parameter value is a table with one row for each
frame to be produced.
Columns in the table are interpreted as parameters
which may take different values for each frame;
the column name is the parameter name,
and the value for a given frame is its value from that row.
Animating like this is considerably more efficient
than invoking the STILTS command in a loop.
<p>The location of the animation control table.
This may take one of the following forms:
<ul>
<li>A filename.</li>
<li>A URL.</li>
<li>The special value "<code>-</code>",
meaning standard input.
In this case the input format must be given explicitly
using the <code>afmt</code>
parameter.
Note that not all formats can be streamed in this way.
</li>
<li>A system command line with
either a "<code><</code>" character at the start,
or a "<code>|</code>" character at the end
("<code><syscmd</code>" or
"<code>syscmd|</code>").
This executes the given pipeline and reads from its
standard output.
This will probably only work on unix-like systems.
</li>
</ul>
In any case, compressed data in one of the supported compression
formats (gzip, Unix compress or bzip2) will be decompressed
transparently.
</p>
</dd>
<dt><strong><code>astream = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If set true, the animation control table
specified by the <code>animate</code> parameter
will be read as a stream.
It is necessary to give the
<code>afmt</code> 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).
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>auxclip = <lo>,<hi></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/Subrange.html">Subrange</a>)</em></strong></dt>
<dd>Defines a subrange of the colour ramp to be used for
Aux shading.
The value is specified as a (low,high) comma-separated pair
of two numbers between 0 and 1.
<p>If the full range <code>0,1</code> is used,
the whole range of colours specified by the selected
shader will be used.
But if for instance a value of <code>0,0.5</code> is given,
only those colours at the left hand end of the ramp
will be seen.
</p>
<p>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
<code>0,1</code> explicitly.
</p>
</dd>
<dt><strong><code>auxcrowd = <factor></code> <em>(Double)</em></strong></dt>
<dd>Determines how closely the tick marks are spaced on
the Aux axis,
if visible.
The default value is 1, meaning normal crowding.
Larger values result in more ticks,
and smaller values fewer ticks.
Tick marks will not however be spaced so closely that
the labels overlap each other,
so to get very closely spaced marks you may need to
reduce the font size as well.
<p>[Default: <code>1.0</code>]
</p>
</dd>
<dt><strong><code>auxflip = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, the colour map on the
Aux
axis will be reversed.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>auxfunc = log|linear|sqrt|square</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/Scaling.html">Scaling</a>)</em></strong></dt>
<dd>Defines the way that values in the
Aux
range are mapped to the selected colour ramp.
<p>The available options are:
<ul>
<li><code>log</code>: Logarithmic scaling
</li>
<li><code>linear</code>: Linear scaling
</li>
<li><code>sqrt</code>: Square root scaling
</li>
<li><code>square</code>: Square scaling
</li>
</ul>
</p>
<p>[Default: <code>linear</code>]
</p>
</dd>
<dt><strong><code>auxlabel = <text></code> <em>(String)</em></strong></dt>
<dd>Sets the label used to annotate the aux axis,
if it is visible.
</dd>
<dt><strong><code>auxmap = <map-name>|<color>-<color>[-<color>...]</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot/Shader.html">Shader</a>)</em></strong></dt>
<dd>Color map used for
Aux
axis shading.
<p>A mixed bag of colour ramps are available:
<code>inferno</code>,
<code>magma</code>,
<code>plasma</code>,
<code>viridis</code>,
<code>cubehelix</code>,
<code>sron</code>,
<code>rainbow</code>,
<code>rainbow2</code>,
<code>rainbow3</code>,
<code>pastel</code>,
<code>accent</code>,
<code>gnuplot</code>,
<code>gnuplot2</code>,
<code>specxby</code>,
<code>set1</code>,
<code>paired</code>,
<code>hotcold</code>,
<code>rdbu</code>,
<code>piyg</code>,
<code>brbg</code>,
<code>cyan-magenta</code>,
<code>red-blue</code>,
<code>brg</code>,
<code>heat</code>,
<code>cold</code>,
<code>light</code>,
<code>greyscale</code>,
<code>colour</code>,
<code>standard</code>,
<code>bugn</code>,
<code>bupu</code>,
<code>orrd</code>,
<code>pubu</code>,
<code>purd</code>,
<code>huecl</code>,
<code>hue</code>,
<code>intensity</code>,
<code>rgb_red</code>,
<code>rgb_green</code>,
<code>rgb_blue</code>,
<code>hsv_h</code>,
<code>hsv_s</code>,
<code>hsv_v</code>,
<code>yuv_y</code>,
<code>yuv_u</code>,
<code>yuv_v</code>,
<code>scale_hsv_s</code>,
<code>scale_hsv_v</code>,
<code>scale_yuv_y</code>,
<code>mask</code>,
<code>blacker</code>,
<code>whiter</code>,
<code>transparency</code>.
<em>Note:</em>
many of these, including rainbow-like ones,
are frowned upon by the visualisation community.
</p>
<p>You can also construct your own custom colour map
by giving a sequence of colour names separated by
minus sign ("<code>-</code>") 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
"<code>yellow-hotpink-#0000ff</code>"
would shade from yellow via hot pink to blue.
</p>
<p>[Default: <code>inferno</code>]
</p>
</dd>
<dt><strong><code>auxmax = <number></code> <em>(Double)</em></strong></dt>
<dd>Maximum value of the data coordinate
on the Aux axis.
This sets the value before any subranging is applied.
If not supplied, the value is determined from the plotted data.
</dd>
<dt><strong><code>auxmin = <number></code> <em>(Double)</em></strong></dt>
<dd>Minimum value of the data coordinate
on the Aux axis.
This sets the value before any subranging is applied.
If not supplied, the value is determined from the plotted data.
</dd>
<dt><strong><code>auxquant = <number></code> <em>(Double)</em></strong></dt>
<dd>Allows the colour map used for the
Aux
axis to be quantised.
If an integer value N is chosen
then the colour map will be viewed as N discrete evenly-spaced
levels,
so that only N different colours will appear in the plot.
This can be used to generate a contour-like effect,
and may make it easier to trace the boundaries of
regions of interest by eye.
<p>If left blank, the colour map is
nominally continuous (though in practice it may be quantised
to a medium-sized number like 256).
</p>
</dd>
<dt><strong><code>auxvisible = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether the aux axis colour ramp
is displayed alongside the plot.
<p>If not supplied (the default),
the aux axis will be visible when aux shading is used
in any of the plotted layers.
</p>
</dd>
<dt><strong><code>auxwidth = <pixels></code> <em>(Integer)</em></strong></dt>
<dd>Determines the lateral size of the aux colour ramp,
if visible, in pixels.
<p>[Default: <code>15</code>]
</p>
</dd>
<dt><strong><code>clat = <degrees></code> <em>(Double)</em></strong></dt>
<dd>Latitude of the central position of the plot
in decimal degrees.
Use with <code>clon</code>
and <code>radius</code>.
If the center is not specified,
the field of view is determined from the data.
</dd>
<dt><strong><code>clon = <degrees></code> <em>(Double)</em></strong></dt>
<dd>Longitude of the central position of the plot
in decimal degrees.
Use with <code>clat</code>
and <code>radius</code>.
If the center is not specified,
the field of view is determined from the data.
</dd>
<dt><strong><code>compositor = 0..1</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/paper/Compositor.html">Compositor</a>)</em></strong></dt>
<dd>Defines how multiple overplotted partially transparent pixels
are combined to form a resulting colour.
The way this is used depends on the details of
the specified plot.
<p>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.
</p>
<p>[Default: <code>0.05</code>]
</p>
</dd>
<dt><strong><code>crowd = <number></code> <em>(Double)</em></strong></dt>
<dd>Determines how closely sky grid lines are spaced.
The default value is 1, meaning normal crowding.
Larger values result in more grid lines,
and smaller values in fewer grid lines.
<p>[Default: <code>1</code>]
</p>
</dd>
<dt><strong><code>fontsize = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Size of the text font in points.
<p>[Default: <code>12</code>]
</p>
</dd>
<dt><strong><code>fontstyle = standard|serif|mono</code> <em>(FontType)</em></strong></dt>
<dd>Font style for text.
<p>The available options are:
<ul>
<li><code>standard</code></li>
<li><code>serif</code></li>
<li><code>mono</code></li>
</ul>
</p>
<p>[Default: <code>standard</code>]
</p>
</dd>
<dt><strong><code>fontweight = plain|bold|italic|bold_italic</code> <em>(FontWeight)</em></strong></dt>
<dd>Font weight for text.
<p>The available options are:
<ul>
<li><code>plain</code></li>
<li><code>bold</code></li>
<li><code>italic</code></li>
<li><code>bold_italic</code></li>
</ul>
</p>
<p>[Default: <code>plain</code>]
</p>
</dd>
<dt><strong><code>forcebitmap = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Affects whether rendering of the data contents of a plot
(though not axis labels etc) is always done to
an intermediate bitmap rather than, where possible,
being painted using graphics primitives.
This is a rather arcane setting that may nevertheless
have noticeable effects on the appearance and
size of an output graphics file, as well as plotting time.
For some types of plot
(e.g. <code>shadingN=auto</code>
or <code>shadingN=density</code>)
it will have no effect, since this kind of rendering
happens in any case.
<p>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.
</p>
<p>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.
</p>
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>grid = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, sky coordinate grid lines are drawn
on the plot.
If false, they are absent.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>gridaa = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, grid lines are drawn with antialiasing.
Antialiased lines look smoother, but may take
perceptibly longer to draw.
Only has any effect for bitmapped output formats.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>gridcolor = <rrggbb>|red|blue|...</code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Color.html">Color</a>)</em></strong></dt>
<dd>The color of the plot grid,
given by name or as a hexadecimal RGB value.
<p>The standard plotting colour names are
<code>red</code>, <code>blue</code>, <code>green</code>, <code>grey</code>, <code>magenta</code>, <code>cyan</code>, <code>orange</code>, <code>pink</code>, <code>yellow</code>, <code>black</code>, <code>light_grey</code>, <code>white</code>.
However, many other common colour names (too many to list here)
are also understood.
The list currently contains those colour names understood
by most web browsers,
from <code>AliceBlue</code> to <code>YellowGreen</code>,
listed e.g. in the
<em>Extended color keywords</em> section of
the <a href="http://www.w3c.org/TR/css3-color#svg-color">CSS3</a> standard.
</p>
<p>Alternatively, a six-digit hexadecimal number <em>RRGGBB</em>
may be supplied,
optionally prefixed by "<code>#</code>" or "<code>0x</code>",
giving red, green and blue intensities,
e.g. "<code>ff00ff</code>", "<code>#ff00ff</code>"
or "<code>0xff00ff</code>" for magenta.
</p>
<p>[Default: <code>light_grey</code>]
</p>
</dd>
<dt><strong><code>insets = <top>,<left>,<bottom>,<right></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/Padding.html">Padding</a>)</em></strong></dt>
<dd>Defines the amount of space in pixels around the
actual plotting area.
This space is used for axis labels, and other decorations
and any left over forms an empty border.
<p>The size and position of the actual plotting area
is determined by this parameter along with
<code>xpix</code> and
<code>ypix</code>.
</p>
<p>The value of this parameter is 4 comma separated integers:
<code><top>,<left>,<bottom>,<right></code>.
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.
</p>
</dd>
<dt><strong><code>labelcolor = <rrggbb>|red|blue|...</code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Color.html">Color</a>)</em></strong></dt>
<dd>The color of axis labels and other plot annotations,
given by name or as a hexadecimal RGB value.
<p>The standard plotting colour names are
<code>red</code>, <code>blue</code>, <code>green</code>, <code>grey</code>, <code>magenta</code>, <code>cyan</code>, <code>orange</code>, <code>pink</code>, <code>yellow</code>, <code>black</code>, <code>light_grey</code>, <code>white</code>.
However, many other common colour names (too many to list here)
are also understood.
The list currently contains those colour names understood
by most web browsers,
from <code>AliceBlue</code> to <code>YellowGreen</code>,
listed e.g. in the
<em>Extended color keywords</em> section of
the <a href="http://www.w3c.org/TR/css3-color#svg-color">CSS3</a> standard.
</p>
<p>Alternatively, a six-digit hexadecimal number <em>RRGGBB</em>
may be supplied,
optionally prefixed by "<code>#</code>" or "<code>0x</code>",
giving red, green and blue intensities,
e.g. "<code>ff00ff</code>", "<code>#ff00ff</code>"
or "<code>0xff00ff</code>" for magenta.
</p>
<p>[Default: <code>black</code>]
</p>
</dd>
<dt><strong><code>labelpos = Auto|External|Internal|Basic|Hybrid|None</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/geom/SkyAxisLabeller.html">SkyAxisLabeller</a>)</em></strong></dt>
<dd>Controls whether and where the numeric annotations
of the lon/lat axes are displayed.
The default option <code>Auto</code>
usually does the sensible thing,
but other options exist to force labelling internally
or externally to the plot region,
or to remove numeric labels altogether.
<p>The available options are:
<ul>
<li><code>Auto</code>: Uses <code>External</code> or <code>Internal</code> policy according to whether the sky fills the plot bounds or not
</li>
<li><code>External</code>: Labels are drawn outside the plot bounds
</li>
<li><code>Internal</code>: Labels are drawn inside the plot bounds
</li>
<li><code>Basic</code>: Labels are drawn somewhere near the grid line
</li>
<li><code>Hybrid</code>: Grid lines are labelled outside the plot bounds where possible, but inside if they
would otherwise be invisible
</li>
<li><code>None</code>: Axes are not labelled
</li>
</ul>
</p>
<p>[Default: <code>Auto</code>]
</p>
</dd>
<dt><strong><code>layerN = <layer-type> <layerN-specific-params></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/task/LayerType.html">LayerType</a>)</em></strong></dt>
<dd>Selects one of the available plot types
for layerN.
A plot consists of a plotting surface,
set up using the various unsuffixed parameters
of the plotting command,
and zero or more plot layers.
Each layer is introduced by a parameter with the name
<code>layer<N></code>
where the suffix "<code><N></code>"
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.
<p>This parameter may take one of the following values,
described in more detail in <a href="LayerType.html">Section 8.3</a>:
<ul>
<li><code><a href="layer-mark.html">mark</a></code></li>
<li><code><a href="layer-size.html">size</a></code></li>
<li><code><a href="layer-sizexy.html">sizexy</a></code></li>
<li><code><a href="layer-skyvector.html">skyvector</a></code></li>
<li><code><a href="layer-skyellipse.html">skyellipse</a></code></li>
<li><code><a href="layer-skycorr.html">skycorr</a></code></li>
<li><code><a href="layer-link2.html">link2</a></code></li>
<li><code><a href="layer-mark2.html">mark2</a></code></li>
<li><code><a href="layer-label.html">label</a></code></li>
<li><code><a href="layer-contour.html">contour</a></code></li>
<li><code><a href="layer-skydensity.html">skydensity</a></code></li>
<li><code><a href="layer-healpix.html">healpix</a></code></li>
<li><code><a href="layer-skygrid.html">skygrid</a></code></li>
</ul>
</p>
<p>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:
<ul>
<li>input table parameters
(e.g. <code>inN</code>,
<code>icmdN</code>)
</li>
<li>coordinate params referring to input table columns
(e.g. <code>xN</code>,
<code>yN</code>)
</li>
<li>layer style parameters
(e.g. <code>shadingN</code>,
<code>colorN</code>)
</li>
</ul>
</p>
<p>Every parameter notionally carries the same suffix
<code>N</code>.
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.
</p>
</dd>
<dt><strong><code>legborder = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, a line border is drawn around the legend.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>legend = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Whether to draw a legend or not.
If no value is supplied, the decision is made automatically:
a legend is drawn only if it would have more than one entry.
</dd>
<dt><strong><code>leglabelN = <text></code> <em>(String)</em></strong></dt>
<dd>Sets the presentation label for the layer with a given suffix.
This is the text which is displayed in the legend, if present.
Multiple layers may use the same label, in which case
they will be combined to form a single legend entry.
<p>If no value is supplied (the default),
the suffix itself is used as the label.
</p>
</dd>
<dt><strong><code>legopaque = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, the background of the legend is opaque,
and the legend obscures any plot components behind it.
Otherwise, it's transparent.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>legpos = <xfrac,yfrac></code> <em>(double[])</em></strong></dt>
<dd>Determines the internal position of the legend on
the plot.
The value is a comma-separated pair of values giving the
X and Y positions of the legend within the plotting bounds,
so for instance "<code>0.5,0.5</code>" will put the legend
right in the middle of the plot.
If no value is supplied, the legend will appear outside
the plot boundary.
</dd>
<dt><strong><code>legseq = <suffix>[,...]</code> <em>(String[])</em></strong></dt>
<dd>Determines which layers are represented in the legend
(if present) and in which order they appear.
The legend has a line for each layer label
(as determined by the
<code>leglabelN</code>
parameter).
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.
<p>If no value is supplied (the default),
the sequence is the same as the layer plotting sequence
(see <code>seq</code>).
</p>
</dd>
<dt><strong><code>omode = swing|out|cgi|discard|auto</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plottask/PaintMode.html">PaintMode</a>)</em></strong></dt>
<dd>Determines how the drawn plot will be output, see <a href="paintMode.html">Section 8.5</a>.
<ul>
<li><code><a href="paintmode-swing.html">swing</a></code>:
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.
</li>
<li><code><a href="paintmode-out.html">out</a></code>:
Plot will be written to a file given by <code>out</code> using the graphics format given by <code><a href="graphicExporter.html">ofmt</a></code>.
</li>
<li><code><a href="paintmode-cgi.html">cgi</a></code>:
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 <code><a href="graphicExporter.html">ofmt</a></code>,
preceded by a suitable "Content-type" declaration.
</li>
<li><code><a href="paintmode-discard.html">discard</a></code>:
Plot is drawn, but discarded. There is no output.
</li>
<li><code><a href="paintmode-auto.html">auto</a></code>:
Behaves as <code><a href="paintmode-swing.html">swing</a></code> or <code><a href="paintmode-out.html">out</a></code> mode depending on presence of <code>out</code> parameter
</li>
</ul>
<p>[Default: <code>auto</code>]
</p>
</dd>
<dt><strong><code>parallel = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Determines how many threads will run in parallel
if animation output is being produced.
Only used if the <code>animate</code>
parameter is supplied.
The default value is the number of processors apparently
available to the JVM.
<p>[Default: <code>4</code>]
</p>
</dd>
<dt><strong><code>projection = sin|aitoff|car</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/geom/Projection.html">Projection</a>)</em></strong></dt>
<dd>Sky projection used to display the plot.
<p>The available options are:
<ul>
<li><code>sin</code>: rotatable sphere
</li>
<li><code>aitoff</code>: Hammer-Aitoff projection
</li>
<li><code>car</code>: Plate Carree projection (lon/lat on Cartesian axes)
</li>
</ul>
</p>
<p>[Default: <code>sin</code>]
</p>
</dd>
<dt><strong><code>radius = <degrees></code> <em>(Double)</em></strong></dt>
<dd>Approximate radius of the plot field of view in degrees.
Only used if <code>clon</code>
and <code>clat</code> are also specified.
<p>[Default: <code>1</code>]
</p>
</dd>
<dt><strong><code>reflectlon = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Whether to invert the celestial sphere by displaying
the longitude axis increasing right-to-left
rather than left-to-right.
It is conventional to display the celestial sphere
in this way because that's what it looks like
from the earth, so the default is <code>true</code>.
Set it false to see the sphere from the outside.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>seq = <suffix>[,...]</code> <em>(String[])</em></strong></dt>
<dd>Contains a comma-separated list of layer suffixes
to determine the order in which layers are drawn on the plot.
This can affect which symbol are plotted on top of,
and so potentially obscure, which other ones.
<p>When specifying a plot, multiple layers may be specified,
each introduced by a parameter
<code>layer<N></code>,
where <code><N></code> is a different (arbitrary)
suffix labelling the layer,
and is appended to all the parameters
specific to defining that layer.
</p>
<p>By default the layers are drawn on the plot in the order
in which the <code>layer*</code> 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
<code>layer</code> parameter,
but missing or repeated elements are allowed.
</p>
</dd>
<dt><strong><code>sex = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, grid line labels are written in
sexagesimal notation, if false in decimal degrees.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>storage = simple|cache|basic-cache</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/data/DataStoreFactory.html">DataStoreFactory</a>)</em></strong></dt>
<dd>Determines the way that data is accessed when constructing
the plot.
There are two basic options, cached or not.
<p>If no caching is used (<code>simple</code>)
then rows are read sequentially from the specified input table(s)
every time they are required.
This generally requires a small memory footprint
(though that can depend on how the table is specified)
and makes sense if the data only needs to be scanned once
or perhaps if the table is very large.
</p>
<p>If caching is used
(<code>cache</code>)
then the required data is read once
from the specified input table(s) and cached
before any plotting is performed,
and plots are done using this cached data.
This may use a significant amount of memory for large tables
but it's usually more sensible (faster)
if the data will need to be scanned multiple times.
</p>
<p>The default value is
<code>cache</code>
if a live plot is being generated
(<code>omode=swing</code>),
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
<code>simple</code>.
</p>
<p>[Default: <code>simple</code>]
</p>
</dd>
<dt><strong><code>texttype = plain|antialias|latex</code> <em>(TextSyntax)</em></strong></dt>
<dd>Determines how to turn label text into characters
on the plot.
<code>Plain</code> and
<code>Antialias</code>
both take the text at face value,
but <code>Antialias</code>
smooths the characters.
<code>LaTeX</code>
interprets the text as LaTeX source code
and typesets it accordingly.
<p>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).
</p>
<p>[Default: <code>plain</code>]
</p>
</dd>
<dt><strong><code>title = <value></code> <em>(String)</em></strong></dt>
<dd>Text of a title to be displayed at the top of
the plot.
If null, the default, no title is shown
and there's more space for the graphics.
</dd>
<dt><strong><code>viewsys = equatorial|galactic|supergalactic|ecliptic</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/geom/SkySys.html">SkySys</a>)</em></strong></dt>
<dd>The sky coordinate system used for the generated plot.
<p>Choice of this value goes along with the data coordinate
system that may be specified for plot layers.
If unspecified, a generic longitude/latitude system is used,
and all lon/lat coordinates in the plotted data layers
are assumed to be in the same system.
If a value is supplied for this parameter,
then a sky system must (implicitly or explicitly)
be supplied for each data layer,
and the coordinates are converted from data to view system
before being plotted.
</p>
<p>The available options are:
<ul>
<li><code>equatorial</code>: J2000 equatorial system
</li>
<li><code>galactic</code>: IAU 1958 galactic system
</li>
<li><code>supergalactic</code>: De Vaucouleurs supergalactic system
</li>
<li><code>ecliptic</code>: ecliptic system based on conversion at 2000.0
</li>
</ul>
</p>
</dd>
<dt><strong><code>xpix = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Size of the output image in the X direction in pixels.
This includes space for any axis labels, padding
and other decoration outside the plot area itself.
See also <code>insets</code>.
<p>[Default: <code>500</code>]
</p>
</dd>
<dt><strong><code>ypix = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Size of the output image in the Y direction in pixels.
This includes space for any axis labels, padding
and other decoration outside the plot area itself.
See also <code>insets</code>.
<p>[Default: <code>400</code>]
</p>
</dd>
<dt><strong><code>zoomfactor = <number></code> <em>(Double)</em></strong></dt>
<dd>Sets the amount by which the plot view zooms in or out
for each unit of mouse wheel movement.
A value of 1 means that mouse wheel zooming has no effect.
A higher value means that the mouse wheel zooms faster
and a value nearer 1 means it zooms slower.
Values below 1 are not permitted.
<p>[Default: <code>1.2</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="plot2sky-examples.html">Next</a> <a href="plot2sky.html">Previous</a> <a href="plot2sky.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="plot2sky-examples.html">Examples</a><br>
<b>Up: </b><a href="plot2sky.html">plot2sky: Draws a sky plot</a><br>
<b>Previous: </b><a href="plot2sky.html">plot2sky: Draws a sky plot</a><br>
<hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
<a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
<a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
<a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>
|