scippneutron.tof.unwrap.frame_period#
- scippneutron.tof.unwrap.frame_period(pulse_period, pulse_stride)[source]#
Return the period of a frame, which is defined by the pulse period times the pulse stride.
- Parameters:
pulse_period (
tof.unwrap.PulsePeriod(scipp.Variable)) – Period of the source pulses, i.e., time between consecutive pulse starts.pulse_stride (
tof.unwrap.PulseStride(int)) – Stride of used pulses. Usually 1, but may be a small integer when pulse-skipping.
- Return type: