\(\renewcommand\AA{\unicode{x212B}}\)
DgsConvertToEnergyTransfer v1¶
Summary¶
Algorithm to convert from TOF to energy transfer.
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputWorkspace |
Input |
Mandatory |
A sample data workspace. |
|
InputMonitorWorkspace |
Input |
A monitor workspace associated with the sample workspace. |
||
IncidentEnergyGuess |
Input |
number |
Optional |
This is the starting point for the incident energy calculation. |
IntegratedDetectorVanadium |
Input |
A workspace containing the integrated detector vanadium. |
||
MaskWorkspace |
Input |
A mask workspace |
||
GroupingWorkspace |
Input |
A grouping workspace |
||
AlternateGroupingTag |
Input |
string |
Allows modification to the OldGroupingFile property name |
|
OutputWorkspace |
Output |
Mandatory |
The name for the output workspace. |
|
OutputTibWorkspace |
Output |
Mandatory |
The name for the output TIB workspace. |
|
ReductionProperties |
Input |
string |
__dgs_reduction_properties |
Description¶
This algorithm is responsible for making the conversion from time-of-flight to energy transfer for direct geometry spectrometers. The diagram below shows the workflow for the algorithm. The SNS instruments have a log called EnergyRequest which allows the IncidentEnergyGuess parameter to be left blank. Also, SNS instruments need to pass a monitor workspace to GetEi since they are separate from the sample workspace. 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 |
|---|---|
TibTofRangeStart |
bkgd-range-min |
TibTofRangeEnd |
bkgd-range-max |
Parameters in italics with dashed perimeters are only controllable by the IPF name given. All underlined parameters are fixed and not controllable. The EnergyTransferRange parameter takes the canonical Mantid notation of (start, step, stop). However, it can be left blank and the following values will be used \((-0.5E^{Guess}_{i}, 0.01E^{Guess}_{i}, 0.99E^{Guess}_{i})\).
The use of the SofPhiEIsDistribution parameter in the last Rebin call is used to set the Rebin algorithm parameter PreserveEvents.
Workflow¶
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: DgsConvertToEnergyTransfer.h
C++ source: DgsConvertToEnergyTransfer.cpp