ess.spectroscopy.indirect.kf.move_time_to_sample#

ess.spectroscopy.indirect.kf.move_time_to_sample(data, pulse_period)[source]#

Return the events with the event_time_offset coordinate offset to time at sample.

Parameters:
  • data (DataGroupedByRotation[TypeVar(RunType, ess.reduce.nexus.types.SampleRun (int), ess.reduce.nexus.types.VanadiumRun (int))]) – Data array with “event_time_offset” and “secondary_flight_time” coordinates.

  • pulse_period (ess.reduce.time_of_flight.types.PulsePeriod (scipp.Variable)) – Duration of a neutron pulse.

Returns:

DataAtSample[TypeVar(RunType, ess.reduce.nexus.types.SampleRun (int), ess.reduce.nexus.types.VanadiumRun (int))] – A shallow copy of data where the “event_time_offset” coordinate has been shifted to the time at the sample.