/usr/share/doc/stilts/sun256/plot2-layer-params.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 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Layer Parameters</title>
</head>
<body>
<hr>
<a href="animate.html">Next</a> <a href="plot2-global-params.html">Previous</a> <a href="TypedPlot2Task.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="animate.html">Animation</a><br>
<b>Up: </b><a href="TypedPlot2Task.html">Plot Parameters</a><br>
<b>Previous: </b><a href="plot2-global-params.html">Global Parameters</a><br>
<hr>
<h4><a name="plot2-layer-params">8.1.2 Layer Parameters</a></h4>
<p>The layer parameters come in groups, each specifying the
details of one plot layer.
Each layer type has its own list of parameters.
A plot layer is introduced on the command line with a parameter
of the form
<pre>
layer<suffix>=<layer-type>
</pre>
and any other parameters with the same <code><suffix></code>
are considered to apply to the same layer.
In the basic example we considered:
<pre>
stilts plot2plane layer_1=mark in_1=cat.fits x_1=BMAG-RMAG y_1=BMAG
</pre>
the suffix is "<code>_1</code>" and the layer type associated with it is
<code>mark</code> (plotting markers to make a scatter plot).
The different layer types are documented in <a href="LayerType.html">Section 8.3</a>,
and each has its own set of parameters, some of which are mandatory
and some which are optional with sensible defaults.
In the documentation, the suffix is represented as "<code>N</code>".
For instance the <code><a href="layer-mark.html">mark</a></code> layer type
requires you to specify an input table (<code>inN</code>) and
point positions (<code>xN</code> and <code>yN</code>).
Since the suffix we have used in the example for the
<code>layerN</code> parameter is "<code>_1</code>",
we have written <code>in_1</code>, <code>x_1</code> and <code>y_1</code>.
The <code>mark</code> layer has some optional style parameters as well,
so we could adjust the plot's appearance by adding
<code>shape_1=cross size_1=4 color_1=blue</code>.
</p>
<p>You can have as many layers as you like (even none),
so we could overplot two datasets from different input files like this:
<pre>
stilts plot2plane
layer_1=mark in_1=cat1.fits x_1=BMAG-RMAG y_1=BMAG color_1=magenta size_1=5
layer_2=mark in_2=cat2.fits x_2=mag_b-mag_r y_2=mag_b color_2=cyan size_2=5
</pre>
We have assigned different colours to the different layers
and boosted the marker size to 5 pixels.
</p>
<p>As a convenience, if the same value is used for all the layers,
you can omit the suffix. So to avoid having to specify the same
markers size for both layers, you can write instead:
<pre>
stilts plot2plane
size=5
layer_1=mark in_1=cat1.fits x_1=BMAG-RMAG y_1=BMAG color_1=magenta
layer_2=mark in_2=cat2.fits x_2=mag_b-mag_r y_2=mag_b color_2=teal
</pre>
Although the <code>size</code> parameter no longer has an explicit suffix,
it's still a layer parameter, it just applies to multiple layers.
This shorthand works for all layer parameters.
Here is another example which also shows how you can use the
<code>icmdN</code> parameter to <a href="pipes.html">pre-process</a>
input data prior to performing the plot.
Here, we make two different selections of the input rows to plot
two different data sets.
<pre>
stilts plot2plane
in=cat.fits x=BMAG-RMAG y=BMAG
layer_1=mark icmd_1='select vel<1000' color_1=blue
layer_2=mark icmd_2='select vel>=1000' color_2=red
</pre>
The input tables and data values are the same for both datasets,
so we can just supply the parameters
<code>in</code>, <code>x</code> and <code>y</code>,
rather than
<code>in_1</code>, <code>in_2</code> etc.
</p>
<p>Any string can be used as a suffix, including the empty string
(though an empty string can cause confusion if there are multiple layers).
The suffixing is also slightly more sophisticated than described above;
to find parameters relating to a layer with a given suffix, the
parameter looks first using the whole suffix, and strips single
characters off it until it has none left.
So if a layer is introduced with the parameter <code>layer_ab</code>,
you can give the marker shape using any of the parameters
<code>shape_ab</code>, <code>shape_a</code>, <code>shape_</code>
or <code>shape</code>. If more than one of these is present,
the first one in that list will be used
(the order in which they appear on the command line is not significant).
This can be used to group sets of layers.
</p>
<p>By default, if multiple layers are specified, they are plotted
in the order in which the introducing <code>layerN</code> parameters
appear on the command line. This may be relevant, since layers
plotted later sometimes obscure ones plotted earlier.
You can alter the order of plotting with the <code>seq</code> (global)
parameter, which is a comma-separated list of layer suffixes giving
the sequence in which layers should be plotted.
So adding "<code>seq=_2,_1</code>" would cause layer _2 to be plotted
before layer _1, instead of the other way round.
</p>
<p>By default, if more than one layer is plotted, a legend will
appear labelling the datasets.
The dataset labels appearing in the legend are by default
the layer suffixes specified on the command line.
However, the labels can be given explicitly with the <code>legendN</code>
parameter, so for instance in the example above
<code>leglabel_1=Slow leglabel_2=Fast</code> would adjust the
legend accordingly.
Legend appearance and positioning can be adjusted by various
<code>leg*</code> global parameters.
</p>
<hr><a href="animate.html">Next</a> <a href="plot2-global-params.html">Previous</a> <a href="TypedPlot2Task.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="animate.html">Animation</a><br>
<b>Up: </b><a href="TypedPlot2Task.html">Plot Parameters</a><br>
<b>Previous: </b><a href="plot2-global-params.html">Global Parameters</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>
|