\(\renewcommand\AA{\unicode{x212B}}\)

DgsPreprocessData v1

../_images/DgsPreprocessData-v1_dlg.png

DgsPreprocessData dialog.

Summary

Preprocess data via an incident beam parameter.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory An input workspace.
InputMonitorWorkspace Input MatrixWorkspace   A monitor workspace associated with the input workspace.
OutputWorkspace Output MatrixWorkspace Mandatory The name for the output workspace.
TofRangeOffset Input number 0 An addition to the TOF axis for monitor integration.
ReductionProperties Input string __dgs_reduction_properties  

Description

This algorithm is responsible for normalising data via a given incident beam parameter. This parameter, IncidentBeamNormalisation, is controlled from the reduction property manager. It can have the values None, ByCurrent or ByMonitor. For SNS, monitor workspaces need to be passed. Parameters in italics are controlled by the instrument parameter file (IPF) unless provided to the algorithm via a property manager. The mappings are given below.

Parameter IPF Mapping
MonitorIntRangeLow norm-mon1-min
MonitorIntRangeHigh norm-mon1-max

Parameters in italics with dashed perimeters are only controllable by the IPF name given. All underlined parameters are fixed via other input methods. If normalisation is performed, a sample log called DirectInelasticReductionNormalisedBy is added to the resulting workspace with the normalisation procedure used.

Usage

Warning

This algorithm is not really intended for use at the command line, but is used within DgsReduction.

Categories: AlgorithmIndex | Workflow\Inelastic\UsesPropertyManager

Source

C++ header: DgsPreprocessData.h (last modified: 2021-03-31)

C++ source: DgsPreprocessData.cpp (last modified: 2021-05-24)