ess.reduce.unwrap.lut#

Utilities for computing wavelength lookup tables.

Module Attributes

NumberOfSimulatedNeutrons

Number of neutrons simulated in the simulation that is used to create the lookup table.

DistanceResolution

Step size of the distance axis in the lookup table.

TimeResolution

Step size of the event_time_offset axis in the lookup table.

PulsePeriod

Period of the source pulses, i.e., time between consecutive pulse starts.

SimulationSeed

Seed for the random number generator used in the simulation.

SimulationFacility

Facility where the experiment is performed, e.g., 'ess'.

SimulationMinWavelength

Minimum wavelength of the neutrons in the simulation used to create the lookup table.

SimulationMaxWavelength

Maximum wavelength of the neutrons in the simulation used to create the lookup table.

Functions

chopper_distance_along_beam(axle_position, ...)

Flight distance from the source to a chopper along the incident beam.

close_non_synced_disk_choppers(choppers, ...)

If a chopper's frequency is not in sync with the frame frequency (it is not a multiple of the frame frequency), it is replaced with a chopper that is always closed.

compute_frame_sequence(pulse_period, ...)

Compute the chopper frame sequence for a given set of disk choppers and source pulse parameters.

default_parameters([wavelength_from])

get_active_choppers(choppers)

Return a dict of choppers that are active (i.e., have a non-zero frequency).

guess_pulse_stride_from_choppers(choppers, ...)

If the pulse stride is not provided, we try to guess it from the chopper parameters.

load_lookup_table_from_file(filename)

Load a wavelength lookup table from an HDF5 file.

ltotal_range_from_ltotal_detector(ltotal)

Compute the range of total flight path lengths from the source to the detector from the ltotal variable in the input data for the detector workflow.

ltotal_range_from_ltotal_monitor(ltotal)

Compute the range of total flight path lengths from the source to the detector from the ltotal variable in the input data for the monitor workflow.

make_wavelength_lut_from_polygons(...)

Compute a lookup table for wavelength as a function of distance and time-of-arrival.

make_wavelength_lut_from_simulation(...)

Compute a lookup table for wavelength as a function of distance and time-of-arrival.

providers([wavelength_from])

simulate_chopper_cascade_using_tof(choppers, ...)

Simulate a pulse of neutrons propagating through a chopper cascade using the tof package (https://scipp.github.io/tof).

Classes

ActiveDiskChoppers(x)

A dict of choppers that are active (i.e., have a non-zero frequency).

BeamlineComponentReading(time_of_arrival, ...)

Reading at a given position along the beamline from a time-of-flight simulation.

ChopperFrameSequence(frames)

Sequence of chopper frames used to compute the wavelength as a function of distance and event_time_offset in the lookup table.

FrameCompatibleDiskChoppers(x)

Disk choppers compatible with the frame period (which is made from the source period and the pulse stride).

LtotalRange(x)

Range (min, max) of the total length of the flight path from the source to the detector.

PulseStride(x)

Stride of used pulses.

SimulationResults(readings[, choppers])

Results of a time-of-flight simulation used to create a lookup table.

SourceBounds(time, wavelength)

Time and wavelength bounds of the neutrons in the source pulse that encompass all possible neutrons that can be generated by the source.