Ticket42 sum detect monitor spectra #66
Conversation
esmith1729
commented
Nov 19, 2024
esmith1729
commented
- Sum detector/monitor spectra with tof/wavelength bounds #42
…default monitor and detector summers to sum_spectra
…f bound and wavelength bounding of spectra
…ter for tof_bounded_spectra and wavelength_bounded_spectra
| @@ -205,6 +205,54 @@ Published signals: | |||
| - `reducer.mon_counts_stddev` - uncertainty (standard deviation) of the summed monitor counts | |||
| - `reducer.intensity_stddev` - uncertainty (standard deviation) of the normalised intensity | |||
|
|
|||
| ### Time of Flight and Wavelength Bounding Spectra | |||
|
|
|||
| Scalar Normalizers (such as PeriodGoodFramesNormalizer, GoodFramesNormalizer) can be passed a | |||
There was a problem hiding this comment.
nit: maybe you could link these to api docs? something like:
{py:obj}`ibex_bluesky_core.some.path.PeriodGoodFramesNormalizer`
should make a "nice" link to the API docs out of this.
| - In either case, the bounds are passed as a scipp array, which needs a `dims` attribute, `values` passed | ||
| as a list, and `units` (μs/microseconds for time of flight bounding, and angstrom for wavelength bounding) | ||
|
|
||
| - If you don't specify either of these options, they will default to an unbounded spectra |
There was a problem hiding this comment.
clarity nit:
| - If you don't specify either of these options, they will default to an unbounded spectra | |
| - If you don't specify either of these options, they will default to summing over the entire spectrum. |
| import scipp | ||
|
|
||
| wavelength_bounds = scipp.array(dims=["tof"], values=[0.0, 5.1], unit=scipp.units.angstrom, dtype="float64") | ||
| beam_total = scipp.scalar(value=85.0, unit=sc.units.m), |
There was a problem hiding this comment.
clarity nit:
beam_total is a bit ambiguous - maybe total_flight_path_length is clearer?
| {py:obj}`ibex_bluesky_core.devices.simpledae.reducers.tof_bounded_spectra` | ||
|
|
||
|
|
||
| Monitor Normalizers, which have both a monitor as well as detector, can be passed a summing function for each of these components independently, e.g. the detector can use time of flight while the monitor uses wavelength. Here is an example with wavelength bounding used to sum the monitor component, and time of flight bounding for the detector summing spectra: |
There was a problem hiding this comment.
should: somewhere we need to explain that while you can use different flight path lengths for detectors & monitors, there is an assumption that the flight path length is the same for all detector pixels. This will usually be true for the kinds of detector pixels that are regularly scanned over.
(We could in future allow a length-per-pixel, but not as part of this ticket)
| and monitor normalizers. | ||
|
|
||
| Both Scalar Normalizers (PeriodGoodFramesNormalizer, GoodFramesNormalizer) and MonitorNormalizers | ||
| provide the following: |
There was a problem hiding this comment.
nit:
| provide the following: | |
| accept the following arguments: |
|
|
||
|
|
||
| def wavelength_bounded_spectra( | ||
| bounds: sc.Variable, beam_total: sc.Variable |
There was a problem hiding this comment.
nit:
As per comment in docs earlier, I think beam_total is a little ambiguous, can we think of a clearer name? total_flight_path_length?
|
|
||
| assert det_counts == 500 # 500 from first detector | ||
| assert mon_counts == 2000 # 2000 half of monitor first bin | ||
| assert intensity == pytest.approx(0.25) # 500 / 2500 |
There was a problem hiding this comment.
unless I'm really bad at maths...
| assert intensity == pytest.approx(0.25) # 500 / 2500 | |
| assert intensity == pytest.approx(0.25) # 500 / 2000 |
| intensity = await monitor_normalizer_zero_to_one_half_det_norm_mon_tof.intensity.get_value() | ||
|
|
||
| assert det_counts == 9000.0 # 1 + 2 + 3 + 2 + 1 from detector = 9 | ||
| assert mon_counts == 500.0 # 1k / 2k = 500 from monitor |
There was a problem hiding this comment.
| assert mon_counts == 500.0 # 1k / 2k = 500 from monitor | |
| assert mon_counts == 500.0 # 1k / 2 = 500 from monitor |
?
| if "tof" not in bounds.dims: | ||
| raise ValueError("Should contain tof dims") |
There was a problem hiding this comment.
could: In the other one we also check bounds have length 2, should that be done here too?
| async def sum_spectra_with_wavelength( | ||
| spectra: Collection[DaeSpectra], | ||
| ) -> sc.Variable | sc.DataArray: | ||
| """Sum spectra and convert time of flight to wavelength.""" |
There was a problem hiding this comment.
nit: can we make this docstring a little more precise?
e.g.
| """Sum spectra and convert time of flight to wavelength.""" | |
| """Sum a set of spectra between the specified wavelength bounds.""" |
