/usr/share/doc/stilts/sun256/plothist-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 | <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="secB.14.2.html">Next</a> <a href="plothist.html">Previous</a> <a href="plothist.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.14.2.html">Examples</a><br>
<b>Up: </b><a href="plothist.html">plothist: Old-style Histogram</a><br>
<b>Previous: </b><a href="plothist.html">plothist: Old-style Histogram</a><br>
<hr>
<h3><a name="plothist-usage">B.14.1 Usage</a></h3>
<p>The usage of <code>plothist</code> is
<pre>
stilts <stilts-flags> plothist xpix=<int-value> ypix=<int-value>
font=dialog|serif|... fontsize=<int-value>
fontstyle=plain|bold|italic|bold-italic
legend=true|false title=<value>
omode=swing|out|cgi|discard|auto
out=<out-file>
ofmt=png|png-transp|gif|jpeg|pdf|eps|eps-gzip
inN=<table> ifmtN=<in-format>
istreamN=true|false cmdN=<cmds>
xdataN=<expr> xlo=<float-value>
xhi=<float-value> xlog=true|false
xflip=true|false xlabel=<value>
subsetNS=<expr> nameNS=<value>
colourNS=<rrggbb>|red|blue|...
barstyleNS=fill|open|...
linewidthNS=<int-value>
dashNS=dot|dash|...|<a,b,...>
grid=true|false antialias=true|false
sequence=<suffix>,<suffix>,...
ylo=<float-value> yhi=<float-value>
ylog=true|false ylabel=<value>
weightN=<value> binwidth=<float-value>
norm=true|false cumulative=true|false
binbase=<float-value>
</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.task.TableHistogram</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>antialias = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Controls whether lines are drawn using antialiasing,
where applicable.
If lines are drawn to a bitmapped-type graphics output format
setting this parameter to true smooths the lines out by
using gradations of colour for diagonal lines, and setting it
false simply sets each pixel in the line to on or off.
For vector-type graphics output formats, or for cases in which
no diagonal lines are drawn, the setting of this parameter
has no effect.
Setting it true may slow the plot down slightly.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>barstyleNS = fill|open|...</code> <em>(BarShape)</em></strong></dt>
<dd>Defines how histogram bars will be drawn for dataset
NS.
The options are:
<ul>
<li><code>fill</code></li>
<li><code>open</code></li>
<li><code>tops</code></li>
<li><code>semi</code></li>
<li><code>semitops</code></li>
<li><code>spikes</code></li>
<li><code>fillover</code></li>
<li><code>openover</code></li>
</ul>
<p>[Default: <code>fill</code>]
</p>
</dd>
<dt><strong><code>binbase = <float-value></code> <em>(Double)</em></strong></dt>
<dd>Adjusts the offset of the bins.
By default zero (or one for logarithmic X axis)
is a boundary between bins;
other boundaries are defined by this and the bin width.
If this value is adjusted, the lower bound of one of the bins
will be set to this value, so all the bins move along by the
corresponding distance.
<p>[Default: <code>0.0</code>]
</p>
</dd>
<dt><strong><code>binwidth = <float-value></code> <em>(Double)</em></strong></dt>
<dd>Defines the width on the X axis of histogram bins.
If the X axis is logarithmic, then this is a multiplicative
value.
</dd>
<dt><strong><code>cmdN = <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 table.
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>colourNS = <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>Defines the colour of bars plotted for data set
NS.
The value may be a 6-digit hexadecimal number giving
red, green and blue intensities,
e.g. "<code>ff00ff</code>" for magenta.
Alternatively it may be the name of one of the
pre-defined colours.
These are currently
red, blue, green, grey, magenta, cyan, orange, pink, yellow, black and white.
<p>For most purposes, either the American or the British spelling
is accepted for this parameter name.
</p>
</dd>
<dt><strong><code>cumulative = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether historams are cumulative.
When false (the default), the height of each bar is determined
by counting the number of points which fall into the range
on the X axis that it covers.
When true, the height is determined by counting all the points
between negative infinity and the upper bound of the range
on the X axis that it covers.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>dashNS = dot|dash|...|<a,b,...></code> <em>(float[])</em></strong></dt>
<dd>Defines the dashing pattern for lines drawn for dataset
NS.
To generate a dashed line the value may be
one of the named dash types:
<ul>
<li><code>dot</code></li>
<li><code>dash</code></li>
<li><code>longdash</code></li>
<li><code>dotdash</code></li>
</ul>
or may be a comma-separated string of on/off length values such as
"<code>4,2,8,2</code>".
A <code>null</code> value indicates a solid line.
Only certain bar styles are affected by the dash pattern.
</dd>
<dt><strong><code>font = dialog|serif|...</code> <em>(String)</em></strong></dt>
<dd>Determines the font that will be used for textual annotation
of the plot, including axes etc.
At least the following fonts will be available:
<ul>
<li><code>serif</code></li>
<li><code>sansserif</code></li>
<li><code>monospaced</code></li>
<li><code>dialog</code></li>
<li><code>dialoginput</code></li>
</ul>
as well as a range of system-dependent fonts,
possibly including
<ul>
<li><code>dejavu_sans</code></li>
<li><code>dejavu_sans_mono</code></li>
<li><code>dejavu_serif</code></li>
</ul>
<p>[Default: <code>dialog</code>]
</p>
</dd>
<dt><strong><code>fontsize = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Sets the font size used for plot annotations.
<p>[Default: <code>12</code>]
</p>
</dd>
<dt><strong><code>fontstyle = plain|bold|italic|bold-italic</code> <em>(Integer)</em></strong></dt>
<dd>Gives a style in which the font is to be applied for
plot annotations.
Options are
<code>plain</code>,
<code>bold</code>,
<code>italic</code> and
<code>bold-italic</code>.
<p>[Default: <code>plain</code>]
</p>
</dd>
<dt><strong><code>grid = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, grid lines are drawn on the plot.
If false, they are absent.
<p>[Default: <code>true</code>]
</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>legend = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether a legend showing which plotting style is
used for each data set.
Defaults to true if there is more than one set, false otherwise.
</dd>
<dt><strong><code>linewidthNS = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>Defines the line width for lines drawn as part of the bars
for dataset NS.
Only certain bar styles are affected by the line width.
<p>[Default: <code>2</code>]
</p>
</dd>
<dt><strong><code>nameNS = <value></code> <em>(String)</em></strong></dt>
<dd>Provides a name to use for a subset with the symbolic label
NS.
This name will be used for display in the legend,
if one is displayed.
</dd>
<dt><strong><code>norm = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether bin counts are normalised.
If true, histogram bars are scaled such that
summed height of all bars over the whole dataset is equal to one.
Otherwise (the default), no scaling is done.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>ofmt = png|png-transp|gif|jpeg|pdf|eps|eps-gzip</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot/GraphicExporter.html">GraphicExporter</a>)</em></strong></dt>
<dd>Graphics format in which the plot is written to
the output file, see <a href="graphicExporter.html">Section 8.6</a>.
One of:
<ul>
<li><code>png</code>: PNG
</li>
<li><code>png-transp</code>: PNG with transparent background
</li>
<li><code>gif</code>: GIF
</li>
<li><code>jpeg</code>: JPEG
</li>
<li><code>pdf</code>: Portable Document Format
</li>
<li><code>eps</code>: Encapsulated PostScript
</li>
<li><code>eps-gzip</code>: Gzipped Encapsulated PostScript
</li>
</ul>
May default to a sensible value depending on the
filename given by <code>out</code>.
</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>out = <out-file></code> <em>(uk.ac.starlink.util.Destination)</em></strong></dt>
<dd>The location of the output file. This is usually a filename
to write to.
If it is equal to the special value "-"
the output will be written to standard output.
</dd>
<dt><strong><code>sequence = <suffix>,<suffix>,...</code> <em>(String[])</em></strong></dt>
<dd>Can be used to control the sequence in which different
datasets and subsets are plotted.
This will affect which symbols are plotted on top of,
and so potentially obscure,
which other ones.
The value of this parameter is a comma-separated list of the
"<code>NS</code>"
suffixes which appear on the
parameters which apply to subsets.
The sets which are named
will be plotted in order, so the first-named one will be
at the bottom (most likely to be obscured).
Note that if this parameter is supplied, then only those sets
which are named will be plotted,
so this parameter may also be used to restrict which plots appear
(though it may not be the most efficient way of doing this).
If no explicit value is supplied for this parameter,
sets will be plotted in some sequence decided by STILTS
(probably alphabetic by suffix).
</dd>
<dt><strong><code>subsetNS = <expr></code> <em>(String)</em></strong></dt>
<dd>Gives the selection criterion for the subset labelled
"<code>NS</code>".
This is a boolean expression which may be the name of
a boolean-valued column or any other boolean-valued expression.
Rows for which the expression evaluates true will be included
in the subset, and those for which it evaluates false will not.
</dd>
<dt><strong><code>title = <value></code> <em>(String)</em></strong></dt>
<dd>A one-line title to display at the top of the plot.
</dd>
<dt><strong><code>weightN = <value></code> <em>(String)</em></strong></dt>
<dd>Defines a weighting for each point accumulated to determine
the height of plotted bars.
If this parameter has a value other than 1 (the default)
then instead of simply accumulating the number of points per bin
to determine bar height,
the bar height will be the sum over the weighting expression
for the points in each bin.
Note that with weighting, the figure drawn is no longer
strictly speaking a histogram.
<p>When weighted, bars can be of negative height.
An anomaly of the plot as currently implemented is that the
Y axis never descends below zero, so any such bars are currently
invisible.
This may be amended in a future release
(contact the author to lobby for such an amendment).
</p>
<p>[Default: <code>1</code>]
</p>
</dd>
<dt><strong><code>xdataN = <expr></code> <em>(String)</em></strong></dt>
<dd>Gives a column name or expression for the x
axis data for table N.
The expression is a numeric algebraic expression
based on column names
as described in <a href="jel.html">Section 10</a>
</dd>
<dt><strong><code>xflip = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If set true, the scale on the x axis
will increase in the opposite sense from usual
(e.g. right to left rather than left to right).
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>xhi = <float-value></code> <em>(Double)</em></strong></dt>
<dd>The upper limit for the plotted x axis.
If not set, a value will be chosen which is high enough
to accommodate all the data.
</dd>
<dt><strong><code>xlabel = <value></code> <em>(String)</em></strong></dt>
<dd>Specifies a label to be used for annotating axis x.
A default values based on the plotted data will be used
if no value is supplied for this parameter.
</dd>
<dt><strong><code>xlo = <float-value></code> <em>(Double)</em></strong></dt>
<dd>The lower limit for the plotted x axis.
If not set, a value will be chosen which is low enough
to accommodate all the data.
</dd>
<dt><strong><code>xlog = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If false (the default), the scale on the x
axis is linear; if true it is logarithmic.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>xpix = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>The width of the output graphic in pixels.
<p>[Default: <code>400</code>]
</p>
</dd>
<dt><strong><code>yhi = <float-value></code> <em>(Double)</em></strong></dt>
<dd>Upper bound for Y axis.
Autogenerated from the data if not supplied.
</dd>
<dt><strong><code>ylabel = <value></code> <em>(String)</em></strong></dt>
<dd>Specifies a label for annotating the vertical axis.
A default value based on the type of histogram will be used
if no value is supplied for this parameter.
<p>[Default: <code>Count</code>]
</p>
</dd>
<dt><strong><code>ylo = <float-value></code> <em>(Double)</em></strong></dt>
<dd>Lower bound for Y axis.
<p>[Default: <code>0.0</code>]
</p>
</dd>
<dt><strong><code>ylog = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Whether to use a logarithmic scale for the Y axis.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>ypix = <int-value></code> <em>(Integer)</em></strong></dt>
<dd>The height of the output graphic in pixels.
<p>[Default: <code>300</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="secB.14.2.html">Next</a> <a href="plothist.html">Previous</a> <a href="plothist.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.14.2.html">Examples</a><br>
<b>Up: </b><a href="plothist.html">plothist: Old-style Histogram</a><br>
<b>Previous: </b><a href="plothist.html">plothist: Old-style Histogram</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>
|