/usr/share/slsh/local-packages/help/histogram.hlp is in slang-histogram 0.3.2a-3.1.
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 | hist1d
SYNOPSIS
Compute a 1-d histogram
USAGE
h = hist1d (pnts, grid [, &rev)
DESCRIPTION
The `hist1d' function bins a set of points `pnts' into a
1-d histogram using bin-edges given by the grid argument. The
optional third argument `&rev' is a reference to a variable
whose value will be assigned the reverse-indices of the histogram.
The value of the ith bin in the histogram is given by the number of
values in the `pnts' array that satisfy
`grid[i]<=X<grid[i+1]' where `X' represents the value of
the candidate point. The last bin of the histogram represents an
overflow bin with the right bin edge at plus infinity. The grid is
required to be sorted into ascending order.
The reverse-indices array is an array-of-arrays of indices such that
`rev[i]' is an array of indices into the `pnts' array that
have fallen into the ith bin.
SEE ALSO
hist1d_rebin, hist2d, hist2d_rebin, hist_bsearch
--------------------------------------------------------------
hist2d
SYNOPSIS
Compute a 2-d histogram
USAGE
h = hist2d (xpnts, ypnts, xgrid, ygrid, [, &rev])
DESCRIPTION
The `hist2d' function bins a set of `(x,y)' pairs
represented by the `xpnts' and `ypnts' arrays into a 2-d
histogram using bin-edges given by the `xgrid' and `ygrid'
arguments. The optional fifth argument `&rev' is a reference to
a variable whose value will be assigned the reverse-indices of the
histogram.
The value of the bin `[i,j]' of the histogram is given by the
number of (X,Y) pairs that satisfy `xgrid[i]<=X<xgrid[i+1]' and
`ygrid[i]<=Y<ygrid[i+1]'. The bins at the extreme edges of the
histogram represent overflow bins with the upper bin edge at plus
infinity. The grids are required to be sorted into ascending order.
The reverse-indices array is a 2-d array-of-arrays of indices such that
`rev[i,j]' is an array of indices into the `xpnts' and
`ypnts' arrays that have fallen into the bin `[i,j]'.
SEE ALSO
hist1d, whist2d, hist2d_rebin, hist1d_rebin, hist_bsearch
--------------------------------------------------------------
hist1d_rebin
SYNOPSIS
Rebin a 1-d histogram
USAGE
new_h = hist1d_rebin (new_grid, old_grid, old_h)
DESCRIPTION
The `hist1d_rebin' function rebins a histogram `old_h'
with bin edges defined by `old_grid' into a histogram with bin
edges given by `new_grid'.
Unlike the `hist1d' function which returns an integer array,
the `hist1d_rebin' function returns an array of doubles since
the new grid does not have to be commensurate with the old grid.
SEE ALSO
hist1d, hist2d_rebin, hist2d, hist_bsearch
--------------------------------------------------------------
hist2d_rebin
SYNOPSIS
Rebin a 2-d histogram
USAGE
new_h = hist2d_rebin (new_xgrid, new_ygrid, old_xgrid, old_ygrid, old_h)
DESCRIPTION
The `hist2d_rebin' function rebins a 2-d histogram `old_h'
with bin edges defined by `old_xgrid' and `old_ygrid' into
a 2-d histogram with bin edges given by `new_xgrid' and
`new_ygrid'.
Unlike the `hist2d' function which returns an integer array,
the `hist2d_rebin' function returns an array of doubles since
the new grids do not have to be commensurate with the old grids.
SEE ALSO
hist1d_rebin, hist2d, whist2d, hist_bsearch
--------------------------------------------------------------
hist_bsearch
SYNOPSIS
Perform a binary search
USAGE
i = hist_bsearch (x, xbins)
DESCRIPTION
The `hist_bsearch' function performs a binary search for the
bin `i' satisfying `xbins[i]<=x<xbins[i+1]'. If the value
`x' is greater than or equal to the value of the last bin, the
index of the last bin will be returned. If `x' is smaller than
the value of the first bin (`xbins[0]'), then the function will
return the index of the first bin, i.e., `0'. The grid is
required to be sorted into ascending order.
If the value of `x' is an array, an array of indices will be
returned.
NOTES
As pointed out above, if the value of `x' is less than the value
of the first bin, the index of the first bin will be returned even
though `x' does not belong to the bin. If this behavior is not
desired, then such points should be filtered out before the binary
search is performed.
SEE ALSO
hist1d, hist1d_rebin
--------------------------------------------------------------
whist1d
SYNOPSIS
Created a weighted 1-d histogram
USAGE
h = whist1d (pnts, wghts, grid [,&rev [,&weight_func]]
DESCRIPTION
The `whist1d' function creates a 1-dimensional weighted
histogram. The value of the ith bin in the histogram is given by a
function applied to values of the `wghts' that correspond to
those values in the `pnts' array that satisfy
`grid[i]<=X<grid[i+1]' where `X' represents the value of
the candidate point. The last bin of the histogram represents an
overflow bin with the right bin edge at plus infinity. The grid is
required to be sorted into ascending order.
If the optional fourth argument `&rev' is present, upon return
it will be set to the array of reverse-indices of the histogram. The
optional `&weight_func' argument may be used to specify the
function to be applied to the weights array. By default, the
`sum' function will be used.
NOTES
The source code to this function may be found in `histogram.sl'.
As such, it is available only after this file has been loaded.
Simply importing the module will not load this function into the
interpreter.
SEE ALSO
hist1d, whist2d, hist1d_rebin
--------------------------------------------------------------
whist2d
SYNOPSIS
Created a weighted 2-d histogram
USAGE
h = whist2d (xpnts, ypnts, wghts, xgrid, ygrid [,&rev [,&weight_func]]
DESCRIPTION
The `whist2d' function creates a 2-dimensional weighted
histogram. The value of the bin `[i,j]' of the histogram is
given by a function applied to those values in the `wghts' array
that correspond to the (X,Y) pairs that satisfy
`xgrid[i]<=X<xgrid[i+1]' and `ygrid[i]<=Y<ygrid[i+1]'. The
bins at the extreme edges of the histogram represent overflow bins
with the upper bin edge at plus infinity. The grids are required to
be sorted into ascending order.
If the optional sixth argument `&rev' is present, upon return
it will be set to the array of reverse-indices of the histogram. The
optional `&weight_func' argument may be used to specify the
function to be applied to the weights array. By default, the
`sum' function will be used.
NOTES
The source code to this function may be found in `histogram.sl'.
As such, it is available only after this file has been loaded.
Simply importing the module will not load this function into the
interpreter.
SEE ALSO
hist2d, whist1d, hist1d, hist2d_rebin
--------------------------------------------------------------
|