Skip to content

Commit 876cc78

Browse files
committed
Improve docs
1 parent 0bb8b60 commit 876cc78

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/ess/reduce/normalization.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ def normalize_by_monitor_histogram(
3232
d_i^\\text{Norm} = \\frac{d_i}{\\bar{m}_i} \\Delta x_i
3333
\\frac{\\sum_j\\,\\bar{m}_j}{\\sum_j\\,\\Delta x_j}
3434
35-
where :math:`\\Delta x_i` is the width of monitor bin :math:`i` (see below).
35+
where :math:`\\Delta x_i = x_{i+1} - x_i` is the width of
36+
monitor bin :math:`i` (see below).
3637
This normalization leads to a result that has the same
3738
unit as the input detector data.
3839
@@ -46,16 +47,16 @@ def normalize_by_monitor_histogram(
4647
:func:`scipp.lookup`. This means that for each event, the monitor value
4748
is obtained from the monitor histogram at that event coordinate value.
4849
49-
This function is based on the implementation in
50+
This function is based on the implementation of
5051
`NormaliseToMonitor <https://docs.mantidproject.org/nightly/algorithms/NormaliseToMonitor-v1.html>`_
51-
of Mantid.
52+
in Mantid.
5253
5354
Parameters
5455
----------
5556
detector:
5657
Input detector data.
5758
Must have a coordinate named ``monitor.dim``, that is, the single
58-
dimension name of the monitor.
59+
dimension name of the **monitor**.
5960
monitor:
6061
A histogrammed monitor.
6162
Must be one-dimensional and have a dimension coordinate, typically "wavelength".

0 commit comments

Comments
 (0)