ess.reduce.unwrap.lut.simulate_chopper_cascade_using_tof#

ess.reduce.unwrap.lut.simulate_chopper_cascade_using_tof(choppers, source_position, neutrons, pulse_stride, seed, facility, wmin, wmax)[source]#

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

Parameters:

choppers (FrameCompatibleDiskChoppers[TypeVar(RunType)]) – A dict of DiskChopper objects representing the choppers in the beamline. See https://scipp.github.io/scippneutron/user-guide/chopper/processing-nexus-choppers.html for more information.
source_position (Position[NXsource, TypeVar(RunType)]) – A scalar variable with dtype=vector3 that defines the source position. Must be in the same coordinate system as the choppers’ axle positions.
neutrons (unwrap.lut.NumberOfSimulatedNeutrons (int)) – Number of neutrons to simulate.
pulse_stride (PulseStride[TypeVar(RunType)]) – The pulse strinde; we need to simulate at least enough pulses to cover the requested stride.
seed (unwrap.lut.SimulationSeed (types.int | None)) – Seed for the random number generator used in the simulation.
facility (unwrap.lut.SimulationFacility (str)) – Facility where the experiment is performed.
wmin (unwrap.lut.SimulationMinWavelength (types.scipp._scipp.core.Variable | None)) – Minimum wavelength of the neutrons in the simulation.
wmax (unwrap.lut.SimulationMaxWavelength (types.scipp._scipp.core.Variable | None)) – Maximum wavelength of the neutrons in the simulation.

Return type:

SimulationResults[TypeVar(RunType)]