ess.reduce.time_of_flight.eto_to_tof.compute_tof_lookup_table#
- ess.reduce.time_of_flight.eto_to_tof.compute_tof_lookup_table(simulation, ltotal_range, distance_resolution, time_resolution, pulse_period, pulse_stride, error_threshold)[source]#
Compute a lookup table for time-of-flight as a function of distance and time-of-arrival.
- Parameters:
simulation (
SimulationResults
) – Results of a time-of-flight simulation used to create a lookup table. The results should be a flat table with columns for time-of-arrival, speed, wavelength, and weight.ltotal_range (
time_of_flight.types.LtotalRange
(tuple
)) – Range of total flight path lengths from the source to the detector.distance_resolution (
time_of_flight.types.DistanceResolution
(scipp.Variable
)) – Resolution of the distance axis in the lookup table.time_resolution (
time_of_flight.types.TimeResolution
(scipp.Variable
)) – Resolution of the time-of-arrival axis in the lookup table. Must be an integer.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.error_threshold (
time_of_flight.types.LookupTableRelativeErrorThreshold
(float
)) – Threshold for the relative standard deviation (coefficient of variation) of the projected time-of-flight above which values are masked.
- Return type:
time_of_flight.types.TimeOfFlightLookupTable
(scipp.DataArray
)