ess.reduce.normalization.normalize_by_monitor_integrated#

ess.reduce.normalization.normalize_by_monitor_integrated(detector, *, monitor, uncertainty_broadcast_mode, skip_range_check=False)[source]#

Normalize detector data by an integrated monitor.

This normalization accounts only for the integrated neutron flux, meaning measurement duration and source strength. It does not account for the (wavelength) profile of the incident beam. For that, see normalize_by_monitor_histogram().

Let \(d_i\) be a detector event or the counts in a detector bin. The normalized detector is

\[d_i^\text{Norm} = \frac{d_i}{\sum_j\, m_j}\]

where \(m_j\) is the monitor counts in bin \(j\). Note that this is not a true integral but only a sum over monitor events.

The result depends on the range of the monitor but not its binning within that range.

Parameters:

  • detector (DataArray) – Input detector data.

  • monitor (DataArray) – A histogrammed monitor. Must be one-dimensional and have a dimension coordinate, typically “wavelength”.

  • uncertainty_broadcast_mode (UncertaintyBroadcastMode) – Choose how uncertainties of the monitor are broadcast to the sample data.

  • skip_range_check (bool, default: False) –

    If false (default), the detector data must be within the range of the monitor coordinate. Set this to true to disable the check. The value of out-of-range bins / events is undefined in that case.

    This is useful when the detector contains data outside the monitor range, and it is difficult or impossible to slice the detector without also removing in-range data. In this case, the caller can mask those data points and skip the range check. normalize_by_monitor_histogram does not take masks into account when checking ranges as that is expensive to implement in a general case.

Returns:

DataArray – detector normalized by a monitor. If the monitor has masks or contains non-finite values, the output has a mask called ‘_monitor_mask’ constructed from the monitor masks and non-finite values.

See also

normalize_by_monitor_histogram

Normalize by a monitor histogram.