ess.freia.workflow.FreiaOffspecWorkflow#

ess.freia.workflow.FreiaOffspecWorkflow(*, incident_beam_from='closest', wavelength_from='file', **kwargs)[source]#

Workflow for unnormalized, coplanar off-specular FREIA data.

Supply UpstreamSlitCenters and DownstreamSlitCenters for SampleRun as dictionaries pairing the fixed openings of each candidate incident beam. The assigned incident_angle and measured reflection_angle determine Qx and Qz. The output is CorrectedDetector[SampleRun].

Parameters:

  • incident_beam_from (Literal['closest', 'fixed_slits', 'shutter_logs'], default: 'closest') – 'closest' assigns the beam whose specular reflection angle is closest to the measured reflection angle. 'fixed_slits' uses the single beam defined by one matching pair of slit centers, independently of the reflection angle and without shutter positions or status logs. 'shutter_logs' uses ShutterStatusLogs[SampleRun] and ShutterPositions[SampleRun] for all candidate beams. Each log is evaluated at the neutron’s crossing time at that shutter, independently of the slit positions. Exactly one open shutter, with all states known, determines the incident beam. Otherwise the incidence is NaN and the event is masked as incident_beam_unassigned.

  • wavelength_from (WavelengthLutMode, default: 'file') – Wavelength lookup table mode: ‘analytical’, ‘simulation’, or ‘file’.

Return type:

Pipeline