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

IndirectQuickRun v1

Summary

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

Properties

Name

Direction

Type

Default

Description

InputFiles

Input

str list

A comma separated list of run numbers.

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

Mandatory

Energy range for the elastic component.

InelasticRange

Input

dbl list

Mandatory

Energy range for the inelastic component.

TotalRange

Input

dbl list

Mandatory

Energy range for the total energy component.

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.

WidthFit

Input

boolean

False

Perform a 2 peak width Fit.

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. It also provides the option to perform a Width Fit which utilizes the IndirectTwoPeakFit algorithm.

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 - 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: AlgorithmIndex | Workflow\Inelastic | Inelastic\Indirect | Workflow\MIDAS

Source

Python: IndirectQuickRun.py