Skip to content

Commit 2397d65

Browse files
committed
Add explanation of _monitor_mask
1 parent 7cba862 commit 2397d65

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/ess/reduce/normalization.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ def normalize_by_monitor_histogram(
7777
-------
7878
:
7979
``detector`` normalized by ``monitor``.
80+
If the monitor has masks or contains non-finite values, the output has a mask
81+
called '_monitor_mask' constructed from the monitor masks and non-finite values.
8082
8183
See also
8284
--------
@@ -144,6 +146,8 @@ def normalize_by_monitor_integrated(
144146
-------
145147
:
146148
`detector` normalized by a monitor.
149+
If the monitor has masks or contains non-finite values, the output has a mask
150+
called '_monitor_mask' constructed from the monitor masks and non-finite values.
147151
148152
See also
149153
--------

0 commit comments

Comments
 (0)