ess.reduce.time_of_flight.types.TimeOfFlightLookupTable

class ess.reduce.time_of_flight.types.TimeOfFlightLookupTable(array, pulse_period, pulse_stride, distance_resolution, time_resolution, error_threshold, choppers=None)

Lookup table giving time-of-flight as a function of distance and time of arrival.

__init__(array, pulse_period, pulse_stride, distance_resolution, time_resolution, error_threshold, choppers=None)

Methods

__init__(array, pulse_period, pulse_stride, ...)
plot(*args, **kwargs)	Plot the data array of the lookup table.
save_hdf5(filename)	Save the lookup table to an HDF5 file.

Attributes

choppers	Chopper parameters used when generating the lookup table, if any.
array	The lookup table data array that maps (distance, time_of_arrival) to time_of_flight.
pulse_period	Pulse period of the neutron source.
pulse_stride	Pulse stride used when generating the lookup table.
distance_resolution	Resolution of the distance coordinate in the lookup table.
time_resolution	Resolution of the time_of_arrival coordinate in the lookup table.
error_threshold	The table is masked with NaNs in regions where the standard deviation of the time-of-flight is above this threshold.

array: DataArray

The lookup table data array that maps (distance, time_of_arrival) to time_of_flight.

choppers: DataGroup | None = None

Chopper parameters used when generating the lookup table, if any. This is made optional so we can still support old lookup tables without chopper info.

distance_resolution: Variable

Resolution of the distance coordinate in the lookup table.

error_threshold: float

The table is masked with NaNs in regions where the standard deviation of the time-of-flight is above this threshold.

plot(*args, **kwargs)

Plot the data array of the lookup table.

Return type:

Any

pulse_period: Variable

Pulse period of the neutron source.

pulse_stride: int

Pulse stride used when generating the lookup table.

save_hdf5(filename)

Save the lookup table to an HDF5 file.

Return type:

None

time_resolution: Variable

Resolution of the time_of_arrival coordinate in the lookup table.