ess.imaging.normalize.normalize_sample_images#
- ess.imaging.normalize.normalize_sample_images(*, samples, background, factor)[source]#
Normalize the sample image stack.
\[NormalizedImages = SampleImages / Background * ScaleFactor\]- Parameters:
samples (
normalize.SampleImageStacks(scipp.DataArray)) – Sample image stack to be normalized.background (
normalize.BackgroundImage(scipp.DataArray)) – Background image to be used for normalization.factor (
normalize.ScaleFactor(scipp.Variable)) – Scale factor for the normalization.
- Raises:
ValueError: – If the scale factor is negative. It is for the safety of the calculation on short data type. Depending on how you calculate the scale factor, the operation might fail and return negative values.
- Return type: