ess.reduce.time_of_flight.toa_to_tof.time_of_flight_data#
- ess.reduce.time_of_flight.toa_to_tof.time_of_flight_data(da, lookup, ltotal, pulse_period, pulse_stride, pulse_stride_offset)[source]#
Convert the time-of-arrival data to time-of-flight data using a lookup table. The output data will have a time-of-flight coordinate.
- Parameters:
da (
time_of_flight.types.RawData
(scipp.DataArray
)) – Raw detector data loaded from a NeXus file, e.g., NXdetector containing NXevent_data.lookup (
time_of_flight.types.TimeOfFlightLookupTable
(scipp.DataArray
)) – Lookup table giving time-of-flight as a function of distance and time of arrival.ltotal (
time_of_flight.types.Ltotal
(scipp.Variable
)) – Total length of the flight path from the source to the detector.pulse_period (
time_of_flight.types.PulsePeriod
(scipp.Variable
)) – Period of the source pulses, i.e., time between consecutive pulse starts.pulse_stride (
time_of_flight.types.PulseStride
(int
)) – Stride of used pulses. Usually 1, but may be a small integer when pulse-skipping.pulse_stride_offset (
time_of_flight.types.PulseStrideOffset
(int
)) – When pulse-skipping, the offset of the first pulse in the stride. This is typically zero but can be a small integer < pulse_stride.
- Return type: