IndirectQuickRun v1

../_images/IndirectQuickRun-v1_dlg.png

IndirectQuickRun dialog.

Summary

Runs an energy transfer reduction for an inelastic indirect geometry instrument.

Properties

Name Direction Type Default Description
RunNumbers Input str list   List of input runs
LoadLogFiles Input boolean True Load log files when loading runs
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.
ElasticRange Input dbl list   Range of background to subtract from raw data in time of flight.
InelasticRange Input dbl list   Range of background to subtract from raw data in time of flight.
DetailedBalance Input number Optional  
GroupingMethod Input string Individual Method used to group spectra. Allowed values: [‘Individual’, ‘All’, ‘File’]
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’]
MSDFit Input boolean False Perform an MSDFit, do not use with GroupingMethod as “All”
SumFiles Input boolean False Toggle input file summing or sequential processing
Plot Input boolean False Switch Plot Off/On
Save Input boolean False Switch Save result to nxs file Off/On

Description

Runs the EnergyWindowScan algorithm with slightly customised inputs and provides options for plotting and saving output.

Usage

Note

To run these usage examples please first download the usage data, and add these to your path. In MantidPlot this is done using Manage User Directories.

Example - IRIS Energy Window Scan

IndirectQuickRun(RunNumbers="21360", Instrument='IRIS', Analyser='graphite',
                 Reflection='002', SpectraRange='3, 50', ElasticRange='-0.5, 0',
                 InelasticRange='0, 0.5', GroupingMethod='Individual', MSDFit=True)

Categories: Algorithm Index | Workflow\Inelastic | Inelastic\Indirect | Workflow\MIDAS

Source

Python: IndirectQuickRun.py (last modified: 2018-10-05)