ess.reduce.time_of_flight.types.SimulationResults#

class ess.reduce.time_of_flight.types.SimulationResults(time_of_arrival, speed, wavelength, weight, distance)[source]#

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

The results (apart from distance) should be flat lists (1d arrays) of length N where N is the number of neutrons, containing the properties of the neutrons in the simulation.

Parameters:
  • time_of_arrival (Variable) – Time of arrival of the neutrons at the position where the events were recorded (1d array of size N).

  • speed (Variable) – Speed of the neutrons, typically derived from the wavelength of the neutrons (1d array of size N).

  • wavelength (Variable) – Wavelength of the neutrons (1d array of size N).

  • weight (Variable) – Weight/probability of the neutrons (1d array of size N).

  • distance (Variable) – Distance from the source to the position where the events were recorded (single value; we assume all neutrons were recorded at the same position). For a tof simulation, this is just the position of the detector where the events are recorded. For a McStas simulation, this is the distance between the source and the event monitor.

__init__(time_of_arrival, speed, wavelength, weight, distance)#

Methods

__init__(time_of_arrival, speed, wavelength, ...)

Attributes

time_of_arrival

speed

wavelength

weight

distance