ess.reduce.uncertainty#

Tools for handling statistical uncertainties.

This module provides tools for handling statistical uncertainties in the context of data reduction. Handling variances during broadcast operations is not handled correctly by Scipp because correlations are not tracked. See https://doi.org/10.3233/JNR-220049 for context.

This module provides three ways of handling variances during broadcast operations, defined by UncertaintyBroadcastMode. The recommended use of this module is via the broadcast_uncertainties() helper function.

Module Attributes

UncertaintyBroadcastMode(value)

Mode for broadcasting uncertainties.

Functions

`broadcast_uncertainties`(data, /, *, ...)	Broadcast uncertainties using the specified mode.
`broadcast_with_upper_bound_variances`(data, ...)	Compute an upper bound for the variances of the broadcasted data.
`drop_variances_if_broadcast`(data, /, *, ...)	Drop variances if the data is broadcasted.

Classes

UncertaintyBroadcastMode(value)

Mode for broadcasting uncertainties.