/usr/share/doc/stilts/sun256/layer-linearfit.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 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>linearfit</title>
</head>
<body>
<hr>
<a href="layer-label.html">Next</a> <a href="layer-line.html">Previous</a> <a href="LayerType.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="layer-label.html">label</a><br>
<b>Up: </b><a href="LayerType.html">Layer Types</a><br>
<b>Previous: </b><a href="layer-line.html">line</a><br>
<hr>
<h4><a name="layer-linearfit">8.3.11 <code>linearfit</code></a></h4>
<p>Plots a line of best fit for the data points.
</p>
<p>
<strong>Usage Overview:</strong>
<pre>
layerN=linearfit colorN=<rrggbb>|red|blue|... thickN=<pixels>
dashN=dot|dash|...|<a,b,...> antialiasN=true|false
<pos-coord-paramsN> weightN=<num-expr> inN=<table>
ifmtN=<in-format> istreamN=true|false icmdN=<cmds>
</pre>
</p>
<p>All the parameters listed here
affect only the relevant layer,
identified by the suffix
<code>N</code>.
</p>
<p>
<dl>
<dt><strong>Positional Coordinate Parameters:</strong></dt>
<dd>The positional coordinates
<code><pos-coord-paramsN></code>
give a position for each row of the input table.
Their form depends on the plot geometry,
i.e. which plotting command is used.
For a plane plot (<a href="plot2plane.html"><code>plot2plane</code></a>)
the parameters would be
<code>xN</code> and <code>yN</code>.
The coordinate parameter values are in all cases strings
interpreted as numeric expressions based on column names.
These can be column names, fixed values or algebraic
expressions as described in <a href="jel.html">Section 10</a>.
</dd>
</dl>
</p>
<p>
<strong>Example:</strong>
</p>
<div align="center"><img src="plot2-layer-linearfit.png" alt="" align="middle"></div>
<p><pre> stilts plot2plane <strong>in=6dfgs_mini.xml</strong> <strong>x=RMAG</strong> <strong>y=BMAG</strong> layer1=mark <strong>layer2=linearfit</strong></pre></p>
<p>
<dl>
<dt><strong><code>antialiasN = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, plotted lines are drawn with antialising.
Antialised 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>colorN = <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 plotted data,
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>red</code>]
</p>
</dd>
<dt><strong><code>dashN = dot|dash|...|<a,b,...></code> <em>(float[])</em></strong></dt>
<dd>Determines the dash pattern of the line drawn.
If null (the default), the line is solid.
<p>Possible values for dashed lines are
<code>dot</code>, <code>dash</code>, <code>longdash</code>, <code>dotdash</code>.
You can alternatively supply a comma-separated list
of on/off length values such as
"<code>4,2,8,2</code>".
</p>
</dd>
<dt><strong><code>icmdN = <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 layer N input table as specified by parameter <code>inN</code>.
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>ifmtN = <in-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format of the input table as specified by parameter <code>inN</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>inN = <table></code> <em>(<a href="http://www.starlink.ac.uk/stil/javadocs/uk/ac/starlink/table/StarTable.html">StarTable</a>)</em></strong></dt>
<dd>The location of the input 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>ifmtN</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.
</dd>
<dt><strong><code>istreamN = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If set true, the input table
specified by the <code>inN</code> parameter
will be read as a stream.
It is necessary to give the
<code>ifmtN</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>thickN = <pixels></code> <em>(Integer)</em></strong></dt>
<dd>Thickness of plotted line in pixels.
<p>[Default: <code>1</code>]
</p>
</dd>
<dt><strong><code>weightN = <num-expr></code> <em>(String)</em></strong></dt>
<dd>The weight associated with each data point
for fitting purposes.
This is used for calculating the coefficients of
the line of best fit, and the correlation coefficient.
If no coordinate is supplied, all points are assumed to
have equal weight (1).
Otherwise, any point with a null weight value
is assigned a weight of zero, i.e. ignored.
<p>Given certain assumptions about independence of samples,
a suitable value for the weight may be
<code>1/(err*err)</code>, if <code>err</code> is the
measurement error for each Y value.
</p>
<p>The value is a numeric algebraic expression based on column names
as described in <a href="jel.html">Section 10</a>.
</p>
</dd>
</dl>
</p>
<hr><a href="layer-label.html">Next</a> <a href="layer-line.html">Previous</a> <a href="LayerType.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="layer-label.html">label</a><br>
<b>Up: </b><a href="LayerType.html">Layer Types</a><br>
<b>Previous: </b><a href="layer-line.html">line</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>
|