ess.reduce.unwrap.workflow.GenericUnwrapWorkflow#

ess.reduce.unwrap.workflow.GenericUnwrapWorkflow(*, run_types, monitor_types, wavelength_from='file')[source]#

Generic workflow for computing the neutron wavelength for detector and monitor data.

This workflow builds on the GenericNeXusWorkflow and computes wavelength from a lookup table that is created from the chopper settings, detector Ltotal and the neutron time-of-arrival.

It is possible to limit which run types and monitor types are supported by the returned workflow. This is useful to reduce the size of the workflow and make it easier to inspect. Make sure to add all required run types and monitor types when using this feature.

Attention

Filtering by run type and monitor type does not work with nested type vars. E.g., if you have a type like Outer[Inner[RunType]], this type and its provider will be removed.

Parameters:

run_types (Iterable[type]) – List of run types to include in the workflow. Constrains the possible values of ess.reduce.nexus.types.RunType.
monitor_types (Iterable[type]) – List of monitor types to include in the workflow. Constrains the possible values of ess.reduce.nexus.types.MonitorType and ess.reduce.nexus.types.Component.
wavelength_from (WavelengthLutMode, default: 'file') – Mode for creating the wavelength lookup table. Possible values are ‘analytical’, ‘simulation’, and ‘file’. See https://scipp.github.io/ess/reduce/user-guide/unwrap/lut-building-methods.html

Returns:

Pipeline – The workflow.