This file is indexed.

/usr/share/doc/stilts/sun256/layer-histogram.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
<html>
   
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <link rel="stylesheet" type="text/css" href="sun-style.css">
      <title>histogram</title>
   </head>
   
   <body>
      <hr>
      <a href="layer-kde.html">Next</a> <a href="layer-quantile.html">Previous</a> <a href="LayerType.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="layer-kde.html">kde</a><br>
       <b>Up: </b><a href="LayerType.html">Layer Types</a><br>
       <b>Previous: </b><a href="layer-quantile.html">quantile</a><br>
      
      <hr>
      <h4><a name="layer-histogram">8.3.17 <code>histogram</code></a></h4>
      <p>Plots a histogram.</p>
      <p>
         <strong>Usage Overview:</strong>
         <pre>
   layerN=histogram colorN=&lt;rrggbb&gt;|red|blue|... transparencyN=0..1
                    binsizeN=+&lt;width&gt;|-&lt;count&gt; phaseN=&lt;number&gt;
                    cumulativeN=true|false
                    normaliseN=none|area|unit|maximum|height
                    barformN=open|filled|semi_filled|steps|semi_steps|spikes
                    thickN=&lt;pixels&gt; dashN=dot|dash|...|&lt;a,b,...&gt; xN=&lt;num-expr&gt;
                    weightN=&lt;num-expr&gt; inN=&lt;table&gt; ifmtN=&lt;in-format&gt;
                    istreamN=true|false icmdN=&lt;cmds&gt;
</pre>
         </p>
      <p>All the parameters listed here
         affect only the relevant layer,
         identified by the suffix
         <code>N</code>.
         
      </p>
      <p>
         <strong>Example:</strong>
         
      </p>
      <div align="center"><img src="plot2-layer-histogram.png" alt="" align="middle"></div>
      <p><pre>   stilts plot2plane <strong>layer1=histogram</strong> <strong>in1=rrlyrae.fits</strong> <strong>x1=p1</strong></pre></p>
      <p>
         <dl>
            <dt><strong><code>barformN = open|filled|semi_filled|steps|semi_steps|spikes</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot/BarStyle.Form.html">Form</a>)</em></strong></dt>
            <dd>How histogram bars are represented.
               Note that options using transparent colours
               may not render very faithfully
               to some vector formats like PDF and EPS.
               
               <p>The available options are:
                  
                  <ul>
                     <li><code>open</code></li>
                     <li><code>filled</code></li>
                     <li><code>semi_filled</code></li>
                     <li><code>steps</code></li>
                     <li><code>semi_steps</code></li>
                     <li><code>spikes</code></li>
                  </ul>
                  
               </p>
               <p>[Default: <code>semi_filled</code>]
               </p>
            </dd>
            <dt><strong><code>binsizeN = +&lt;width&gt;|-&lt;count&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/layer/BinSizer.html">BinSizer</a>)</em></strong></dt>
            <dd>Configures the width of histogram bins.
               If the supplied string is a positive number,
               it is interpreted as a fixed width in the data coordinates
               of the X axis
               (if the X axis is logarithmic, the value is a fixed factor).
               If it is a negative number, then it will be interpreted
               as the approximate number of bins to display across
               the width of the plot
               (though an attempt is made to use only round numbers
               for bin widths).
               
               <p>When setting this value graphically,
                  you can use either the slider to adjust the bin count
                  or the numeric entry field to fix the bin width.
                  
               </p>
               <p>[Default: <code>-30</code>]
               </p>
            </dd>
            <dt><strong><code>colorN = &lt;rrggbb&gt;|red|blue|...</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>cumulativeN = true|false</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Boolean)</em></strong></dt>
            <dd>If true, the histogram bars plotted are calculated
               cumulatively;
               each bin includes the counts from all previous bins.
               
               <p>[Default: <code>false</code>]
               </p>
            </dd>
            <dt><strong><code>dashN = dot|dash|...|&lt;a,b,...&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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 = &lt;cmds&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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 = &lt;in-format&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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 = &lt;table&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>&lt;</code>" character at the start,
                     or a "<code>|</code>" character at the end
                     ("<code>&lt;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> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<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>normaliseN = none|area|unit|maximum|height</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/plot2/layer/Normalisation.html">Normalisation</a>)</em></strong></dt>
            <dd>Defines how, if at all, the bars of histogram-like plots
               are normalised or otherwise scaled vertically.
               
               <p>When used in the time plot only, time-specific options
                  like <code>per_second</code>
                  and <code>per_day</code>
                  are available.
                  
               </p>
               <p>The available options are:
                  
                  <ul>
                     <li><code>none</code>: No normalisation is performed.
                     </li>
                     <li><code>area</code>: The total area of histogram bars is normalised to unity. For cumulative plots, this
                        behaves like <code>height</code>.
                     </li>
                     <li><code>unit</code>: Histogram bars are scaled by the inverse of the bin width in data units. For cumulative
                        plots, this behaves like <code>none</code>.
                     </li>
                     <li><code>maximum</code>: The height of the tallest histogram bar is normalised to unity. For cumulative plots,
                        this behaves like <code>height</code>.
                     </li>
                     <li><code>height</code>: The total height of histogram bars is normalised to unity.
                     </li>
                  </ul>
                  
               </p>
               <p>[Default: <code>none</code>]
               </p>
            </dd>
            <dt><strong><code>phaseN = &lt;number&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Double)</em></strong></dt>
            <dd>Controls where the horizontal zero point for binning
               is set.
               For instance if your bin size is 1,
               this value controls whether bin boundaries are at
               0, 1, 2, .. or 0.5, 1.5, 2.5, ... etc.
               
               <p>A value of 0 (or any integer) will result in
                  a bin boundary at X=0 (linear X axis)
                  or X=1 (logarithmic X axis).
                  A fractional value will give a bin boundary at
                  that value multiplied by the bin width.
                  
               </p>
               <p>[Default: <code>0</code>]
               </p>
            </dd>
            <dt><strong><code>thickN = &lt;pixels&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Integer)</em></strong></dt>
            <dd>Thickness of plotted line in pixels.
               
               <p>[Default: <code>2</code>]
               </p>
            </dd>
            <dt><strong><code>transparencyN = 0..1</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(Double)</em></strong></dt>
            <dd>Transparency with which components are plotted,
               in the range 0 (opaque) to 1 (invisible).
               The value is 1-alpha.
               
               <p>[Default: <code>0</code>]
               </p>
            </dd>
            <dt><strong><code>weightN = &lt;num-expr&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String)</em></strong></dt>
            <dd>Weighting of data points.
               If supplied, each point contributes a value
               to the histogram equal to the data value
               multiplied by this coordinate.
               If not supplied, the effect is the same as
               supplying a fixed value of one.
               
               <p>The value is a numeric algebraic expression based on column names
                  as described in <a href="jel.html">Section 10</a>.
                  
               </p>
            </dd>
            <dt><strong><code>xN = &lt;num-expr&gt;</code> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<em>(String)</em></strong></dt>
            <dd>Horizontal coordinate.
               <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-kde.html">Next</a> <a href="layer-quantile.html">Previous</a> <a href="LayerType.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="layer-kde.html">kde</a><br>
       <b>Up: </b><a href="LayerType.html">Layer Types</a><br>
       <b>Previous: </b><a href="layer-quantile.html">quantile</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>