SofQWMomentsScan v1#
Summary#
Runs an energy transfer reduction for an inelastic indirect geometry instrument.
Properties#
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
InputFiles |
Input |
str list |
Comma separated list of input files |
|
LoadLogFiles |
Input |
boolean |
True |
Load log files when loading runs |
CalibrationWorkspace |
Input |
Workspace containing calibration data |
||
Instrument |
Input |
string |
Mandatory |
Instrument used during run. Allowed values: [‘IRIS’, ‘OSIRIS’] |
Analyser |
Input |
string |
Mandatory |
Analyser bank used during run. Allowed values: [‘graphite’, ‘mica’, ‘fmica’] |
Reflection |
Input |
string |
Mandatory |
Reflection number for instrument setup during run. Allowed values: [‘002’, ‘004’, ‘006’] |
SpectraRange |
Input |
int list |
0,1 |
Comma separated range of spectra number to use. |
QRange |
Input |
dbl list |
Mandatory |
Range of background to subtract from raw data in time of flight. Start, Width, End |
EnergyRange |
Input |
dbl list |
Mandatory |
Range of background to subtract from raw data in time of flight. Start, Width, End |
DetailedBalance |
Input |
number |
Optional |
Apply the detailed balance correction |
GroupingMethod |
Input |
string |
Individual |
Method used to group spectra. Allowed values: [‘Individual’, ‘All’, ‘File’, ‘Workspace’, ‘IPF’] |
GroupingWorkspace |
Input |
Workspace containing spectra grouping. |
||
MapFile |
Input |
string |
File containing spectra grouping. Allowed extensions: [‘.map’] |
|
SampleEnvironmentLogName |
Input |
string |
sample |
Name of the sample environment log entry |
SampleEnvironmentLogValue |
Input |
string |
last_value |
Value selection of the sample environment log entry. Allowed values: [‘last_value’, ‘average’] |
ReducedWorkspace |
Input |
string |
Reduced |
The output reduced workspace. |
SqwWorkspace |
Input |
string |
Sqw |
The output Sqw workspace. |
MomentWorkspace |
Input |
string |
Moment |
The output Moment workspace. |
Description#
Performs a data reduction from ISISIndirectEnergyTransfer, before performing the SofQW algorithm and SofQWMoments. Width and diffusion workspaces are then created.
Usage#
Note
To run these usage examples please first download the usage data, and add these to your path. In Mantid this is done using Manage User Directories.
Example - Running SofQWMoments from with an SofQW workspace.
reduced, sqw, moments = SofQWMomentsScan(InputFiles='OSIRIS100320', LoadLogFiles=False, Instrument='OSIRIS', Analyser='graphite', Reflection='002', SpectraRange='3,53',
QRange='0,0.1,2', EnergyRange='-0.4,0.01,0.4')
Categories: AlgorithmIndex | Workflow\Inelastic | Inelastic\Indirect | Workflow\MIDAS
Source#
Python: SofQWMomentsScan.py