ess.reduce.time_of_flight.lut.simulate_chopper_cascade_using_tof

ess.reduce.time_of_flight.lut.simulate_chopper_cascade_using_tof(choppers, source_position, neutrons, pulse_stride, seed, facility)

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

Parameters:

• choppers (DiskChoppers) – A dict of DiskChopper objects representing the choppers in the beamline. See https://scipp.github.io/scippneutron/user-guide/chopper/processing-nexus-choppers.html#Build-DiskChopper for more information.

• source_position (time_of_flight.lut.SourcePosition (scipp.Variable)) – A scalar variable with dtype=vector3 that defines the source position. Must be in the same coordinate system as the choppers’ axle positions.

• neutrons (time_of_flight.lut.NumberOfSimulatedNeutrons (int)) – Number of neutrons to simulate.

• pulse_stride (time_of_flight.lut.PulseStride (int)) – The pulse strinde; we need to simulate at least enough pulses to cover the requested stride.

• seed (time_of_flight.lut.SimulationSeed (types.int | None)) – Seed for the random number generator used in the simulation.

• facility (time_of_flight.lut.SimulationFacility (str)) – Facility where the experiment is performed.

Return type:

SimulationResults